org.pentaho.di.trans.steps.pentahoreporting

Class PentahoReportingOutput

java.lang.Object

org.pentaho.di.trans.step.BaseStep

org.pentaho.di.trans.steps.pentahoreporting.PentahoReportingOutput

All Implemented Interfaces:

ExtensionDataInterface, HasLogChannelInterface, LoggingObjectInterface, VariableSpace, StepInterface

public class PentahoReportingOutput
extends BaseStep
implements StepInterface

Outputs a stream/series of rows to a file, effectively building a sort of (compressed) microcube.

Since:

4-apr-2003

Author:

Matt

Field Summary

Fields inherited from class org.pentaho.di.trans.step.BaseStep

deadLockCounter, extensionDataMap, first, linesInput, linesOutput, linesRead, linesRejected, linesSkipped, linesUpdated, linesWritten, log, metaStore, repository, rowListeners, safeStopped, terminator, terminator_rows, variables

Constructor Summary

Constructors

Constructor and Description
PentahoReportingOutput(StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr, TransMeta transMeta, Trans trans)

Method Summary

Modifier and Type	Method and Description
protected static org.apache.commons.vfs2.FileObject	getFileObject(String sourceFilename, VariableSpace space)
protected static Object	getKeyValue(org.apache.commons.vfs2.FileObject fileObject)
protected static org.pentaho.reporting.libraries.resourceloader.Resource	getResource(String sourceFilename, VariableSpace space)
static org.pentaho.reporting.engine.classic.core.MasterReport	loadMasterReport(String sourceFilename)
static org.pentaho.reporting.engine.classic.core.MasterReport	loadMasterReport(String sourceFilename, VariableSpace space)
static void	performPentahoReportingBoot(LogChannelInterface log, Class<?> referenceClass)
void	processReport(Object[] r, String sourceFilename, String targetFilename, PentahoReportingOutputMeta.ProcessorType outputProcessorType, Boolean createParentFolder)
boolean	processRow(StepMetaInterface smi, StepDataInterface sdi) Perform the equivalent of processing one row.

Methods inherited from class org.pentaho.di.trans.step.BaseStep

addResultFile, addRowListener, addRowSetToInputRowSets, addRowSetToOutputRowSets, addStepListener, batchComplete, buildLog, canProcessOneRow, checkFeedback, cleanup, clearInputRowSets, clearOutputRowSets, closeQuietly, copyVariablesFrom, decrementLinesRead, decrementLinesWritten, dispatch, dispose, environmentSubstitute, environmentSubstitute, environmentSubstitute, fieldSubstitute, findInputRowSet, findInputRowSet, findOutputRowSet, findOutputRowSet, getBooleanValueOfVariable, getClusterSize, getContainerObjectId, getCopy, getCurrentInputRowSetNr, getCurrentOutputRowSetNr, getDispatcher, getErrorRowMeta, getErrors, getExtensionDataMap, getFilename, getFirstInputRowSet, getInputRowMeta, getInputRowSets, getLinesInput, getLinesOutput, getLinesRead, getLinesRejected, getLinesSkipped, getLinesUpdated, getLinesWritten, getLogChannel, getLogChannelId, getLogFields, getLogLevel, getMetaStore, getNextClassNr, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getOutputRowSets, getParent, getParentVariableSpace, getPartitionID, getPartitionTargets, getPreviewRowMeta, getProcessed, getRegistrationDate, getRemoteInputSteps, getRemoteOutputSteps, getRepartitioning, getRepository, getRepositoryDirectory, getResultFiles, getRow, getRowFrom, getRowHandler, getRowListeners, getRuntime, getServerSockets, getSlaveNr, getSocketRepository, getStatus, getStatusDescription, getStepDataInterface, getStepID, getStepListeners, getStepMeta, getStepMetaInterface, getStepname, getTrans, getTransMeta, getTypeId, getUniqueStepCountAcrossSlaves, getUniqueStepNrAcrossSlaves, getVariable, getVariable, handleGetRowFrom, handlePutRowTo, identifyErrorOutput, incrementLinesInput, incrementLinesOutput, incrementLinesRead, incrementLinesRejected, incrementLinesSkipped, incrementLinesUpdated, incrementLinesWritten, init, initBeforeStart, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDistributed, isForcingSeparateLogging, isGatheringMetrics, isInitialising, isMapping, isPartitioned, isPaused, isRowLevel, isRunning, isSafeStopped, isStopped, isUsingThreadPriorityManagment, listVariables, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, logSummary, markStart, markStop, openRemoteInputStepSocketsOnce, openRemoteOutputStepSocketsOnce, outputIsDone, pauseRunning, putError, putRow, putRowTo, removeRowListener, resumeRunning, rowsetInputSize, rowsetOutputSize, safeModeChecking, safeModeChecking, setCarteObjectId, setCopy, setCurrentInputRowSetNr, setCurrentOutputRowSetNr, setDistributed, setErrorRowMeta, setErrors, setForcingSeparateLogging, setGatheringMetrics, setInputRowMeta, setInputRowSets, setInternalVariables, setLinesInput, setLinesOutput, setLinesRead, setLinesRejected, setLinesSkipped, setLinesUpdated, setLinesWritten, setLogLevel, setMetaStore, setOutputDone, setOutputRowSets, setParentVariableSpace, setPartitioned, setPartitionID, setPartitionTargets, setPaused, setPaused, setPreviewRowMeta, setRepartitioning, setRepository, setRowHandler, setRunning, setSafeStopped, setServerSockets, setSocketRepository, setStepDataInterface, setStepListeners, setStepMeta, setStepMetaInterface, setStepname, setStopped, setTransMeta, setUsingThreadPriorityManagment, setVariable, shareVariablesWith, stopAll, stopRunning, stopRunning, swapFirstInputRowSetIfExists, toString, verifyInputDeadLock, waitUntilTransformationIsStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.di.trans.step.StepInterface

addRowListener, addRowSetToInputRowSets, addRowSetToOutputRowSets, addStepListener, batchComplete, canProcessOneRow, cleanup, dispose, getCopy, getCurrentInputRowSetNr, getCurrentOutputRowSetNr, getErrors, getInputRowSets, getLinesInput, getLinesOutput, getLinesRead, getLinesRejected, getLinesUpdated, getLinesWritten, getLogChannel, getMetaStore, getOutputRowSets, getPartitionID, getProcessed, getRepository, getResultFiles, getRow, getRowListeners, getRuntime, getStatus, getStepID, getStepMeta, getStepname, getTrans, identifyErrorOutput, init, initBeforeStart, isMapping, isPartitioned, isPaused, isRunning, isSafeStopped, isStopped, isUsingThreadPriorityManagment, markStart, markStop, pauseRunning, putRow, removeRowListener, resumeRunning, rowsetInputSize, rowsetOutputSize, setCurrentInputRowSetNr, setCurrentOutputRowSetNr, setErrors, setLinesRejected, setMetaStore, setOutputDone, setPartitioned, setPartitionID, setRepartitioning, setRepository, setRunning, setSafeStopped, setStopped, setUsingThreadPriorityManagment, stopAll, stopRunning, subStatuses

Methods inherited from interface org.pentaho.di.core.variables.VariableSpace

copyVariablesFrom, environmentSubstitute, environmentSubstitute, environmentSubstitute, fieldSubstitute, getBooleanValueOfVariable, getParentVariableSpace, getVariable, getVariable, initializeVariablesFrom, injectVariables, listVariables, setParentVariableSpace, setVariable, shareVariablesWith

Constructor Detail

PentahoReportingOutput

public PentahoReportingOutput(StepMeta stepMeta,
                              StepDataInterface stepDataInterface,
                              int copyNr,
                              TransMeta transMeta,
                              Trans trans)

Method Detail

processRow

public boolean processRow(StepMetaInterface smi,
                          StepDataInterface sdi)
                   throws KettleException

Description copied from interface: StepInterface

Perform the equivalent of processing one row. Typically this means reading a row from input (getRow()) and passing a row to output (putRow)).

Specified by:

processRow in interface StepInterface

Overrides:

processRow in class BaseStep

Parameters:

smi - The steps metadata to work with

sdi - The steps temporary working data to work with (database connections, result sets, caches, temporary variables, etc.)

Returns:

false if no more rows can be processed or an error occurred.

Throws:

KettleException

performPentahoReportingBoot

public static void performPentahoReportingBoot(LogChannelInterface log,
                                               Class<?> referenceClass)

loadMasterReport

public static org.pentaho.reporting.engine.classic.core.MasterReport loadMasterReport(String sourceFilename,
                                                                                      VariableSpace space)
                                                                               throws KettleFileException,
                                                                                      MalformedURLException,
                                                                                      org.pentaho.reporting.libraries.resourceloader.ResourceException

Throws:

KettleFileException

MalformedURLException

org.pentaho.reporting.libraries.resourceloader.ResourceException

loadMasterReport

public static org.pentaho.reporting.engine.classic.core.MasterReport loadMasterReport(String sourceFilename)
                                                                               throws KettleFileException,
                                                                                      MalformedURLException,
                                                                                      org.pentaho.reporting.libraries.resourceloader.ResourceException

Throws:

KettleFileException

MalformedURLException

org.pentaho.reporting.libraries.resourceloader.ResourceException

getResource

protected static org.pentaho.reporting.libraries.resourceloader.Resource getResource(String sourceFilename,
                                                                                     VariableSpace space)
                                                                              throws KettleFileException,
                                                                                     MalformedURLException,
                                                                                     org.pentaho.reporting.libraries.resourceloader.ResourceLoadingException,
                                                                                     org.pentaho.reporting.libraries.resourceloader.ResourceCreationException,
                                                                                     org.pentaho.reporting.libraries.resourceloader.ResourceKeyCreationException

Throws:

KettleFileException

MalformedURLException

org.pentaho.reporting.libraries.resourceloader.ResourceLoadingException

org.pentaho.reporting.libraries.resourceloader.ResourceCreationException

org.pentaho.reporting.libraries.resourceloader.ResourceKeyCreationException

getFileObject

protected static org.apache.commons.vfs2.FileObject getFileObject(String sourceFilename,
                                                                  VariableSpace space)
                                                           throws KettleFileException

Throws:

KettleFileException

getKeyValue

protected static Object getKeyValue(org.apache.commons.vfs2.FileObject fileObject)
                             throws MalformedURLException

Throws:

MalformedURLException

processReport

public void processReport(Object[] r,
                          String sourceFilename,
                          String targetFilename,
                          PentahoReportingOutputMeta.ProcessorType outputProcessorType,
                          Boolean createParentFolder)
                   throws KettleException

Throws:

KettleException