org.jminor.plugin.jasperreports.model

Class JasperReportsWrapper

java.lang.Object

org.jminor.plugin.jasperreports.model.JasperReportsWrapper

All Implemented Interfaces:

java.io.Serializable, ReportWrapper<net.sf.jasperreports.engine.JasperPrint,net.sf.jasperreports.engine.JRDataSource>

public final class JasperReportsWrapper
extends java.lang.Object
implements ReportWrapper<net.sf.jasperreports.engine.JasperPrint,net.sf.jasperreports.engine.JRDataSource>, java.io.Serializable

A Jasper Reports wrapper.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyValue<java.lang.Boolean>	CACHE_REPORTS Specifies whether or not reports are cached when loaded from disk/network, this prevents "hot deploy" of reports. Value type: Boolean Default value: true

Fields inherited from interface org.jminor.common.db.reports.ReportWrapper

REPORT_PATH

Constructor Summary

Constructors

Constructor and Description
JasperReportsWrapper(net.sf.jasperreports.engine.JasperReport report, java.util.Map<java.lang.String,java.lang.Object> reportParameters)
JasperReportsWrapper(java.lang.String reportPath)
JasperReportsWrapper(java.lang.String reportPath, java.util.Map<java.lang.String,java.lang.Object> reportParameters)

Method Summary

Modifier and Type	Method and Description
ReportResult<net.sf.jasperreports.engine.JasperPrint>	fillReport(java.sql.Connection connection) Fills the report using the given database connection
ReportResult<net.sf.jasperreports.engine.JasperPrint>	fillReport(ReportDataWrapper<net.sf.jasperreports.engine.JRDataSource> dataWrapper) Fills the report using the data source wrapped by the given data wrapper
java.lang.String	getReportName()
static net.sf.jasperreports.engine.JasperReport	loadJasperReport(java.lang.String reportPath) Loads a JasperReport file from the path given, it can be a URL a file or classpath resource.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jminor.common.db.reports.ReportWrapper

getReportPath

Field Detail

CACHE_REPORTS

public static final PropertyValue<java.lang.Boolean> CACHE_REPORTS

Specifies whether or not reports are cached when loaded from disk/network,
this prevents "hot deploy" of reports.
Value type: Boolean
Default value: true

Constructor Detail

JasperReportsWrapper

public JasperReportsWrapper(java.lang.String reportPath)
                     throws ReportException

Parameters:

reportPath - the report path

Throws:

ReportException - in case of an exception while loading the report

JasperReportsWrapper

public JasperReportsWrapper(java.lang.String reportPath,
                            java.util.Map<java.lang.String,java.lang.Object> reportParameters)
                     throws ReportException

Parameters:

reportPath - the report path

reportParameters - the report parameters

Throws:

ReportException - in case of an exception while loading the report

JasperReportsWrapper

public JasperReportsWrapper(net.sf.jasperreports.engine.JasperReport report,
                            java.util.Map<java.lang.String,java.lang.Object> reportParameters)

Parameters:

report - the report

reportParameters - the report parameters

Method Detail

getReportName

public java.lang.String getReportName()

Specified by:

getReportName in interface ReportWrapper<net.sf.jasperreports.engine.JasperPrint,net.sf.jasperreports.engine.JRDataSource>

Returns:

the name of the report

fillReport

public ReportResult<net.sf.jasperreports.engine.JasperPrint> fillReport(java.sql.Connection connection)
                                                                 throws ReportException

Fills the report using the given database connection

Specified by:

fillReport in interface ReportWrapper<net.sf.jasperreports.engine.JasperPrint,net.sf.jasperreports.engine.JRDataSource>

Parameters:

connection - the connection to use for the report generation

Returns:

a filled report ready for display

Throws:

ReportException - in case of an exception

fillReport

public ReportResult<net.sf.jasperreports.engine.JasperPrint> fillReport(ReportDataWrapper<net.sf.jasperreports.engine.JRDataSource> dataWrapper)
                                                                 throws ReportException

Fills the report using the data source wrapped by the given data wrapper

Specified by:

fillReport in interface ReportWrapper<net.sf.jasperreports.engine.JasperPrint,net.sf.jasperreports.engine.JRDataSource>

Parameters:

dataWrapper - the data provider to use for the report generation

Returns:

a filled report ready for display

Throws:

ReportException - in case of an exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

loadJasperReport

public static net.sf.jasperreports.engine.JasperReport loadJasperReport(java.lang.String reportPath)
                                                                 throws net.sf.jasperreports.engine.JRException,
                                                                        java.net.MalformedURLException

Loads a JasperReport file from the path given, it can be a URL a file or classpath resource.

Parameters:

reportPath - the path to the report file to load

Returns:

a loaded JasperReport file

Throws:

net.sf.jasperreports.engine.JRException - in case loading the report fails

java.net.MalformedURLException - in case the report path is a malformed URL

java.lang.IllegalArgumentException - in case the report path is not specified