public abstract class

AbstractJasperReportsSingleFormatView

extends AbstractJasperReportsView

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

Known Direct Subclasses

ConfigurableJasperReportsView, JasperReportsCsvView, JasperReportsHtmlView, JasperReportsPdfView, JasperReportsXlsView

Class Overview

Extends AbstractJasperReportsView to provide basic rendering logic for views that use a fixed format, e.g. always PDF or always HTML.

Subclasses need to implement two template methods: createExporter to create a JasperReports exporter for a specific output format, and useWriter to determine whether to write text or binary content.

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
	AbstractJasperReportsSingleFormatView()

Protected Methods
abstract JRExporter	createExporter() Create a JasperReports exporter for a specific output format, which will be used to render the report to the HTTP response.
boolean	generatesDownloadContent() Return whether this view generates download content (typically binary content like PDF or Excel files).
void	renderReport(JasperPrint populatedReport, Map<String, Object> model, HttpServletResponse response) Perform rendering for a single Jasper Reports exporter, that is, for a pre-defined output format.
void	renderReportUsingOutputStream(JRExporter exporter, JasperPrint populatedReport, HttpServletResponse response) We need to write binary output to the response OutputStream.
void	renderReportUsingWriter(JRExporter exporter, JasperPrint populatedReport, HttpServletResponse response) We need to write text to the response Writer.
abstract boolean	useWriter() Return whether to use a `java.io.Writer` to write text content to the HTTP response.

[Expand]

Inherited Methods

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 AbstractJasperReportsSingleFormatView ()

Protected Methods

protected abstract JRExporter createExporter ()

Create a JasperReports exporter for a specific output format, which will be used to render the report to the HTTP response.

The useWriter method determines whether the output will be written as text or as binary content.

protected boolean generatesDownloadContent ()

Return whether this view generates download content (typically binary content like PDF or Excel files).

The default implementation returns false. Subclasses are encouraged to return true here if they know that they are generating download content that requires temporary caching on the client side, typically via the response OutputStream.

protected void renderReport (JasperPrint populatedReport, Map<String, Object> model, HttpServletResponse response)

Perform rendering for a single Jasper Reports exporter, that is, for a pre-defined output format.

Parameters

populatedReport	the populated `JasperPrint` to render
model	the map containing report parameters
response	the HTTP response the report should be rendered to

Throws

Exception

protected void renderReportUsingOutputStream (JRExporter exporter, JasperPrint populatedReport, HttpServletResponse response)

We need to write binary output to the response OutputStream.

Parameters

exporter	the JasperReports exporter to use
populatedReport	the populated `JasperPrint` to render
response	the HTTP response the report should be rendered to

Throws

Exception	if rendering failed

protected void renderReportUsingWriter (JRExporter exporter, JasperPrint populatedReport, HttpServletResponse response)

We need to write text to the response Writer.

Parameters

exporter	the JasperReports exporter to use
populatedReport	the populated `JasperPrint` to render
response	the HTTP response the report should be rendered to

Throws

Exception	if rendering failed

protected abstract boolean useWriter ()

Return whether to use a java.io.Writer to write text content to the HTTP response. Else, a java.io.OutputStream will be used, to write binary content to the response.

Classes

AbstractJasperReportsSingleFormatView

Class Overview

See Also

Summary

Public Constructors

public AbstractJasperReportsSingleFormatView ()

Protected Methods

protected abstract JRExporter createExporter ()

See Also

protected boolean generatesDownloadContent ()

protected void renderReport (JasperPrint populatedReport, Map<String, Object> model, HttpServletResponse response)

Parameters

Throws

protected void renderReportUsingOutputStream (JRExporter exporter, JasperPrint populatedReport, HttpServletResponse response)

Parameters

Throws

protected void renderReportUsingWriter (JRExporter exporter, JasperPrint populatedReport, HttpServletResponse response)

Parameters

Throws

protected abstract boolean useWriter ()

See Also