类 JasperReportsUtils
- java.lang.Object
- org.springframework.ui.jasperreports.JasperReportsUtils
public abstract class JasperReportsUtils extends Object
Utility methods for working with JasperReports. Provides a set of convenience methods for generating reports in a CSV, HTML, PDF and XLS formats.This class is compatible with classic JasperReports releases back until 2.x. As a consequence, it keeps using the
JRExporterAPI which has been deprecated in early 2014.- 从以下版本开始:
- 1.1.3
- 作者:
- Rob Harrop, Juergen Hoeller
构造器概要
构造器 构造器 说明 JasperReportsUtils()
方法概要
所有方法 静态方法 具体方法 修饰符和类型 方法 说明 static net.sf.jasperreports.engine.JRDataSourceconvertReportData(Object value)Convert the given report data value to aJRDataSource.static voidrender(net.sf.jasperreports.engine.JRExporter exporter, net.sf.jasperreports.engine.JasperPrint print, OutputStream outputStream)Render the suppliedJasperPrintinstance using the suppliedJRAbstractExporterinstance and write the results to the suppliedOutputStream.static voidrender(net.sf.jasperreports.engine.JRExporter exporter, net.sf.jasperreports.engine.JasperPrint print, Writer writer)Render the suppliedJasperPrintinstance using the suppliedJRAbstractExporterinstance and write the results to the suppliedWriter.static voidrenderAsCsv(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, Writer writer)Render a report in CSV format using the supplied report data.static voidrenderAsCsv(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, Writer writer, Map<net.sf.jasperreports.engine.JRExporterParameter,Object> exporterParameters)Render a report in CSV format using the supplied report data.static voidrenderAsHtml(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, Writer writer)Render a report in HTML format using the supplied report data.static voidrenderAsHtml(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, Writer writer, Map<net.sf.jasperreports.engine.JRExporterParameter,Object> exporterParameters)Render a report in HTML format using the supplied report data.static voidrenderAsPdf(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, OutputStream stream)Render a report in PDF format using the supplied report data.static voidrenderAsPdf(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, OutputStream stream, Map<net.sf.jasperreports.engine.JRExporterParameter,Object> exporterParameters)Render a report in PDF format using the supplied report data.static voidrenderAsXls(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, OutputStream stream)Render a report in XLS format using the supplied report data.static voidrenderAsXls(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, OutputStream stream, Map<net.sf.jasperreports.engine.JRExporterParameter,Object> exporterParameters)Render a report in XLS format using the supplied report data.
构造器详细资料
JasperReportsUtils
public JasperReportsUtils()
方法详细资料
convertReportData
public static net.sf.jasperreports.engine.JRDataSource convertReportData(Object value) throws IllegalArgumentException
Convert the given report data value to aJRDataSource.In the default implementation, a
JRDataSource,java.util.Collectionor object array is detected. The latter are converted toJRBeanCollectionDataSourceorJRBeanArrayDataSource, respectively.- 参数:
value- the report data value to convert- 返回:
- the JRDataSource (never
null) - 抛出:
IllegalArgumentException- if the value could not be converted- 另请参阅:
JRDataSource,JRBeanCollectionDataSource,JRBeanArrayDataSource
render
public static void render(net.sf.jasperreports.engine.JRExporter exporter, net.sf.jasperreports.engine.JasperPrint print, Writer writer) throws net.sf.jasperreports.engine.JRException
Render the suppliedJasperPrintinstance using the suppliedJRAbstractExporterinstance and write the results to the suppliedWriter.Make sure that the
JRAbstractExporterimplementation you supply is capable of writing to aWriter.- 参数:
exporter- theJRAbstractExporterto use to render the reportprint- theJasperPrintinstance to renderwriter- theWriterto write the result to- 抛出:
net.sf.jasperreports.engine.JRException- if rendering failed
render
public static void render(net.sf.jasperreports.engine.JRExporter exporter, net.sf.jasperreports.engine.JasperPrint print, OutputStream outputStream) throws net.sf.jasperreports.engine.JRException
Render the suppliedJasperPrintinstance using the suppliedJRAbstractExporterinstance and write the results to the suppliedOutputStream.Make sure that the
JRAbstractExporterimplementation you supply is capable of writing to aOutputStream.- 参数:
exporter- theJRAbstractExporterto use to render the reportprint- theJasperPrintinstance to renderoutputStream- theOutputStreamto write the result to- 抛出:
net.sf.jasperreports.engine.JRException- if rendering failed
renderAsCsv
public static void renderAsCsv(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, Writer writer) throws net.sf.jasperreports.engine.JRException
Render a report in CSV format using the supplied report data. Writes the results to the suppliedWriter.- 参数:
report- theJasperReportinstance to renderparameters- the parameters to use for renderingwriter- theWriterto write the rendered report toreportData- aJRDataSource,java.util.Collectionor object array (converted accordingly), representing the report data to read fields from- 抛出:
net.sf.jasperreports.engine.JRException- if rendering failed- 另请参阅:
convertReportData(java.lang.Object)
renderAsCsv
public static void renderAsCsv(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, Writer writer, Map<net.sf.jasperreports.engine.JRExporterParameter,Object> exporterParameters) throws net.sf.jasperreports.engine.JRException
Render a report in CSV format using the supplied report data. Writes the results to the suppliedWriter.- 参数:
report- theJasperReportinstance to renderparameters- the parameters to use for renderingwriter- theWriterto write the rendered report toreportData- aJRDataSource,java.util.Collectionor object array (converted accordingly), representing the report data to read fields fromexporterParameters- aMapofJRExporterParameter exporter parameters- 抛出:
net.sf.jasperreports.engine.JRException- if rendering failed- 另请参阅:
convertReportData(java.lang.Object)
renderAsHtml
public static void renderAsHtml(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, Writer writer) throws net.sf.jasperreports.engine.JRException
Render a report in HTML format using the supplied report data. Writes the results to the suppliedWriter.- 参数:
report- theJasperReportinstance to renderparameters- the parameters to use for renderingwriter- theWriterto write the rendered report toreportData- aJRDataSource,java.util.Collectionor object array (converted accordingly), representing the report data to read fields from- 抛出:
net.sf.jasperreports.engine.JRException- if rendering failed- 另请参阅:
convertReportData(java.lang.Object)
renderAsHtml
public static void renderAsHtml(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, Writer writer, Map<net.sf.jasperreports.engine.JRExporterParameter,Object> exporterParameters) throws net.sf.jasperreports.engine.JRException
Render a report in HTML format using the supplied report data. Writes the results to the suppliedWriter.- 参数:
report- theJasperReportinstance to renderparameters- the parameters to use for renderingwriter- theWriterto write the rendered report toreportData- aJRDataSource,java.util.Collectionor object array (converted accordingly), representing the report data to read fields fromexporterParameters- aMapofJRExporterParameter exporter parameters- 抛出:
net.sf.jasperreports.engine.JRException- if rendering failed- 另请参阅:
convertReportData(java.lang.Object)
renderAsPdf
public static void renderAsPdf(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, OutputStream stream) throws net.sf.jasperreports.engine.JRException
Render a report in PDF format using the supplied report data. Writes the results to the suppliedOutputStream.- 参数:
report- theJasperReportinstance to renderparameters- the parameters to use for renderingstream- theOutputStreamto write the rendered report toreportData- aJRDataSource,java.util.Collectionor object array (converted accordingly), representing the report data to read fields from- 抛出:
net.sf.jasperreports.engine.JRException- if rendering failed- 另请参阅:
convertReportData(java.lang.Object)
renderAsPdf
public static void renderAsPdf(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, OutputStream stream, Map<net.sf.jasperreports.engine.JRExporterParameter,Object> exporterParameters) throws net.sf.jasperreports.engine.JRException
Render a report in PDF format using the supplied report data. Writes the results to the suppliedOutputStream.- 参数:
report- theJasperReportinstance to renderparameters- the parameters to use for renderingstream- theOutputStreamto write the rendered report toreportData- aJRDataSource,java.util.Collectionor object array (converted accordingly), representing the report data to read fields fromexporterParameters- aMapofJRExporterParameter exporter parameters- 抛出:
net.sf.jasperreports.engine.JRException- if rendering failed- 另请参阅:
convertReportData(java.lang.Object)
renderAsXls
public static void renderAsXls(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, OutputStream stream) throws net.sf.jasperreports.engine.JRException
Render a report in XLS format using the supplied report data. Writes the results to the suppliedOutputStream.- 参数:
report- theJasperReportinstance to renderparameters- the parameters to use for renderingstream- theOutputStreamto write the rendered report toreportData- aJRDataSource,java.util.Collectionor object array (converted accordingly), representing the report data to read fields from- 抛出:
net.sf.jasperreports.engine.JRException- if rendering failed- 另请参阅:
convertReportData(java.lang.Object)
renderAsXls
public static void renderAsXls(net.sf.jasperreports.engine.JasperReport report, Map<String,Object> parameters, Object reportData, OutputStream stream, Map<net.sf.jasperreports.engine.JRExporterParameter,Object> exporterParameters) throws net.sf.jasperreports.engine.JRException
Render a report in XLS format using the supplied report data. Writes the results to the suppliedOutputStream.- 参数:
report- theJasperReportinstance to renderparameters- the parameters to use for renderingstream- theOutputStreamto write the rendered report toreportData- aJRDataSource,java.util.Collectionor object array (converted accordingly), representing the report data to read fields fromexporterParameters- aMapofJRExporterParameter exporter parameters- 抛出:
net.sf.jasperreports.engine.JRException- if rendering failed- 另请参阅:
convertReportData(java.lang.Object)