Package org.pentaho.di.trans.streaming.common

Class BaseStreamStep

java.lang.Object

org.pentaho.di.trans.step.BaseStep

org.pentaho.di.trans.streaming.common.BaseStreamStep

All Implemented Interfaces:

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

public class BaseStreamStep
extends BaseStep

Field Summary

Fields

Modifier and Type	Field	Description
protected StreamSource<List<Object>>	source
protected BaseStreamStepMeta	variablizedStepMeta
protected StreamWindow<List<Object>,org.pentaho.di.core.Result>	window

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected int	getBatchSize()
protected long	getDuration()
protected int	getParallelism()
protected int	getPrefetchCount()	Get Prefetch Count
StreamSource<List<Object>>	getSource()
SubtransExecutor	getSubtransExecutor()
BaseStreamStepMeta	getVariablizedStepMeta()
boolean	init(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface)	Initialize and do work where other steps need to wait for...
void	pauseRunning()	Pause a running step
boolean	processRow(StepMetaInterface smi, StepDataInterface sdi)	Perform the equivalent of processing one row.
void	resumeRunning()	Resume a running step
void	setOutputDone()	Signal output done to destination steps
void	setSource(StreamSource<List<Object>> source)
void	stopRunning(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface)	Perform actions to stop a running step.
Collection<StepStatus>	subStatuses()

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

addResultFile, addRowListener, addRowSetToInputRowSets, addRowSetToOutputRowSets, addStepListener, batchComplete, beforeStartProcessing, 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, initBeforeStart, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDistributed, isForcingSeparateLogging, isGatheringMetrics, isInitialising, isLoggingObjectInUse, 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, putError, putRow, putRowTo, removeRowListener, rowsetInputSize, rowsetOutputSize, safeModeChecking, safeModeChecking, setCarteObjectId, setCopy, setCurrentInputRowSetNr, setCurrentOutputRowSetNr, setDistributed, setErrorRowMeta, setErrors, setForcingSeparateLogging, setGatheringMetrics, setInputRowMeta, setInputRowSets, setInternalVariables, setLinesInput, setLinesOutput, setLinesRead, setLinesRejected, setLinesSkipped, setLinesUpdated, setLinesWritten, setLoggingObjectInUse, setLogLevel, setMetaStore, 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, 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.core.logging.LoggingObjectLifecycleInterface

callAfterLog, callBeforeLog

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

afterFinishProcessing

Field Detail

variablizedStepMeta

protected BaseStreamStepMeta variablizedStepMeta

window

protected StreamWindow<List<Object>,org.pentaho.di.core.Result> window

source

protected StreamSource<List<Object>> source

Constructor Detail

BaseStreamStep

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

Method Detail

getVariablizedStepMeta

public BaseStreamStepMeta getVariablizedStepMeta()

init

public boolean init(StepMetaInterface stepMetaInterface,
                    StepDataInterface stepDataInterface)

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:

stepMetaInterface - The metadata to work with

stepDataInterface - The data to initialize

setOutputDone

public void setOutputDone()

Description copied from interface: StepInterface

Signal output done to destination steps

Specified by:

setOutputDone in interface StepInterface

Overrides:

setOutputDone in class BaseStep

processRow

public boolean processRow(StepMetaInterface smi,
                          StepDataInterface sdi)
                   throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleException

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

resumeRunning

public void resumeRunning()

Description copied from interface: StepInterface

Resume a running step

Specified by:

resumeRunning in interface StepInterface

Overrides:

resumeRunning in class BaseStep

pauseRunning

public void pauseRunning()

Description copied from interface: StepInterface

Pause a running step

Specified by:

pauseRunning in interface StepInterface

Overrides:

pauseRunning in class BaseStep

getBatchSize

protected int getBatchSize()

getPrefetchCount

protected int getPrefetchCount()

Get Prefetch Count

Returns:

the number of messages to prefetch from the broker

getDuration

protected long getDuration()

getParallelism

protected int getParallelism()

subStatuses

public Collection<StepStatus> subStatuses()

getSource

public StreamSource<List<Object>> getSource()

setSource

public void setSource(StreamSource<List<Object>> source)

getSubtransExecutor

public SubtransExecutor getSubtransExecutor()