org.pentaho.di.trans.steps.scriptvalues_mod
Class ScriptValuesMod

java.lang.Object
  extended by java.lang.Thread
      extended by org.pentaho.di.trans.step.BaseStep
          extended by org.pentaho.di.trans.steps.scriptvalues_mod.ScriptValuesMod
All Implemented Interfaces:
Runnable, org.pentaho.di.core.variables.VariableSpace, StepInterface, ScriptValuesModInterface

public class ScriptValuesMod
extends BaseStep
implements StepInterface, ScriptValuesModInterface

Executes a JavaScript on the values in the input stream. Selected calculated values can then be put on the output stream.

Since:
5-April-2003
Author:
Matt

Nested Class Summary
 
Nested classes/interfaces inherited from class java.lang.Thread
Thread.State, Thread.UncaughtExceptionHandler
 
Field Summary
static int ABORT_TRANSFORMATION
           
static int CONTINUE_TRANSFORMATION
           
static int ERROR_TRANSFORMATION
           
 org.mozilla.javascript.Script script
           
static int SKIP_TRANSFORMATION
           
 
Fields inherited from class org.pentaho.di.trans.step.BaseStep
category_order, errorRowSet, first, init, inputRowSets, linesInput, linesOutput, linesRead, linesRejected, linesSkipped, linesUpdated, linesWritten, outputRowSets, paused, remoteInputSteps, remoteOutputSteps, statusDesc, steps, stopped, terminator, terminator_rows, thr, waiting
 
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
 
Constructor Summary
ScriptValuesMod(StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr, TransMeta transMeta, Trans trans)
           
 
Method Summary
 void dispose(StepMetaInterface smi, StepDataInterface sdi)
          Dispose of this step: close files, empty logs, etc.
 org.pentaho.di.core.row.RowMetaInterface getOutputRowMeta()
           
 Object getValueFromJScript(Object result, int i)
           
 boolean init(StepMetaInterface smi, StepDataInterface sdi)
          Initialise and do work where other steps need to wait for...
 boolean processRow(StepMetaInterface smi, StepDataInterface sdi)
          Process one row.
 void run()
          Run is where the action happens in a step...
 
Methods inherited from class org.pentaho.di.trans.step.BaseStep
addResultFile, addRowListener, addStepListener, buildLog, cleanup, copyVariablesFrom, decrementLinesRead, decrementLinesWritten, dispatch, environmentSubstitute, environmentSubstitute, findInputRowSet, findInputRowSet, findOutputRowSet, findOutputRowSet, getBooleanValueOfVariable, getClusterSize, getCopy, getDispatcher, getErrorRowMeta, getErrors, getIconFilename, getInputRowMeta, getInputRowSets, getLinesInput, getLinesOutput, getLinesRead, getLinesRejected, getLinesSkipped, getLinesUpdated, getLinesWritten, getLogFields, getNextClassNr, getOutputRowSets, getParentVariableSpace, getPartitionID, getPartitionTargets, getPreviewRowMeta, getProcessed, getRepartitioning, getResultFiles, getRow, getRowFrom, getRowListeners, getRuntime, getServerSockets, getSlaveNr, getSocketRepository, getStatus, getStatusDescription, getStepDataInterface, getStepID, getStepInfo, getStepListeners, getStepMeta, getStepMetaInterface, getStepname, getThread, getTrans, getTransMeta, getTypeId, getUniqueStepCountAcrossSlaves, getUniqueStepNrAcrossSlaves, getVariable, getVariable, incrementLinesInput, incrementLinesOutput, incrementLinesRead, incrementLinesRejected, incrementLinesSkipped, incrementLinesUpdated, incrementLinesWritten, initBeforeStart, initializeVariablesFrom, injectVariables, isDistributed, isInitialising, isMapping, isPartitioned, isPaused, isSafeModeEnabled, isStopped, isUsingThreadPriorityManagment, listVariables, logBasic, logDebug, logDetailed, logError, logError, logMinimal, logRowlevel, logSummary, markStart, markStop, outputIsDone, pauseRunning, putError, putRow, putRowTo, removeRowListener, resumeRunning, rowsetInputSize, rowsetOutputSize, runStepThread, safeModeChecking, setCopy, setDistributed, setErrorRowMeta, setErrors, setInputRowMeta, setInputRowSets, setInternalVariables, setLinesInput, setLinesOutput, setLinesRead, setLinesRejected, setLinesSkipped, setLinesUpdated, setLinesWritten, setOutputDone, setOutputRowSets, setParentVariableSpace, setPartitioned, setPartitionID, setPartitionTargets, setPaused, setPaused, setPreviewRowMeta, setRepartitioning, setSafeModeEnabled, setServerSockets, setSocketRepository, setStepDataInterface, setStepListeners, setStepMeta, setStepMetaInterface, setStepname, setStopped, setStopped, setTransMeta, setUsingThreadPriorityManagment, setVariable, shareVariablesWith, stopAll, stopRunning, stopRunning, toString
 
Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield
 
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
addRowListener, addStepListener, cleanup, getCopy, getErrors, getInputRowSets, getLinesInput, getLinesOutput, getLinesRead, getLinesRejected, getLinesUpdated, getLinesWritten, getOutputRowSets, getPartitionID, getRow, getRowListeners, getStepID, getStepMeta, getStepname, initBeforeStart, isAlive, isMapping, isPartitioned, isStopped, markStart, markStop, pauseRunning, putRow, removeRowListener, resumeRunning, setErrors, setLinesRejected, setOutputDone, setPartitionID, start, stopAll, stopRunning
 
Methods inherited from interface org.pentaho.di.trans.steps.scriptvalues_mod.ScriptValuesModInterface
addRowListener, cleanup, getErrors, getInputRowSets, getLinesInput, getLinesOutput, getLinesRead, getLinesRejected, getLinesUpdated, getLinesWritten, getOutputRowSets, getPartitionID, getRow, getRowListeners, getStepID, getStepname, isAlive, isPartitioned, isStopped, markStart, markStop, pauseRunning, putRow, removeRowListener, resumeRunning, setErrors, setOutputDone, setPartitionID, start, stopAll, stopRunning
 
Methods inherited from interface org.pentaho.di.core.variables.VariableSpace
copyVariablesFrom, environmentSubstitute, environmentSubstitute, getBooleanValueOfVariable, getParentVariableSpace, getVariable, getVariable, initializeVariablesFrom, injectVariables, listVariables, setParentVariableSpace, setVariable, shareVariablesWith
 

Field Detail

SKIP_TRANSFORMATION

public static final int SKIP_TRANSFORMATION
See Also:
Constant Field Values

ABORT_TRANSFORMATION

public static final int ABORT_TRANSFORMATION
See Also:
Constant Field Values

ERROR_TRANSFORMATION

public static final int ERROR_TRANSFORMATION
See Also:
Constant Field Values

CONTINUE_TRANSFORMATION

public static final int CONTINUE_TRANSFORMATION
See Also:
Constant Field Values

script

public org.mozilla.javascript.Script script
Constructor Detail

ScriptValuesMod

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

getValueFromJScript

public Object getValueFromJScript(Object result,
                                  int i)
                           throws org.pentaho.di.core.exception.KettleValueException
Throws:
org.pentaho.di.core.exception.KettleValueException

getOutputRowMeta

public org.pentaho.di.core.row.RowMetaInterface getOutputRowMeta()

processRow

public boolean processRow(StepMetaInterface smi,
                          StepDataInterface sdi)
                   throws org.pentaho.di.core.exception.KettleException
Description copied from interface: StepInterface
Process one row.

Specified by:
processRow in interface StepInterface
Specified by:
processRow in interface ScriptValuesModInterface
Overrides:
processRow in class BaseStep
Parameters:
smi - The metadata to work with
sdi - The temporary working data to work with (database connections, resultsets, caches, temporary variables, etc.)
Returns:
false if no more rows can be processed or an error occurred.
Throws:
org.pentaho.di.core.exception.KettleException

init

public boolean init(StepMetaInterface smi,
                    StepDataInterface sdi)
Description copied from interface: StepInterface
Initialise and do work where other steps need to wait for...

Specified by:
init in interface StepInterface
Specified by:
init in interface ScriptValuesModInterface
Overrides:
init in class BaseStep
Parameters:
smi - The metadata to work with
sdi - The data to initialize

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
Specified by:
dispose in interface ScriptValuesModInterface
Overrides:
dispose in class BaseStep
Parameters:
smi - The metadata to work with
sdi - The data to dispose of

run

public void run()
Description copied from interface: StepInterface
Run is where the action happens in a step...

Specified by:
run in interface Runnable
Specified by:
run in interface StepInterface
Specified by:
run in interface ScriptValuesModInterface
Overrides:
run in class Thread