|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StepInterface
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 |
addStepListener(StepListener stepListener)
Attach a step listener to be notified when a step arrives in a certain state. |
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. |
int |
getCopy()
|
long |
getErrors()
Get the number of errors |
List<org.pentaho.di.core.RowSet> |
getInputRowSets()
|
long |
getLinesInput()
|
long |
getLinesOutput()
|
long |
getLinesRead()
|
long |
getLinesRejected()
|
long |
getLinesUpdated()
|
long |
getLinesWritten()
|
List<org.pentaho.di.core.RowSet> |
getOutputRowSets()
|
String |
getPartitionID()
|
Object[] |
getRow()
|
List<RowListener> |
getRowListeners()
|
String |
getStepID()
|
StepMeta |
getStepMeta()
|
String |
getStepname()
Get the name of the step. |
boolean |
init(StepMetaInterface stepMetaInterface,
StepDataInterface stepDataInterface)
Initialise 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. !!! A plugin implementing this method should make sure to also call super.initBeforeStart(); !!! |
boolean |
isAlive()
Is the thread still alive? |
boolean |
isMapping()
|
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)
Process one row. |
void |
putRow(org.pentaho.di.core.row.RowMetaInterface row,
Object[] data)
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()
Run is where the action happens in a step... |
void |
setErrors(long errors)
Sets the number of errors |
void |
setLinesRejected(long linesRejected)
|
void |
setOutputDone()
Signal output done to destination steps |
void |
setPartitionID(String partitionID)
|
void |
start()
Starts the thread... |
void |
stopAll()
Flags all rowsets as stopped/completed/finished. |
void |
stopRunning(StepMetaInterface stepMetaInterface,
StepDataInterface stepDataInterface)
Stop running operations... |
Method Detail |
---|
boolean init(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface)
stepMetaInterface
- The metadata to work withstepDataInterface
- The data to initializevoid dispose(StepMetaInterface sii, StepDataInterface sdi)
sii
- The metadata to work withsdi
- The data to dispose ofvoid markStart()
void markStop()
void start()
void stopRunning(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface) throws org.pentaho.di.core.exception.KettleException
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.
org.pentaho.di.core.exception.KettleException
boolean isAlive()
boolean isStopped()
void stopAll()
void pauseRunning()
void resumeRunning()
void run()
String getStepname()
int getCopy()
String getStepID()
long getErrors()
void setErrors(long errors)
errors
- the number of errors to setlong getLinesInput()
long getLinesOutput()
long getLinesRead()
long getLinesWritten()
long getLinesUpdated()
void setLinesRejected(long linesRejected)
linesRejected
- steps the lines rejected by error handling.long getLinesRejected()
boolean processRow(StepMetaInterface smi, StepDataInterface sdi) throws org.pentaho.di.core.exception.KettleException
smi
- The metadata to work withsdi
- The temporary working data to work with (database connections, resultsets, caches, temporary variables, etc.)
org.pentaho.di.core.exception.KettleException
void putRow(org.pentaho.di.core.row.RowMetaInterface row, Object[] data) throws org.pentaho.di.core.exception.KettleException
row
- The row to send to the destinations steps
org.pentaho.di.core.exception.KettleException
Object[] getRow() throws org.pentaho.di.core.exception.KettleException
org.pentaho.di.core.exception.KettleException
void setOutputDone()
void addRowListener(RowListener rowListener)
rowListener
- the rowlistener to addvoid removeRowListener(RowListener rowListener)
rowListener
- the rowlistener to removeList<RowListener> getRowListeners()
List<org.pentaho.di.core.RowSet> getInputRowSets()
List<org.pentaho.di.core.RowSet> getOutputRowSets()
boolean isPartitioned()
void setPartitionID(String partitionID)
partitionID
- the partitionID to setString getPartitionID()
void cleanup()
void initBeforeStart() throws org.pentaho.di.core.exception.KettleStepException
org.pentaho.di.core.exception.KettleStepException
- In case there is an errorvoid addStepListener(StepListener stepListener)
stepListener
- The listener to add to the stepboolean isMapping()
StepMeta getStepMeta()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |