Package org.pentaho.platform.plugin.action.jfreereport

Class ReportWizardSpecComponent

java.lang.Object

org.pentaho.platform.engine.core.system.PentahoBase

org.pentaho.platform.engine.services.PentahoMessenger

org.pentaho.platform.engine.services.solution.ComponentBase

org.pentaho.platform.plugin.action.jfreereport.AbstractJFreeReportComponent

org.pentaho.platform.plugin.action.jfreereport.JFreeReportComponent

org.pentaho.platform.plugin.action.jfreereport.ReportWizardSpecComponent

All Implemented Interfaces:

Serializable, org.pentaho.platform.api.engine.IAuditable, org.pentaho.platform.api.engine.IComponent, org.pentaho.platform.api.engine.ILogger, org.pentaho.platform.api.engine.IParameterResolver

public class ReportWizardSpecComponent
extends JFreeReportComponent

The report-wizard component generates a report definition from a report-spec file. Use this component, if want to use the standard-report process only or if you have no need to tweak the processing.

Author:

Michael D'Amour

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pentaho.platform.plugin.action.jfreereport.JFreeReportComponent

logger

Fields inherited from class org.pentaho.platform.plugin.action.jfreereport.AbstractJFreeReportComponent

DATACOMPONENT_CLASSLOCINPUT, DATACOMPONENT_DATAINPUT, DATACOMPONENT_DEFAULTINPUT, DATACOMPONENT_JARINPUT, DATACOMPONENT_MDXCLASS, DATACOMPONENT_MDXSOURCE, DATACOMPONENT_REPORTTEMP_DATAINPUT, DATACOMPONENT_REPORTTEMP_OBJINPUT, DATACOMPONENT_SOURCE, DATACOMPONENT_SQLCLASS, DATACOMPONENT_SQLSOURCE, REPORTALLCONTENT_OUTPUTTYPE, REPORTALLCONTENT_OUTPUTTYPE_CSV, REPORTALLCONTENT_OUTPUTTYPE_HTML, REPORTALLCONTENT_OUTPUTTYPE_PDF, REPORTALLCONTENT_OUTPUTTYPE_RTF, REPORTALLCONTENT_OUTPUTTYPE_SWING, REPORTALLCONTENT_OUTPUTTYPE_XLS, REPORTALLCONTENT_OUTPUTTYPE_XML, REPORTDIRECTORYHTML_DATADIR, REPORTDIRECTORYHTML_TARGETFILE, REPORTGENERATE_PRIORITYINPUT, REPORTGENERATE_PRIORITYLOWER, REPORTGENERATE_PRIORITYLOWEST, REPORTGENERATE_PRIORITYNORMAL, REPORTGENERATE_YIELDRATE, REPORTGENERATEDEFN_REPORTDEFN, REPORTGENERATEDEFN_REPORTSPECINPUT, REPORTGENERATEDEFN_REPORTTEMP_PERFQRY, REPORTGENERATESTREAM_REPORT_OUTPUT, REPORTHTML_CONTENTHANDLER, REPORTLOAD_REPORTLOC, REPORTLOAD_RESOURCENAME, REPORTLOAD_RESURL, REPORTPARAMCOMPONENT_PRIVATEREPORT_OUTPUT, REPORTSWING_MODAL, REPORTSWING_PARENTDIALOG, REPORTSWING_PROGRESSBAR, REPORTSWING_PROGRESSDIALOG, REPORTSWING_REPORTCONTROLLER, WORKBOOK_PARAM

Fields inherited from class org.pentaho.platform.engine.services.solution.ComponentBase

COMPONENT_EXECUTE_FAIL, debug, MISSING_SESSION, UNKNOWN_COMPONENT_ID

Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase

EMPTYLOGID, loggingLevel, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR

Fields inherited from interface org.pentaho.platform.api.engine.ILogger

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Constructor Summary

Constructors

Constructor	Description
ReportWizardSpecComponent()

Method Summary

Modifier and Type	Method	Description
protected boolean	executeReportAction()
protected PentahoTableDataFactory	getDataFactory()
org.apache.commons.logging.Log	getLogger()
org.pentaho.reporting.engine.classic.core.MasterReport	getReport()
org.pentaho.jfreereport.castormodel.reportspec.ReportSpec	getReportSpec()
org.pentaho.commons.connection.IPentahoResultSet	getResultSet(org.pentaho.jfreereport.castormodel.reportspec.ReportSpec reportSpec)
String	setupQueryParameters(String query)
boolean	validateAction()	We cannot validate the parameters of all components, as the required parameters might not have been created.

Methods inherited from class org.pentaho.platform.plugin.action.jfreereport.JFreeReportComponent

createReport, done, executeAction, getContentItem, init, initAndValidate, print, validateSystemSettings, writeCsv, writeHtml, writePdf, writeRtf, writeSwingPreview, writeXls, writeXml

Methods inherited from class org.pentaho.platform.engine.services.solution.ComponentBase

addTempParameter, addTempParameterObject, applyInputsToFormat, audit, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createNewInstance, execute, feedbackAllowed, getActionDefinition, getActionName, getActionTitle, getComponentDefinition, getComponentDefinition, getContentOutputItem, getDefaultOutputStream, getFeedbackOutputStream, getId, getInitFailMessage, getInitOk, getInputBooleanValue, getInputLongValue, getInputNames, getInputParameter, getInputStream, getInputStringValue, getInputStringValue, getInputValue, getInstanceId, getLogId, getObjectName, getOutputContentItem, getOutputContentItem, getOutputItem, getOutputItem, getOutputNames, getOutputPreference, getProcessId, getResource, getResourceAsString, getResourceDataSource, getResourceInputStream, getResourceNames, getRuntimeContext, getSession, getSetting, getSolutionName, getSolutionPath, getStringSetting, inputMissingError, isDefinedInput, isDefinedOutput, isDefinedResource, isPromptPending, outputMissingError, promptNeeded, promptNow, resolveParameter, resourceComponentSettingError, resourceMissingError, saveSetting, setActionDefinition, setActionName, setComponentDefinition, setComponentDefinitionMap, setFeedbackMimeType, setInstanceId, setOutputMimeType, setOutputMimeType, setOutputValue, setProcessId, setRuntimeContext, setSession, validate

Methods inherited from class org.pentaho.platform.engine.services.PentahoMessenger

debug, debug, error, error, error, fatal, fatal, getMessages, getUserString, info, info, setMessages, trace, trace, warn, warn

Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase

genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, setLoggingLevel, setLogId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.platform.api.engine.IComponent

getMessages, setMessages

Methods inherited from interface org.pentaho.platform.api.engine.ILogger

debug, debug, error, error, fatal, fatal, getLoggingLevel, info, info, setLoggingLevel, trace, trace, warn, warn

Constructor Detail

ReportWizardSpecComponent

public ReportWizardSpecComponent()

Method Detail

getLogger

public org.apache.commons.logging.Log getLogger()

Overrides:

getLogger in class JFreeReportComponent

validateAction

public boolean validateAction()

Description copied from class: JFreeReportComponent

We cannot validate the parameters of all components, as the required parameters might not have been created.

Overrides:

validateAction in class JFreeReportComponent

executeReportAction

protected boolean executeReportAction()

Overrides:

executeReportAction in class JFreeReportComponent

getReport

public org.pentaho.reporting.engine.classic.core.MasterReport getReport()
                                                                 throws Exception

Overrides:

getReport in class JFreeReportComponent

Throws:

Exception

getDataFactory

protected PentahoTableDataFactory getDataFactory()
                                          throws ClassNotFoundException,
                                                 InstantiationException,
                                                 IllegalAccessException,
                                                 Exception

Overrides:

getDataFactory in class JFreeReportComponent

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException

Exception

getReportSpec

public org.pentaho.jfreereport.castormodel.reportspec.ReportSpec getReportSpec()
                                                                        throws IOException

Throws:

IOException

getResultSet

public org.pentaho.commons.connection.IPentahoResultSet getResultSet(org.pentaho.jfreereport.castormodel.reportspec.ReportSpec reportSpec)
                                                              throws Exception

Throws:

Exception

setupQueryParameters

public String setupQueryParameters(String query)