org.pentaho.di.trans.steps.userdefinedjavaclass
Class UserDefinedJavaClass

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStep
      extended by org.pentaho.di.trans.steps.userdefinedjavaclass.UserDefinedJavaClass
All Implemented Interfaces:
HasLogChannelInterface, LoggingObjectInterface, VariableSpace, StepInterface

public class UserDefinedJavaClass
extends BaseStep
implements StepInterface


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
UserDefinedJavaClass(StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr, TransMeta transMeta, Trans trans)
           
 
Method Summary
 void addResultFile(ResultFile resultFile)
          Adds the result file.
 void addResultFileImpl(ResultFile resultFile)
           
 void addRowListener(RowListener rowListener)
          Add a rowlistener to the step allowing you to inspect (or manipulate, be careful) the rows coming in or exiting the step.
 void addRowListenerImpl(RowListener rowListener)
           
 void addStepListener(StepListener stepListener)
          Attach a step listener to be notified when a step arrives in a certain state.
 void addStepListenerImpl(StepListener stepListener)
           
 boolean checkFeedback(long lines)
          Check feedback.
 boolean checkFeedbackImpl(long lines)
           
 void cleanup()
          Call this method typically, after ALL the slave transformations in a clustered run have finished.
 void cleanupImpl()
           
 long decrementLinesRead()
          Decrements the number of lines read from previous steps by one
 long decrementLinesReadImpl()
           
 long decrementLinesWritten()
          Decrements the number of lines written to next steps by one
 long decrementLinesWrittenImpl()
           
 void dispose(StepMetaInterface smi, StepDataInterface sdi)
          Dispose of this step: close files, empty logs, etc.
 void disposeImpl(StepMetaInterface smi, StepDataInterface sdi)
           
 RowSet findInputRowSet(String sourceStep)
          Find input row set.
 RowSet findInputRowSet(String from, int fromcopy, String to, int tocopy)
          Find input row set.
 RowSet findInputRowSetImpl(String sourceStep)
           
 RowSet findInputRowSetImpl(String from, int fromcopy, String to, int tocopy)
           
 RowSet findOutputRowSet(String targetStep)
          Find output row set.
 RowSet findOutputRowSet(String from, int fromcopy, String to, int tocopy)
          Find an output rowset in a running transformation.
 RowSet findOutputRowSetImpl(String targetStep)
           
 RowSet findOutputRowSetImpl(String from, int fromcopy, String to, int tocopy)
           
 int getClusterSize()
          Returns the cluster size.
 int getClusterSizeImpl()
           
 int getCopyImpl()
           
 RowMetaInterface getErrorRowMeta()
           
 RowMetaInterface getErrorRowMetaImpl()
           
 long getErrors()
          Get the number of errors
 long getErrorsImpl()
           
 RowMetaInterface getInputRowMeta()
           
 RowMetaInterface getInputRowMetaImpl()
           
 List<RowSet> getInputRowSets()
           
 List<RowSet> getInputRowSetsImpl()
           
 long getLinesInput()
           
 long getLinesInputImpl()
           
 long getLinesOutput()
           
 long getLinesOutputImpl()
           
 long getLinesRead()
           
 long getLinesReadImpl()
           
 long getLinesRejected()
           
 long getLinesRejectedImpl()
           
 long getLinesSkipped()
           
 long getLinesSkippedImpl()
           
 long getLinesUpdated()
           
 long getLinesUpdatedImpl()
           
 long getLinesWritten()
           
 long getLinesWrittenImpl()
           
 List<RowSet> getOutputRowSets()
           
 List<RowSet> getOutputRowSetsImpl()
           
 String getPartitionID()
           
 String getPartitionIDImpl()
           
 Map<String,BlockingRowSet> getPartitionTargets()
           
 Map<String,BlockingRowSet> getPartitionTargetsImpl()
           
 long getProcessed()
           
 long getProcessedImpl()
           
 int getRepartitioning()
           
 int getRepartitioningImpl()
           
 Map<String,ResultFile> getResultFiles()
           
 Map<String,ResultFile> getResultFilesImpl()
           
 Object[] getRow()
          In case of getRow, we receive data from previous steps through the input rowset.
 Object[] getRowFrom(RowSet rowSet)
          Gets the row from.
 Object[] getRowFromImpl(RowSet rowSet)
           
 Object[] getRowImpl()
           
 List<RowListener> getRowListeners()
           
 List<RowListener> getRowListenersImpl()
           
 long getRuntime()
           
 long getRuntimeImpl()
           
 int getSlaveNr()
          Returns the unique slave number in the cluster.
 int getSlaveNrImpl()
           
 SocketRepository getSocketRepository()
          Retutns the socket repository.
 SocketRepository getSocketRepositoryImpl()
           
 BaseStepData.StepExecutionStatus getStatus()
           
 String getStatusDescription()
          Gets the status description.
 String getStatusDescriptionImpl()
           
 BaseStepData.StepExecutionStatus getStatusImpl()
           
 StepDataInterface getStepDataInterface()
           
 StepDataInterface getStepDataInterfaceImpl()
           
 String getStepID()
           
 String getStepIDImpl()
           
 List<StepListener> getStepListeners()
          Returns the step listeners.
 List<StepListener> getStepListenersImpl()
           
 StepMeta getStepMeta()
           
 StepMeta getStepMetaImpl()
           
 String getStepname()
          Get the name of the step.
 String getStepnameImpl()
           
 Trans getTransImpl()
           
 TransMeta getTransMeta()
           
 TransMeta getTransMetaImpl()
           
 String getTypeId()
          Returns the step ID via the getStepID() method call.
 String getTypeIdImpl()
           
 int getUniqueStepCountAcrossSlaves()
          Returns the number of unique steps across all slave servers.
 int getUniqueStepCountAcrossSlavesImpl()
           
 int getUniqueStepNrAcrossSlaves()
          Returns a unique step number across all slave servers: slaveNr * nrCopies + copyNr.
 int getUniqueStepNrAcrossSlavesImpl()
           
 String getVariable(String variableName)
          Get the value of a variable.
 String getVariable(String variableName, String defaultValue)
          Get the value of a variable with a default in case the variable is not found.
 String getVariableImpl(String variableName)
           
 String getVariableImpl(String variableName, String defaultValue)
           
 long incrementLinesInput()
          Increments the number of lines read from an input source: database, file, socket, etc.
 long incrementLinesInputImpl()
           
 long incrementLinesOutput()
          Increments the number of lines written to an output target: database, file, socket, etc.
 long incrementLinesOutputImpl()
           
 long incrementLinesRead()
          Increments the number of lines read from previous steps by one
 long incrementLinesReadImpl()
           
 long incrementLinesRejected()
          Increments the number of lines rejected to an error handling step
 long incrementLinesRejectedImpl()
           
 long incrementLinesSkipped()
          Increments the number of lines skipped
 long incrementLinesSkippedImpl()
           
 long incrementLinesUpdated()
          Increments the number of lines updated in an output target: database, file, socket, etc.
 long incrementLinesUpdatedImpl()
           
 long incrementLinesWritten()
          Increments the number of lines written to next steps by one
 long incrementLinesWrittenImpl()
           
 boolean init(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface)
          Initialize and do work where other steps need to wait for...
 void initBeforeStart()
          This method is executed by Trans right before the threads start and right after initialization.
 void initBeforeStartImpl()
           
 boolean initImpl(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface)
           
 boolean isDistributed()
           
 boolean isDistributedImpl()
           
 boolean isInitialising()
          Checks if is initialising.
 boolean isInitialisingImpl()
           
 boolean isPartitioned()
           
 boolean isPartitionedImpl()
           
 boolean isSafeModeEnabled()
           
 boolean isSafeModeEnabledImpl()
           
 boolean isStopped()
           
 boolean isStoppedImpl()
           
 boolean isUsingThreadPriorityManagment()
          Retusn true if we are actively managing priorities of step threads.
 boolean isUsingThreadPriorityManagmentImpl()
           
 void logBasic(String s)
          Log basic.
 void logBasicImpl(String s)
           
 void logDebug(String s)
          Log debug.
 void logDebugImpl(String s)
           
 void logDetailed(String s)
          Log detailed.
 void logDetailedImpl(String s)
           
 void logError(String s)
          Log error.
 void logError(String s, Throwable e)
          Log error.
 void logErrorImpl(String s)
           
 void logErrorImpl(String s, Throwable e)
           
 void logMinimal(String s)
          Log minimal.
 void logMinimalImpl(String s)
           
 void logRowlevel(String s)
          Log rowlevel.
 void logRowlevelImpl(String s)
           
 void logSummary()
          Log summary.
 void logSummaryImpl()
           
 void markStart()
          Mark the start time of the step.
 void markStartImpl()
           
 void markStop()
          Mark the end time of the step.
 void markStopImpl()
           
 void openRemoteInputStepSocketsOnce()
          Opens socket connections to the remote input steps of this step.
 void openRemoteInputStepSocketsOnceImpl()
           
 void openRemoteOutputStepSocketsOnce()
          Opens socket connections to the remote output steps of this step.
 void openRemoteOutputStepSocketsOnceImpl()
           
 boolean outputIsDone()
          Output is done.
 boolean outputIsDoneImpl()
           
 boolean processRow(StepMetaInterface smi, StepDataInterface sdi)
          Perform the equivalent of processing one row.
 void putError(RowMetaInterface rowMeta, Object[] row, long nrErrors, String errorDescriptions, String fieldNames, String errorCodes)
          Put error.
 void putErrorImpl(RowMetaInterface rowMeta, Object[] row, long nrErrors, String errorDescriptions, String fieldNames, String errorCodes)
           
 void putRow(RowMetaInterface row, Object[] data)
          putRow is used to copy a row, to the alternate rowset(s) This should get priority over everything else! (synchronized) If distribute is true, a row is copied only once to the output rowsets, otherwise copies are sent to each rowset!
 void putRowImpl(RowMetaInterface row, Object[] data)
           
 void putRowTo(RowMetaInterface rowMeta, Object[] row, RowSet rowSet)
          putRowTo is used to put a row in a certain specific RowSet.
 void putRowToImpl(RowMetaInterface rowMeta, Object[] row, RowSet rowSet)
           
 void removeRowListener(RowListener rowListener)
          Remove a rowlistener from this step.
 void removeRowListenerImpl(RowListener rowListener)
           
 int rowsetInputSize()
           
 int rowsetInputSizeImpl()
           
 int rowsetOutputSize()
           
 int rowsetOutputSizeImpl()
           
 void safeModeChecking(RowMetaInterface row)
          Safe mode checking.
 void safeModeCheckingImpl(RowMetaInterface row)
           
 void setErrors(long errors)
          Sets the number of errors
 void setErrorsImpl(long errors)
           
 void setInputRowMeta(RowMetaInterface rowMeta)
           
 void setInputRowMetaImpl(RowMetaInterface rowMeta)
           
 void setInputRowSets(List<RowSet> inputRowSets)
           
 void setInputRowSetsImpl(List<RowSet> inputRowSets)
           
 void setLinesInput(long newLinesInputValue)
           
 void setLinesInputImpl(long newLinesInputValue)
           
 void setLinesOutput(long newLinesOutputValue)
           
 void setLinesOutputImpl(long newLinesOutputValue)
           
 void setLinesRead(long newLinesReadValue)
           
 void setLinesReadImpl(long newLinesReadValue)
           
 void setLinesRejected(long linesRejected)
           
 void setLinesRejectedImpl(long linesRejected)
           
 void setLinesSkipped(long newLinesSkippedValue)
           
 void setLinesSkippedImpl(long newLinesSkippedValue)
           
 void setLinesUpdated(long newLinesUpdatedValue)
           
 void setLinesUpdatedImpl(long newLinesUpdatedValue)
           
 void setLinesWritten(long newLinesWrittenValue)
           
 void setLinesWrittenImpl(long newLinesWrittenValue)
           
 void setOutputDone()
          Signal output done to destination steps
 void setOutputDoneImpl()
           
 void setOutputRowSets(List<RowSet> outputRowSets)
           
 void setOutputRowSetsImpl(List<RowSet> outputRowSets)
           
 void setStepListeners(List<StepListener> stepListeners)
          Sets the step listeners.
 void setStepListenersImpl(List<StepListener> stepListeners)
           
 void setVariable(String variableName, String variableValue)
          Sets a variable in the Kettle Variables list.
 void setVariableImpl(String variableName, String variableValue)
           
 void stopAll()
          Flags all rowsets as stopped/completed/finished.
 void stopAllImpl()
           
 void stopRunning(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface)
          Perform actions to stop a running step.
 void stopRunningImpl(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface)
           
 String toString()
           
 String toStringImpl()
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStep
batchComplete, buildLog, canProcessOneRow, closeQuietly, copyVariablesFrom, dispatch, environmentSubstitute, environmentSubstitute, getBooleanValueOfVariable, getContainerObjectId, getCopy, getDispatcher, getFilename, getLogChannel, getLogChannelId, getLogFields, getLogLevel, getNextClassNr, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentVariableSpace, getPreviewRowMeta, getRegistrationDate, getRemoteInputSteps, getRemoteOutputSteps, getRepositoryDirectory, getServerSockets, getStepMetaInterface, getTrans, identifyErrorOutput, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isMapping, isPaused, isRowLevel, isRunning, listVariables, logBasic, logDebug, logDetailed, logError, logMinimal, logRowlevel, pauseRunning, resumeRunning, safeModeChecking, setCarteObjectId, setCopy, setDistributed, setErrorRowMeta, setInternalVariables, setLogLevel, setParentVariableSpace, setPartitioned, setPartitionID, setPartitionTargets, setPaused, setPaused, setPreviewRowMeta, setRepartitioning, setRunning, setServerSockets, setSocketRepository, setStepDataInterface, setStepMeta, setStepMetaInterface, setStepname, setStopped, setTransMeta, setUsingThreadPriorityManagment, shareVariablesWith, stopRunning
 
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
batchComplete, canProcessOneRow, getCopy, getLogChannel, getTrans, identifyErrorOutput, isMapping, isPaused, isRunning, pauseRunning, resumeRunning, setPartitioned, setPartitionID, setRepartitioning, setRunning, setStopped, setUsingThreadPriorityManagment
 
Methods inherited from interface org.pentaho.di.core.variables.VariableSpace
copyVariablesFrom, environmentSubstitute, environmentSubstitute, getBooleanValueOfVariable, getParentVariableSpace, initializeVariablesFrom, injectVariables, listVariables, setParentVariableSpace, shareVariablesWith
 

Constructor Detail

UserDefinedJavaClass

public UserDefinedJavaClass(StepMeta stepMeta,
                            StepDataInterface stepDataInterface,
                            int copyNr,
                            TransMeta transMeta,
                            Trans trans)
Method Detail

addResultFile

public void addResultFile(ResultFile resultFile)
Description copied from class: BaseStep
Adds the result file.

Overrides:
addResultFile in class BaseStep
Parameters:
resultFile - the result file

addResultFileImpl

public void addResultFileImpl(ResultFile resultFile)

addRowListener

public void addRowListener(RowListener rowListener)
Description copied from interface: StepInterface
Add a rowlistener to the step allowing you to inspect (or manipulate, be careful) the rows coming in or exiting the step.

Specified by:
addRowListener in interface StepInterface
Overrides:
addRowListener in class BaseStep
Parameters:
rowListener - the rowlistener to add

addRowListenerImpl

public void addRowListenerImpl(RowListener rowListener)

addStepListener

public void addStepListener(StepListener stepListener)
Description copied from interface: StepInterface
Attach a step listener to be notified when a step arrives in a certain state. (finished)

Specified by:
addStepListener in interface StepInterface
Overrides:
addStepListener in class BaseStep
Parameters:
stepListener - The listener to add to the step

addStepListenerImpl

public void addStepListenerImpl(StepListener stepListener)

checkFeedback

public boolean checkFeedback(long lines)
Description copied from class: BaseStep
Check feedback.

Parameters:
lines - the lines
Returns:
true, if successful

checkFeedbackImpl

public boolean checkFeedbackImpl(long lines)

cleanup

public void cleanup()
Description copied from interface: StepInterface
Call this method typically, after ALL the slave transformations in a clustered run have finished.

Specified by:
cleanup in interface StepInterface
Overrides:
cleanup in class BaseStep

cleanupImpl

public void cleanupImpl()

decrementLinesRead

public long decrementLinesRead()
Description copied from class: BaseStep
Decrements the number of lines read from previous steps by one

Overrides:
decrementLinesRead in class BaseStep
Returns:
Returns the new value

decrementLinesReadImpl

public long decrementLinesReadImpl()

decrementLinesWritten

public long decrementLinesWritten()
Description copied from class: BaseStep
Decrements the number of lines written to next steps by one

Overrides:
decrementLinesWritten in class BaseStep
Returns:
Returns the new value

decrementLinesWrittenImpl

public long decrementLinesWrittenImpl()

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

disposeImpl

public void disposeImpl(StepMetaInterface smi,
                        StepDataInterface sdi)

findInputRowSet

public RowSet findInputRowSet(String sourceStep)
                       throws KettleStepException
Description copied from class: BaseStep
Find input row set.

Overrides:
findInputRowSet in class BaseStep
Parameters:
sourceStep - the source step
Returns:
the row set
Throws:
KettleStepException - the kettle step exception

findInputRowSet

public RowSet findInputRowSet(String from,
                              int fromcopy,
                              String to,
                              int tocopy)
Description copied from class: BaseStep
Find input row set.

Overrides:
findInputRowSet in class BaseStep
Parameters:
from - the from
fromcopy - the fromcopy
to - the to
tocopy - the tocopy
Returns:
the row set

findInputRowSetImpl

public RowSet findInputRowSetImpl(String sourceStep)
                           throws KettleStepException
Throws:
KettleStepException

findInputRowSetImpl

public RowSet findInputRowSetImpl(String from,
                                  int fromcopy,
                                  String to,
                                  int tocopy)

findOutputRowSet

public RowSet findOutputRowSet(String targetStep)
                        throws KettleStepException
Description copied from class: BaseStep
Find output row set.

Overrides:
findOutputRowSet in class BaseStep
Parameters:
targetStep - the target step
Returns:
the row set
Throws:
KettleStepException - the kettle step exception

findOutputRowSet

public RowSet findOutputRowSet(String from,
                               int fromcopy,
                               String to,
                               int tocopy)
Description copied from class: BaseStep
Find an output rowset in a running transformation. It will also look at the "to" step to see if this is a mapping. If it is, it will find the appropriate rowset in that transformation.

Overrides:
findOutputRowSet in class BaseStep
Returns:
The rowset or null if none is found.

findOutputRowSetImpl

public RowSet findOutputRowSetImpl(String targetStep)
                            throws KettleStepException
Throws:
KettleStepException

findOutputRowSetImpl

public RowSet findOutputRowSetImpl(String from,
                                   int fromcopy,
                                   String to,
                                   int tocopy)

getClusterSize

public int getClusterSize()
Description copied from class: BaseStep
Returns the cluster size.

Overrides:
getClusterSize in class BaseStep
Returns:
the cluster size

getClusterSizeImpl

public int getClusterSizeImpl()

getCopyImpl

public int getCopyImpl()

getErrorRowMeta

public RowMetaInterface getErrorRowMeta()
Overrides:
getErrorRowMeta in class BaseStep
Returns:
the errorRowMeta

getErrorRowMetaImpl

public RowMetaInterface getErrorRowMetaImpl()

getErrors

public long getErrors()
Description copied from interface: StepInterface
Get the number of errors

Specified by:
getErrors in interface StepInterface
Overrides:
getErrors in class BaseStep
Returns:
the number of errors

getErrorsImpl

public long getErrorsImpl()

getInputRowMeta

public RowMetaInterface getInputRowMeta()
Overrides:
getInputRowMeta in class BaseStep
Returns:
the rowMeta

getInputRowMetaImpl

public RowMetaInterface getInputRowMetaImpl()

getInputRowSets

public List<RowSet> getInputRowSets()
Specified by:
getInputRowSets in interface StepInterface
Overrides:
getInputRowSets in class BaseStep
Returns:
Returns the inputRowSets.

getInputRowSetsImpl

public List<RowSet> getInputRowSetsImpl()

getLinesInput

public long getLinesInput()
Specified by:
getLinesInput in interface StepInterface
Overrides:
getLinesInput in class BaseStep
Returns:
Returns the number of lines read from an input source: database, file, socket, etc.

getLinesInputImpl

public long getLinesInputImpl()

getLinesOutput

public long getLinesOutput()
Specified by:
getLinesOutput in interface StepInterface
Overrides:
getLinesOutput in class BaseStep
Returns:
Returns the number of lines written to an output target: database, file, socket, etc.

getLinesOutputImpl

public long getLinesOutputImpl()

getLinesRead

public long getLinesRead()
Specified by:
getLinesRead in interface StepInterface
Overrides:
getLinesRead in class BaseStep
Returns:
Returns the number of lines read from previous steps

getLinesReadImpl

public long getLinesReadImpl()

getLinesRejected

public long getLinesRejected()
Specified by:
getLinesRejected in interface StepInterface
Overrides:
getLinesRejected in class BaseStep
Returns:
the number of lines rejected to an error handling step

getLinesRejectedImpl

public long getLinesRejectedImpl()

getLinesSkipped

public long getLinesSkipped()
Overrides:
getLinesSkipped in class BaseStep
Returns:
the number of lines skipped

getLinesSkippedImpl

public long getLinesSkippedImpl()

getLinesUpdated

public long getLinesUpdated()
Specified by:
getLinesUpdated in interface StepInterface
Overrides:
getLinesUpdated in class BaseStep
Returns:
Returns the number of lines updated in an output target: database, file, socket, etc.

getLinesUpdatedImpl

public long getLinesUpdatedImpl()

getLinesWritten

public long getLinesWritten()
Specified by:
getLinesWritten in interface StepInterface
Overrides:
getLinesWritten in class BaseStep
Returns:
Returns the linesWritten.

getLinesWrittenImpl

public long getLinesWrittenImpl()

getOutputRowSets

public List<RowSet> getOutputRowSets()
Specified by:
getOutputRowSets in interface StepInterface
Overrides:
getOutputRowSets in class BaseStep
Returns:
Returns the outputRowSets.

getOutputRowSetsImpl

public List<RowSet> getOutputRowSetsImpl()

getPartitionID

public String getPartitionID()
Specified by:
getPartitionID in interface StepInterface
Overrides:
getPartitionID in class BaseStep
Returns:
the partitionID

getPartitionIDImpl

public String getPartitionIDImpl()

getPartitionTargets

public Map<String,BlockingRowSet> getPartitionTargets()
Overrides:
getPartitionTargets in class BaseStep
Returns:
the partitionTargets

getPartitionTargetsImpl

public Map<String,BlockingRowSet> getPartitionTargetsImpl()

getProcessed

public long getProcessed()
Specified by:
getProcessed in interface StepInterface
Overrides:
getProcessed in class BaseStep
Returns:
The number of "processed" lines of a step. Well, a representable metric for that anyway.

getProcessedImpl

public long getProcessedImpl()

getRepartitioning

public int getRepartitioning()
Overrides:
getRepartitioning in class BaseStep
Returns:
the repartitioning type

getRepartitioningImpl

public int getRepartitioningImpl()

getResultFiles

public Map<String,ResultFile> getResultFiles()
Specified by:
getResultFiles in interface StepInterface
Overrides:
getResultFiles in class BaseStep
Returns:
The result files for this step

getResultFilesImpl

public Map<String,ResultFile> getResultFilesImpl()

getRow

public Object[] getRow()
                throws KettleException
Description copied from class: BaseStep
In case of getRow, we receive data from previous steps through the input rowset. In case we split the stream, we have to copy the data to the alternate splits: rowsets 1 through n.

Specified by:
getRow in interface StepInterface
Overrides:
getRow in class BaseStep
Returns:
a row from the source step(s).
Throws:
KettleException

getRowFrom

public Object[] getRowFrom(RowSet rowSet)
                    throws KettleStepException
Description copied from class: BaseStep
Gets the row from.

Overrides:
getRowFrom in class BaseStep
Parameters:
rowSet - the row set
Returns:
the row from
Throws:
KettleStepException - the kettle step exception

getRowFromImpl

public Object[] getRowFromImpl(RowSet rowSet)
                        throws KettleStepException
Throws:
KettleStepException

getRowImpl

public Object[] getRowImpl()
                    throws KettleException
Throws:
KettleException

getRowListeners

public List<RowListener> getRowListeners()
Specified by:
getRowListeners in interface StepInterface
Overrides:
getRowListeners in class BaseStep
Returns:
a list of the installed RowListeners

getRowListenersImpl

public List<RowListener> getRowListenersImpl()

getRuntime

public long getRuntime()
Specified by:
getRuntime in interface StepInterface
Overrides:
getRuntime in class BaseStep
Returns:
The number of ms that this step has been running

getRuntimeImpl

public long getRuntimeImpl()

getSlaveNr

public int getSlaveNr()
Description copied from class: BaseStep
Returns the unique slave number in the cluster.

Overrides:
getSlaveNr in class BaseStep
Returns:
the unique slave number in the cluster

getSlaveNrImpl

public int getSlaveNrImpl()

getSocketRepository

public SocketRepository getSocketRepository()
Description copied from class: BaseStep
Retutns the socket repository.

Overrides:
getSocketRepository in class BaseStep
Returns:
the socketRepository

getSocketRepositoryImpl

public SocketRepository getSocketRepositoryImpl()

getStatus

public BaseStepData.StepExecutionStatus getStatus()
Specified by:
getStatus in interface StepInterface
Overrides:
getStatus in class BaseStep
Returns:
the description as in StepDataInterface

getStatusDescription

public String getStatusDescription()
Description copied from class: BaseStep
Gets the status description.

Overrides:
getStatusDescription in class BaseStep
Returns:
the status description

getStatusDescriptionImpl

public String getStatusDescriptionImpl()

getStatusImpl

public BaseStepData.StepExecutionStatus getStatusImpl()

getStepDataInterface

public StepDataInterface getStepDataInterface()
Overrides:
getStepDataInterface in class BaseStep
Returns:
Returns the stepDataInterface.

getStepDataInterfaceImpl

public StepDataInterface getStepDataInterfaceImpl()

getStepID

public String getStepID()
Specified by:
getStepID in interface StepInterface
Overrides:
getStepID in class BaseStep
Returns:
the type ID of the step...

getStepIDImpl

public String getStepIDImpl()

getStepListeners

public List<StepListener> getStepListeners()
Description copied from class: BaseStep
Returns the step listeners.

Overrides:
getStepListeners in class BaseStep
Returns:
the stepListeners

getStepListenersImpl

public List<StepListener> getStepListenersImpl()

getStepMeta

public StepMeta getStepMeta()
Specified by:
getStepMeta in interface StepInterface
Overrides:
getStepMeta in class BaseStep
Returns:
Returns the stepMeta.

getStepMetaImpl

public StepMeta getStepMetaImpl()

getStepname

public String getStepname()
Description copied from interface: StepInterface
Get the name of the step.

Specified by:
getStepname in interface StepInterface
Overrides:
getStepname in class BaseStep
Returns:
the name of the step

getStepnameImpl

public String getStepnameImpl()

getTransImpl

public Trans getTransImpl()

getTransMeta

public TransMeta getTransMeta()
Overrides:
getTransMeta in class BaseStep
Returns:
Returns the transMeta.

getTransMetaImpl

public TransMeta getTransMetaImpl()

getTypeId

public String getTypeId()
Description copied from class: BaseStep
Returns the step ID via the getStepID() method call. Support for CheckResultSourceInterface.

Overrides:
getTypeId in class BaseStep
Returns:
getStepID()

getTypeIdImpl

public String getTypeIdImpl()

getUniqueStepCountAcrossSlaves

public int getUniqueStepCountAcrossSlaves()
Description copied from class: BaseStep
Returns the number of unique steps across all slave servers.

Overrides:
getUniqueStepCountAcrossSlaves in class BaseStep
Returns:
the number of unique steps across all slave servers

getUniqueStepCountAcrossSlavesImpl

public int getUniqueStepCountAcrossSlavesImpl()

getUniqueStepNrAcrossSlaves

public int getUniqueStepNrAcrossSlaves()
Description copied from class: BaseStep
Returns a unique step number across all slave servers: slaveNr * nrCopies + copyNr.

Overrides:
getUniqueStepNrAcrossSlaves in class BaseStep
Returns:
a unique step number across all slave servers: slaveNr * nrCopies + copyNr

getUniqueStepNrAcrossSlavesImpl

public int getUniqueStepNrAcrossSlavesImpl()

getVariable

public String getVariable(String variableName)
Description copied from interface: VariableSpace
Get the value of a variable.

Specified by:
getVariable in interface VariableSpace
Overrides:
getVariable in class BaseStep
Parameters:
variableName - The name of the variable
Returns:
the String value of a variable or null in case the variable could not be found.

getVariable

public String getVariable(String variableName,
                          String defaultValue)
Description copied from interface: VariableSpace
Get the value of a variable with a default in case the variable is not found.

Specified by:
getVariable in interface VariableSpace
Overrides:
getVariable in class BaseStep
Parameters:
variableName - The name of the variable
defaultValue - The default value in case the variable could not be found
Returns:
the String value of a variable

getVariableImpl

public String getVariableImpl(String variableName)

getVariableImpl

public String getVariableImpl(String variableName,
                              String defaultValue)

incrementLinesInput

public long incrementLinesInput()
Description copied from class: BaseStep
Increments the number of lines read from an input source: database, file, socket, etc.

Overrides:
incrementLinesInput in class BaseStep
Returns:
the new incremented value

incrementLinesInputImpl

public long incrementLinesInputImpl()

incrementLinesOutput

public long incrementLinesOutput()
Description copied from class: BaseStep
Increments the number of lines written to an output target: database, file, socket, etc.

Overrides:
incrementLinesOutput in class BaseStep
Returns:
the new incremented value

incrementLinesOutputImpl

public long incrementLinesOutputImpl()

incrementLinesRead

public long incrementLinesRead()
Description copied from class: BaseStep
Increments the number of lines read from previous steps by one

Overrides:
incrementLinesRead in class BaseStep
Returns:
Returns the new value

incrementLinesReadImpl

public long incrementLinesReadImpl()

incrementLinesRejected

public long incrementLinesRejected()
Description copied from class: BaseStep
Increments the number of lines rejected to an error handling step

Overrides:
incrementLinesRejected in class BaseStep
Returns:
the new incremented value

incrementLinesRejectedImpl

public long incrementLinesRejectedImpl()

incrementLinesSkipped

public long incrementLinesSkipped()
Description copied from class: BaseStep
Increments the number of lines skipped

Overrides:
incrementLinesSkipped in class BaseStep
Returns:
the new incremented value

incrementLinesSkippedImpl

public long incrementLinesSkippedImpl()

incrementLinesUpdated

public long incrementLinesUpdated()
Description copied from class: BaseStep
Increments the number of lines updated in an output target: database, file, socket, etc.

Overrides:
incrementLinesUpdated in class BaseStep
Returns:
the new incremented value

incrementLinesUpdatedImpl

public long incrementLinesUpdatedImpl()

incrementLinesWritten

public long incrementLinesWritten()
Description copied from class: BaseStep
Increments the number of lines written to next steps by one

Overrides:
incrementLinesWritten in class BaseStep
Returns:
Returns the new value

incrementLinesWrittenImpl

public long incrementLinesWrittenImpl()

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

initBeforeStart

public void initBeforeStart()
                     throws KettleStepException
Description copied from class: BaseStep
This method is executed by Trans right before the threads start and right after initialization. More to the point: here we open remote output step sockets.

Specified by:
initBeforeStart in interface StepInterface
Overrides:
initBeforeStart in class BaseStep
Throws:
KettleStepException - In case there is an error

initBeforeStartImpl

public void initBeforeStartImpl()
                         throws KettleStepException
Throws:
KettleStepException

initImpl

public boolean initImpl(StepMetaInterface stepMetaInterface,
                        StepDataInterface stepDataInterface)

isDistributed

public boolean isDistributed()
Overrides:
isDistributed in class BaseStep
Returns:
Returns the distributed.

isDistributedImpl

public boolean isDistributedImpl()

isInitialising

public boolean isInitialising()
Description copied from class: BaseStep
Checks if is initialising.

Overrides:
isInitialising in class BaseStep
Returns:
true, if is initialising

isInitialisingImpl

public boolean isInitialisingImpl()

isPartitioned

public boolean isPartitioned()
Specified by:
isPartitioned in interface StepInterface
Overrides:
isPartitioned in class BaseStep
Returns:
the partitioned

isPartitionedImpl

public boolean isPartitionedImpl()

isSafeModeEnabled

public boolean isSafeModeEnabled()

isSafeModeEnabledImpl

public boolean isSafeModeEnabledImpl()

isStopped

public boolean isStopped()
Specified by:
isStopped in interface StepInterface
Overrides:
isStopped in class BaseStep
Returns:
True if the step is marked as stopped. Execution should stop immediate.

isStoppedImpl

public boolean isStoppedImpl()

isUsingThreadPriorityManagment

public boolean isUsingThreadPriorityManagment()
Description copied from class: BaseStep
Retusn true if we are actively managing priorities of step threads.

Specified by:
isUsingThreadPriorityManagment in interface StepInterface
Overrides:
isUsingThreadPriorityManagment in class BaseStep
Returns:
true if we are actively managing priorities of step threads

isUsingThreadPriorityManagmentImpl

public boolean isUsingThreadPriorityManagmentImpl()

logBasic

public void logBasic(String s)
Description copied from class: BaseStep
Log basic.

Overrides:
logBasic in class BaseStep
Parameters:
s - the message

logBasicImpl

public void logBasicImpl(String s)

logDebug

public void logDebug(String s)
Description copied from class: BaseStep
Log debug.

Overrides:
logDebug in class BaseStep
Parameters:
s - the message

logDebugImpl

public void logDebugImpl(String s)

logDetailed

public void logDetailed(String s)
Description copied from class: BaseStep
Log detailed.

Overrides:
logDetailed in class BaseStep
Parameters:
s - the message

logDetailedImpl

public void logDetailedImpl(String s)

logError

public void logError(String s)
Description copied from class: BaseStep
Log error.

Overrides:
logError in class BaseStep
Parameters:
s - the message

logError

public void logError(String s,
                     Throwable e)
Description copied from class: BaseStep
Log error.

Overrides:
logError in class BaseStep
Parameters:
s - the message
e - the e

logErrorImpl

public void logErrorImpl(String s)

logErrorImpl

public void logErrorImpl(String s,
                         Throwable e)

logMinimal

public void logMinimal(String s)
Description copied from class: BaseStep
Log minimal.

Overrides:
logMinimal in class BaseStep
Parameters:
s - the message

logMinimalImpl

public void logMinimalImpl(String s)

logRowlevel

public void logRowlevel(String s)
Description copied from class: BaseStep
Log rowlevel.

Overrides:
logRowlevel in class BaseStep
Parameters:
s - the message

logRowlevelImpl

public void logRowlevelImpl(String s)

logSummary

public void logSummary()
Description copied from class: BaseStep
Log summary.

Overrides:
logSummary in class BaseStep

logSummaryImpl

public void logSummaryImpl()

markStart

public void markStart()
Description copied from interface: StepInterface
Mark the start time of the step.

Specified by:
markStart in interface StepInterface
Overrides:
markStart in class BaseStep

markStartImpl

public void markStartImpl()

markStop

public void markStop()
Description copied from interface: StepInterface
Mark the end time of the step.

Specified by:
markStop in interface StepInterface
Overrides:
markStop in class BaseStep

markStopImpl

public void markStopImpl()

openRemoteInputStepSocketsOnce

public void openRemoteInputStepSocketsOnce()
                                    throws KettleStepException
Description copied from class: BaseStep
Opens socket connections to the remote input steps of this step.
This method should be used by steps that don't call getRow() first in which it is executed automatically.
This method should be called before any data is read from previous steps.
This action is executed only once.

Throws:
KettleStepException

openRemoteInputStepSocketsOnceImpl

public void openRemoteInputStepSocketsOnceImpl()
                                        throws KettleStepException
Throws:
KettleStepException

openRemoteOutputStepSocketsOnce

public void openRemoteOutputStepSocketsOnce()
                                     throws KettleStepException
Description copied from class: BaseStep
Opens socket connections to the remote output steps of this step.
This method is called in method initBeforeStart() because it needs to connect to the server sockets (remote steps) as soon as possible to avoid time-out situations.
This action is executed only once.

Throws:
KettleStepException

openRemoteOutputStepSocketsOnceImpl

public void openRemoteOutputStepSocketsOnceImpl()
                                         throws KettleStepException
Throws:
KettleStepException

outputIsDone

public boolean outputIsDone()
Description copied from class: BaseStep
Output is done.

Overrides:
outputIsDone in class BaseStep
Returns:
true, if successful

outputIsDoneImpl

public boolean outputIsDoneImpl()

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

putError

public void putError(RowMetaInterface rowMeta,
                     Object[] row,
                     long nrErrors,
                     String errorDescriptions,
                     String fieldNames,
                     String errorCodes)
              throws KettleStepException
Description copied from class: BaseStep
Put error.

Overrides:
putError in class BaseStep
Parameters:
rowMeta - the row meta
row - the row
nrErrors - the nr errors
errorDescriptions - the error descriptions
fieldNames - the field names
errorCodes - the error codes
Throws:
KettleStepException - the kettle step exception

putErrorImpl

public void putErrorImpl(RowMetaInterface rowMeta,
                         Object[] row,
                         long nrErrors,
                         String errorDescriptions,
                         String fieldNames,
                         String errorCodes)
                  throws KettleStepException
Throws:
KettleStepException

putRow

public void putRow(RowMetaInterface row,
                   Object[] data)
            throws KettleStepException
Description copied from class: BaseStep
putRow is used to copy a row, to the alternate rowset(s) This should get priority over everything else! (synchronized) If distribute is true, a row is copied only once to the output rowsets, otherwise copies are sent to each rowset!

Specified by:
putRow in interface StepInterface
Overrides:
putRow in class BaseStep
Parameters:
row - The row to send to the destinations steps
data - The row to put to the destination rowset(s).
Throws:
KettleStepException

putRowImpl

public void putRowImpl(RowMetaInterface row,
                       Object[] data)
                throws KettleStepException
Throws:
KettleStepException

putRowTo

public void putRowTo(RowMetaInterface rowMeta,
                     Object[] row,
                     RowSet rowSet)
              throws KettleStepException
Description copied from class: BaseStep
putRowTo is used to put a row in a certain specific RowSet.

Overrides:
putRowTo in class BaseStep
Parameters:
rowMeta - The row meta-data to put to the destination RowSet.
row - the data to put in the RowSet
rowSet - the RoWset to put the row into.
Throws:
KettleStepException - In case something unexpected goes wrong

putRowToImpl

public void putRowToImpl(RowMetaInterface rowMeta,
                         Object[] row,
                         RowSet rowSet)
                  throws KettleStepException
Throws:
KettleStepException

removeRowListener

public void removeRowListener(RowListener rowListener)
Description copied from interface: StepInterface
Remove a rowlistener from this step.

Specified by:
removeRowListener in interface StepInterface
Overrides:
removeRowListener in class BaseStep
Parameters:
rowListener - the rowlistener to remove

removeRowListenerImpl

public void removeRowListenerImpl(RowListener rowListener)

rowsetInputSize

public int rowsetInputSize()
Specified by:
rowsetInputSize in interface StepInterface
Overrides:
rowsetInputSize in class BaseStep
Returns:
The total amount of rows in the input buffers

rowsetInputSizeImpl

public int rowsetInputSizeImpl()

rowsetOutputSize

public int rowsetOutputSize()
Specified by:
rowsetOutputSize in interface StepInterface
Overrides:
rowsetOutputSize in class BaseStep
Returns:
The total amount of rows in the output buffers

rowsetOutputSizeImpl

public int rowsetOutputSizeImpl()

safeModeChecking

public void safeModeChecking(RowMetaInterface row)
                      throws KettleRowException
Description copied from class: BaseStep
Safe mode checking.

Parameters:
row - the row
Throws:
KettleRowException - the kettle row exception

safeModeCheckingImpl

public void safeModeCheckingImpl(RowMetaInterface row)
                          throws KettleRowException
Throws:
KettleRowException

setErrors

public void setErrors(long errors)
Description copied from interface: StepInterface
Sets the number of errors

Specified by:
setErrors in interface StepInterface
Overrides:
setErrors in class BaseStep
Parameters:
errors - the number of errors to set

setErrorsImpl

public void setErrorsImpl(long errors)

setInputRowMeta

public void setInputRowMeta(RowMetaInterface rowMeta)
Overrides:
setInputRowMeta in class BaseStep
Parameters:
rowMeta - the rowMeta to set

setInputRowMetaImpl

public void setInputRowMetaImpl(RowMetaInterface rowMeta)

setInputRowSets

public void setInputRowSets(List<RowSet> inputRowSets)
Overrides:
setInputRowSets in class BaseStep
Parameters:
inputRowSets - The inputRowSets to set.

setInputRowSetsImpl

public void setInputRowSetsImpl(List<RowSet> inputRowSets)

setLinesInput

public void setLinesInput(long newLinesInputValue)
Overrides:
setLinesInput in class BaseStep
Parameters:
newLinesInputValue - the new number of lines read from an input source: database, file, socket, etc.

setLinesInputImpl

public void setLinesInputImpl(long newLinesInputValue)

setLinesOutput

public void setLinesOutput(long newLinesOutputValue)
Overrides:
setLinesOutput in class BaseStep
Parameters:
newLinesOutputValue - the new number of lines written to an output target: database, file, socket, etc.

setLinesOutputImpl

public void setLinesOutputImpl(long newLinesOutputValue)

setLinesRead

public void setLinesRead(long newLinesReadValue)
Overrides:
setLinesRead in class BaseStep
Parameters:
newLinesReadValue - the new number of lines read from previous steps

setLinesReadImpl

public void setLinesReadImpl(long newLinesReadValue)

setLinesRejected

public void setLinesRejected(long linesRejected)
Specified by:
setLinesRejected in interface StepInterface
Overrides:
setLinesRejected in class BaseStep
Parameters:
linesRejected - lines number of lines rejected to an error handling step

setLinesRejectedImpl

public void setLinesRejectedImpl(long linesRejected)

setLinesSkipped

public void setLinesSkipped(long newLinesSkippedValue)
Overrides:
setLinesSkipped in class BaseStep
Parameters:
newLinesSkippedValue - lines number of lines skipped

setLinesSkippedImpl

public void setLinesSkippedImpl(long newLinesSkippedValue)

setLinesUpdated

public void setLinesUpdated(long newLinesUpdatedValue)
Overrides:
setLinesUpdated in class BaseStep

setLinesUpdatedImpl

public void setLinesUpdatedImpl(long newLinesUpdatedValue)

setLinesWritten

public void setLinesWritten(long newLinesWrittenValue)
Overrides:
setLinesWritten in class BaseStep
Parameters:
newLinesWrittenValue - the new number of lines written to next steps

setLinesWrittenImpl

public void setLinesWrittenImpl(long newLinesWrittenValue)

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

setOutputDoneImpl

public void setOutputDoneImpl()

setOutputRowSets

public void setOutputRowSets(List<RowSet> outputRowSets)
Overrides:
setOutputRowSets in class BaseStep
Parameters:
outputRowSets - The outputRowSets to set.

setOutputRowSetsImpl

public void setOutputRowSetsImpl(List<RowSet> outputRowSets)

setStepListeners

public void setStepListeners(List<StepListener> stepListeners)
Description copied from class: BaseStep
Sets the step listeners.

Overrides:
setStepListeners in class BaseStep
Parameters:
stepListeners - the stepListeners to set

setStepListenersImpl

public void setStepListenersImpl(List<StepListener> stepListeners)

setVariable

public void setVariable(String variableName,
                        String variableValue)
Description copied from interface: VariableSpace
Sets a variable in the Kettle Variables list.

Specified by:
setVariable in interface VariableSpace
Overrides:
setVariable in class BaseStep
Parameters:
variableName - The name of the variable to set
variableValue - The value of the variable to set. If the variableValue is null, the variable is cleared from the list.

setVariableImpl

public void setVariableImpl(String variableName,
                            String variableValue)

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

stopAllImpl

public void stopAllImpl()

stopRunning

public void stopRunning(StepMetaInterface stepMetaInterface,
                        StepDataInterface stepDataInterface)
                 throws 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:
KettleException - in case something goes wrong

stopRunningImpl

public void stopRunningImpl(StepMetaInterface stepMetaInterface,
                            StepDataInterface stepDataInterface)
                     throws KettleException
Throws:
KettleException

toString

public String toString()
Overrides:
toString in class BaseStep

toStringImpl

public String toStringImpl()