com.goldencode.p2j.reporting

Class QueryJasperDataSource

java.lang.Object

com.goldencode.p2j.reporting.QueryJasperDataSource

All Implemented Interfaces:

JasperDataSource, net.sf.jasperreports.engine.JRDataSource

class QueryJasperDataSource
extends java.lang.Object
implements JasperDataSource

Data source for a FWD Jasper report backed by a query.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.HashMap<java.lang.String,BufferField>	fieldMapping Map of Jasper report field names to 4GL fields.
private boolean	iterated true if the query was already iterated by this data source and we already got the first record in the result set.
private QueryWrapper	query Query for getting report data.

Constructor Summary

Constructors

Constructor and Description
QueryJasperDataSource(QueryWrapper query) Create data source which gets the report data from the specified query.

Method Summary

Modifier and Type	Method and Description
handle	asProgressObject() Get underlying 4GL query object which provides data for the report.
private boolean	buildFieldMapping(net.sf.jasperreports.engine.JasperReport report) Build and store field mapping (Jasper report field names to 4GL fields) for the given report.
java.lang.Object	getFieldValue(net.sf.jasperreports.engine.JRField field) Gets the field value for the current position.
private BufferField	getMatchingBufferField(net.sf.jasperreports.engine.JRField reportField) Get the 4GL buffer field matching the given Jasper report field.
net.sf.jasperreports.engine.JasperReport	getReport(java.lang.String designFileName) Get compiled Jasper report for the given report design file.
boolean	next() Tries to position the cursor on the next element in the data source.
void	reportFinished(boolean error) Executed after report was filled from the data source.
boolean	reportStarted(net.sf.jasperreports.engine.JasperReport report) Executed before report is filled from the data source.

Methods inherited from class java.lang.Object

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

Field Detail

query

private final QueryWrapper query

Query for getting report data.

fieldMapping

private java.util.HashMap<java.lang.String,BufferField> fieldMapping

Map of Jasper report field names to 4GL fields.

iterated

private boolean iterated

true if the query was already iterated by this data source and we already got the first record in the result set.

Constructor Detail

QueryJasperDataSource

QueryJasperDataSource(QueryWrapper query)

Create data source which gets the report data from the specified query.

Parameters:

query - Query for getting report data.

Method Detail

next

public boolean next()
             throws net.sf.jasperreports.engine.JRException

Tries to position the cursor on the next element in the data source.

Specified by:

next in interface net.sf.jasperreports.engine.JRDataSource

Returns:

true if there is a next record, false otherwise.

Throws:

net.sf.jasperreports.engine.JRException - if any error occurs while trying to move to the next element.

getFieldValue

public java.lang.Object getFieldValue(net.sf.jasperreports.engine.JRField field)
                               throws net.sf.jasperreports.engine.JRException

Gets the field value for the current position.

Specified by:

getFieldValue in interface net.sf.jasperreports.engine.JRDataSource

Parameters:

field - Field to get.

Returns:

an object containing the field value. The object type must be the field object type.

Throws:

net.sf.jasperreports.engine.JRException - if any error occurs while trying to get the field value.

getReport

public net.sf.jasperreports.engine.JasperReport getReport(java.lang.String designFileName)

Get compiled Jasper report for the given report design file.

Specified by:

getReport in interface JasperDataSource

Parameters:

designFileName - File name of the Jasper report design file.

Returns:

compiled Jasper report for the given report design file.

reportStarted

public boolean reportStarted(net.sf.jasperreports.engine.JasperReport report)

Executed before report is filled from the data source.

Specified by:

reportStarted in interface JasperDataSource

Parameters:

report - Jasper report to be filled.

Returns:

true on success, false if the data source cannot provide data.

reportFinished

public void reportFinished(boolean error)

Executed after report was filled from the data source.

Specified by:

reportFinished in interface JasperDataSource

Parameters:

error - true if there were problems while getting data from the data source. false on success,

asProgressObject

public handle asProgressObject()

Get underlying 4GL query object which provides data for the report.

Specified by:

asProgressObject in interface JasperDataSource

Returns:

handle to the underlying 4GL query object which provides data for the report.

buildFieldMapping

private boolean buildFieldMapping(net.sf.jasperreports.engine.JasperReport report)

Build and store field mapping (Jasper report field names to 4GL fields) for the given report.

Parameters:

report - Jasper report for which we need to build a field mapping.

Returns:

true on success.

getMatchingBufferField

private BufferField getMatchingBufferField(net.sf.jasperreports.engine.JRField reportField)

Get the 4GL buffer field matching the given Jasper report field. Search is performed by report field name which should have format "4gl-buffer-name.4gl-field-name" or "4gl-field-name". If explicit buffer name is not specified and query has multiple buffers which have the field with the specified name, error is raised.

Parameters:

reportField - Jasper report field.

Returns:

matching 4GL buffer field or null if there is no matching field.