anyframe.web.springmvc.jasperreports
Class ExtendedAbstractJasperReportsSingleFormatView

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
                  anyframe.web.springmvc.jasperreports.ExtendedAbstractJasperReportsView
                      anyframe.web.springmvc.jasperreports.ExtendedAbstractJasperReportsSingleFormatView

All Implemented Interfaces:

org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.View

Direct Known Subclasses:

ExtendedJasperReportsCsvView, ExtendedJasperReportsHtmlView, ExtendedJasperReportsJXlsView, ExtendedJasperReportsPdfView

public abstract class ExtendedAbstractJasperReportsSingleFormatView
extends ExtendedAbstractJasperReportsView

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.

We changed org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsSingleFormatView Class into anyframe.web.springmvc.common.jasperreports.ExtendedAbstractJasperReportsSingleFormatView Class in Anyframe.

Since:

1.1.5

Author:

Rob Harrop, Juergen Hoeller, modified by Sooyeon Park

See Also:

createExporter(), useWriter()

Field Summary

Fields inherited from class anyframe.web.springmvc.jasperreports.ExtendedAbstractJasperReportsView

CONTENT_DISPOSITION_INLINE, HEADER_CONTENT_DISPOSITION

Fields inherited from class org.springframework.web.servlet.view.AbstractView

DEFAULT_CONTENT_TYPE

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

ExtendedAbstractJasperReportsSingleFormatView()

Method Summary

protected abstract net.sf.jasperreports.engine.JRExporter	createExporter() Create a JasperReports exporter for a specific output format, which will be used to render the report to the HTTP response.
protected java.util.Map	mergeExporterParameters(java.util.Map model) Merges the configured JRExporterParameters with any specified in the supplied model data.
protected void	renderReport(net.sf.jasperreports.engine.JasperPrint populatedReport, java.util.Map model, javax.servlet.http.HttpServletResponse response) Perform rendering for a single Jasper Reports exporter, that is, for a pre-defined output format.
protected abstract boolean	useWriter() Return whether to use a java.io.Writer to write text content to the HTTP response.

Methods inherited from class anyframe.web.springmvc.jasperreports.ExtendedAbstractJasperReportsView

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

Methods inherited from class org.springframework.web.servlet.view.AbstractUrlBasedView

afterPropertiesSet, getUrl, isUrlRequired, setUrl, toString

Methods inherited from class org.springframework.web.servlet.view.AbstractView

addStaticAttribute, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setRequestContextAttribute, writeToResponse

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExtendedAbstractJasperReportsSingleFormatView

public ExtendedAbstractJasperReportsSingleFormatView()

Method Detail

renderReport

protected void renderReport(net.sf.jasperreports.engine.JasperPrint populatedReport,
                            java.util.Map model,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception

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

Specified by:

renderReport in class ExtendedAbstractJasperReportsView

Parameters:

populatedReport - the populated JasperPrint to render

model - the map containing report parameters

response - the HTTP response the report should be rendered to

Throws:

java.lang.Exception - if rendering failed

See Also:

AbstractView.getContentType(), ServletResponse.setContentType(java.lang.String), ServletResponse.setCharacterEncoding(java.lang.String)

mergeExporterParameters

protected java.util.Map mergeExporterParameters(java.util.Map model)

Merges the configured JRExporterParameters with any specified in the supplied model data. JRExporterParameters in the model override those specified in the configuration.

See Also:

ExtendedAbstractJasperReportsView.setExporterParameters(java.util.Map)

createExporter

protected abstract net.sf.jasperreports.engine.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.

See Also:

useWriter()

useWriter

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.

See Also:

ServletResponse.getWriter(), ServletResponse.getOutputStream()