Package org.pentaho.di.trans.steps.mapping

Class Mapping

java.lang.Object

org.pentaho.di.trans.step.BaseStep

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

All Implemented Interfaces:

org.pentaho.di.core.ExtensionDataInterface, HasLogChannelInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.logging.LoggingObjectLifecycleInterface, org.pentaho.di.core.variables.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

deadLockCounter, extensionDataMap, first, linesInput, linesOutput, linesRead, linesRejected, linesSkipped, linesUpdated, linesWritten, log, metaStore, repository, rowListeners, safeStopped, terminator, terminator_rows, variables

Constructor Summary

Constructors

Constructor	Description
Mapping(StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr, TransMeta transMeta, Trans trans)

Method Summary

Modifier and Type	Method	Description
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, addRowSetToInputRowSets, addRowSetToOutputRowSets, addStepListener, batchComplete, buildLog, canProcessOneRow, checkFeedback, cleanup, clearInputRowSets, clearOutputRowSets, closeQuietly, copyVariablesFrom, decrementLinesRead, decrementLinesWritten, dispatch, environmentSubstitute, environmentSubstitute, environmentSubstitute, fieldSubstitute, findInputRowSet, findInputRowSet, findOutputRowSet, findOutputRowSet, getBooleanValueOfVariable, getClusterSize, getContainerObjectId, getCopy, getCurrentInputRowSetNr, getCurrentOutputRowSetNr, getDispatcher, getErrorRowMeta, getErrors, getExtensionDataMap, getFilename, getFirstInputRowSet, getInputRowMeta, getInputRowSets, getLinesSkipped, getLogChannel, getLogChannelId, getLogFields, getLogLevel, getMetaStore, getNextClassNr, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getOutputRowSets, getParent, getParentVariableSpace, getPartitionID, getPartitionTargets, getPreviewRowMeta, getProcessed, getRegistrationDate, getRemoteInputSteps, getRemoteOutputSteps, getRepartitioning, getRepository, getRepositoryDirectory, getResultFiles, getRow, getRowFrom, getRowHandler, getRowListeners, getRuntime, getServerSockets, getSlaveNr, getSocketRepository, getStatus, getStatusDescription, getStepDataInterface, getStepID, getStepListeners, getStepMeta, getStepMetaInterface, getStepname, getTrans, getTransMeta, getTypeId, getUniqueStepCountAcrossSlaves, getUniqueStepNrAcrossSlaves, getVariable, getVariable, handleGetRowFrom, handlePutRowTo, identifyErrorOutput, incrementLinesInput, incrementLinesOutput, incrementLinesRead, incrementLinesRejected, incrementLinesSkipped, incrementLinesUpdated, incrementLinesWritten, initBeforeStart, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDistributed, isForcingSeparateLogging, isGatheringMetrics, isInitialising, isMapping, isPartitioned, isPaused, isRowLevel, isRunning, isSafeStopped, isStopped, isUsingThreadPriorityManagment, listVariables, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, logSummary, markStart, markStop, openRemoteInputStepSocketsOnce, openRemoteOutputStepSocketsOnce, outputIsDone, pauseRunning, putError, putRow, putRowTo, removeRowListener, resumeRunning, safeModeChecking, safeModeChecking, setCarteObjectId, setCopy, setCurrentInputRowSetNr, setCurrentOutputRowSetNr, setDistributed, setErrorRowMeta, setErrors, setForcingSeparateLogging, setGatheringMetrics, setInputRowMeta, setInputRowSets, setInternalVariables, setLinesInput, setLinesOutput, setLinesRead, setLinesRejected, setLinesSkipped, setLinesUpdated, setLinesWritten, setLogLevel, setMetaStore, setOutputDone, setOutputRowSets, setParentVariableSpace, setPartitioned, setPartitionID, setPartitionTargets, setPaused, setPaused, setPreviewRowMeta, setRepartitioning, setRepository, setRowHandler, setRunning, setSafeStopped, setServerSockets, setSocketRepository, setStepDataInterface, setStepListeners, setStepMeta, setStepMetaInterface, setStepname, setStopped, setTransMeta, setUsingThreadPriorityManagment, setVariable, shareVariablesWith, stopRunning, swapFirstInputRowSetIfExists, toString, verifyInputDeadLock, waitUntilTransformationIsStarted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.di.core.logging.LoggingObjectLifecycleInterface

callAfterLog, callBeforeLog

Methods inherited from interface org.pentaho.di.trans.step.StepInterface

addRowSetToInputRowSets, addRowSetToOutputRowSets, addStepListener, batchComplete, canProcessOneRow, cleanup, getCopy, getCurrentInputRowSetNr, getCurrentOutputRowSetNr, getErrors, getInputRowSets, getLogChannel, getMetaStore, getOutputRowSets, getPartitionID, getProcessed, getRepository, getResultFiles, getRow, getRowListeners, getRuntime, getStatus, getStepID, getStepMeta, getStepname, getTrans, identifyErrorOutput, initBeforeStart, isMapping, isPartitioned, isPaused, isRunning, isSafeStopped, isStopped, isUsingThreadPriorityManagment, markStart, markStop, pauseRunning, putRow, removeRowListener, resumeRunning, setCurrentInputRowSetNr, setCurrentOutputRowSetNr, setErrors, setLinesRejected, setMetaStore, setOutputDone, setPartitioned, setPartitionID, setRepartitioning, setRepository, setRunning, setSafeStopped, setStopped, setUsingThreadPriorityManagment, subStatuses

Methods inherited from interface org.pentaho.di.core.variables.VariableSpace

copyVariablesFrom, environmentSubstitute, environmentSubstitute, environmentSubstitute, fieldSubstitute, 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 org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleException

prepareMappingExecution

public void prepareMappingExecution()
                             throws org.pentaho.di.core.exception.KettleException

Throws:

org.pentaho.di.core.exception.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 org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.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