org.egov.infra.reporting.engine

Class ReportRequest

java.lang.Object

org.egov.infra.reporting.engine.ReportRequest

public class ReportRequest
extends Object

Class representing the input passed for report generation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportRequest.ReportDataSourceType Enumeration for report data source type (object/sql).

Constructor Summary

Constructors

Constructor and Description
ReportRequest(String reportTemplate, Collection reportInputData, Map<String,Object> reportParams) Constructor to be used when report data is being passed as collection of objects
ReportRequest(String reportTemplate, Map<String,Object> reportParams, ReportRequest.ReportDataSourceType dataSourceType) Constructor to be used when report template contains the SQL/HQL query for fetching report data
ReportRequest(String reportTemplate, Object[] reportInputData, Map<String,Object> reportParams) Constructor to be used when report data is being passed as array of objects
ReportRequest(String reportTemplate, Object reportInputData, Map<String,Object> reportParams) Constructor

Method Summary

Modifier and Type	Method and Description
ReportRequest.ReportDataSourceType	getReportDataSourceType()
ReportConstants.FileFormat	getReportFormat()
Object	getReportInputData()
Map<String,Object>	getReportParams()
String	getReportTemplate()
boolean	isPrintDialogOnOpenReport()
void	setPrintDialogOnOpenReport(boolean printDialogOnOpenReport)
void	setReportFormat(ReportConstants.FileFormat reportFormat)
void	setReportInputData(Object reportInputData)
void	setReportParams(Map<String,Object> reportParams)
void	setReportTemplate(String reportTemplate)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportRequest

public ReportRequest(String reportTemplate,
                     Object reportInputData,
                     Map<String,Object> reportParams)

Constructor

Parameters:

reportTemplate - Report template name (without extension)

reportInputData - Report input data. This can be one of the following:
1. An array of objects
2. A collection of objects
3. A single object

reportParams - Report parameters. Key = parameter name, Value = parameter value

ReportRequest

public ReportRequest(String reportTemplate,
                     Map<String,Object> reportParams,
                     ReportRequest.ReportDataSourceType dataSourceType)

Constructor to be used when report template contains the SQL/HQL query for fetching report data

Parameters:

reportTemplate - Report template name (without extension)

reportInputData - Report data in the form of an array of objects.

reportParams - Report parameters. Key = parameter name, Value = parameter value

dataSourceType - Report data source type (JDBC/HIBERNATE)

ReportRequest

public ReportRequest(String reportTemplate,
                     Object[] reportInputData,
                     Map<String,Object> reportParams)

Constructor to be used when report data is being passed as array of objects

Parameters:

reportTemplate - Report template name (without extension)

reportInputData - Report input data in the form of an array of objects.

reportParams - Report parameters. Key = parameter name, Value = parameter value

ReportRequest

public ReportRequest(String reportTemplate,
                     Collection reportInputData,
                     Map<String,Object> reportParams)

Constructor to be used when report data is being passed as collection of objects

Parameters:

reportTemplate - Report template name (without extension)

reportInputData - Report input data in the form of a collection of objects.

reportParams - Report parameters. Key = parameter name, Value = parameter value

Method Detail

getReportTemplate

public String getReportTemplate()

Returns:

the Report Template name (without extension)

setReportTemplate

public void setReportTemplate(String reportTemplate)

Parameters:

reportTemplate - the Report Template to set

getReportFormat

public ReportConstants.FileFormat getReportFormat()

Returns:

the Report Format

See Also:

ReportConstants.FileFormat

setReportFormat

public void setReportFormat(ReportConstants.FileFormat reportFormat)

Parameters:

reportFormat - the Report Format to set

See Also:

ReportConstants.FileFormat

getReportParams

public Map<String,Object> getReportParams()

Returns:

the Report Parameters

setReportParams

public void setReportParams(Map<String,Object> reportParams)

Parameters:

reportParams - the Report Parameters to set

setReportInputData

public void setReportInputData(Object reportInputData)

Parameters:

reportInputData - Data to be passed to report engine as report input data. This can be one of the following:
1. An array of objects
2. A collection of objects
3. A single object

getReportInputData

public Object getReportInputData()

Returns:

the report data. This can be one of the following:
1. An array of objects
2. A collection of objects
3. A single object

getReportDataSourceType

public ReportRequest.ReportDataSourceType getReportDataSourceType()

Returns:

the Report Data Source Type

setPrintDialogOnOpenReport

public void setPrintDialogOnOpenReport(boolean printDialogOnOpenReport)

Parameters:

printDialogOnOpenReport - This flag is applicable only for PDF format. If set to true, the report will be generated such that a print dialog box is automatically shown whenever the PDF file is opened.

isPrintDialogOnOpenReport

public boolean isPrintDialogOnOpenReport()

Returns:

the flag printDialogOnOpenReport
This flag is applicable only for PDF format. If set to true, the report will be generated such that a print dialog box is automatically shown whenever the PDF file is opened.