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

Class AbstractGenerateContentComponent

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.outputs.AbstractGenerateContentComponent

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

Direct Known Subclasses:

AbstractGenerateStreamContentComponent, JFreeReportDirectoryHtmlComponent, JFreeReportPreviewSwingComponent, JFreeReportPrintComponent

public abstract class AbstractGenerateContentComponent
extends AbstractJFreeReportComponent

The base class for all content generating components. This class adds the report-data to the JFreeReport object. If requested, it creates a private copy of the report before doing any work - cloning is faster than parsing.

Sub-Actions of this component are usually the last step in the report processing.

Author:

Thomas Morgner

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

Modifier	Constructor	Description
protected	AbstractGenerateContentComponent()

Method Summary

Modifier and Type	Method	Description
void	done()
protected boolean	executeAction()
org.apache.commons.logging.Log	getLogger()
protected org.pentaho.reporting.engine.classic.core.MasterReport	getReport()
protected int	getYieldRate()
boolean	init()
protected abstract boolean	performExport(org.pentaho.reporting.engine.classic.core.MasterReport report)
protected boolean	validateAction()
protected boolean	validateSystemSettings()

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

AbstractGenerateContentComponent

protected AbstractGenerateContentComponent()

Method Detail

validateAction

protected boolean validateAction()

Specified by:

validateAction in class org.pentaho.platform.engine.services.solution.ComponentBase

getReport

protected org.pentaho.reporting.engine.classic.core.MasterReport getReport()

validateSystemSettings

protected boolean validateSystemSettings()

Specified by:

validateSystemSettings in class org.pentaho.platform.engine.services.solution.ComponentBase

executeAction

protected boolean executeAction()
                         throws Throwable

Specified by:

executeAction in class org.pentaho.platform.engine.services.solution.ComponentBase

Throws:

Throwable

performExport

protected abstract boolean performExport(org.pentaho.reporting.engine.classic.core.MasterReport report)
                                  throws IOException

Throws:

IOException

done

public void done()

Specified by:

done in interface org.pentaho.platform.api.engine.IComponent

Specified by:

done in class org.pentaho.platform.engine.services.solution.ComponentBase

init

public boolean init()

Specified by:

init in interface org.pentaho.platform.api.engine.IComponent

Specified by:

init in class org.pentaho.platform.engine.services.solution.ComponentBase

getLogger

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

Specified by:

getLogger in class org.pentaho.platform.engine.core.system.PentahoBase

getYieldRate

protected int getYieldRate()