org.pentaho.di.trans.steps.mapping
Class Mapping

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

public class Mapping
extends BaseStep
implements StepInterface

Execute a mapping: a re-usuable transformation

Since:
22-nov-2005
Author:
Matt

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
Mapping(StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr, TransMeta transMeta, Trans trans)
           
 
Method Summary
static void addInputRenames(List<MappingValueRename> renameList, List<MappingValueRename> addRenameList)
           
 void addRowListener(RowListener rowListener)
          For preview of the main data path, make sure we pass the row listener down to the Mapping Output step...
 void dispose(StepMetaInterface smi, StepDataInterface sdi)
          Dispose of this step: close files, empty logs, etc.
 long getLinesInput()
           
 long getLinesOutput()
           
 long getLinesRead()
           
 long getLinesRejected()
           
 long getLinesUpdated()
           
 long getLinesWritten()
           
 Trans getMappingTrans()
           
 boolean init(StepMetaInterface smi, StepDataInterface sdi)
          Initialize and do work where other steps need to wait for...
 void prepareMappingExecution()
           
 boolean processRow(StepMetaInterface smi, StepDataInterface sdi)
          Process a single row.
 int rowsetInputSize()
           
 int rowsetOutputSize()
           
 void stopAll()
          Flags all rowsets as stopped/completed/finished.
 void stopRunning(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface)
          Perform actions to stop a running step.
 
Methods inherited from class org.pentaho.di.trans.step.BaseStep
addResultFile, addStepListener, batchComplete, buildLog, canProcessOneRow, cleanup, closeQuietly, copyVariablesFrom, decrementLinesRead, decrementLinesWritten, dispatch, environmentSubstitute, environmentSubstitute, findInputRowSet, findInputRowSet, findOutputRowSet, findOutputRowSet, getBooleanValueOfVariable, getClusterSize, getContainerObjectId, getCopy, getDispatcher, getErrorRowMeta, getErrors, getFilename, getInputRowMeta, getInputRowSets, getLinesSkipped, getLogChannel, getLogChannelId, getLogFields, getLogLevel, getNextClassNr, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getOutputRowSets, getParent, getParentVariableSpace, getPartitionID, getPartitionTargets, getPreviewRowMeta, getProcessed, getRegistrationDate, getRemoteInputSteps, getRemoteOutputSteps, getRepartitioning, getRepositoryDirectory, getResultFiles, getRow, getRowFrom, getRowListeners, getRuntime, getServerSockets, getSlaveNr, getSocketRepository, getStatus, getStatusDescription, getStepDataInterface, getStepID, getStepListeners, getStepMeta, getStepMetaInterface, getStepname, getTrans, getTransMeta, getTypeId, getUniqueStepCountAcrossSlaves, getUniqueStepNrAcrossSlaves, getVariable, getVariable, identifyErrorOutput, incrementLinesInput, incrementLinesOutput, incrementLinesRead, incrementLinesRejected, incrementLinesSkipped, incrementLinesUpdated, incrementLinesWritten, initBeforeStart, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDistributed, isInitialising, isMapping, isPartitioned, isPaused, isRowLevel, isRunning, isStopped, isUsingThreadPriorityManagment, listVariables, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, logSummary, markStart, markStop, outputIsDone, pauseRunning, putError, putRow, putRowTo, removeRowListener, resumeRunning, safeModeChecking, setCarteObjectId, setCopy, setDistributed, setErrorRowMeta, setErrors, setInputRowMeta, setInputRowSets, setInternalVariables, setLinesInput, setLinesOutput, setLinesRead, setLinesRejected, setLinesSkipped, setLinesUpdated, setLinesWritten, setLogLevel, setOutputDone, setOutputRowSets, setParentVariableSpace, setPartitioned, setPartitionID, setPartitionTargets, setPaused, setPaused, setPreviewRowMeta, setRepartitioning, setRunning, setServerSockets, setSocketRepository, setStepDataInterface, setStepListeners, setStepMeta, setStepMetaInterface, setStepname, setStopped, setTransMeta, setUsingThreadPriorityManagment, setVariable, shareVariablesWith, stopRunning, toString
 
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
addStepListener, batchComplete, canProcessOneRow, cleanup, getCopy, getErrors, getInputRowSets, getLogChannel, getOutputRowSets, getPartitionID, getProcessed, getResultFiles, getRow, getRowListeners, getRuntime, getStatus, getStepID, getStepMeta, getStepname, getTrans, identifyErrorOutput, initBeforeStart, isMapping, isPartitioned, isPaused, isRunning, isStopped, isUsingThreadPriorityManagment, markStart, markStop, pauseRunning, putRow, removeRowListener, resumeRunning, setErrors, setLinesRejected, setOutputDone, setPartitioned, setPartitionID, 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
 

Constructor Detail

Mapping

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

processRow

public boolean processRow(StepMetaInterface smi,
                          StepDataInterface sdi)
                   throws KettleException
Process a single row. In our case, we send one row of data to a piece of transformation. In the transformation, we look up the MappingInput step to send our rows to it. As a consequence, for the time being, there can only be one MappingInput and one MappingOutput step in the Mapping.

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

prepareMappingExecution

public void prepareMappingExecution()
                             throws KettleException
Throws:
KettleException

addInputRenames

public static void addInputRenames(List<MappingValueRename> renameList,
                                   List<MappingValueRename> addRenameList)

init

public boolean init(StepMetaInterface smi,
                    StepDataInterface sdi)
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:
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
Overrides:
dispose in class BaseStep
Parameters:
smi - The metadata to work with
sdi - The data to dispose of

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

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

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.

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.

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

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

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.

getLinesWritten

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

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

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

getMappingTrans

public Trans getMappingTrans()

addRowListener

public void addRowListener(RowListener rowListener)
For preview of the main data path, make sure we pass the row listener down to the Mapping Output step...

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