ReportEngine (ontimize-core 5.6.0 API)

All Known Implementing Classes:

DynamicJasperEngine
```
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

Methods
Modifier and Type	Method and Description
`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(String pageTitle)` This method should be only implemented to define a custom report store for reports in our application.
`Object`	`generateReport(String pageTitle, String description)` Generates the report.
`Object`	`getBaseTemplate()` Gets the viewer for this engine.
`Hashtable`	`getColumnWidth()`
`List`	`getDefaultTemplates()` Returns the list of templates for reports.
`String`	`getPageTitle()` Gets the title of report (Maintains backward compatibility).
`PreviewDialog`	`getPreviewDialog(Component c, String title, TableModel m, URL xMLTemplate, URL base)` Implementation of this method for each engine must return a dialog with printed report.
`PreviewDialog`	`getPreviewDialog(Component c, String title, TableModel m, URL xMLTemplate, URL base, ReportProcessor r)` Implementation of this method for each engine must return a dialog with printed report.
`PreviewDialog`	`getPreviewDialog(Component c, String title, TableModel m, URL xMLTemplate, URL base, String[] order, boolean[] asc)` Implementation of this method for each engine must return a dialog with printed report.
`PreviewDialog`	`getPreviewDialog(Component c, String title, TableModel m, URL xMLTemplate, URL base, String[] order, boolean[] asc, ReportProcessor r)` Implementation of this method for each engine must return a dialog with printed report.
`PreviewDialog`	`getPreviewDialog(Component c, String title, TableModel m, URL xMLTemplate, URL base, String[] order, boolean[] asc, ReportProcessor r, PageFormat pf)` Implementation of this method for each engine must return a dialog with printed report.
`String`	`getReportDescription()` Gets the description of report (subtitle).
`String`	`getReportEngineName()` Returns the name of report engine.
`String`	`getTitle()` Gets the title of report.
`String`	`getXMLTemplate()`
`void`	`setDefaultReportDialog(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(String text)` Sets the title of report.
`void`	`setTitleReport(String text)` Sets the title of report.
`PreviewDialog`	`showPreviewDialog(Component c, String title, TableModel m, String xMLTemplate, URL base)` Implementation of this method for each engine must show a dialog with printed report.
`PreviewDialog`	`showPreviewDialog(Component c, String title, TableModel m, String template, URL base, ReportProcessor rp)` Implementation of this method for each engine must show a dialog with printed report.
`PreviewDialog`	`showPreviewDialog(Component c, String title, TableModel m, URL xMLTemplate, URL base)` Implementation of this method for each engine must show a dialog with printed report.
`PreviewDialog`	`showPreviewDialog(Component c, String title, TableModel m, URL xMLTemplate, URL base, ReportProcessor rp)` Implementation of this method for each engine must show a dialog with printed report.
`PreviewDialog`	`showPreviewDialog(Component c, String title, TableModel m, URL xMLTemplate, URL base, String[] order, boolean[] asc)` Implementation of this method for each engine must show a dialog with printed report.
`PreviewDialog`	`showPreviewDialog(Component c, String title, TableModel m, URL xMLTemplate, URL base, String[] order, boolean[] asc, ReportProcessor rp)` Implementation of this method for each engine must show a dialog with printed report.
`PreviewDialog`	`showPreviewDialog(Component c, String title, TableModel m, URL xMLTemplate, URL base, String[] order, boolean[] asc, ReportProcessor rp, 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
```
Object getBaseTemplate()
```
Gets the viewer for this engine. It is placed at right in report dialog.

Returns:
the viewer

close
```
void close()
```
Invalidates the viewer. Implementation of this method could be not required.

dispose
```
void dispose()
```
Method to dispose all resources. It is called at the end of report.

getTitle
```
String getTitle()
```
Gets the title of report.

Returns:
the title

setTitleReport
```
void setTitleReport(String text)
```
Sets the title of report.

Parameters:
text - the text to set in title

setReportDescription
```
void setReportDescription(String text)
```
Sets the title of report.

Parameters:
text - the text to set in title

getReportDescription
```
String getReportDescription()
```
Gets the description of report (subtitle).

Returns:
the subtitle of report

generateReport
```
Object generateReport(String pageTitle,
                    String description)
                      throws 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:

Exception - A new Exception

updateReport
```
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
```
String getPageTitle()
```
Gets the title of report (Maintains backward compatibility).

Returns:
the title The title of page

setDefaultReportDialog
```
void setDefaultReportDialog(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
```
BasicReportStoreDefinition generaReportStoreDefinition(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
```
List getDefaultTemplates()
```
Returns the list of templates for reports.

Returns:
The List of templates

buildOptions
```
void buildOptions()
```
Convenience method. TO-DO

getReportEngineName
```
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

getXMLTemplate

String getXMLTemplate()
                      throws IOException

Throws:: IOException

getColumnWidth
```
Hashtable getColumnWidth()
```

checkLibraries
```
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.