public class

ConfigurableJasperReportsView

extends AbstractJasperReportsSingleFormatView

java.lang.Object
↳	org.springframework.context.support.ApplicationObjectSupport
	↳	org.springframework.web.context.support.WebApplicationObjectSupport
		↳	org.springframework.web.servlet.view.AbstractView
			↳	org.springframework.web.servlet.view.AbstractUrlBasedView
				↳	org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsView
					↳	org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsSingleFormatView
						↳	org.springframework.web.servlet.view.jasperreports.ConfigurableJasperReportsView

Class Overview

Configurable JasperReports View, allowing to specify the JasperReports exporter to be specified through bean properties rather than through the view class name.

Summary

[Expand]

Inherited Constants

From class org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsView

From class org.springframework.web.servlet.view.AbstractView

[Expand]

Inherited Fields

From class org.springframework.context.support.ApplicationObjectSupport

From interface org.springframework.web.servlet.View

Public Constructors
	ConfigurableJasperReportsView()

Public Methods
void	setExporterClass(Class<? extends JRExporter> exporterClass) Set the JRExporter implementation `Class` to use.
void	setUseWriter(boolean useWriter) Specifies whether or not the JRExporter writes to the `PrintWriter` of the associated with the request (`true`) or whether it writes directly to the `InputStream` of the request (`false`).

Protected Methods
JRExporter	createExporter() Returns a new instance of the specified JRExporter class.
void	onInit() Checks that the `exporterClass` property is specified.
boolean	useWriter() Indicates how the JRExporter should render its data.

[Expand]

Inherited Methods

From class org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsSingleFormatView

From class org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsView

final void	convertExporterParameters() Converts the exporter parameters passed in by the user which may be keyed by `String`s corresponding to the fully qualified name of the `JRExporterParameter` into parameters which are keyed by `JRExporterParameter`.
Object	convertParameterValue(JRExporterParameter parameter, Object value) Convert the supplied parameter value into the actual type required by the corresponding JRExporterParameter.
JRDataSource	convertReportData(Object value) Convert the given report data value to a `JRDataSource`.
JRExporterParameter	convertToExporterParameter(String fqFieldName) Convert the given fully qualified field name to a corresponding JRExporterParameter instance.
JRDataSource	createReport(JRDataSourceProvider provider) Create a report using the given provider.
void	exposeLocalizationContext(Map<String, Object> model, HttpServletRequest request) Expose current Spring-managed Locale and MessageSource to JasperReports i18n ($R expressions etc).
JasperPrint	fillReport(Map<String, Object> model) Create a populated `JasperPrint` instance from the configured `JasperReport` instance.
Map<JRExporterParameter, Object>	getConvertedExporterParameters() Allows subclasses to retrieve the converted exporter parameters.
JRExporterParameter	getExporterParameter(Object parameter) Return a `JRExporterParameter` for the given parameter object, converting it from a String if necessary.
Map<?, ?>	getExporterParameters() Return the exporter parameters that this view uses, if any.
DataSource	getJdbcDataSource() Return the `javax.sql.DataSource` that this view uses, if any.
JasperReport	getReport() Determine the `JasperReport` to fill.
JRDataSource	getReportData(Map<String, Object> model) Create an appropriate `JRDataSource` for passed-in report data.
Class[]	getReportDataTypes() Return the value types that can be converted to a `JRDataSource`, in prioritized order.
final void	initApplicationContext() Checks to see that a valid report file URL is supplied in the configuration.
boolean	isUrlRequired() JasperReports views do not strictly required a 'url' value.
JasperReport	loadReport() Load the main `JasperReport` from the specified `Resource`.
final JasperReport	loadReport(Resource resource) Loads a `JasperReport` from the specified `Resource`.
void	onInit() Subclasses can override this to add some custom initialization logic.
void	postProcessReport(JasperPrint populatedReport, Map<String, Object> model) Template method to be overridden for custom post-processing of the populated report.
void	renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Finds the report data to use for rendering the report and then invokes the `renderReport(JasperPrint, Map, HttpServletResponse)` method that should be implemented by the subclass.
abstract void	renderReport(JasperPrint populatedReport, Map<String, Object> model, HttpServletResponse response) Subclasses should implement this method to perform the actual rendering process.
void	setConvertedExporterParameters(Map<JRExporterParameter, Object> convertedExporterParameters) Allows subclasses to populate the converted exporter parameters.
void	setExporterParameters(Map<?, ?> parameters) Set the exporter parameters that should be used when rendering a view.
void	setHeaders(Properties headers) Specify the set of headers that are included in each of response.
void	setJdbcDataSource(DataSource jdbcDataSource) Specify the `javax.sql.DataSource` to use for reports with embedded SQL statements.
void	setReportDataKey(String reportDataKey) Set the name of the model attribute that represents the report data.
void	setSubReportDataKeys(String[] subReportDataKeys) Set the list of names corresponding to the model parameters that will contain data source objects for use in sub-reports.
void	setSubReportUrls(Properties subReports) Specify resource paths which must be loaded as instances of `JasperReport` and passed to the JasperReports engine for rendering as sub-reports, under the same keys as in this mapping.

From class org.springframework.web.servlet.view.AbstractUrlBasedView

From class org.springframework.web.servlet.view.AbstractView

void	addStaticAttribute(String name, Object value) Add static data to this view, exposed in each view.
RequestContext	createRequestContext(HttpServletRequest request, HttpServletResponse response, Map<String, Object> model) Create a RequestContext to expose under the specified attribute name.
ByteArrayOutputStream	createTemporaryOutputStream() Create a temporary OutputStream for this view.
void	exposeModelAsRequestAttributes(Map<String, Object> model, HttpServletRequest request) Expose the model objects in the given map as request attributes.
boolean	generatesDownloadContent() Return whether this view generates download content (typically binary content like PDF or Excel files).
Map<String, Object>	getAttributesMap() Allow Map access to the static attributes of this view, with the option to add or override specific entries.
String	getBeanName() Return the view's name.
String	getContentType() Return the content type for this view.
String	getRequestContextAttribute() Return the name of the RequestContext attribute, if any.
Map	getStaticAttributes() Return the static attributes for this view.
void	prepareResponse(HttpServletRequest request, HttpServletResponse response) Prepare the given response for rendering.
void	render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Prepares the view given the specified model, merging it with static attributes and a RequestContext attribute, if necessary.
abstract void	renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view.
void	setAttributes(Properties attributes) Set static attributes for this view from a `java.util.Properties` object.
void	setAttributesCSV(String propString) Set static attributes as a CSV string.
void	setAttributesMap(Map<String, ?> attributes) Set static attributes for this view from a Map.
void	setBeanName(String beanName) Set the view's name.
void	setContentType(String contentType) Set the content type for this view.
void	setRequestContextAttribute(String requestContextAttribute) Set the name of the RequestContext attribute for this view.
String	toString()
void	writeToResponse(HttpServletResponse response, ByteArrayOutputStream baos) Write the given temporary OutputStream to the HTTP response.

From class org.springframework.web.context.support.WebApplicationObjectSupport

From class org.springframework.context.support.ApplicationObjectSupport

From class java.lang.Object

From interface org.springframework.beans.factory.BeanNameAware

From interface org.springframework.beans.factory.InitializingBean

From interface org.springframework.context.ApplicationContextAware

From interface org.springframework.web.context.ServletContextAware

From interface org.springframework.web.servlet.View

Public Constructors

public ConfigurableJasperReportsView ()

Public Methods

public void setExporterClass (Class<? extends JRExporter> exporterClass)

Set the JRExporter implementation Class to use. Throws IllegalArgumentException if the Class doesn't implement JRExporter. Required setting, as it does not have a default.

public void setUseWriter (boolean useWriter)

Specifies whether or not the JRExporter writes to the PrintWriter of the associated with the request (true) or whether it writes directly to the InputStream of the request (false). Default is true.

Protected Methods

protected JRExporter createExporter ()

Returns a new instance of the specified JRExporter class.

protected void onInit ()

Checks that the exporterClass property is specified.

protected boolean useWriter ()

Indicates how the JRExporter should render its data.

Classes

ConfigurableJasperReportsView

Class Overview

See Also

Summary

Public Constructors

public ConfigurableJasperReportsView ()

Public Methods

public void setExporterClass (Class<? extends JRExporter> exporterClass)

public void setUseWriter (boolean useWriter)

Protected Methods

protected JRExporter createExporter ()

See Also

protected void onInit ()

protected boolean useWriter ()

See Also