com.ontimize.report
Interface ReportEngine

All Known Implementing Classes:

DynamicJasperEngine, FreeReportEngine

public interface ReportEngine

This interface provides definition of necessary methods to add a new engine for reports. Actually, Ontimize provides two default implementations of this one: FreeReportEngine (for JFreeReport 0.8.4_10) and DynamicJasperEngine (for JasperReports 3.5.1).

Author:

Imatia Innovation

Method Summary

void	buildOptions() Convenience method.
boolean	checkLibraries() Implementation of this method for each engine must check libraries in classpath and return true/false whether all required for reports are present/missed.
void	close() Invalidates the viewer.
void	dispose() Method to dispose all resources.
BasicReportStoreDefinition	generaReportStoreDefinition(java.lang.String pageTitle) This method should be only implemented to define a custom report store for reports in our application.
java.lang.Object	generateReport(java.lang.String pageTitle, java.lang.String description) Generates the report.
java.lang.Object	getBaseTemplate() Gets the viewer for this engine.
java.util.List	getDefaultTemplates() Returns the list of templates for reports.
java.lang.String	getPageTitle() Gets the title of report (Maintains backward compatibility).
PreviewDialog	getPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.net.URL xMLTemplate, java.net.URL base) Implementation of this method for each engine must return a dialog with printed report.
PreviewDialog	getPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.net.URL xMLTemplate, java.net.URL base, ReportProcessor r) Implementation of this method for each engine must return a dialog with printed report.
PreviewDialog	getPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.net.URL xMLTemplate, java.net.URL base, java.lang.String[] order, boolean[] asc) Implementation of this method for each engine must return a dialog with printed report.
PreviewDialog	getPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.net.URL xMLTemplate, java.net.URL base, java.lang.String[] order, boolean[] asc, ReportProcessor r) Implementation of this method for each engine must return a dialog with printed report.
PreviewDialog	getPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.net.URL xMLTemplate, java.net.URL base, java.lang.String[] order, boolean[] asc, ReportProcessor r, java.awt.print.PageFormat pf) Implementation of this method for each engine must return a dialog with printed report.
java.lang.String	getReportDescription() Gets the description of report (subtitle).
java.lang.String	getReportEngineName() Returns the name of report engine.
java.lang.String	getTitle() Gets the title of report.
void	setDefaultReportDialog(java.lang.Object reportDialog) Report dialog is passed to engine to get references to dialog elements from engine (i.e. check buttons marked, columns selected,...).
void	setReportDescription(java.lang.String text) Sets the title of report.
void	setTitleReport(java.lang.String text) Sets the title of report.
PreviewDialog	showPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.lang.String xMLTemplate, java.net.URL base) Implementation of this method for each engine must show a dialog with printed report.
PreviewDialog	showPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.lang.String template, java.net.URL base, ReportProcessor rp) Implementation of this method for each engine must show a dialog with printed report.
PreviewDialog	showPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.net.URL xMLTemplate, java.net.URL base) Implementation of this method for each engine must show a dialog with printed report.
PreviewDialog	showPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.net.URL xMLTemplate, java.net.URL base, ReportProcessor rp) Implementation of this method for each engine must show a dialog with printed report.
PreviewDialog	showPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.net.URL xMLTemplate, java.net.URL base, java.lang.String[] order, boolean[] asc) Implementation of this method for each engine must show a dialog with printed report.
PreviewDialog	showPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.net.URL xMLTemplate, java.net.URL base, java.lang.String[] order, boolean[] asc, ReportProcessor rp) Implementation of this method for each engine must show a dialog with printed report.
PreviewDialog	showPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.net.URL xMLTemplate, java.net.URL base, java.lang.String[] order, boolean[] asc, ReportProcessor rp, java.awt.print.PageFormat pf) Implementation of this method for each engine must show a dialog with printed report.
void	updateReport(boolean force) Updates the report.

Method Detail

getBaseTemplate

public java.lang.Object getBaseTemplate()

Gets the viewer for this engine. It is placed at right in report dialog.

Returns:

the viewer

close

public void close()

Invalidates the viewer. Implementation of this method could be not required.

dispose

public void dispose()

Method to dispose all resources. It is called at the end of report.

getTitle

public java.lang.String getTitle()

Gets the title of report.

Returns:

the title

setTitleReport

public void setTitleReport(java.lang.String text)

Sets the title of report.

Parameters:

text - the text to set in title

setReportDescription

public void setReportDescription(java.lang.String text)

Sets the title of report.

Parameters:

text - the text to set in title

getReportDescription

public java.lang.String getReportDescription()

Gets the description of report (subtitle).

Returns:

the subtitle of report

generateReport

public java.lang.Object generateReport(java.lang.String pageTitle,
                                       java.lang.String description)
                                throws java.lang.Exception

Generates the report. It is the method where all logic of report should be implemented. Parameters passed can be null whether programmer controls them inside of this method.

Parameters:

pageTitle - the title of report

description - subtitle of report

Returns:

the generated report

Throws:

java.lang.Exception - A new Exception

updateReport

public void updateReport(boolean force)

Updates the report. When this method is called, report should be generated again.

Parameters:

force - The boolean to allow/deny dynamically updates when user presses the update dynamically button in report dialog.

getPageTitle

public java.lang.String getPageTitle()

Gets the title of report (Maintains backward compatibility).

Returns:

the title The title of page

setDefaultReportDialog

public void setDefaultReportDialog(java.lang.Object reportDialog)

Report dialog is passed to engine to get references to dialog elements from engine (i.e. check buttons marked, columns selected,...).

Parameters:

reportDialog - the report dialog to be used in engine.

generaReportStoreDefinition

public BasicReportStoreDefinition generaReportStoreDefinition(java.lang.String pageTitle)

This method should be only implemented to define a custom report store for reports in our application.

Parameters:

pageTitle - the title of page

Returns:

The reportStoreDefinition

getDefaultTemplates

public java.util.List getDefaultTemplates()

Returns the list of templates for reports.

Returns:

The List of templates

buildOptions

public void buildOptions()

Convenience method. TO-DO

getReportEngineName

public java.lang.String getReportEngineName()

Returns the name of report engine. It will be used only for log and debug purposes.

Returns:

the name of report engine configured

checkLibraries

public boolean checkLibraries()

Implementation of this method for each engine must check libraries in classpath and return true/false whether all required for reports are present/missed. This method is automatically checked when report engine is registered.

Returns:

the condition of availability of libraries.

showPreviewDialog

public PreviewDialog showPreviewDialog(java.awt.Component c,
                                       java.lang.String title,
                                       javax.swing.table.TableModel m,
                                       java.lang.String template,
                                       java.net.URL base,
                                       ReportProcessor rp)
                                throws java.lang.Exception

Implementation of this method for each engine must show a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception

showPreviewDialog

public PreviewDialog showPreviewDialog(java.awt.Component c,
                                       java.lang.String title,
                                       javax.swing.table.TableModel m,
                                       java.lang.String xMLTemplate,
                                       java.net.URL base)
                                throws java.lang.Exception

Implementation of this method for each engine must show a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception

showPreviewDialog

public PreviewDialog showPreviewDialog(java.awt.Component c,
                                       java.lang.String title,
                                       javax.swing.table.TableModel m,
                                       java.net.URL xMLTemplate,
                                       java.net.URL base,
                                       ReportProcessor rp)
                                throws java.lang.Exception

Implementation of this method for each engine must show a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception

showPreviewDialog

public PreviewDialog showPreviewDialog(java.awt.Component c,
                                       java.lang.String title,
                                       javax.swing.table.TableModel m,
                                       java.net.URL xMLTemplate,
                                       java.net.URL base)
                                throws java.lang.Exception

Implementation of this method for each engine must show a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception

showPreviewDialog

public PreviewDialog showPreviewDialog(java.awt.Component c,
                                       java.lang.String title,
                                       javax.swing.table.TableModel m,
                                       java.net.URL xMLTemplate,
                                       java.net.URL base,
                                       java.lang.String[] order,
                                       boolean[] asc)
                                throws java.lang.Exception

Implementation of this method for each engine must show a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception

showPreviewDialog

public PreviewDialog showPreviewDialog(java.awt.Component c,
                                       java.lang.String title,
                                       javax.swing.table.TableModel m,
                                       java.net.URL xMLTemplate,
                                       java.net.URL base,
                                       java.lang.String[] order,
                                       boolean[] asc,
                                       ReportProcessor rp)
                                throws java.lang.Exception

Implementation of this method for each engine must show a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception

showPreviewDialog

public PreviewDialog showPreviewDialog(java.awt.Component c,
                                       java.lang.String title,
                                       javax.swing.table.TableModel m,
                                       java.net.URL xMLTemplate,
                                       java.net.URL base,
                                       java.lang.String[] order,
                                       boolean[] asc,
                                       ReportProcessor rp,
                                       java.awt.print.PageFormat pf)
                                throws java.lang.Exception

Implementation of this method for each engine must show a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception

getPreviewDialog

public PreviewDialog getPreviewDialog(java.awt.Component c,
                                      java.lang.String title,
                                      javax.swing.table.TableModel m,
                                      java.net.URL xMLTemplate,
                                      java.net.URL base,
                                      ReportProcessor r)
                               throws java.lang.Exception

Implementation of this method for each engine must return a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception

getPreviewDialog

public PreviewDialog getPreviewDialog(java.awt.Component c,
                                      java.lang.String title,
                                      javax.swing.table.TableModel m,
                                      java.net.URL xMLTemplate,
                                      java.net.URL base)
                               throws java.lang.Exception

Implementation of this method for each engine must return a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception

getPreviewDialog

public PreviewDialog getPreviewDialog(java.awt.Component c,
                                      java.lang.String title,
                                      javax.swing.table.TableModel m,
                                      java.net.URL xMLTemplate,
                                      java.net.URL base,
                                      java.lang.String[] order,
                                      boolean[] asc)
                               throws java.lang.Exception

Implementation of this method for each engine must return a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception

getPreviewDialog

public PreviewDialog getPreviewDialog(java.awt.Component c,
                                      java.lang.String title,
                                      javax.swing.table.TableModel m,
                                      java.net.URL xMLTemplate,
                                      java.net.URL base,
                                      java.lang.String[] order,
                                      boolean[] asc,
                                      ReportProcessor r)
                               throws java.lang.Exception

Implementation of this method for each engine must return a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception

getPreviewDialog

public PreviewDialog getPreviewDialog(java.awt.Component c,
                                      java.lang.String title,
                                      javax.swing.table.TableModel m,
                                      java.net.URL xMLTemplate,
                                      java.net.URL base,
                                      java.lang.String[] order,
                                      boolean[] asc,
                                      ReportProcessor r,
                                      java.awt.print.PageFormat pf)
                               throws java.lang.Exception

Implementation of this method for each engine must return a dialog with printed report. Not all parameters are required

Throws:

java.lang.Exception