org.pentaho.di.trans.steps.singlethreader

Class SingleThreader

java.lang.Object

org.pentaho.di.trans.step.BaseStep

org.pentaho.di.trans.steps.singlethreader.SingleThreader

All Implemented Interfaces:

org.pentaho.di.core.ExtensionDataInterface, HasLogChannelInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.variables.VariableSpace, StepInterface

public class SingleThreader
extends BaseStep
implements StepInterface

Execute a mapping: a re-usuable transformation

Since:

22-nov-2005

Author:

Matt

Field Summary

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

first, linesInput, linesOutput, linesRead, linesRejected, linesSkipped, linesUpdated, linesWritten, terminator, terminator_rows

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	dispose(StepMetaInterface smi, StepDataInterface sdi) Dispose of this step: close files, empty logs, etc.
Trans	getMappingTrans()
boolean	init(StepMetaInterface smi, StepDataInterface sdi) Initialize and do work where other steps need to wait for...
void	prepareMappingExecution()
boolean	processRow(StepMetaInterface smi, StepDataInterface sdi) Process rows in batches of N rows.
void	stopAll() Flags all rowsets as stopped/completed/finished.
void	stopRunning(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface) Perform actions to stop a running step.

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

addResultFile, addRowListener, addStepListener, batchComplete, buildLog, canProcessOneRow, cleanup, closeQuietly, copyVariablesFrom, decrementLinesRead, decrementLinesWritten, dispatch, environmentSubstitute, environmentSubstitute, fieldSubstitute, findInputRowSet, findInputRowSet, findOutputRowSet, findOutputRowSet, getBooleanValueOfVariable, getClusterSize, getContainerObjectId, getCopy, getCurrentInputRowSetNr, getCurrentOutputRowSetNr, getDispatcher, getErrorRowMeta, getErrors, getExtensionDataMap, getFilename, 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, getRowListeners, getRuntime, getServerSockets, getSlaveNr, getSocketRepository, getStatus, getStatusDescription, getStepDataInterface, getStepID, getStepListeners, getStepMeta, getStepMetaInterface, getStepname, getTrans, getTransMeta, getTypeId, getUniqueStepCountAcrossSlaves, getUniqueStepNrAcrossSlaves, getVariable, getVariable, identifyErrorOutput, incrementLinesInput, incrementLinesOutput, incrementLinesRead, incrementLinesRejected, incrementLinesSkipped, incrementLinesUpdated, incrementLinesWritten, initBeforeStart, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDistributed, isForcingSeparateLogging, isGatheringMetrics, isInitialising, isMapping, isPartitioned, isPaused, isRowLevel, isRunning, isStopped, isUsingThreadPriorityManagment, listVariables, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, logSummary, markStart, markStop, outputIsDone, pauseRunning, putError, putRow, putRowTo, removeRowListener, resumeRunning, rowsetInputSize, rowsetOutputSize, 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, setRunning, setServerSockets, setSocketRepository, setStepDataInterface, setStepListeners, setStepMeta, setStepMetaInterface, setStepname, setStopped, setTransMeta, setUsingThreadPriorityManagment, setVariable, shareVariablesWith, stopRunning, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

addRowListener, addStepListener, batchComplete, canProcessOneRow, cleanup, 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, initBeforeStart, isMapping, isPartitioned, isPaused, isRunning, isStopped, isUsingThreadPriorityManagment, markStart, markStop, pauseRunning, putRow, removeRowListener, resumeRunning, rowsetInputSize, rowsetOutputSize, setCurrentInputRowSetNr, setCurrentOutputRowSetNr, setErrors, setLinesRejected, setMetaStore, setOutputDone, setPartitioned, setPartitionID, setRepartitioning, setRepository, setRunning, setStopped, setUsingThreadPriorityManagment

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

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

Constructor Detail

SingleThreader

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

Method Detail

processRow

public boolean processRow(StepMetaInterface smi,
                          StepDataInterface sdi)
                   throws org.pentaho.di.core.exception.KettleException

Process rows in batches of N rows. The sub-transformation will execute in a single thread.

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:

org.pentaho.di.core.exception.KettleException

prepareMappingExecution

public void prepareMappingExecution()
                             throws org.pentaho.di.core.exception.KettleException

Throws:

org.pentaho.di.core.exception.KettleException

init

public boolean init(StepMetaInterface smi,
                    StepDataInterface sdi)

Description copied from interface: StepInterface

Initialize and do work where other steps need to wait for...

Specified by:

init in interface StepInterface

Overrides:

init in class BaseStep

Parameters:

smi - The metadata to work with

sdi - The data to initialize

dispose

public void dispose(StepMetaInterface smi,
                    StepDataInterface sdi)

Description copied from interface: StepInterface

Dispose of this step: close files, empty logs, etc.

Specified by:

dispose in interface StepInterface

Overrides:

dispose in class BaseStep

Parameters:

smi - The metadata to work with

sdi - The data to dispose of

stopRunning

public void stopRunning(StepMetaInterface stepMetaInterface,
                        StepDataInterface stepDataInterface)
                 throws org.pentaho.di.core.exception.KettleException

Description copied from class: BaseStep

Perform actions to stop a running step. This can be stopping running SQL queries (cancel), etc. Default it doesn't do anything.

Specified by:

stopRunning in interface StepInterface

Overrides:

stopRunning in class BaseStep

Parameters:

stepMetaInterface - The metadata that might be needed by the step to stop running.

stepDataInterface - The interface to the step data containing the connections, resultsets, open files, etc.

Throws:

org.pentaho.di.core.exception.KettleException - in case something goes wrong

stopAll

public void stopAll()

Description copied from interface: StepInterface

Flags all rowsets as stopped/completed/finished.

Specified by:

stopAll in interface StepInterface

Overrides:

stopAll in class BaseStep

getMappingTrans

public Trans getMappingTrans()