org.egov.infra.reporting.engine

Class AbstractReportService<T>

java.lang.Object

org.egov.infra.reporting.engine.AbstractReportService<T>

All Implemented Interfaces:

ReportService

Direct Known Subclasses:

JasperReportService

public abstract class AbstractReportService<T>
extends Object
implements ReportService

Abstract report service providing common eGov reporting functionality. eGov infrastructure uses JasperReports for creating reports JasperReportService. Any other third party reporting framework can be supported by implementing a class that extends from AbstractReportService and then configuring that class in the global bean definitions xml.

Constructor Summary

Constructors

Constructor and Description
AbstractReportService(int templateCachMinSize, int templateCacheMaxSize)

Method Summary

Modifier and Type	Method and Description
ReportOutput	createReport(ReportRequest reportInput) Creates report using given report input object, and returns the generated report output object.
protected abstract ReportOutput	createReportFromHql(ReportRequest reportInput) Creates report using a template that uses HQL for fetching data
protected abstract ReportOutput	createReportFromJavaBean(ReportRequest reportInput) Creates a report using given report input where the report data source is java beans
protected ReportOutput	createReportFromSql(ReportRequest reportInput) Creates report using a JDBC connection
protected abstract ReportOutput	createReportFromSql(ReportRequest reportInput, Connection connection) Creates report for given report template, format, connection and parameters
protected T	getTemplate(String templateName) Returns the Report Template object for given template path.
protected abstract String	getTemplateExtension()
boolean	isValidTemplate(String templateName)
protected abstract T	loadTemplate(InputStream templateInputStream)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReportService

public AbstractReportService(int templateCachMinSize,
                             int templateCacheMaxSize)

Parameters:

templateCacheMinSize - Minimum size of template cache

templateCacheMaxSize - Maximum size of template cache

Method Detail

createReportFromJavaBean

protected abstract ReportOutput createReportFromJavaBean(ReportRequest reportInput)

Creates a report using given report input where the report data source is java beans

Parameters:

reportInput - The report input

Returns:

The report output

createReportFromSql

protected abstract ReportOutput createReportFromSql(ReportRequest reportInput,
                                                    Connection connection)

Creates report for given report template, format, connection and parameters

Parameters:

reportInput - Report Input object

dataSource - Data source

Returns:

Report output for given report template, format, data source and parameters.

createReportFromHql

protected abstract ReportOutput createReportFromHql(ReportRequest reportInput)

Creates report using a template that uses HQL for fetching data

Parameters:

reportInput - The report input

Returns:

Report output created using given input

getTemplateExtension

protected abstract String getTemplateExtension()

Returns:

Extension of the report templates supported by the report service

loadTemplate

protected abstract T loadTemplate(InputStream templateInputStream)

Parameters:

templateInputStream - Input stream from which the report template is to be loaded

Returns:

The report template object

createReport

public ReportOutput createReport(ReportRequest reportInput)

Description copied from interface: ReportService

Creates report using given report input object, and returns the generated report output object.

Specified by:

createReport in interface ReportService

Parameters:

reportInput - Input to be passed to report engine for generating the report

Returns:

Report output object

See Also:

ReportRequest, ReportOutput

createReportFromSql

protected ReportOutput createReportFromSql(ReportRequest reportInput)

Creates report using a JDBC connection

Parameters:

reportInput - The report input

Returns:

The report output

getTemplate

protected T getTemplate(String templateName)

Returns the Report Template object for given template path. Fetches it from the template cache is available; else loads the template from disk.

Parameters:

templateName - Name of the Report template (without extension)

Returns:

Report object for given template path.

isValidTemplate

public boolean isValidTemplate(String templateName)

Specified by:

isValidTemplate in interface ReportService

Parameters:

templateName - Template name to be checked

Returns:

true if the template name passed is a valid one and can be used for report generation using this service.