com.goldencode.p2j.reporting

Class BrowseJasperDataSource

java.lang.Object

com.goldencode.p2j.reporting.BrowseJasperDataSource

All Implemented Interfaces:

JasperDataSource, net.sf.jasperreports.engine.JRDataSource

class BrowseJasperDataSource
extends java.lang.Object
implements JasperDataSource

Data source for a FWD Jasper report backed by a browse. Rows are passed to the report in the same way they look in browse (with the same formatting, after ROW-DISPLAY trigger has been applied (if any)).

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.String>	attributeMapping Map of the names of jasper report fields representing cell attributes (like "column33.fontName") to default values of these attributes for specific column.
private static java.util.Set<java.lang.String>	availableJavaFontFamilies Font families available for JVM.
private BrowseWidget	browse Browse which provides data for the report.
private int	browseRowIndex Index of the current browse row in browseRows while iterating the data set.
private BrowseRow[]	browseRows Browse rows which represent the report data.
private java.util.Map<java.lang.String,java.lang.Integer>	fieldMapping Map of the names of jasper report fields representing cell data (like "column33") to browse column ordinals (0-based).

Constructor Summary

Constructors

Constructor and Description
BrowseJasperDataSource(BrowseWidget browse) Constructs a data source object for the given browse.

Method Summary

Modifier and Type	Method and Description
handle	asProgressObject() Get underlying 4GL browse 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 1-based browse column index) for the given report.
(package private) static FontDetails	getColumnFont(BrowseColumnWidget column, boolean label) Get effective column font.
private int	getColumnOrdinal(java.lang.String fieldName) Get 0-based ordinal of the browse column referenced by the given field.
(package private) static java.lang.String	getElementColor(BrowseWidget browse, EnhancedColor ehColumnColor, int columnColor, EnhancedColor ehBrowseColor, int browseColor) Get color of the browse element following general color application rules.
private static FontDetails	getElementFont(FontDetails ehColumnFont, int columnFont, FontDetails ehBrowseFont, int browseFont) Get font of the browse element following general font application rules.
java.lang.Object	getFieldValue(net.sf.jasperreports.engine.JRField field) Gets the field value for the current position.
private static java.lang.String	getJasperColor(ColorRgb color) Get string representation of the color in Jasper report format.
net.sf.jasperreports.engine.JasperReport	getReport(java.lang.String designTemplateFileName) Get compiled Jasper report for the given report template design file.
private static ColorRgb	getTableColor(BrowseWidget browse, int colorIndex) Get color at the specified index in the system color table.
(package private) static boolean	isFontFamilyAvailable(FontDetails font) Checks is the given font available for the JVM.
boolean	next() Tries to position the cursor on the next element in the data source.
private boolean	putAttributeValue(java.lang.String fieldName) Put the default column-specific value of the corresponding attribute into attributeMapping map.
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.
private static ColorRgb	resolveEnhancedColor(BrowseWidget browse, EnhancedColor enhancedColor) Return RGB color defined by the enhanced color.

Methods inherited from class java.lang.Object

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

Field Detail

availableJavaFontFamilies

private static final java.util.Set<java.lang.String> availableJavaFontFamilies

Font families available for JVM.

browse

private final BrowseWidget browse

Browse which provides data for the report.

fieldMapping

private java.util.Map<java.lang.String,java.lang.Integer> fieldMapping

Map of the names of jasper report fields representing cell data (like "column33") to browse column ordinals (0-based).

attributeMapping

private java.util.Map<java.lang.String,java.lang.String> attributeMapping

Map of the names of jasper report fields representing cell attributes (like "column33.fontName") to default values of these attributes for specific column.

browseRows

private BrowseRow[] browseRows

Browse rows which represent the report data.

browseRowIndex

private int browseRowIndex

Index of the current browse row in browseRows while iterating the data set.

Constructor Detail

BrowseJasperDataSource

BrowseJasperDataSource(BrowseWidget browse)

Constructs a data source object for the given browse.

Parameters:

browse - Underlying browse.

Method Detail

getReport

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

Get compiled Jasper report for the given report template design file.

Specified by:

getReport in interface JasperDataSource

Parameters:

designTemplateFileName - File name of the Jasper report design template file.

Returns:

compiled Jasper report for the given report design template 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 browse object which provides data for the report.

Specified by:

asProgressObject in interface JasperDataSource

Returns:

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

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.

isFontFamilyAvailable

static boolean isFontFamilyAvailable(FontDetails font)

Checks is the given font available for the JVM.

Parameters:

font - Font to check.

Returns:

true if the given font available for the JVM.

getElementColor

static java.lang.String getElementColor(BrowseWidget browse,
                                        EnhancedColor ehColumnColor,
                                        int columnColor,
                                        EnhancedColor ehBrowseColor,
                                        int browseColor)

Get color of the browse element following general color application rules.

Parameters:

browse - Parent browse.

ehColumnColor - Enhanced column-specific color.

columnColor - Column-specific color.

ehBrowseColor - Enhanced browse-specific color.

browseColor - Browse-specific color.

Returns:

color of the browse element in Jasper report format.

getColumnFont

static FontDetails getColumnFont(BrowseColumnWidget column,
                                 boolean label)

Get effective column font.

Parameters:

column - Browse column.

label - true for label font, false for cells font.

Returns:

effective label or cells font of the specified column.

getJasperColor

private static java.lang.String getJasperColor(ColorRgb color)

Get string representation of the color in Jasper report format.

Parameters:

color - Color.

Returns:

string representation of the color in Jasper report format.

resolveEnhancedColor

private static ColorRgb resolveEnhancedColor(BrowseWidget browse,
                                             EnhancedColor enhancedColor)

Return RGB color defined by the enhanced color.

Parameters:

browse - Parent browse of the element which color is resolved.

enhancedColor - Enhanced color. Can be null.

Returns:

RGB color defined by the enhanced color.

getTableColor

private static ColorRgb getTableColor(BrowseWidget browse,
                                      int colorIndex)

Get color at the specified index in the system color table.

Parameters:

browse - Parent browse of the element which color is resolved.

colorIndex - Index of the color.

Returns:

color at the specified index in the system color table.

getElementFont

private static FontDetails getElementFont(FontDetails ehColumnFont,
                                          int columnFont,
                                          FontDetails ehBrowseFont,
                                          int browseFont)

Get font of the browse element following general font application rules.

Parameters:

ehColumnFont - Enhanced column-specific font.

columnFont - Column-specific font.

ehBrowseFont - Enhanced browse-specific font.

browseFont - Browse-specific font.

Returns:

font of the browse element.

buildFieldMapping

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

Build and store field mapping (Jasper report field names to 1-based browse column index) for the given report.

Parameters:

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

Returns:

true on success.

getColumnOrdinal

private int getColumnOrdinal(java.lang.String fieldName)

Get 0-based ordinal of the browse column referenced by the given field.

Parameters:

fieldName - Name of the field.

Returns:

0-based ordinal of the browse column referenced by the given field.

putAttributeValue

private boolean putAttributeValue(java.lang.String fieldName)

Put the default column-specific value of the corresponding attribute into attributeMapping map.

Parameters:

fieldName - Name of the report field representing the specific attribute of the specific column (like "column33.fontName").

Returns:

true of success. false if the field name is invalid.