com.goldencode.p2j.reporting

Class JasperReportWrapper

java.lang.Object

com.goldencode.p2j.reporting.JasperReportWrapper

All Implemented Interfaces:

FwdReport, WrappedResource

class JasperReportWrapper
extends java.lang.Object
implements FwdReport

Jasper reporting facility implemented as 4GL syntax extension.

Field Summary

Fields

Modifier and Type	Field and Description
private JasperDataSource	dataSource Data source used by this report.
private java.lang.String	designFileName File name of the report design file.
private java.lang.Long	id The resource ID.
private static int	OUTPUT_BUFFER_SIZE Buffer size for exporting report to a file.
private java.util.Map<java.lang.String,BaseDataType>	parameters Report parameters (the ones which were set in 4GL code).

Constructor Summary

Constructors

Constructor and Description
JasperReportWrapper()

Method Summary

Modifier and Type	Method and Description
void	addChart() Starts to prepare data for new chart.
void	chartAddPicture(character pictName, int x, int y, int w, int h) Gets the total rows range of the report sheet.
void	chartAddPicture(java.lang.String pictName, int x, int y, int w, int h) Gets the total rows range of the report sheet.
logical	exportReport(character outputFileName, MediaType outputFormat) Run report end export result using the specified format to the specified file.
logical	exportReportCsv(character fileName) Run report end export result to the CSV file.
logical	exportReportCsv(java.lang.String fileName) Run report end export result to the CSV file.
logical	exportReportDocx(character fileName) Run report end export result to the DOCX file.
logical	exportReportDocx(java.lang.String fileName) Run report end export result to the DOCX file.
logical	exportReportHtml(character fileName) Run report end export result to the HTML file.
logical	exportReportHtml(java.lang.String fileName) Run report end export result to the HTML file.
logical	exportReportPdf(character fileName) Run report end export result to the PDF file.
logical	exportReportPdf(java.lang.String fileName) Run report end export result to the PDF file.
logical	exportReportRtf(character fileName) Run report end export result to the RTF file.
logical	exportReportRtf(java.lang.String fileName) Run report end export result to the RTF file.
logical	exportReportXls(character fileName) Run report end export result to the XLS file.
logical	exportReportXls(java.lang.String fileName) Run report end export result to the XLS file.
logical	exportReportXlsx(character fileName) Run report end export result to the XLSX file.
logical	exportReportXlsx(java.lang.String fileName) Run report end export result to the XLSX file.
(package private) static java.lang.Object	getJavaValue(BaseDataType value, java.lang.Class<?> jasperValueClass) Get Jasper-compatible value from the 4GL-compatible value.
handle	getReportDataSource() Get the data source used by this report.
character	getReportDesign() Get the name of the report design file.
integer	getSheetRangeColumns(character sheetName) Gets the total coluns range of the report sheet.
integer	getSheetRangeColumns(java.lang.String sheetName) Gets the total coluns range of the report sheet.
integer	getSheetRangeRows(character sheetName) Gets the total rows range of the report sheet.
integer	getSheetRangeRows(java.lang.String sheetName) Gets the total rows range of the report sheet.
java.lang.Long	id() Get this resource's ID, if is already set.
void	id(long id) Set this resource's ID.
logical	importCsvDataSource(character fileName) Import CSV file as data source for report generation.
logical	importCsvDataSource(java.lang.String fileName) Import CSV file as data source for report generation.
void	setReportDataSource(handle dataSource) Set the data source used by this report.
void	setReportDataSource(QueryWrapper dataSource) Set the query used as the data source by this report.
void	setReportDesign(character designFileName) Set report design file.
void	setReportDesign(java.lang.String designFileName) Set report design file.
logical	setReportParameter(character param, BaseDataType value) Set the parameter used by the report.
logical	setReportParameter(java.lang.String param, BaseDataType value) Set the parameter used by the report.
logical	setReportParameter(java.lang.String param, java.lang.String value) Set the parameter used by the report.
boolean	unknown() Reports if this object is unknown.
boolean	valid() Reports if this object is valid for use.

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_BUFFER_SIZE

private static final int OUTPUT_BUFFER_SIZE

Buffer size for exporting report to a file.

See Also:

Constant Field Values

parameters

private java.util.Map<java.lang.String,BaseDataType> parameters

Report parameters (the ones which were set in 4GL code).

dataSource

private JasperDataSource dataSource

Data source used by this report.

designFileName

private java.lang.String designFileName

File name of the report design file.

id

private java.lang.Long id

The resource ID.

Constructor Detail

JasperReportWrapper

JasperReportWrapper()

Method Detail

getJavaValue

static java.lang.Object getJavaValue(BaseDataType value,
                                     java.lang.Class<?> jasperValueClass)

Get Jasper-compatible value from the 4GL-compatible value. In most cases Jasper-compatible value has Java primitive data type.

Parameters:

value - 4GL-compatible value

jasperValueClass - Expected Jasper-compatible data type.

Returns:

Jasper-compatible value.

Throws:

java.lang.IllegalArgumentException - If 4GL-compatible data type is not supported or doesn't match expected Jasper-compatible data type.

setReportParameter

public logical setReportParameter(java.lang.String param,
                                  BaseDataType value)

Set the parameter used by the report.

Specified by:

setReportParameter in interface FwdReport

Parameters:

param - Name of the parameter.

value - Value of the parameter.

Returns:

true on success.

setReportParameter

public logical setReportParameter(java.lang.String param,
                                  java.lang.String value)

Set the parameter used by the report.

Specified by:

setReportParameter in interface FwdReport

Parameters:

param - Name of the parameter.

value - Value of the parameter.

Returns:

true on success.

setReportParameter

public logical setReportParameter(character param,
                                  BaseDataType value)

Set the parameter used by the report.

Specified by:

setReportParameter in interface FwdReport

Parameters:

param - Name of the parameter.

value - Value of the parameter.

Returns:

true on success.

exportReportPdf

public logical exportReportPdf(java.lang.String fileName)

Run report end export result to the PDF file.

Specified by:

exportReportPdf in interface FwdReport

Parameters:

fileName - Name of the output PDF file.

Returns:

true on success.

exportReportPdf

public logical exportReportPdf(character fileName)

Run report end export result to the PDF file.

Specified by:

exportReportPdf in interface FwdReport

Parameters:

fileName - Name of the output PDF file.

Returns:

true on success.

exportReportXls

public logical exportReportXls(java.lang.String fileName)

Run report end export result to the XLS file.

Specified by:

exportReportXls in interface FwdReport

Parameters:

fileName - Name of the output XLS file.

Returns:

true on success.

exportReportXls

public logical exportReportXls(character fileName)

Run report end export result to the XLS file.

Specified by:

exportReportXls in interface FwdReport

Parameters:

fileName - Name of the output XLS file.

Returns:

true on success.

exportReportXlsx

public logical exportReportXlsx(java.lang.String fileName)

Run report end export result to the XLSX file.

Specified by:

exportReportXlsx in interface FwdReport

Parameters:

fileName - Name of the output XLSX file.

Returns:

true on success.

exportReportXlsx

public logical exportReportXlsx(character fileName)

Run report end export result to the XLSX file.

Specified by:

exportReportXlsx in interface FwdReport

Parameters:

fileName - Name of the output XLSX file.

Returns:

true on success.

exportReportRtf

public logical exportReportRtf(java.lang.String fileName)

Run report end export result to the RTF file.

Specified by:

exportReportRtf in interface FwdReport

Parameters:

fileName - Name of the output RTF file.

Returns:

true on success.

exportReportRtf

public logical exportReportRtf(character fileName)

Run report end export result to the RTF file.

Specified by:

exportReportRtf in interface FwdReport

Parameters:

fileName - Name of the output RTF file.

Returns:

true on success.

exportReportDocx

public logical exportReportDocx(java.lang.String fileName)

Run report end export result to the DOCX file.

Specified by:

exportReportDocx in interface FwdReport

Parameters:

fileName - Name of the output DOCX file.

Returns:

true on success.

exportReportDocx

public logical exportReportDocx(character fileName)

Run report end export result to the DOCX file.

Specified by:

exportReportDocx in interface FwdReport

Parameters:

fileName - Name of the output DOCX file.

Returns:

true on success.

exportReportCsv

public logical exportReportCsv(java.lang.String fileName)

Run report end export result to the CSV file.

Specified by:

exportReportCsv in interface FwdReport

Parameters:

fileName - Name of the output CSV file.

Returns:

true on success.

exportReportCsv

public logical exportReportCsv(character fileName)

Run report end export result to the CSV file.

Specified by:

exportReportCsv in interface FwdReport

Parameters:

fileName - Name of the output CSV file.

Returns:

true on success.

importCsvDataSource

public logical importCsvDataSource(character fileName)

Import CSV file as data source for report generation.

Specified by:

importCsvDataSource in interface FwdReport

Parameters:

fileName - Name of the output CSV file.

Returns:

true on success.

importCsvDataSource

public logical importCsvDataSource(java.lang.String fileName)

Import CSV file as data source for report generation.

Specified by:

importCsvDataSource in interface FwdReport

Parameters:

fileName - Name of the output CSV file.

Returns:

true on success.

getSheetRangeColumns

public integer getSheetRangeColumns(character sheetName)

Gets the total coluns range of the report sheet.

Specified by:

getSheetRangeColumns in interface FwdReport

Parameters:

sheetName - The name of the sheet to inspect.

Returns:

The total columns count.

getSheetRangeColumns

public integer getSheetRangeColumns(java.lang.String sheetName)

Gets the total coluns range of the report sheet.

Specified by:

getSheetRangeColumns in interface FwdReport

Parameters:

sheetName - The name of the sheet to inspect.

Returns:

The total columns count.

getSheetRangeRows

public integer getSheetRangeRows(character sheetName)

Gets the total rows range of the report sheet.

Specified by:

getSheetRangeRows in interface FwdReport

Parameters:

sheetName - The name of the sheet to inspect.

Returns:

The total rows count.

getSheetRangeRows

public integer getSheetRangeRows(java.lang.String sheetName)

Gets the total rows range of the report sheet.

Specified by:

getSheetRangeRows in interface FwdReport

Parameters:

sheetName - The name of the sheet to inspect.

Returns:

The total rows count.

addChart

public void addChart()

Starts to prepare data for new chart.

Specified by:

addChart in interface FwdReport

chartAddPicture

public void chartAddPicture(character pictName,
                            int x,
                            int y,
                            int w,
                            int h)

Gets the total rows range of the report sheet.

Specified by:

chartAddPicture in interface FwdReport

Parameters:

pictName - The name of the picture file.

x - X position of the picture.

y - Y position of the picture.

w - Width of the picture.

h - Height of the picture.

chartAddPicture

public void chartAddPicture(java.lang.String pictName,
                            int x,
                            int y,
                            int w,
                            int h)

Gets the total rows range of the report sheet.

Specified by:

chartAddPicture in interface FwdReport

Parameters:

pictName - The name of the picture file.

x - X position of the picture.

y - Y position of the picture.

w - Width of the picture.

h - Height of the picture.

exportReportHtml

public logical exportReportHtml(java.lang.String fileName)

Run report end export result to the HTML file.

Specified by:

exportReportHtml in interface FwdReport

Parameters:

fileName - Name of the output HTML file.

Returns:

true on success.

exportReportHtml

public logical exportReportHtml(character fileName)

Run report end export result to the HTML file.

Specified by:

exportReportHtml in interface FwdReport

Parameters:

fileName - Name of the output HTML file.

Returns:

true on success.

setReportDesign

public void setReportDesign(character designFileName)

Set report design file.

Specified by:

setReportDesign in interface FwdReport

Parameters:

designFileName - Name of the report design file.

setReportDesign

public void setReportDesign(java.lang.String designFileName)

Set report design file.

Specified by:

setReportDesign in interface FwdReport

Parameters:

designFileName - Name of the report design file.

getReportDesign

public character getReportDesign()

Get the name of the report design file.

Specified by:

getReportDesign in interface FwdReport

Returns:

the name of the report design file.

setReportDataSource

public void setReportDataSource(handle dataSource)

Set the data source used by this report.

Specified by:

setReportDataSource in interface FwdReport

Parameters:

dataSource - Handle to the data source.

setReportDataSource

public void setReportDataSource(QueryWrapper dataSource)

Set the query used as the data source by this report.

Specified by:

setReportDataSource in interface FwdReport

Parameters:

dataSource - Handle to the query used as the data source by this report.

getReportDataSource

public handle getReportDataSource()

Get the data source used by this report.

Specified by:

getReportDataSource in interface FwdReport

Returns:

handle to the data source used by this report.

valid

public boolean valid()

Reports if this object is valid for use.

Specified by:

valid in interface WrappedResource

Returns:

always true.

unknown

public boolean unknown()

Reports if this object is unknown.

Specified by:

unknown in interface WrappedResource

Returns:

always false.

id

public java.lang.Long id()

Get this resource's ID, if is already set.

This is for internal usage only. If you need the resource ID, use handle.resourceId(com.goldencode.p2j.util.WrappedResource), which will compute it and save it at the resource, too.

Specified by:

id in interface WrappedResource

Returns:

The resource's ID or null if not set.

id

public void id(long id)

Set this resource's ID.

Specified by:

id in interface WrappedResource

Parameters:

id - The resource's ID.

exportReport

public logical exportReport(character outputFileName,
                            MediaType outputFormat)

Run report end export result using the specified format to the specified file.

Specified by:

exportReport in interface FwdReport

Parameters:

outputFileName - Name of the output file.

outputFormat - Output format (e.g. PDF).

Returns:

true on success.