| org.pentaho.plugin.jfreereport.AbstractJFreeReportComponent
 org.pentaho.plugin.jfreereport.JFreeReportComponent
All known Subclasses: org.pentaho.plugin.jfreereport.ReportWizardSpecComponent,
| JFreeReportComponent | | public class JFreeReportComponent extends AbstractJFreeReportComponent (Code) | | The JFreeReportComponent provides a simple-to-use frontend for the reporting
process. This component will execute JFreeReport reports in one of two
different modes:
sqlMode = true
This means that the JFreeReport component is expected to execute an SQL query,
wrap the resulting SQL Resultset in a TableModel, and use that to execute a report
whose definition is in the file system. In this mode, the action-sequence
definition must contain the following elements: In the resource-definition section,
there must be a resource called "report-definition" which defines the location of
the jfreereport xml document. In the component-definition sction, there must
be the following entries:
- A "query" parameter which contains an SQL query.
- Either for connecting to the SQL datasource:
- A "jndi" parameter (with the jndi name of the datasource)
- or The database parameters "driver", "user-id", "password" and "connection" so
that a database connection can be established for running the afore-mentioned
"query".
sqlMode = false
This means that the JFreeReport component is expected to execute a report that
exists in a .jar file (like the reporting demo reports) along with the TableModel
class that provides the data for the report. In this mode, the action-sequence
definition must contain the following elements: In the resource-definition section,
there must be a resource called "report-jar" that points to the .jar file that
contains the report .xml file, and the TableModel implementation. In the
component-definition section, there must be two entries:
- "report-location" - This is the location of the report .xml document (e.g.
org/jfree/report/demo/report1.xml)
- "class-location" - This is the package-qualified class that implements
TableModel (e.g. org.jfree.report.demo.SampleData1).
author:
mbatchel |
| Method Summary | |
| protected JFreeReport | createReport(String reportDefinition)
| | public void | done()
| | public boolean | executeAction()
This method gets called from the outside. | | protected boolean | executeReportAction()
| | protected IContentItem | getContentItem(String mimeType, String extension)
| | protected PentahoTableDataFactory | getDataFactory()
| | public Log | getLogger()
| | public JFreeReport | getReport()
| | public boolean | init()
| | protected boolean | initAndValidate(IComponent component)
| | public boolean | print(JFreeReport report, String jobName, String printerName)
| | public boolean | validateAction()
We cannot validate the parameters of all components, as the required parameters
might not have been created. | | public boolean | validateSystemSettings()
| | protected boolean | writeCsv(JFreeReport report, OutputStream outputStream, int yieldRate)
| | public boolean | writeHtml(JFreeReport report, OutputStream outputStream, int yieldRate, String htmlContentHandlerUrlPattern)
| | protected boolean | writePdf(JFreeReport report, OutputStream outputStream, int yieldRate)
| | protected boolean | writeRtf(JFreeReport report, OutputStream outputStream, int yieldRate)
| | protected boolean | writeSwingPreview(JFreeReport report)
| | protected boolean | writeXls(JFreeReport report, OutputStream outputStream, int yieldRate)
| | protected boolean | writeXml(JFreeReport report, OutputStream outputStream)
|
| JFreeReportComponent | | public JFreeReportComponent()(Code) | | |
| executeAction | | public boolean executeAction()(Code) | | This method gets called from the outside. Based upon our mode call the correct
function.
|
| executeReportAction | | protected boolean executeReportAction()(Code) | | |
| getLogger | | public Log getLogger()(Code) | | |
| init | | public boolean init()(Code) | | |
| validateAction | | public boolean validateAction()(Code) | | We cannot validate the parameters of all components, as the required parameters
might not have been created.
|
| validateSystemSettings | | public boolean validateSystemSettings()(Code) | | |
|
|