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, IAuditable, IComponent, ILogger, 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.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, MISSING_SESSION

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

EMPTYLOGID, 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

ReportWizardSpecComponent()

Method Summary

Log	getLogger()
JFreeReport	getReport()
ReportSpec	getReportSpec()
IPentahoResultSet	getResultSet(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

done, executeAction, init, print, validateSystemSettings, writeHtml

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

createFeedbackParameter, createFeedbackParameter, createNewInstance, execute, getActionDefinition, getActionName, getActionTitle, getComponentDefinition, getComponentDefinition, getId, getInitFailMessage, getInitOk, getInstanceId, getLogId, getObjectName, getProcessId, getResourceAsString, getRuntimeContext, getSession, inputMissingError, outputMissingError, promptNeeded, promptNow, resolveParameter, resourceComponentSettingError, resourceMissingError, setActionDefinition, setActionName, setComponentDefinition, setComponentDefinitionMap, setInstanceId, setProcessId, setRuntimeContext, setSession, validate

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

debug, debug, 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

equals, 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 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

getReport

public JFreeReport getReport()
                      throws Exception

Overrides:

getReport in class JFreeReportComponent

Throws:

Exception

getReportSpec

public ReportSpec getReportSpec()
                         throws IOException

Throws:

IOException

getResultSet

public IPentahoResultSet getResultSet(ReportSpec reportSpec)
                               throws Exception

Throws:

Exception

setupQueryParameters

public String setupQueryParameters(String query)