com.ontimize.report.engine.jfreereport
Class FreeReportEngine

java.lang.Object
  com.ontimize.report.engine.jfreereport.FreeReportEngine

All Implemented Interfaces:

org.jfree.report.modules.gui.base.PreviewProxy, ReportEngine

public class FreeReportEngine

extends java.lang.Object

implements org.jfree.report.modules.gui.base.PreviewProxy, ReportEngine

Field Summary

protected ExtPreviewProxyBase	base
protected DefaultReportDialog	reportDialog

Constructor Summary

FreeReportEngine()

Method Summary

void	addComponentListener(java.awt.event.ComponentListener componentListener)
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.
javax.swing.Action	createDefaultCloseAction()
protected static PreviewDialog	createPreviewDialog(java.awt.Component c, java.lang.String title)
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 tituloPag, java.lang.String descripcion) Generates the report.
org.jfree.report.modules.gui.base.PreviewProxyBase	getBase()
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).
static PreviewDialog	getPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.lang.String xMLTemplate, java.net.URL base)
static PreviewDialog	getPreviewDialog(java.awt.Component c, java.lang.String title, javax.swing.table.TableModel m, java.lang.String xMLTemplate, java.net.URL base, ReportProcessor rp)
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.
boolean	isShowedRowNumber()
void	pack()
static void	print(ReportPageable r, boolean printDialog, java.lang.String jobname)
static void	print(ReportPageable r, boolean printDialog, java.lang.String jobname, boolean wait)
static void	print(ReportPageable r, boolean printDialog, java.lang.String jobname, boolean wait, boolean dispose)
static void	print(ReportPageable r, boolean printDialog, java.lang.String jobname, boolean wait, boolean dispose, java.lang.String serviceName)
static void	printPreview(java.awt.Window owner, ReportPageable r, java.lang.String jobname)
void	removeComponentListener(java.awt.event.ComponentListener componentListener)
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	setJMenuBar(javax.swing.JMenuBar jMenuBar)
void	setReportDescription(java.lang.String text) Sets the title of report.
void	setTitle(java.lang.String title)
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 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) 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()
void	updateReport(boolean force) Updates the report.

Methods inherited from class java.lang.Object

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

Field Detail

reportDialog

protected DefaultReportDialog reportDialog

base

protected ExtPreviewProxyBase base

Constructor Detail

FreeReportEngine

public FreeReportEngine()

Method Detail

close

public void close()

Description copied from interface: ReportEngine

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

Specified by:

close in interface org.jfree.report.modules.gui.base.PreviewProxy

createDefaultCloseAction

public javax.swing.Action createDefaultCloseAction()

Specified by:

createDefaultCloseAction in interface org.jfree.report.modules.gui.base.PreviewProxy

generaReportStoreDefinition

public BasicReportStoreDefinition generaReportStoreDefinition(java.lang.String pageTitle)

Description copied from interface: ReportEngine

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

Specified by:

generaReportStoreDefinition in interface ReportEngine

Parameters:

pageTitle - the title of page

Returns:

The reportStoreDefinition

dispose

public void dispose()

Description copied from interface: ReportEngine

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

Specified by:

dispose in interface org.jfree.report.modules.gui.base.PreviewProxy

getBase

public org.jfree.report.modules.gui.base.PreviewProxyBase getBase()

Specified by:

getBase in interface org.jfree.report.modules.gui.base.PreviewProxy

pack

public void pack()

Specified by:

pack in interface org.jfree.report.modules.gui.base.PreviewProxy

setJMenuBar

public void setJMenuBar(javax.swing.JMenuBar jMenuBar)

Specified by:

setJMenuBar in interface org.jfree.report.modules.gui.base.PreviewProxy

setTitle

public void setTitle(java.lang.String title)

Specified by:

setTitle in interface org.jfree.report.modules.gui.base.PreviewProxy

addComponentListener

public void addComponentListener(java.awt.event.ComponentListener componentListener)

Specified by:

addComponentListener in interface org.jfree.report.modules.gui.base.PreviewProxy

removeComponentListener

public void removeComponentListener(java.awt.event.ComponentListener componentListener)

Specified by:

removeComponentListener in interface org.jfree.report.modules.gui.base.PreviewProxy

updateReport

public void updateReport()

updateReport

public void updateReport(boolean force)

Description copied from interface: ReportEngine

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

Specified by:

updateReport in interface ReportEngine

Parameters:

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

getBaseTemplate

public java.lang.Object getBaseTemplate()

Description copied from interface: ReportEngine

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

Specified by:

getBaseTemplate in interface ReportEngine

Returns:

the viewer

generateReport

public java.lang.Object generateReport(java.lang.String tituloPag,
                                       java.lang.String descripcion)
                                throws java.io.IOException

Description copied from interface: ReportEngine

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.

Specified by:

generateReport in interface ReportEngine

Parameters:

tituloPag - the title of report

descripcion - subtitle of report

Returns:

the generated report

Throws:

java.io.IOException

getPageTitle

public java.lang.String getPageTitle()

Description copied from interface: ReportEngine

Gets the title of report (Maintains backward compatibility).

Specified by:

getPageTitle in interface ReportEngine

Returns:

the title The title of page

getReportDescription

public java.lang.String getReportDescription()

Description copied from interface: ReportEngine

Gets the description of report (subtitle).

Specified by:

getReportDescription in interface ReportEngine

Returns:

the subtitle of report

getTitle

public java.lang.String getTitle()

Description copied from interface: ReportEngine

Gets the title of report.

Specified by:

getTitle in interface ReportEngine

Returns:

the title

setTitleReport

public void setTitleReport(java.lang.String text)

Description copied from interface: ReportEngine

Sets the title of report.

Specified by:

setTitleReport in interface ReportEngine

Parameters:

text - the text to set in title

setReportDescription

public void setReportDescription(java.lang.String text)

Description copied from interface: ReportEngine

Sets the title of report.

Specified by:

setReportDescription in interface ReportEngine

Parameters:

text - the text to set in title

setDefaultReportDialog

public void setDefaultReportDialog(java.lang.Object reportDialog)

Description copied from interface: ReportEngine

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

Specified by:

setDefaultReportDialog in interface ReportEngine

Parameters:

reportDialog - the report dialog to be used in engine.

getDefaultTemplates

public java.util.List getDefaultTemplates()

Description copied from interface: ReportEngine

Returns the list of templates for reports.

Specified by:

getDefaultTemplates in interface ReportEngine

Returns:

The List of templates

buildOptions

public void buildOptions()

Description copied from interface: ReportEngine

Convenience method. TO-DO

Specified by:

buildOptions in interface ReportEngine

isShowedRowNumber

public boolean isShowedRowNumber()

getReportEngineName

public java.lang.String getReportEngineName()

Description copied from interface: ReportEngine

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

Specified by:

getReportEngineName in interface ReportEngine

Returns:

the name of report engine configured

checkLibraries

public boolean checkLibraries()

Description copied from interface: ReportEngine

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.

Specified by:

checkLibraries in interface ReportEngine

Returns:

the condition of availability of libraries.

print

public static void print(ReportPageable r,
                         boolean printDialog,
                         java.lang.String jobname)
                  throws java.awt.print.PrinterException

Throws:

java.awt.print.PrinterException

printPreview

public static void printPreview(java.awt.Window owner,
                                ReportPageable r,
                                java.lang.String jobname)
                         throws java.awt.print.PrinterException

Throws:

java.awt.print.PrinterException

print

public static void print(ReportPageable r,
                         boolean printDialog,
                         java.lang.String jobname,
                         boolean wait)
                  throws java.awt.print.PrinterException

Throws:

java.awt.print.PrinterException

print

public static void print(ReportPageable r,
                         boolean printDialog,
                         java.lang.String jobname,
                         boolean wait,
                         boolean dispose)
                  throws java.awt.print.PrinterException

Throws:

java.awt.print.PrinterException

print

public static void print(ReportPageable r,
                         boolean printDialog,
                         java.lang.String jobname,
                         boolean wait,
                         boolean dispose,
                         java.lang.String serviceName)
                  throws java.awt.print.PrinterException

Throws:

java.awt.print.PrinterException

createPreviewDialog

protected static PreviewDialog createPreviewDialog(java.awt.Component c,
                                                   java.lang.String title)

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,
                                       ReportProcessor rp)
                                throws java.lang.Exception

Description copied from interface: ReportEngine

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

Specified by:

showPreviewDialog in interface ReportEngine

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

Description copied from interface: ReportEngine

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

Specified by:

showPreviewDialog in interface ReportEngine

Throws:

java.lang.Exception

getPreviewDialog

public static PreviewDialog getPreviewDialog(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

Throws:

java.lang.Exception

getPreviewDialog

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

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

Description copied from interface: ReportEngine

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

Specified by:

showPreviewDialog in interface ReportEngine

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

Description copied from interface: ReportEngine

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

Specified by:

showPreviewDialog in interface ReportEngine

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

Description copied from interface: ReportEngine

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

Specified by:

showPreviewDialog in interface ReportEngine

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

Description copied from interface: ReportEngine

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

Specified by:

showPreviewDialog in interface ReportEngine

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

Description copied from interface: ReportEngine

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

Specified by:

showPreviewDialog in interface ReportEngine

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

Description copied from interface: ReportEngine

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

Specified by:

getPreviewDialog in interface ReportEngine

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

Description copied from interface: ReportEngine

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

Specified by:

getPreviewDialog in interface ReportEngine

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

Description copied from interface: ReportEngine

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

Specified by:

getPreviewDialog in interface ReportEngine

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

Description copied from interface: ReportEngine

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

Specified by:

getPreviewDialog in interface ReportEngine

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

Description copied from interface: ReportEngine

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

Specified by:

getPreviewDialog in interface ReportEngine

Throws:

java.lang.Exception