org.pentaho.di.trans.steps.script

接口 ScriptInterface

所有超级接口:

HasLogChannelInterface, StepInterface, org.pentaho.di.core.variables.VariableSpace

public interface ScriptInterface
extends StepInterface

Interface to make the real ScriptValueMod and ScriptValueModDummy similar.

作者:

Sven Boden

方法概要

限定符和类型	方法和说明
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<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()
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(org.pentaho.di.core.row.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...

从接口继承的方法 org.pentaho.di.trans.step.StepInterface

addRowSetToInputRowSets, addRowSetToOutputRowSets, addStepListener, batchComplete, canProcessOneRow, getCopy, getCurrentInputRowSetNr, getCurrentOutputRowSetNr, getLogChannel, getMetaStore, getProcessed, getRepository, getResultFiles, getRuntime, getStatus, getStepMeta, getTrans, identifyErrorOutput, initBeforeStart, isMapping, isPaused, isRunning, isSafeStopped, isUsingThreadPriorityManagment, rowsetInputSize, rowsetOutputSize, setCurrentInputRowSetNr, setCurrentOutputRowSetNr, setLinesRejected, setMetaStore, setPartitioned, setRepartitioning, setRepository, setRunning, setSafeStopped, setStopped, setUsingThreadPriorityManagment, subStatuses

从接口继承的方法 org.pentaho.di.core.variables.VariableSpace

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

方法详细资料

processRow

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

从接口复制的说明: StepInterface

Perform the equivalent of processing one row. Typically this means reading a row from input (getRow()) and passing a row to output (putRow)).

指定者:

processRow 在接口中 StepInterface

参数:

smi - The steps metadata to work with

sdi - The steps temporary working data to work with (database connections, result sets, caches, temporary variables, etc.)

返回:

false if no more rows can be processed or an error occurred.

抛出:

org.pentaho.di.core.exception.KettleException

addRowListener

void addRowListener(RowListener rowListener)

从接口复制的说明: StepInterface

Add a rowlistener to the step allowing you to inspect (or manipulate, be careful) the rows coming in or exiting the step.

指定者:

addRowListener 在接口中 StepInterface

参数:

rowListener - the rowlistener to add

dispose

void dispose(StepMetaInterface sii,
             StepDataInterface sdi)

从接口复制的说明: StepInterface

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

指定者:

dispose 在接口中 StepInterface

参数:

sii - The metadata to work with

sdi - The data to dispose of

getErrors

long getErrors()

从接口复制的说明: StepInterface

Get the number of errors

指定者:

getErrors 在接口中 StepInterface

返回:

the number of errors

getInputRowSets

List<org.pentaho.di.core.RowSet> getInputRowSets()

指定者:

getInputRowSets 在接口中 StepInterface

返回:

The list of active input rowsets for the step

getLinesInput

long getLinesInput()

指定者:

getLinesInput 在接口中 StepInterface

返回:

Returns the linesInput.

getLinesOutput

long getLinesOutput()

指定者:

getLinesOutput 在接口中 StepInterface

返回:

Returns the linesOutput.

getLinesRead

long getLinesRead()

指定者:

getLinesRead 在接口中 StepInterface

返回:

Returns the linesRead.

getLinesUpdated

long getLinesUpdated()

指定者:

getLinesUpdated 在接口中 StepInterface

返回:

Returns the linesUpdated.

getLinesWritten

long getLinesWritten()

指定者:

getLinesWritten 在接口中 StepInterface

返回:

Returns the linesWritten.

getLinesRejected

long getLinesRejected()

指定者:

getLinesRejected 在接口中 StepInterface

返回:

Returns the lines rejected by error handling.

getOutputRowSets

List<org.pentaho.di.core.RowSet> getOutputRowSets()

指定者:

getOutputRowSets 在接口中 StepInterface

返回:

The list of active output rowsets for the step

getPartitionID

String getPartitionID()

指定者:

getPartitionID 在接口中 StepInterface

返回:

the steps partition ID

getRow

Object[] getRow()
         throws org.pentaho.di.core.exception.KettleException

指定者:

getRow 在接口中 StepInterface

返回:

a row from the source step(s).

抛出:

org.pentaho.di.core.exception.KettleException

getRowListeners

List<RowListener> getRowListeners()

指定者:

getRowListeners 在接口中 StepInterface

返回:

a list of the installed RowListeners

getStepID

String getStepID()

指定者:

getStepID 在接口中 StepInterface

返回:

the type ID of the step...

getStepname

String getStepname()

从接口复制的说明: StepInterface

Get the name of the step.

指定者:

getStepname 在接口中 StepInterface

返回:

the name of the step

init

boolean init(StepMetaInterface stepMetaInterface,
             StepDataInterface stepDataInterface)

从接口复制的说明: StepInterface

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

指定者:

init 在接口中 StepInterface

参数:

stepMetaInterface - The metadata to work with

stepDataInterface - The data to initialize

isAlive

boolean isAlive()

isPartitioned

boolean isPartitioned()

指定者:

isPartitioned 在接口中 StepInterface

返回:

true if the step is running partitioned

isStopped

boolean isStopped()

指定者:

isStopped 在接口中 StepInterface

返回:

True if the step is marked as stopped. Execution should stop immediate.

markStart

void markStart()

从接口复制的说明: StepInterface

Mark the start time of the step.

指定者:

markStart 在接口中 StepInterface

markStop

void markStop()

从接口复制的说明: StepInterface

Mark the end time of the step.

指定者:

markStop 在接口中 StepInterface

putRow

void putRow(org.pentaho.di.core.row.RowMetaInterface rowMeta,
            Object[] row)
     throws org.pentaho.di.core.exception.KettleException

从接口复制的说明: StepInterface

Put a row on the destination rowsets.

指定者:

putRow 在接口中 StepInterface

参数:

rowMeta - The row to send to the destinations steps

抛出:

org.pentaho.di.core.exception.KettleException

removeRowListener

void removeRowListener(RowListener rowListener)

从接口复制的说明: StepInterface

Remove a rowlistener from this step.

指定者:

removeRowListener 在接口中 StepInterface

参数:

rowListener - the rowlistener to remove

run

void run()

setErrors

void setErrors(long errors)

从接口复制的说明: StepInterface

Sets the number of errors

指定者:

setErrors 在接口中 StepInterface

参数:

errors - the number of errors to set

setOutputDone

void setOutputDone()

从接口复制的说明: StepInterface

Signal output done to destination steps

指定者:

setOutputDone 在接口中 StepInterface

setPartitionID

void setPartitionID(String partitionID)

指定者:

setPartitionID 在接口中 StepInterface

参数:

partitionID - the partitionID to set

start

void start()

stopAll

void stopAll()

从接口复制的说明: StepInterface

Flags all rowsets as stopped/completed/finished.

指定者:

stopAll 在接口中 StepInterface

stopRunning

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

从接口复制的说明: StepInterface

Stop running operations...

指定者:

stopRunning 在接口中 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.

抛出:

org.pentaho.di.core.exception.KettleException

cleanup

void cleanup()

从接口复制的说明: StepInterface

Call this method typically, after ALL the slave transformations in a clustered run have finished.

指定者:

cleanup 在接口中 StepInterface

pauseRunning

void pauseRunning()

从接口复制的说明: StepInterface

Pause a running step

指定者:

pauseRunning 在接口中 StepInterface

resumeRunning

void resumeRunning()

从接口复制的说明: StepInterface

Resume a running step

指定者:

resumeRunning 在接口中 StepInterface