org.springframework.web.servlet.view.jasperreports: public class: ConfigurableJasperReportsView

org.springframework.web.servlet.view.jasperreports
public class: ConfigurableJasperReportsView [javadoc | source]

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

All Implemented Interfaces:
InitializingBean, View, BeanNameAware, ServletContextAware, ApplicationContextAware

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

Also see:

JasperReportsCsvView

JasperReportsHtmlView

JasperReportsPdfView

JasperReportsXlsView

author: Rob - Harrop

since: 2.0 -

Fields inherited from org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsView:
HEADER_CONTENT_DISPOSITION, CONTENT_DISPOSITION_INLINE

Fields inherited from org.springframework.web.servlet.view.AbstractView:
DEFAULT_CONTENT_TYPE

Fields inherited from org.springframework.context.support.ApplicationObjectSupport:
logger

Method from org.springframework.web.servlet.view.jasperreports.ConfigurableJasperReportsView Summary:
createExporter, onInit, setExporterClass, setUseWriter, useWriter

Methods from org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsSingleFormatView:
createExporter, generatesDownloadContent, mergeExporterParameters, renderReport, renderReportUsingOutputStream, renderReportUsingWriter, useWriter

Methods from org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsView:
convertExporterParameters, convertParameterValue, convertReportData, convertToExporterParameter, exposeLocalizationContext, fillReport, getConvertedExporterParameters, getExporterParameter, getExporterParameters, getJdbcDataSource, getReport, getReportCompiler, getReportData, getReportDataTypes, initApplicationContext, isUrlRequired, loadReport, loadReport, onInit, postProcessReport, renderMergedOutputModel, renderReport, setExporterParameters, setHeaders, setJdbcDataSource, setReportCompiler, setReportDataKey, setSubReportDataKeys, setSubReportUrls

Methods from org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsView:

convertExporterParameters, convertParameterValue, convertReportData, convertToExporterParameter, exposeLocalizationContext, fillReport, getConvertedExporterParameters, getExporterParameter, getExporterParameters, getJdbcDataSource, getReport, getReportCompiler, getReportData, getReportDataTypes, initApplicationContext, isUrlRequired, loadReport, loadReport, onInit, postProcessReport, renderMergedOutputModel, renderReport, setExporterParameters, setHeaders, setJdbcDataSource, setReportCompiler, setReportDataKey, setSubReportDataKeys, setSubReportUrls

Methods from org.springframework.web.servlet.view.AbstractUrlBasedView:
afterPropertiesSet, getUrl, isUrlRequired, setUrl, toString

Methods from org.springframework.web.servlet.view.AbstractView:
addStaticAttribute, createRequestContext, exposeModelAsRequestAttributes, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, prepareResponse, render, renderMergedOutputModel, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setRequestContextAttribute, toString

Methods from org.springframework.web.context.support.WebApplicationObjectSupport:
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods from org.springframework.context.support.ApplicationObjectSupport:
getApplicationContext, getMessageSourceAccessor, initApplicationContext, initApplicationContext, isContextRequired, requiredContextClass, setApplicationContext

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.springframework.web.servlet.view.jasperreports.ConfigurableJasperReportsView Detail:
protected JRExporter createExporter() { return (JRExporter) BeanUtils.instantiateClass(this.exporterClass); } Returns a new instance of the specified JRExporter class.
protected void onInit() { if (this.exporterClass == null) { throw new IllegalArgumentException("exporterClass is required"); } } Checks that the exporterClass property is specified.
public void setExporterClass(Class exporterClass) { if (!(JRExporter.class.isAssignableFrom(exporterClass))) { throw new IllegalArgumentException( "Exporter class [" + exporterClass.getName() + "] does not implement JRExporter"); } this.exporterClass = 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) { this.useWriter = useWriter; } Specifies whether or not the JRExporter writes to the java.io.PrintWriter of the associated with the request (`true`) or whether it writes directly to the java.io.InputStream of the request (`false`). Default is `true`.
protected boolean useWriter() { return this.useWriter; } Indicates how the JRExporter should render its data.

Method from org.springframework.web.servlet.view.jasperreports.ConfigurableJasperReportsView Detail:

 protected JRExporter createExporter() {
		return (JRExporter) BeanUtils.instantiateClass(this.exporterClass);
}

JRExporter

 protected  void onInit() {
		if (this.exporterClass == null) {
			throw new IllegalArgumentException("exporterClass is required");
		}
}

exporterClass

 public  void setExporterClass(Class exporterClass) {
	                           	 
		if (!(JRExporter.class.isAssignableFrom(exporterClass))) {
			throw new IllegalArgumentException(
					"Exporter class [" + exporterClass.getName() + "] does not implement JRExporter");
		}
		this.exporterClass = exporterClass;
}

JRExporter

Class

IllegalArgumentException

Class

JRExporter

 public  void setUseWriter(boolean useWriter) {
		this.useWriter = useWriter;
}

JRExporter

java.io.PrintWriter

true

java.io.InputStream

false

true

 protected boolean useWriter() {
		return this.useWriter;
}

JRExporter