|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScriptInterface
Interface to make the real ScriptValueMod and ScriptValueModDummy similar.
Method Summary | |
---|---|
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 |
cleanup()
Call this method typically, after ALL the slave transformations in a clustered run have finished. |
void |
dispose(StepMetaInterface sii,
StepDataInterface sdi)
Dispose of this step: close files, empty logs, etc. |
long |
getErrors()
Get the number of errors |
List<RowSet> |
getInputRowSets()
|
long |
getLinesInput()
|
long |
getLinesOutput()
|
long |
getLinesRead()
|
long |
getLinesRejected()
|
long |
getLinesUpdated()
|
long |
getLinesWritten()
|
List<RowSet> |
getOutputRowSets()
|
String |
getPartitionID()
|
Object[] |
getRow()
|
List<RowListener> |
getRowListeners()
|
String |
getStepID()
|
String |
getStepname()
Get the name of the step. |
boolean |
init(StepMetaInterface stepMetaInterface,
StepDataInterface stepDataInterface)
Initialize and do work where other steps need to wait for... |
boolean |
isAlive()
|
boolean |
isPartitioned()
|
boolean |
isStopped()
|
void |
markStart()
Mark the start time of the step. |
void |
markStop()
Mark the end time of the step. |
void |
pauseRunning()
Pause a running step |
boolean |
processRow(StepMetaInterface smi,
StepDataInterface sdi)
Perform the equivalent of processing one row. |
void |
putRow(RowMetaInterface rowMeta,
Object[] row)
Put a row on the destination rowsets. |
void |
removeRowListener(RowListener rowListener)
Remove a rowlistener from this step. |
void |
resumeRunning()
Resume a running step |
void |
run()
|
void |
setErrors(long errors)
Sets the number of errors |
void |
setOutputDone()
Signal output done to destination steps |
void |
setPartitionID(String partitionID)
|
void |
start()
|
void |
stopAll()
Flags all rowsets as stopped/completed/finished. |
void |
stopRunning(StepMetaInterface stepMetaInterface,
StepDataInterface stepDataInterface)
Stop running operations... |
Methods inherited from interface org.pentaho.di.trans.step.StepInterface |
---|
addStepListener, batchComplete, canProcessOneRow, getCopy, getLogChannel, getProcessed, getResultFiles, getRuntime, getStatus, getStepMeta, getTrans, identifyErrorOutput, initBeforeStart, isMapping, isPaused, isRunning, isUsingThreadPriorityManagment, rowsetInputSize, rowsetOutputSize, setLinesRejected, setPartitioned, setRepartitioning, setRunning, setStopped, setUsingThreadPriorityManagment |
Methods inherited from interface org.pentaho.di.core.variables.VariableSpace |
---|
copyVariablesFrom, environmentSubstitute, environmentSubstitute, getBooleanValueOfVariable, getParentVariableSpace, getVariable, getVariable, initializeVariablesFrom, injectVariables, listVariables, setParentVariableSpace, setVariable, shareVariablesWith |
Method Detail |
---|
boolean processRow(StepMetaInterface smi, StepDataInterface sdi) throws KettleException
StepInterface
processRow
in interface StepInterface
smi
- The steps metadata to work withsdi
- The steps temporary working data to work with (database connections, result sets, caches, temporary variables, etc.)
KettleException
void addRowListener(RowListener rowListener)
StepInterface
addRowListener
in interface StepInterface
rowListener
- the rowlistener to addvoid dispose(StepMetaInterface sii, StepDataInterface sdi)
StepInterface
dispose
in interface StepInterface
sii
- The metadata to work withsdi
- The data to dispose oflong getErrors()
StepInterface
getErrors
in interface StepInterface
List<RowSet> getInputRowSets()
getInputRowSets
in interface StepInterface
long getLinesInput()
getLinesInput
in interface StepInterface
long getLinesOutput()
getLinesOutput
in interface StepInterface
long getLinesRead()
getLinesRead
in interface StepInterface
long getLinesUpdated()
getLinesUpdated
in interface StepInterface
long getLinesWritten()
getLinesWritten
in interface StepInterface
long getLinesRejected()
getLinesRejected
in interface StepInterface
List<RowSet> getOutputRowSets()
getOutputRowSets
in interface StepInterface
String getPartitionID()
getPartitionID
in interface StepInterface
Object[] getRow() throws KettleException
getRow
in interface StepInterface
KettleException
List<RowListener> getRowListeners()
getRowListeners
in interface StepInterface
String getStepID()
getStepID
in interface StepInterface
String getStepname()
StepInterface
getStepname
in interface StepInterface
boolean init(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface)
StepInterface
init
in interface StepInterface
stepMetaInterface
- The metadata to work withstepDataInterface
- The data to initializeboolean isAlive()
boolean isPartitioned()
isPartitioned
in interface StepInterface
boolean isStopped()
isStopped
in interface StepInterface
void markStart()
StepInterface
markStart
in interface StepInterface
void markStop()
StepInterface
markStop
in interface StepInterface
void putRow(RowMetaInterface rowMeta, Object[] row) throws KettleException
StepInterface
putRow
in interface StepInterface
rowMeta
- The row to send to the destinations steps
KettleException
void removeRowListener(RowListener rowListener)
StepInterface
removeRowListener
in interface StepInterface
rowListener
- the rowlistener to removevoid run()
void setErrors(long errors)
StepInterface
setErrors
in interface StepInterface
errors
- the number of errors to setvoid setOutputDone()
StepInterface
setOutputDone
in interface StepInterface
void setPartitionID(String partitionID)
setPartitionID
in interface StepInterface
partitionID
- the partitionID to setvoid start()
void stopAll()
StepInterface
stopAll
in interface StepInterface
void stopRunning(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface) throws KettleException
StepInterface
stopRunning
in interface StepInterface
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.
KettleException
void cleanup()
StepInterface
cleanup
in interface StepInterface
void pauseRunning()
StepInterface
pauseRunning
in interface StepInterface
void resumeRunning()
StepInterface
resumeRunning
in interface StepInterface
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |