类 AbstractJasperReportsView

字段详细资料

• HEADER_CONTENT_DISPOSITION

  protected static final String HEADER_CONTENT_DISPOSITION

  Constant that defines "Content-Disposition" header.

  另请参阅:

  常量字段值

• CONTENT_DISPOSITION_INLINE

  protected static final String CONTENT_DISPOSITION_INLINE

  The default Content-Disposition header. Used to make IE play nice.

  另请参阅:

  常量字段值

构造器详细资料

• AbstractJasperReportsView

  public AbstractJasperReportsView()

方法详细资料

• setReportDataKey

  public void setReportDataKey​(String reportDataKey)

  Set the name of the model attribute that represents the report data. If not specified, the model map will be searched for a matching value type.

  A JRDataSource will be taken as-is. For other types, conversion will apply: By default, a java.util.Collection will be converted to JRBeanCollectionDataSource, and an object array to JRBeanArrayDataSource.

  Note: If you pass in a Collection or object array in the model map for use as plain report parameter, rather than as report data to extract fields from, you need to specify the key for the actual report data to use, to avoid mis-detection of report data by type.

  另请参阅:

  convertReportData(java.lang.Object), JRDataSource, JRBeanCollectionDataSource, JRBeanArrayDataSource

• setSubReportUrls

  public 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.

  参数:

  subReports - mapping between model keys and resource paths (Spring resource locations)

  另请参阅:

  AbstractUrlBasedView.setUrl(java.lang.String), ResourceLoader.getResource(java.lang.String)

• setSubReportDataKeys

  public 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. Spring will convert these objects to instances of JRDataSource where applicable and will then include the resulting JRDataSource in the parameters passed into the JasperReports engine.

  The name specified in the list should correspond to an attribute in the model Map, and to a sub-report data source parameter in your report file. If you pass in JRDataSource objects as model attributes, specifying this list of keys is not required.

  If you specify a list of sub-report data keys, it is required to also specify a reportDataKey for the main report, to avoid confusion between the data source objects for the various reports involved.

  参数:

  subReportDataKeys - list of names for sub-report data source objects

  另请参阅:

  setReportDataKey(java.lang.String), convertReportData(java.lang.Object), JRDataSource, JRBeanCollectionDataSource, JRBeanArrayDataSource

• setHeaders

  public void setHeaders​(Properties headers)

  Specify the set of headers that are included in each of response.

  参数:

  headers - the headers to write to each response.

• setExporterParameters

  public void setExporterParameters​(Map<?,​?> parameters)

  Set the exporter parameters that should be used when rendering a view.

  参数:

  parameters - Map with the fully qualified field name of the JRExporterParameter instance as key (e.g. "net.sf.jasperreports.engine.export.JRHtmlExporterParameter.IMAGES_URI") and the value you wish to assign to the parameter as value

• getExporterParameters

  public Map<?,​?> getExporterParameters()

  Return the exporter parameters that this view uses, if any.

• setConvertedExporterParameters

  protected void setConvertedExporterParameters​(Map<net.sf.jasperreports.engine.JRExporterParameter,​Object> parameters)

  Allows subclasses to populate the converted exporter parameters.

• getConvertedExporterParameters

  protected Map<net.sf.jasperreports.engine.JRExporterParameter,​Object> getConvertedExporterParameters()

  Allows subclasses to retrieve the converted exporter parameters.

• setJdbcDataSource

  public void setJdbcDataSource​(DataSource jdbcDataSource)

  Specify the javax.sql.DataSource to use for reports with embedded SQL statements.

• getJdbcDataSource

  protected DataSource getJdbcDataSource()

  Return the javax.sql.DataSource that this view uses, if any.

• isUrlRequired

  protected boolean isUrlRequired()

  JasperReports views do not strictly required a 'url' value. Alternatively, the getReport() template method may be overridden.

  覆盖:

  isUrlRequired 在类中 AbstractUrlBasedView

• initApplicationContext

  protected final void initApplicationContext()
                                       throws ApplicationContextException

  Checks to see that a valid report file URL is supplied in the configuration. Compiles the report file is necessary.

  Subclasses can add custom initialization logic by overriding the onInit() method.

  覆盖:

  initApplicationContext 在类中 ApplicationObjectSupport

  抛出:

  ApplicationContextException - in case of initialization errors

  另请参阅:

  ApplicationObjectSupport.setApplicationContext(org.springframework.context.ApplicationContext)

• onInit

  protected void onInit()

  Subclasses can override this to add some custom initialization logic. Called by initApplicationContext() as soon as all standard initialization logic has finished executing.

  另请参阅:

  initApplicationContext()

• convertExporterParameters

  protected final void convertExporterParameters()

  Converts the exporter parameters passed in by the user which may be keyed by Strings corresponding to the fully qualified name of the JRExporterParameter into parameters which are keyed by JRExporterParameter.

  另请参阅:

  getExporterParameter(Object)

• convertParameterValue

  protected Object convertParameterValue​(net.sf.jasperreports.engine.JRExporterParameter parameter,
                                         Object value)

  Convert the supplied parameter value into the actual type required by the corresponding JRExporterParameter.

  The default implementation simply converts the String values "true" and "false" into corresponding Boolean objects, and tries to convert String values that start with a digit into Integer objects (simply keeping them as String if number conversion fails).

  参数:

  parameter - the parameter key

  value - the parameter value

  返回:

  the converted parameter value

• getExporterParameter

  protected net.sf.jasperreports.engine.JRExporterParameter getExporterParameter​(Object parameter)

  Return a JRExporterParameter for the given parameter object, converting it from a String if necessary.

  参数:

  parameter - the parameter object, either a String or a JRExporterParameter

  返回:

  a JRExporterParameter for the given parameter object

  另请参阅:

  convertToExporterParameter(String)

• convertToExporterParameter

  protected net.sf.jasperreports.engine.JRExporterParameter convertToExporterParameter​(String fqFieldName)

  Convert the given fully qualified field name to a corresponding JRExporterParameter instance.

  参数:

  fqFieldName - the fully qualified field name, consisting of the class name followed by a dot followed by the field name (e.g. "net.sf.jasperreports.engine.export.JRHtmlExporterParameter.IMAGES_URI")

  返回:

  the corresponding JRExporterParameter instance

• loadReport

  protected net.sf.jasperreports.engine.JasperReport loadReport()

  Load the main JasperReport from the specified Resource. If the Resource points to an uncompiled report design file then the report file is compiled dynamically and loaded into memory.

  返回:

  a JasperReport instance, or null if no main report has been statically defined

• loadReport

  protected final net.sf.jasperreports.engine.JasperReport loadReport​(Resource resource)

  Loads a JasperReport from the specified Resource. If the Resource points to an uncompiled report design file then the report file is compiled dynamically and loaded into memory.

  参数:

  resource - the Resource containing the report definition or design

  返回:

  a JasperReport instance

• renderMergedOutputModel

  protected void renderMergedOutputModel​(Map<String,​Object> model,
                                         HttpServletRequest request,
                                         HttpServletResponse response)
                                  throws Exception

  Finds the report data to use for rendering the report and then invokes the renderReport(net.sf.jasperreports.engine.JasperPrint, java.util.Map<java.lang.String, java.lang.Object>, javax.servlet.http.HttpServletResponse) method that should be implemented by the subclass.

  指定者:

  renderMergedOutputModel 在类中 AbstractView

  参数:

  model - the model map, as passed in for view rendering. Must contain a report data value that can be converted to a JRDataSource, according to the rules of the fillReport(java.util.Map<java.lang.String, java.lang.Object>) method.

  request - current HTTP request

  response - current HTTP response

  抛出:

  Exception - if rendering failed

• exposeLocalizationContext

  protected void exposeLocalizationContext​(Map<String,​Object> model,
                                           HttpServletRequest request)

  Expose current Spring-managed Locale and MessageSource to JasperReports i18n ($R expressions etc). The MessageSource should only be exposed as JasperReports resource bundle if no such bundle is defined in the report itself.

  The default implementation exposes the Spring RequestContext Locale and a MessageSourceResourceBundle adapter for the Spring ApplicationContext, analogous to the JstlUtils.exposeLocalizationContext method.

  另请参阅:

  RequestContextUtils.getLocale(javax.servlet.http.HttpServletRequest), MessageSourceResourceBundle, ApplicationObjectSupport.getApplicationContext(), JRParameter.REPORT_LOCALE, JRParameter.REPORT_RESOURCE_BUNDLE, JstlUtils.exposeLocalizationContext(javax.servlet.http.HttpServletRequest, org.springframework.context.MessageSource)

• fillReport

  protected net.sf.jasperreports.engine.JasperPrint fillReport​(Map<String,​Object> model)
                                                        throws Exception

  Create a populated JasperPrint instance from the configured JasperReport instance.

  By default, this method will use any JRDataSource instance (or wrappable Object) that can be located using setReportDataKey(java.lang.String), a lookup for type JRDataSource in the model Map, or a special value retrieved via getReportData(java.util.Map<java.lang.String, java.lang.Object>).

  If no JRDataSource can be found, this method will use a JDBC Connection obtained from the configured javax.sql.DataSource (or a DataSource attribute in the model). If no JDBC DataSource can be found either, the JasperReports engine will be invoked with plain model Map, assuming that the model contains parameters that identify the source for report data (e.g. Hibernate or JPA queries).

  参数:

  model - the model for this request

  返回:

  the populated JasperPrint instance

  抛出:

  IllegalArgumentException - if no JRDataSource can be found and no javax.sql.DataSource is supplied

  SQLException - if there is an error when populating the report using the javax.sql.DataSource

  net.sf.jasperreports.engine.JRException - if there is an error when populating the report using a JRDataSource

  Exception

  另请参阅:

  getReportData(java.util.Map<java.lang.String, java.lang.Object>), setJdbcDataSource(javax.sql.DataSource)

• getReport

  protected net.sf.jasperreports.engine.JasperReport getReport()

  Determine the JasperReport to fill. Called by fillReport(java.util.Map<java.lang.String, java.lang.Object>).

  The default implementation returns the report as statically configured through the 'url' property (and loaded by loadReport()). Can be overridden in subclasses in order to dynamically obtain a JasperReport instance. As an alternative, consider overriding the fillReport(java.util.Map<java.lang.String, java.lang.Object>) template method itself.

  返回:

  an instance of JasperReport

• getReportData

  protected net.sf.jasperreports.engine.JRDataSource getReportData​(Map<String,​Object> model)

  Create an appropriate JRDataSource for passed-in report data. Called by fillReport(java.util.Map<java.lang.String, java.lang.Object>) when its own lookup steps were not successful.

  The default implementation looks for a value of type java.util.Collection or object array (in that order). Can be overridden in subclasses.

  参数:

  model - the model map, as passed in for view rendering

  返回:

  the JRDataSource or null if the data source is not found

  另请参阅:

  getReportDataTypes(), convertReportData(java.lang.Object)

• convertReportData

  protected net.sf.jasperreports.engine.JRDataSource convertReportData​(Object value)
                                                                throws IllegalArgumentException

  Convert the given report data value to a JRDataSource.

  The default implementation delegates to JasperReportUtils unless the report data value is an instance of JRDataSourceProvider. A JRDataSource, JRDataSourceProvider, java.util.Collection or object array is detected. JRDataSources are returned as is, whilst JRDataSourceProviders are used to create an instance of JRDataSource which is then returned. The latter two are converted to JRBeanCollectionDataSource or JRBeanArrayDataSource, respectively.

  参数:

  value - the report data value to convert

  返回:

  the JRDataSource

  抛出:

  IllegalArgumentException - if the value could not be converted

  另请参阅:

  JasperReportsUtils.convertReportData(java.lang.Object), JRDataSource, JRDataSourceProvider, JRBeanCollectionDataSource, JRBeanArrayDataSource

• createReport

  protected net.sf.jasperreports.engine.JRDataSource createReport​(net.sf.jasperreports.engine.JRDataSourceProvider provider)

  Create a report using the given provider.

  参数:

  provider - the JRDataSourceProvider to use

  返回:

  the created report

• getReportDataTypes

  protected Class<?>[] getReportDataTypes()

  Return the value types that can be converted to a JRDataSource, in prioritized order. Should only return types that the convertReportData(java.lang.Object) method is actually able to convert.

  Default value types are: java.util.Collection and Object array.

  返回:

  the value types in prioritized order

• postProcessReport

  protected void postProcessReport​(net.sf.jasperreports.engine.JasperPrint populatedReport,
                                   Map<String,​Object> model)
                            throws Exception

  Template method to be overridden for custom post-processing of the populated report. Invoked after filling but before rendering.

  The default implementation is empty.

  参数:

  populatedReport - the populated JasperPrint

  model - the map containing report parameters

  抛出:

  Exception - if post-processing failed

• renderReport

  protected abstract void renderReport​(net.sf.jasperreports.engine.JasperPrint populatedReport,
                                       Map<String,​Object> model,
                                       HttpServletResponse response)
                                throws Exception

  Subclasses should implement this method to perform the actual rendering process.

  Note that the content type has not been set yet: Implementers should build a content type String and set it via response.setContentType. If necessary, this can include a charset clause for a specific encoding. The latter will only be necessary for textual output onto a Writer, and only in case of the encoding being specified in the JasperReports exporter parameters.

  WARNING: Implementers should not use response.setCharacterEncoding unless they are willing to depend on Servlet API 2.4 or higher. Prefer a concatenated content type String with a charset clause instead.

  参数:

  populatedReport - the populated JasperPrint to render

  model - the map containing report parameters

  response - the HTTP response the report should be rendered to

  抛出:

  Exception - if rendering failed

  另请参阅:

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