java.lang.Object
- org.apache.hop.pipeline.transform.BaseTransform<Meta,Data>

All Implemented Interfaces:

IExtensionData, IHasLogChannel, ILoggingObject, IVariables, IEngineComponent, ITransform

Direct Known Subclasses:

AbstractTransform, BaseFileInputTransform, Dummy, Injector
```
public class BaseTransform<Meta extends ITransformMeta,Data extends ITransformData>
extends Object
implements ITransform, IVariables, ILoggingObject, IExtensionData, IEngineComponent
```
This class can be extended for the actual row processing of the implemented transform.
The implementing class can rely mostly on the base class, and has only three important methods it implements itself. The three methods implement the transform lifecycle during pipeline execution: initialization, row processing, and clean-up.
- Transform Initialization
  The init() method is called when a pipeline is preparing to start execution.
```
 public boolean init(...)
 
```
  Every transform is given the opportunity to do one-time initialization tasks like opening files or establishing database connections. For any transforms derived from BaseTransform it is mandatory that super.init() is called to ensure correct behavior. The method must return true in case the transform initialized correctly, it must returned false if there was an initialization error. Apache Hop will abort the execution of a pipeline in case any transform returns false upon initialization.
- Row Processing
  Once the pipeline starts execution it enters a tight loop calling processRow() on each transform until the method returns false. Each transform typically reads a single row from the input stream, alters the row structure and fields and passes the row on to next transforms.
```
 public boolean processRow(...)
 
```
  A typical implementation queries for incoming input rows by calling getRow(), which blocks and returns a row object or null in case there is no more input. If there was an input row, the transform does the necessary row processing and calls putRow() to pass the row on to the next transform. If there are no more rows, the transform must call setOutputDone() and return false.
  Formally the method must conform to the following rules:
  - If the transform is done processing all rows, the method must call setOutputDone() and return false
  - If the transform is not done processing all rows, the method must return true. Hop will call processRow() again in this case.
- Transform Clean-Up
  Once the pipeline is complete, Hop calls dispose() on all transforms.
```
 public void dispose(...)
 
```
  Transforms are required to deallocate resources allocated during init() or subsequent row processing. This typically means to clear all fields of the ITransformData object, and to ensure that all open files or connections are properly closed. For any transforms derived from BaseTransform it is mandatory that super.dispose() is called to ensure correct deallocation.

Field Summary

Fields
Modifier and Type	Field	Description
`protected Data`	`data`
`protected long`	`deadLockCounter`	Keeps track of the number of rows read for input deadlock verification.
`protected Date`	`executionEndDate`
`protected Date`	`executionStartDate`
`protected Map<String,Object>`	`extensionDataMap`
`boolean`	`first`	if true then the row being processed is the first row
`protected Date`	`firstRowReadDate`
`protected Date`	`initStartDate`
`protected Date`	`lastRowWrittenDate`
`protected ILogChannel`	`log`
`protected Meta`	`meta`
`protected IHopMetadataProvider`	`metadataProvider`	The metadata that the transform uses to load external elements from
`protected List<IRowListener>`	`rowListeners`	The list of IRowListener interfaces
`protected AtomicBoolean`	`safeStopped`
`boolean`	`terminator`
`List<Object[]>`	`terminatorRows`
`protected IVariables`	`variables`

Constructor Summary

Constructors
Constructor	Description
`BaseTransform(TransformMeta transformMeta, Meta meta, Data data, int copyNr, PipelineMeta pipelineMeta, Pipeline pipeline)`	This is the base transform that forms that basis for all transforms.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addResultFile(ResultFile resultFile)`	Adds the result file.
`void`	`addRowListener(IRowListener rowListener)`	Add a rowlistener to the transform allowing you to inspect (or manipulate, be careful) the rows coming in or exiting the transform.
`void`	`addRowSetToInputRowSets(IRowSet rowSet)`
`void`	`addRowSetToOutputRowSets(IRowSet rowSet)`
`void`	`addTransformFinishedListener(ITransformFinishedListener transformFinishedListener)`	Attach a transform listener to be notified when a transform finishes
`void`	`addTransformStartedListener(ITransformStartedListener transformStartedListener)`	Attach a transform listener to be notified when a transform starts
`void`	`batchComplete()`	When using the Single threaded engine this signals to the transform that a batch of records has been processed and that no more are expected in this batch.
`boolean`	`canProcessOneRow()`	This method checks if the transform is capable of processing at least one row.
`protected boolean`	`checkFeedback(long lines)`	Check feedback.
`void`	`cleanup()`	Cleanup any left-over resources for this transform.
`protected void`	`clearInputRowSets()`
`protected void`	`clearOutputRowSets()`
`static void`	`closeQuietly(Closeable cl)`	Close quietly.
`void`	`copyFrom(IVariables variables)`
`long`	`decrementLinesRead()`	Decrements the number of lines read from previous transforms by one
`long`	`decrementLinesWritten()`	Decrements the number of lines written to next transforms by one
`void`	`dispatch()`	This method finds the surrounding transforms and rowsets for this base transform.
`void`	`dispose()`	Dispose of this transform: close files, empty logs, etc.
`IRowSet`	`findInputRowSet(String sourceTransformName)`	Find input row set.
`IRowSet`	`findInputRowSet(String from, int fromCopy, String to, int toCopy)`	Find input row set.
`IRowSet`	`findOutputRowSet(String targetTransform)`	Find output row set.
`IRowSet`	`findOutputRowSet(String from, int fromcopy, String to, int tocopy)`	Find an output rowset in a running pipeline.
`void`	`finishBundle()`	When running in a Beam context this signals the transform that a bundle was finished.
`String`	`getContainerId()`	Returns the container object ID.
`int`	`getCopy()`
`int`	`getCopyNr()`	Gets copyNr
`int`	`getCurrentInputRowSetNr()`
`int`	`getCurrentOutputRowSetNr()`
`Data`	`getData()`	Gets data
`IPipelineEngine<PipelineMeta>`	`getDispatcher()`	Gets the dispatcher.
`IRowMeta`	`getErrorRowMeta()`
`long`	`getErrors()`	Get the number of errors
`long`	`getExecutionDuration()`
`Date`	`getExecutionEndDate()`	Gets executionEndDate
`Date`	`getExecutionStartDate()`	Gets executionStartDate
`Map<String,Object>`	`getExtensionDataMap()`
`String`	`getFilename()`
`protected IRowSet`	`getFirstInputRowSet()`
`Date`	`getFirstRowReadDate()`	Gets firstRowReadDate
`Date`	`getInitStartDate()`	Gets initStartDate
`long`	`getInputBufferSize()`
`IRowMeta`	`getInputRowMeta()`
`List<IRowSet>`	`getInputRowSets()`
`Date`	`getLastRowWrittenDate()`	Gets lastRowWrittenDate
`long`	`getLinesInput()`
`long`	`getLinesOutput()`
`long`	`getLinesRead()`
`long`	`getLinesRejected()`	Get the number of lines rejected to an error handling transform
`long`	`getLinesSkipped()`
`long`	`getLinesUpdated()`
`long`	`getLinesWritten()`	Get the number of lines written to next transforms
`ILogChannel`	`getLogChannel()`
`String`	`getLogChannelId()`
`LogLevel`	`getLogLevel()`
`String`	`getLogText()`	Retrieve the logging text of this component in the engine
`Meta`	`getMeta()`
`IHopMetadataProvider`	`getMetadataProvider()`
`String`	`getName()`
`String`	`getObjectCopy()`
`String`	`getObjectName()`
`LoggingObjectType`	`getObjectType()`
`long`	`getOutputBufferSize()`
`List<IRowSet>`	`getOutputRowSets()`
`ILoggingObject`	`getParent()`
`IVariables`	`getParentVariables()`
`String`	`getPartitionId()`
`Map<String,BlockingRowSet>`	`getPartitionTargets()`
`IPipelineEngine<PipelineMeta>`	`getPipeline()`
`PipelineMeta`	`getPipelineMeta()`
`IRowMeta`	`getPreviewRowMeta()`
`long`	`getProcessed()`
`Date`	`getRegistrationDate()`	Returns the registration date
`int`	`getRepartitioning()`
`Map<String,ResultFile>`	`getResultFiles()`
`Object[]`	`getRow()`	In case of getRow, we receive data from previous transforms through the input rowset.
`Object[]`	`getRowFrom(IRowSet rowSet)`	Gets the row from.
`IRowHandler`	`getRowHandler()`
`List<IRowListener>`	`getRowListeners()`
`EngineComponent.ComponentExecutionStatus`	`getStatus()`	Get the execution status of the component
`String`	`getStatusDescription()`	Gets the status description.
`List<ITransformFinishedListener>`	`getTransformFinishedListeners()`	Gets transformFinishedListeners
`TransformMeta`	`getTransformMeta()`
`String`	`getTransformName()`	Get the name of the transform.
`String`	`getTransformPluginId()`
`List<ITransformStartedListener>`	`getTransformStartedListeners()`	Gets transformStartedListeners
`String`	`getVariable(String variableName)`
`String`	`getVariable(String variableName, String defaultValue)`
`boolean`	`getVariableBoolean(String variableName, boolean defaultValue)`
`String[]`	`getVariableNames()`
`Object[]`	`handleGetRowFrom(IRowSet rowSet)`
`void`	`handlePutError(IVariables variables, IRowMeta rowMeta, Object[] row, long nrErrors, String errorDescriptions, String fieldNames, String errorCodes)`
`void`	`handlePutRowTo(IRowMeta rowMeta, Object[] row, IRowSet rowSet)`
`void`	`identifyErrorOutput()`	To be used to flag an error output channel of a transform prior to execution for performance reasons.
`long`	`incrementLinesInput()`	Increments the number of lines read from an input source: database, file, socket, etc.
`long`	`incrementLinesOutput()`	Increments the number of lines written to an output target: database, file, socket, etc.
`long`	`incrementLinesRead()`	Increments the number of lines read from previous transforms by one
`long`	`incrementLinesRejected()`	Increments the number of lines rejected to an error handling transform
`long`	`incrementLinesSkipped()`	Increments the number of lines skipped
`long`	`incrementLinesUpdated()`	Increments the number of lines updated in an output target: database, file, socket, etc.
`long`	`incrementLinesWritten()`	Increments the number of lines written to next transforms by one
`boolean`	`init()`	Initialize and do work where other transforms need to wait for...
`void`	`initBeforeStart()`	This method is executed by Pipeline right before the threads start and right after initialization.
`void`	`initializeFrom(IVariables parent)`
`boolean`	`isAllowEmptyFieldNamesAndTypes()`	Gets allowEmptyFieldNamesAndTypes
`boolean`	`isBasic()`	Checks if is basic.
`boolean`	`isDebug()`	Checks if is debug.
`boolean`	`isDetailed()`	Checks if is detailed.
`boolean`	`isDistributed()`
`boolean`	`isForcingSeparateLogging()`
`boolean`	`isGatheringMetrics()`
`boolean`	`isInitialising()`	Checks if is initialising.
`boolean`	`isMapping()`
`boolean`	`isPartitioned()`
`boolean`	`isPaused()`
`boolean`	`isRowLevel()`	Checks if is row level.
`boolean`	`isRunning()`
`boolean`	`isSafeStopped()`
`boolean`	`isSelected()`
`boolean`	`isStopped()`
`void`	`logBasic(String message)`	Log basic.
`void`	`logBasic(String message, Object... arguments)`	Log basic.
`void`	`logDebug(String message)`	Log debug.
`void`	`logDebug(String message, Object... arguments)`	Log debug.
`void`	`logDetailed(String message)`	Log detailed.
`void`	`logDetailed(String message, Object... arguments)`	Log detailed.
`void`	`logError(String message)`	Log error.
`void`	`logError(String message, Object... arguments)`	Log error.
`void`	`logError(String message, Throwable e)`	Log error.
`void`	`logMinimal(String message)`	Log minimal.
`void`	`logMinimal(String message, Object... arguments)`	Log minimal.
`void`	`logRowlevel(String message)`	Log rowlevel.
`void`	`logRowlevel(String message, Object... arguments)`	Log rowlevel.
`void`	`logSummary()`	Log summary.
`void`	`markStart()`	Mark the start time of the transform.
`void`	`markStop()`	Mark the end time of the transform.
`boolean`	`outputIsDone()`	Output is done.
`void`	`pauseRunning()`	Pause a running transform
`boolean`	`processRow()`	Perform the equivalent of processing one row.
`void`	`putError(IRowMeta rowMeta, Object[] row, long nrErrors, String errorDescriptions, String fieldNames, String errorCodes)`	Put error.
`void`	`putRow(IRowMeta rowMeta, Object[] row)`	putRow is used to copy a row, to the alternate rowset(s) This should get priority over everything else! (synchronized) If distribute is true, a row is copied only once to the output rowsets, otherwise copies are sent to each rowset!
`void`	`putRowTo(IRowMeta rowMeta, Object[] row, IRowSet rowSet)`	putRowTo is used to put a row in a certain specific IRowSet.
`void`	`removeRowListener(IRowListener rowListener)`	Remove a rowlistener from this transform.
`String`	`resolve(String aString)`
`String[]`	`resolve(String[] aString)`
`String`	`resolve(String aString, IRowMeta rowMeta, Object[] rowData)`
`void`	`resumeRunning()`	Resume a running transform
`int`	`rowsetInputSize()`
`int`	`rowsetOutputSize()`
`protected void`	`safeModeChecking(IRowMeta row)`	Safe mode checking.
`static void`	`safeModeChecking(IRowMeta referenceRowMeta, IRowMeta rowMeta)`	Safe mode checking.
`void`	`setAllowEmptyFieldNamesAndTypes(boolean allowEmptyFieldNamesAndTypes)`	Sets allowEmptyFieldNamesAndTypes
`void`	`setCarteObjectId(String containerObjectId)`	Sets the container object ID.
`void`	`setCopy(int cop)`	Sets the copy.
`void`	`setCopyNr(int copyNr)`
`void`	`setCurrentInputRowSetNr(int index)`
`void`	`setCurrentOutputRowSetNr(int index)`
`void`	`setDistributed(boolean distributed)`
`void`	`setErrorRowMeta(IRowMeta errorRowMeta)`
`void`	`setErrors(long e)`	Sets the number of errors
`void`	`setExecutionEndDate(Date executionEndDate)`
`void`	`setExecutionStartDate(Date executionStartDate)`
`void`	`setFirstRowReadDate(Date firstRowReadDate)`
`void`	`setForcingSeparateLogging(boolean forcingSeparateLogging)`
`void`	`setGatheringMetrics(boolean gatheringMetrics)`
`void`	`setInitStartDate(Date initStartDate)`
`void`	`setInputRowMeta(IRowMeta rowMeta)`
`void`	`setInputRowSets(List<IRowSet> inputRowSets)`
`void`	`setInternalVariables()`	Sets the internal variables.
`void`	`setLastRowWrittenDate(Date lastRowWrittenDate)`
`void`	`setLinesInput(long newLinesInputValue)`
`void`	`setLinesOutput(long newLinesOutputValue)`
`void`	`setLinesRead(long newLinesReadValue)`
`void`	`setLinesRejected(long newLinesRejectedValue)`
`void`	`setLinesSkipped(long newLinesSkippedValue)`
`void`	`setLinesUpdated(long newLinesUpdatedValue)`
`void`	`setLinesWritten(long newLinesWrittenValue)`	Set the number of lines written to next transforms
`void`	`setLogLevel(LogLevel logLevel)`	Sets the log level.
`void`	`setMetadataProvider(IHopMetadataProvider metadataProvider)`	Pass along the metadata to use when loading external elements at runtime.
`void`	`setOutputDone()`	Signal output done to destination transforms
`void`	`setOutputRowSets(List<IRowSet> outputRowSets)`
`void`	`setParentVariables(IVariables parent)`
`void`	`setPartitioned(boolean partitioned)`
`void`	`setPartitionId(String partitionId)`
`void`	`setPartitionTargets(Map<String,BlockingRowSet> partitionTargets)`
`void`	`setPaused(boolean paused)`	Sets the paused.
`void`	`setPaused(AtomicBoolean paused)`	Sets the paused.
`void`	`setPreviewRowMeta(IRowMeta previewRowMeta)`
`void`	`setRepartitioning(int repartitioning)`
`void`	`setRowHandler(IRowHandler rowHandler)`	IRowHandler controls how getRow/putRow are handled.
`void`	`setRunning(boolean running)`	Flag the transform as running or not
`void`	`setSafeStopped(boolean stopped)`
`void`	`setStopped(boolean stopped)`
`void`	`setTransformFinishedListeners(List<ITransformFinishedListener> transformFinishedListeners)`
`void`	`setTransformName(String transformName)`	Sets the transformName.
`void`	`setTransformStartedListeners(List<ITransformStartedListener> transformStartedListeners)`
`void`	`setVariable(String variableName, String variableValue)`
`void`	`setVariables(Map<String,String> map)`
`void`	`shareWith(IVariables variables)`
`void`	`startBundle()`	When running in a Beam context this signals the transform that a new bundle was started.
`void`	`stopAll()`	Flags all rowsets as stopped/completed/finished.
`void`	`stopRunning()`	Perform actions to stop a running transform.
`protected void`	`swapFirstInputRowSetIfExists(String transformName)`
`String`	`toString()`
`protected void`	`waitUntilPipelineIsStarted()`	Wait until the pipeline is completely running and all threads have been started.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hop.pipeline.transform.ITransform
subStatuses

- Field Detail
  - variables
```
protected IVariables variables
```
  - log
```
protected ILogChannel log
```
  - initStartDate
```
protected Date initStartDate
```
  - executionStartDate
```
protected Date executionStartDate
```
  - firstRowReadDate
```
protected Date firstRowReadDate
```
  - lastRowWrittenDate
```
protected Date lastRowWrittenDate
```
  - executionEndDate
```
protected Date executionEndDate
```
  - safeStopped
```
protected AtomicBoolean safeStopped
```
  - first
```
public boolean first
```
    if true then the row being processed is the first row
  - terminator
```
public boolean terminator
```
  - terminatorRows
```
public List<Object[]> terminatorRows
```
  - meta
```
protected final Meta extends ITransformMeta meta
```
  - data
```
protected final Data extends ITransformData data
```
  - rowListeners
```
protected List<IRowListener> rowListeners
```
    The list of IRowListener interfaces
  - deadLockCounter
```
protected long deadLockCounter
```
    Keeps track of the number of rows read for input deadlock verification.
  - metadataProvider
```
protected IHopMetadataProvider metadataProvider
```
    The metadata that the transform uses to load external elements from
  - extensionDataMap
```
protected Map<String,Object> extensionDataMap
```
- Constructor Detail
  - BaseTransform
```
public BaseTransform(TransformMeta transformMeta,
                     Meta meta,
                     Data data,
                     int copyNr,
                     PipelineMeta pipelineMeta,
                     Pipeline pipeline)
```
    This is the base transform that forms that basis for all transforms. You can derive from this class to implement your own transforms.
    
    Parameters:
    
    transformMeta - The TransformMeta object to run.
    
    data - the data object to store temporary data, database connections, caches, result sets, hashtables etc.
    
    copyNr - The copynumber for this transform.
    
    pipelineMeta - The PipelineMeta of which the transform transformMeta is part of.
    
    pipeline - The (running) pipeline to obtain information shared among the transforms.
- Method Detail
  - init
```
public boolean init()
```
    Description copied from interface: ITransform
    
    Initialize and do work where other transforms need to wait for...
    
    Specified by:
    
    init in interface ITransform
  - dispose
```
public void dispose()
```
    Description copied from interface: ITransform
    
    Dispose of this transform: close files, empty logs, etc.
    
    Specified by:
    
    dispose in interface ITransform
  - cleanup
```
public void cleanup()
```
    Description copied from interface: ITransform
    
    Cleanup any left-over resources for this transform.
    
    Specified by:
    
    cleanup in interface ITransform
  - getProcessed
```
public long getProcessed()
```
    Specified by:
    
    getProcessed in interface ITransform
    
    Returns:
    
    The number of "processed" lines of a transform. Well, a representable metric for that anyway.
  - setCopy
```
public void setCopy(int cop)
```
    Sets the copy.
    
    Parameters:
    
    cop - the new copy
  - getCopy
```
public int getCopy()
```
    Specified by:
    
    getCopy in interface ITransform
    
    Returns:
    
    The transforms copy number (default 0)
  - getErrors
```
public long getErrors()
```
    Description copied from interface: ITransform
    
    Get the number of errors
    
    Specified by:
    
    getErrors in interface IEngineComponent
    
    Specified by:
    
    getErrors in interface ITransform
    
    Returns:
    
    the number of errors
  - setErrors
```
public void setErrors(long e)
```
    Description copied from interface: ITransform
    
    Sets the number of errors
    
    Specified by:
    
    setErrors in interface ITransform
    
    Parameters:
    
    e - the number of errors to set
  - getLinesRead
```
public long getLinesRead()
```
    Specified by:
    
    getLinesRead in interface IEngineComponent
    
    Specified by:
    
    getLinesRead in interface ITransform
    
    Returns:
    
    Returns the number of lines read from previous transforms
  - incrementLinesRead
```
public long incrementLinesRead()
```
    Increments the number of lines read from previous transforms by one
    
    Returns:
    
    Returns the new value
  - decrementLinesRead
```
public long decrementLinesRead()
```
    Decrements the number of lines read from previous transforms by one
    
    Returns:
    
    Returns the new value
  - setLinesRead
```
public void setLinesRead(long newLinesReadValue)
```
    Parameters:
    
    newLinesReadValue - the new number of lines read from previous transforms
  - getLinesInput
```
public long getLinesInput()
```
    Specified by:
    
    getLinesInput in interface IEngineComponent
    
    Specified by:
    
    getLinesInput in interface ITransform
    
    Returns:
    
    Returns the number of lines read from an input source: database, file, socket, etc.
  - incrementLinesInput
```
public long incrementLinesInput()
```
    Increments the number of lines read from an input source: database, file, socket, etc.
    
    Returns:
    
    the new incremented value
  - setLinesInput
```
public void setLinesInput(long newLinesInputValue)
```
    Parameters:
    
    newLinesInputValue - the new number of lines read from an input source: database, file, socket, etc.
  - getLinesOutput
```
public long getLinesOutput()
```
    Specified by:
    
    getLinesOutput in interface IEngineComponent
    
    Specified by:
    
    getLinesOutput in interface ITransform
    
    Returns:
    
    Returns the number of lines written to an output target: database, file, socket, etc.
  - incrementLinesOutput
```
public long incrementLinesOutput()
```
    Increments the number of lines written to an output target: database, file, socket, etc.
    
    Returns:
    
    the new incremented value
  - setLinesOutput
```
public void setLinesOutput(long newLinesOutputValue)
```
    Parameters:
    
    newLinesOutputValue - the new number of lines written to an output target: database, file, socket, etc.
  - getLinesWritten
```
public long getLinesWritten()
```
    Get the number of lines written to next transforms
    
    Specified by:
    
    getLinesWritten in interface IEngineComponent
    
    Specified by:
    
    getLinesWritten in interface ITransform
    
    Returns:
    
    Returns the linesWritten.
  - incrementLinesWritten
```
public long incrementLinesWritten()
```
    Increments the number of lines written to next transforms by one
    
    Returns:
    
    Returns the new value
  - decrementLinesWritten
```
public long decrementLinesWritten()
```
    Decrements the number of lines written to next transforms by one
    
    Returns:
    
    Returns the new value
  - setLinesWritten
```
public void setLinesWritten(long newLinesWrittenValue)
```
    Set the number of lines written to next transforms
    
    Parameters:
    
    newLinesWrittenValue - the new number of lines written to next transforms
  - getLinesUpdated
```
public long getLinesUpdated()
```
    Specified by:
    
    getLinesUpdated in interface IEngineComponent
    
    Specified by:
    
    getLinesUpdated in interface ITransform
    
    Returns:
    
    Returns the number of lines updated in an output target: database, file, socket, etc.
  - incrementLinesUpdated
```
public long incrementLinesUpdated()
```
    Increments the number of lines updated in an output target: database, file, socket, etc.
    
    Returns:
    
    the new incremented value
  - setLinesUpdated
```
public void setLinesUpdated(long newLinesUpdatedValue)
```
    Parameters:
    
    newLinesUpdatedValue - the new number of lines updated in an output target: database, file, socket, etc.
  - getLinesRejected
```
public long getLinesRejected()
```
    Get the number of lines rejected to an error handling transform
    
    Specified by:
    
    getLinesRejected in interface IEngineComponent
    
    Specified by:
    
    getLinesRejected in interface ITransform
    
    Returns:
    
    the number of lines rejected to an error handling transform
  - incrementLinesRejected
```
public long incrementLinesRejected()
```
    Increments the number of lines rejected to an error handling transform
    
    Returns:
    
    the new incremented value
  - setLinesRejected
```
public void setLinesRejected(long newLinesRejectedValue)
```
    Specified by:
    
    setLinesRejected in interface ITransform
    
    Parameters:
    
    newLinesRejectedValue - lines number of lines rejected to an error handling transform
  - getLinesSkipped
```
public long getLinesSkipped()
```
    Returns:
    
    the number of lines skipped
  - incrementLinesSkipped
```
public long incrementLinesSkipped()
```
    Increments the number of lines skipped
    
    Returns:
    
    the new incremented value
  - setLinesSkipped
```
public void setLinesSkipped(long newLinesSkippedValue)
```
    Parameters:
    
    newLinesSkippedValue - lines number of lines skipped
  - isSelected
```
public boolean isSelected()
```
    Specified by:
    
    isSelected in interface IEngineComponent
    
    Returns:
    
    true if the component is selected in the user interface
  - getTransformName
```
public String getTransformName()
```
    Description copied from interface: ITransform
    
    Get the name of the transform.
    
    Specified by:
    
    getTransformName in interface ITransform
    
    Returns:
    
    the name of the transform
  - setTransformName
```
public void setTransformName(String transformName)
```
    Sets the transformName.
    
    Parameters:
    
    transformName - the new transformName
  - getDispatcher
```
public IPipelineEngine<PipelineMeta> getDispatcher()
```
    Gets the dispatcher.
    
    Returns:
    
    the dispatcher
  - getStatusDescription
```
public String getStatusDescription()
```
    Gets the status description.
    
    Specified by:
    
    getStatusDescription in interface IEngineComponent
    
    Returns:
    
    the status description
  - getMeta
```
public Meta getMeta()
```
    Specified by:
    
    getMeta in interface ITransform
    
    Returns:
    
    Returns the transformMeta.
  - getData
```
public Data getData()
```
    Gets data
    
    Specified by:
    
    getData in interface ITransform
    
    Returns:
    
    value of data
  - getTransformMeta
```
public TransformMeta getTransformMeta()
```
    Specified by:
    
    getTransformMeta in interface ITransform
    
    Returns:
    
    Returns the transformMeta.
  - getPipelineMeta
```
public PipelineMeta getPipelineMeta()
```
    Returns:
    
    Returns the pipelineMeta.
  - getPipeline
```
public IPipelineEngine<PipelineMeta> getPipeline()
```
    Specified by:
    
    getPipeline in interface ITransform
    
    Returns:
    
    Returns the pipeline.
  - putRow
```
public void putRow(IRowMeta rowMeta,
                   Object[] row)
            throws HopTransformException
```
    putRow is used to copy a row, to the alternate rowset(s) This should get priority over everything else! (synchronized) If distribute is true, a row is copied only once to the output rowsets, otherwise copies are sent to each rowset!
    
    Specified by:
    
    putRow in interface ITransform
    
    Parameters:
    
    row - The row to put to the destination rowset(s).
    
    rowMeta - The row to send to the destinations transforms
    
    Throws:
    
    HopTransformException
  - putRowTo
```
public void putRowTo(IRowMeta rowMeta,
                     Object[] row,
                     IRowSet rowSet)
              throws HopTransformException
```
    putRowTo is used to put a row in a certain specific IRowSet.
    
    Parameters:
    
    rowMeta - The row meta-data to put to the destination IRowSet.
    
    row - the data to put in the IRowSet
    
    rowSet - the RoWset to put the row into.
    
    Throws:
    
    HopTransformException - In case something unexpected goes wrong
  - handlePutRowTo
```
public void handlePutRowTo(IRowMeta rowMeta,
                           Object[] row,
                           IRowSet rowSet)
                    throws HopTransformException
```
    Throws:
    
    HopTransformException
  - putError
```
public void putError(IRowMeta rowMeta,
                     Object[] row,
                     long nrErrors,
                     String errorDescriptions,
                     String fieldNames,
                     String errorCodes)
              throws HopTransformException
```
    Put error.
    
    Parameters:
    
    rowMeta - the row meta
    
    row - the row
    
    nrErrors - the nr errors
    
    errorDescriptions - the error descriptions
    
    fieldNames - the field names
    
    errorCodes - the error codes
    
    Throws:
    
    HopTransformException - the hop transform exception
  - handlePutError
```
public void handlePutError(IVariables variables,
                           IRowMeta rowMeta,
                           Object[] row,
                           long nrErrors,
                           String errorDescriptions,
                           String fieldNames,
                           String errorCodes)
                    throws HopTransformException
```
    Throws:
    
    HopTransformException
  - waitUntilPipelineIsStarted
```
protected void waitUntilPipelineIsStarted()
```
    Wait until the pipeline is completely running and all threads have been started.
  - getRow
```
public Object[] getRow()
                throws HopException
```
    In case of getRow, we receive data from previous transforms through the input rowset. In case we split the stream, we have to copy the data to the alternate splits: rowsets 1 through n.
    
    Specified by:
    
    getRow in interface ITransform
    
    Returns:
    
    a row from the source transform(s).
    
    Throws:
    
    HopException
  - setRowHandler
```
public void setRowHandler(IRowHandler rowHandler)
```
    IRowHandler controls how getRow/putRow are handled. The default IRowHandler will simply call handleGetRow() and handlePutRow(IRowMeta, Object[])
  - getRowHandler
```
public IRowHandler getRowHandler()
```
  - safeModeChecking
```
protected void safeModeChecking(IRowMeta row)
                         throws HopRowException
```
    Safe mode checking.
    
    Parameters:
    
    row - the row
    
    Throws:
    
    HopRowException - the hop row exception
  - identifyErrorOutput
```
public void identifyErrorOutput()
```
    Description copied from interface: ITransform
    
    To be used to flag an error output channel of a transform prior to execution for performance reasons.
    
    Specified by:
    
    identifyErrorOutput in interface ITransform
  - safeModeChecking
```
public static void safeModeChecking(IRowMeta referenceRowMeta,
                                    IRowMeta rowMeta)
                             throws HopRowException
```
    Safe mode checking.
    
    Parameters:
    
    referenceRowMeta - the reference row meta
    
    rowMeta - the row meta
    
    Throws:
    
    HopRowException - the hop row exception
  - getRowFrom
```
public Object[] getRowFrom(IRowSet rowSet)
                    throws HopTransformException
```
    Gets the row from.
    
    Parameters:
    
    rowSet - the row set
    
    Returns:
    
    the row from
    
    Throws:
    
    HopTransformException - the hop transform exception
  - handleGetRowFrom
```
public Object[] handleGetRowFrom(IRowSet rowSet)
                          throws HopTransformException
```
    Throws:
    
    HopTransformException
  - findInputRowSet
```
public IRowSet findInputRowSet(String sourceTransformName)
                        throws HopTransformException
```
    Find input row set.
    
    Parameters:
    
    sourceTransformName - the source transform
    
    Returns:
    
    the row set
    
    Throws:
    
    HopTransformException - the hop transform exception
  - findInputRowSet
```
public IRowSet findInputRowSet(String from,
                               int fromCopy,
                               String to,
                               int toCopy)
```
    Find input row set.
    
    Parameters:
    
    from - the from
    
    fromCopy - the fromcopy
    
    to - the to
    
    toCopy - the tocopy
    
    Returns:
    
    the row set
  - findOutputRowSet
```
public IRowSet findOutputRowSet(String targetTransform)
                         throws HopTransformException
```
    Find output row set.
    
    Parameters:
    
    targetTransform - the target transform
    
    Returns:
    
    the row set
    
    Throws:
    
    HopTransformException - the hop transform exception
  - findOutputRowSet
```
public IRowSet findOutputRowSet(String from,
                                int fromcopy,
                                String to,
                                int tocopy)
```
    Find an output rowset in a running pipeline. It will also look at the "to" transform to see if this is a mapping. If it is, it will find the appropriate rowset in that pipeline.
    
    Parameters:
    
    from -
    
    fromcopy -
    
    to -
    
    tocopy -
    
    Returns:
    
    The rowset or null if none is found.
  - setOutputDone
```
public void setOutputDone()
```
    Description copied from interface: ITransform
    
    Signal output done to destination transforms
    
    Specified by:
    
    setOutputDone in interface ITransform
  - dispatch
```
public void dispatch()
```
    This method finds the surrounding transforms and rowsets for this base transform. This transforms keeps it's own list of rowsets (etc.) to prevent it from having to search every time.
    Note that all rowsets input and output is already created by pipeline itself. So in this place we will look and choose which rowsets will be used by this particular transform.
    We will collect all input rowsets and output rowsets so transform will be able to read input data, and write to the output.
    Transforms can run in multiple copies, on in partitioned fashion. For this case we should take in account that in different cases we should take in account one to one, one to many and other cases properly.
  - isBasic
```
public boolean isBasic()
```
    Checks if is basic.
    
    Returns:
    
    true, if is basic
  - isDetailed
```
public boolean isDetailed()
```
    Checks if is detailed.
    
    Returns:
    
    true, if is detailed
  - isDebug
```
public boolean isDebug()
```
    Checks if is debug.
    
    Returns:
    
    true, if is debug
  - isRowLevel
```
public boolean isRowLevel()
```
    Checks if is row level.
    
    Returns:
    
    true, if is row level
  - logMinimal
```
public void logMinimal(String message)
```
    Log minimal.
    
    Parameters:
    
    message - the message
  - logMinimal
```
public void logMinimal(String message,
                       Object... arguments)
```
    Log minimal.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - logBasic
```
public void logBasic(String message)
```
    Log basic.
    
    Parameters:
    
    message - the message
  - logBasic
```
public void logBasic(String message,
                     Object... arguments)
```
    Log basic.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - logDetailed
```
public void logDetailed(String message)
```
    Log detailed.
    
    Parameters:
    
    message - the message
  - logDetailed
```
public void logDetailed(String message,
                        Object... arguments)
```
    Log detailed.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - logDebug
```
public void logDebug(String message)
```
    Log debug.
    
    Parameters:
    
    message - the message
  - logDebug
```
public void logDebug(String message,
                     Object... arguments)
```
    Log debug.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - logRowlevel
```
public void logRowlevel(String message)
```
    Log rowlevel.
    
    Parameters:
    
    message - the message
  - logRowlevel
```
public void logRowlevel(String message,
                        Object... arguments)
```
    Log rowlevel.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - logError
```
public void logError(String message)
```
    Log error.
    
    Parameters:
    
    message - the message
  - logError
```
public void logError(String message,
                     Throwable e)
```
    Log error.
    
    Parameters:
    
    message - the message
    
    e - the e
  - logError
```
public void logError(String message,
                     Object... arguments)
```
    Log error.
    
    Parameters:
    
    message - the message
    
    arguments - the arguments
  - outputIsDone
```
public boolean outputIsDone()
```
    Output is done.
    
    Returns:
    
    true, if successful
  - stopAll
```
public void stopAll()
```
    Description copied from interface: ITransform
    
    Flags all rowsets as stopped/completed/finished.
    
    Specified by:
    
    stopAll in interface ITransform
  - isStopped
```
public boolean isStopped()
```
    Specified by:
    
    isStopped in interface IEngineComponent
    
    Specified by:
    
    isStopped in interface ITransform
    
    Returns:
    
    True if the transform is marked as stopped. Execution should stop immediate.
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface IEngineComponent
    
    Specified by:
    
    isRunning in interface ITransform
    
    Returns:
    
    true if the transform is running after having been initialized
  - isPaused
```
public boolean isPaused()
```
    Specified by:
    
    isPaused in interface IEngineComponent
    
    Specified by:
    
    isPaused in interface ITransform
    
    Returns:
    
    True if the transform is paused
  - setStopped
```
public void setStopped(boolean stopped)
```
    Specified by:
    
    setStopped in interface ITransform
    
    Parameters:
    
    stopped - true if the transform needs to be stopped
  - setSafeStopped
```
public void setSafeStopped(boolean stopped)
```
    Specified by:
    
    setSafeStopped in interface ITransform
    
    Parameters:
    
    stopped - true if the transform needs to be safe stopped
  - isSafeStopped
```
public boolean isSafeStopped()
```
    Specified by:
    
    isSafeStopped in interface ITransform
    
    Returns:
    
    true if transform is safe stopped.
  - setRunning
```
public void setRunning(boolean running)
```
    Description copied from interface: ITransform
    
    Flag the transform as running or not
    
    Specified by:
    
    setRunning in interface ITransform
    
    Parameters:
    
    running - the running flag to set
  - pauseRunning
```
public void pauseRunning()
```
    Description copied from interface: ITransform
    
    Pause a running transform
    
    Specified by:
    
    pauseRunning in interface ITransform
  - resumeRunning
```
public void resumeRunning()
```
    Description copied from interface: ITransform
    
    Resume a running transform
    
    Specified by:
    
    resumeRunning in interface ITransform
  - setPaused
```
public void setPaused(boolean paused)
```
    Sets the paused.
    
    Parameters:
    
    paused - the new paused
  - setPaused
```
public void setPaused(AtomicBoolean paused)
```
    Sets the paused.
    
    Parameters:
    
    paused - the new paused
  - isInitialising
```
public boolean isInitialising()
```
    Checks if is initialising.
    
    Returns:
    
    true, if is initialising
  - markStart
```
public void markStart()
```
    Description copied from interface: ITransform
    
    Mark the start time of the transform.
    
    Specified by:
    
    markStart in interface ITransform
  - setInternalVariables
```
public void setInternalVariables()
```
    Sets the internal variables.
  - markStop
```
public void markStop()
```
    Description copied from interface: ITransform
    
    Mark the end time of the transform.
    
    Specified by:
    
    markStop in interface ITransform
  - getExecutionDuration
```
public long getExecutionDuration()
```
    Specified by:
    
    getExecutionDuration in interface IEngineComponent
    
    Specified by:
    
    getExecutionDuration in interface ITransform
    
    Returns:
    
    The number of ms that this transform has been running
  - getInputBufferSize
```
public long getInputBufferSize()
```
    Specified by:
    
    getInputBufferSize in interface IEngineComponent
  - getOutputBufferSize
```
public long getOutputBufferSize()
```
    Specified by:
    
    getOutputBufferSize in interface IEngineComponent
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - rowsetOutputSize
```
public int rowsetOutputSize()
```
    Specified by:
    
    rowsetOutputSize in interface ITransform
    
    Returns:
    
    The total amount of rows in the output buffers
  - rowsetInputSize
```
public int rowsetInputSize()
```
    Specified by:
    
    rowsetInputSize in interface ITransform
    
    Returns:
    
    The total amount of rows in the input buffers
  - stopRunning
```
public void stopRunning()
                 throws HopException
```
    Perform actions to stop a running transform. This can be stopping running Sql queries (cancel), etc. Default it doesn't do anything.
    
    Specified by:
    
    stopRunning in interface ITransform
    
    Throws:
    
    HopException - in case something goes wrong
  - logSummary
```
public void logSummary()
```
    Log summary.
  - getTransformPluginId
```
public String getTransformPluginId()
```
    Specified by:
    
    getTransformPluginId in interface ITransform
    
    Returns:
    
    the type ID of the transform...
  - getInputRowSets
```
public List<IRowSet> getInputRowSets()
```
    Specified by:
    
    getInputRowSets in interface ITransform
    
    Returns:
    
    Returns the inputRowSets.
  - addRowSetToInputRowSets
```
public void addRowSetToInputRowSets(IRowSet rowSet)
```
    Specified by:
    
    addRowSetToInputRowSets in interface ITransform
  - getFirstInputRowSet
```
protected IRowSet getFirstInputRowSet()
```
  - clearInputRowSets
```
protected void clearInputRowSets()
```
  - swapFirstInputRowSetIfExists
```
protected void swapFirstInputRowSetIfExists(String transformName)
```
  - setInputRowSets
```
public void setInputRowSets(List<IRowSet> inputRowSets)
```
    Parameters:
    
    inputRowSets - The inputRowSets to set.
  - getOutputRowSets
```
public List<IRowSet> getOutputRowSets()
```
    Specified by:
    
    getOutputRowSets in interface ITransform
    
    Returns:
    
    Returns the outputRowSets.
  - addRowSetToOutputRowSets
```
public void addRowSetToOutputRowSets(IRowSet rowSet)
```
    Specified by:
    
    addRowSetToOutputRowSets in interface ITransform
  - clearOutputRowSets
```
protected void clearOutputRowSets()
```
  - setOutputRowSets
```
public void setOutputRowSets(List<IRowSet> outputRowSets)
```
    Parameters:
    
    outputRowSets - The outputRowSets to set.
  - isDistributed
```
public boolean isDistributed()
```
    Returns:
    
    Returns the distributed.
  - setDistributed
```
public void setDistributed(boolean distributed)
```
    Parameters:
    
    distributed - The distributed to set.
  - addRowListener
```
public void addRowListener(IRowListener rowListener)
```
    Description copied from interface: ITransform
    
    Add a rowlistener to the transform allowing you to inspect (or manipulate, be careful) the rows coming in or exiting the transform.
    
    Specified by:
    
    addRowListener in interface IEngineComponent
    
    Specified by:
    
    addRowListener in interface ITransform
    
    Parameters:
    
    rowListener - the rowlistener to add
  - removeRowListener
```
public void removeRowListener(IRowListener rowListener)
```
    Description copied from interface: ITransform
    
    Remove a rowlistener from this transform.
    
    Specified by:
    
    removeRowListener in interface IEngineComponent
    
    Specified by:
    
    removeRowListener in interface ITransform
    
    Parameters:
    
    rowListener - the rowlistener to remove
  - getRowListeners
```
public List<IRowListener> getRowListeners()
```
    Specified by:
    
    getRowListeners in interface ITransform
    
    Returns:
    
    a list of the installed RowListeners
  - addResultFile
```
public void addResultFile(ResultFile resultFile)
```
    Adds the result file.
    
    Parameters:
    
    resultFile - the result file
  - getResultFiles
```
public Map<String,ResultFile> getResultFiles()
```
    Specified by:
    
    getResultFiles in interface ITransform
    
    Returns:
    
    The result files for this transform
  - getStatus
```
public EngineComponent.ComponentExecutionStatus getStatus()
```
    Description copied from interface: IEngineComponent
    
    Get the execution status of the component
    
    Specified by:
    
    getStatus in interface IEngineComponent
    
    Specified by:
    
    getStatus in interface ITransform
    
    Returns:
    
    the description as in ITransformData
  - getPartitionId
```
public String getPartitionId()
```
    Specified by:
    
    getPartitionId in interface ITransform
    
    Returns:
    
    the partitionId
  - setPartitionId
```
public void setPartitionId(String partitionId)
```
    Specified by:
    
    setPartitionId in interface ITransform
    
    Parameters:
    
    partitionId - the partitionId to set
  - getPartitionTargets
```
public Map<String,BlockingRowSet> getPartitionTargets()
```
    Returns:
    
    the partitionTargets
  - setPartitionTargets
```
public void setPartitionTargets(Map<String,BlockingRowSet> partitionTargets)
```
    Parameters:
    
    partitionTargets - the partitionTargets to set
  - getRepartitioning
```
public int getRepartitioning()
```
    Returns:
    
    the repartitioning type
  - setRepartitioning
```
public void setRepartitioning(int repartitioning)
```
    Specified by:
    
    setRepartitioning in interface ITransform
    
    Parameters:
    
    repartitioning - the repartitioning type to set
  - isPartitioned
```
public boolean isPartitioned()
```
    Specified by:
    
    isPartitioned in interface ITransform
    
    Returns:
    
    the partitioned
  - setPartitioned
```
public void setPartitioned(boolean partitioned)
```
    Specified by:
    
    setPartitioned in interface ITransform
    
    Parameters:
    
    partitioned - the partitioned to set
  - checkFeedback
```
protected boolean checkFeedback(long lines)
```
    Check feedback.
    
    Parameters:
    
    lines - the lines
    
    Returns:
    
    true, if successful
  - getInputRowMeta
```
public IRowMeta getInputRowMeta()
```
    Returns:
    
    the rowMeta
  - setInputRowMeta
```
public void setInputRowMeta(IRowMeta rowMeta)
```
    Parameters:
    
    rowMeta - the rowMeta to set
  - getErrorRowMeta
```
public IRowMeta getErrorRowMeta()
```
    Returns:
    
    the errorRowMeta
  - setErrorRowMeta
```
public void setErrorRowMeta(IRowMeta errorRowMeta)
```
    Parameters:
    
    errorRowMeta - the errorRowMeta to set
  - getPreviewRowMeta
```
public IRowMeta getPreviewRowMeta()
```
    Returns:
    
    the previewRowMeta
  - setPreviewRowMeta
```
public void setPreviewRowMeta(IRowMeta previewRowMeta)
```
    Parameters:
    
    previewRowMeta - the previewRowMeta to set
  - copyFrom
```
public void copyFrom(IVariables variables)
```
    Specified by:
    
    copyFrom in interface IVariables
  - resolve
```
public String resolve(String aString)
```
    Specified by:
    
    resolve in interface IVariables
  - resolve
```
public String[] resolve(String[] aString)
```
    Specified by:
    
    resolve in interface IVariables
  - resolve
```
public String resolve(String aString,
                      IRowMeta rowMeta,
                      Object[] rowData)
               throws HopValueException
```
    Specified by:
    
    resolve in interface IVariables
    
    Throws:
    
    HopValueException
  - getParentVariables
```
public IVariables getParentVariables()
```
    Specified by:
    
    getParentVariables in interface IVariables
  - setParentVariables
```
public void setParentVariables(IVariables parent)
```
    Specified by:
    
    setParentVariables in interface IVariables
  - getVariable
```
public String getVariable(String variableName,
                          String defaultValue)
```
    Specified by:
    
    getVariable in interface IVariables
  - getVariable
```
public String getVariable(String variableName)
```
    Specified by:
    
    getVariable in interface IVariables
  - getVariableBoolean
```
public boolean getVariableBoolean(String variableName,
                                  boolean defaultValue)
```
    Specified by:
    
    getVariableBoolean in interface IVariables
  - initializeFrom
```
public void initializeFrom(IVariables parent)
```
    Specified by:
    
    initializeFrom in interface IVariables
  - getVariableNames
```
public String[] getVariableNames()
```
    Specified by:
    
    getVariableNames in interface IVariables
  - setVariable
```
public void setVariable(String variableName,
                        String variableValue)
```
    Specified by:
    
    setVariable in interface IVariables
  - shareWith
```
public void shareWith(IVariables variables)
```
    Specified by:
    
    shareWith in interface IVariables
  - setVariables
```
public void setVariables(Map<String,String> map)
```
    Specified by:
    
    setVariables in interface IVariables
  - initBeforeStart
```
public void initBeforeStart()
                     throws HopTransformException
```
    This method is executed by Pipeline right before the threads start and right after initialization.
    More to the point: here we open remote output transform sockets.
    
    Specified by:
    
    initBeforeStart in interface ITransform
    
    Throws:
    
    HopTransformException - In case there is an error
  - processRow
```
public boolean processRow()
                   throws HopException
```
    Description copied from interface: ITransform
    
    Perform the equivalent of processing one row. Typically this means reading a row from input (getRow()) and passing a row to output (putRow)).
    
    Specified by:
    
    processRow in interface ITransform
    
    Returns:
    
    false if no more rows can be processed or an error occurred.
    
    Throws:
    
    HopException
  - canProcessOneRow
```
public boolean canProcessOneRow()
```
    Description copied from interface: ITransform
    
    This method checks if the transform is capable of processing at least one row.
    For example, if a transform has no input records but needs at least one to function, it will return false.
    
    Specified by:
    
    canProcessOneRow in interface ITransform
    
    Returns:
    
    true if the transform can process a row.
  - addTransformFinishedListener
```
public void addTransformFinishedListener(ITransformFinishedListener transformFinishedListener)
```
    Description copied from interface: ITransform
    
    Attach a transform listener to be notified when a transform finishes
    
    Specified by:
    
    addTransformFinishedListener in interface ITransform
    
    Parameters:
    
    transformFinishedListener - The listener to add to the transform
  - addTransformStartedListener
```
public void addTransformStartedListener(ITransformStartedListener transformStartedListener)
```
    Description copied from interface: ITransform
    
    Attach a transform listener to be notified when a transform starts
    
    Specified by:
    
    addTransformStartedListener in interface ITransform
    
    Parameters:
    
    transformStartedListener - The listener to add to the transform
  - getTransformFinishedListeners
```
public List<ITransformFinishedListener> getTransformFinishedListeners()
```
    Gets transformFinishedListeners
    
    Returns:
    
    value of transformFinishedListeners
  - setTransformFinishedListeners
```
public void setTransformFinishedListeners(List<ITransformFinishedListener> transformFinishedListeners)
```
    Parameters:
    
    transformFinishedListeners - The transformFinishedListeners to set
  - getTransformStartedListeners
```
public List<ITransformStartedListener> getTransformStartedListeners()
```
    Gets transformStartedListeners
    
    Returns:
    
    value of transformStartedListeners
  - setTransformStartedListeners
```
public void setTransformStartedListeners(List<ITransformStartedListener> transformStartedListeners)
```
    Parameters:
    
    transformStartedListeners - The transformStartedListeners to set
  - isMapping
```
public boolean isMapping()
```
    Specified by:
    
    isMapping in interface ITransform
    
    Returns:
    
    true if the thread is a special mapping transform
  - getObjectName
```
public String getObjectName()
```
    Specified by:
    
    getObjectName in interface ILoggingObject
  - getLogChannel
```
public ILogChannel getLogChannel()
```
    Specified by:
    
    getLogChannel in interface IEngineComponent
    
    Specified by:
    
    getLogChannel in interface IHasLogChannel
    
    Specified by:
    
    getLogChannel in interface ITransform
    
    Returns:
    
    the logging channel for this transform
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface IEngineComponent
    
    Returns:
    
    The component name
  - getCopyNr
```
public int getCopyNr()
```
    Gets copyNr
    
    Specified by:
    
    getCopyNr in interface IEngineComponent
    
    Returns:
    
    value of copyNr
  - setCopyNr
```
public void setCopyNr(int copyNr)
```
    Parameters:
    
    copyNr - The copyNr to set
  - getLogText
```
public String getLogText()
```
    Description copied from interface: IEngineComponent
    
    Retrieve the logging text of this component in the engine
    
    Specified by:
    
    getLogText in interface IEngineComponent
    
    Returns:
    
    logging text
  - getFilename
```
public String getFilename()
```
    Specified by:
    
    getFilename in interface ILoggingObject
  - getLogChannelId
```
public String getLogChannelId()
```
    Specified by:
    
    getLogChannelId in interface IEngineComponent
    
    Specified by:
    
    getLogChannelId in interface ILoggingObject
    
    Returns:
    
    The log channel ID or null if there is no separate log channel.
  - getObjectType
```
public LoggingObjectType getObjectType()
```
    Specified by:
    
    getObjectType in interface ILoggingObject
  - getParent
```
public ILoggingObject getParent()
```
    Specified by:
    
    getParent in interface ILoggingObject
  - getObjectCopy
```
public String getObjectCopy()
```
    Specified by:
    
    getObjectCopy in interface ILoggingObject
  - getLogLevel
```
public LogLevel getLogLevel()
```
    Specified by:
    
    getLogLevel in interface IEngineComponent
    
    Specified by:
    
    getLogLevel in interface ILoggingObject
  - setLogLevel
```
public void setLogLevel(LogLevel logLevel)
```
    Sets the log level.
    
    Specified by:
    
    setLogLevel in interface IEngineComponent
    
    Parameters:
    
    logLevel - the new log level
  - closeQuietly
```
public static void closeQuietly(Closeable cl)
```
    Close quietly.
    
    Parameters:
    
    cl - the object that can be closed.
  - getContainerId
```
public String getContainerId()
```
    Returns the container object ID.
    
    Specified by:
    
    getContainerId in interface ILoggingObject
    
    Returns:
    
    the containerObjectId
  - setCarteObjectId
```
public void setCarteObjectId(String containerObjectId)
```
    Sets the container object ID.
    
    Parameters:
    
    containerObjectId - the containerObjectId to set
  - batchComplete
```
public void batchComplete()
                   throws HopException
```
    Description copied from interface: ITransform
    
    When using the Single threaded engine this signals to the transform that a batch of records has been processed and that no more are expected in this batch.
    
    Specified by:
    
    batchComplete in interface ITransform
    
    Throws:
    
    HopException - In case an error occurs during the processing of the batch of rows.
    
    See Also:
    
    ITransform.batchComplete()
  - startBundle
```
public void startBundle()
                 throws HopException
```
    Description copied from interface: ITransform
    
    When running in a Beam context this signals the transform that a new bundle was started. File writing transforms might want to create new files here.
    
    Specified by:
    
    startBundle in interface ITransform
    
    Throws:
    
    HopException
  - finishBundle
```
public void finishBundle()
                  throws HopException
```
    Description copied from interface: ITransform
    
    When running in a Beam context this signals the transform that a bundle was finished. File writing transforms will want to close open file(s) here.
    
    Specified by:
    
    finishBundle in interface ITransform
    
    Throws:
    
    HopException
  - getRegistrationDate
```
public Date getRegistrationDate()
```
    Returns the registration date
    
    Specified by:
    
    getRegistrationDate in interface ILoggingObject
  - isGatheringMetrics
```
public boolean isGatheringMetrics()
```
    Specified by:
    
    isGatheringMetrics in interface ILoggingObject
  - setGatheringMetrics
```
public void setGatheringMetrics(boolean gatheringMetrics)
```
    Specified by:
    
    setGatheringMetrics in interface ILoggingObject
  - isForcingSeparateLogging
```
public boolean isForcingSeparateLogging()
```
    Specified by:
    
    isForcingSeparateLogging in interface ILoggingObject
  - setForcingSeparateLogging
```
public void setForcingSeparateLogging(boolean forcingSeparateLogging)
```
    Specified by:
    
    setForcingSeparateLogging in interface ILoggingObject
  - getMetadataProvider
```
public IHopMetadataProvider getMetadataProvider()
```
    Specified by:
    
    getMetadataProvider in interface ITransform
    
    Returns:
    
    The metadata that the transform uses to load external elements from.
  - setMetadataProvider
```
public void setMetadataProvider(IHopMetadataProvider metadataProvider)
```
    Description copied from interface: ITransform
    
    Pass along the metadata to use when loading external elements at runtime.
    
    Specified by:
    
    setMetadataProvider in interface ITransform
    
    Parameters:
    
    metadataProvider - The metadata to use
  - getCurrentOutputRowSetNr
```
public int getCurrentOutputRowSetNr()
```
    Specified by:
    
    getCurrentOutputRowSetNr in interface ITransform
    
    Returns:
    
    the index of the active (current) output row set
  - setCurrentOutputRowSetNr
```
public void setCurrentOutputRowSetNr(int index)
```
    Specified by:
    
    setCurrentOutputRowSetNr in interface ITransform
    
    Parameters:
    
    index - Sets the index of the active (current) output row set to use.
  - getCurrentInputRowSetNr
```
public int getCurrentInputRowSetNr()
```
    Specified by:
    
    getCurrentInputRowSetNr in interface ITransform
    
    Returns:
    
    the index of the active (current) input row set
  - setCurrentInputRowSetNr
```
public void setCurrentInputRowSetNr(int index)
```
    Specified by:
    
    setCurrentInputRowSetNr in interface ITransform
    
    Parameters:
    
    index - Sets the index of the active (current) input row set to use.
  - getExtensionDataMap
```
public Map<String,Object> getExtensionDataMap()
```
    Specified by:
    
    getExtensionDataMap in interface IExtensionData
  - getInitStartDate
```
public Date getInitStartDate()
```
    Gets initStartDate
    
    Specified by:
    
    getInitStartDate in interface IEngineComponent
    
    Specified by:
    
    getInitStartDate in interface ITransform
    
    Returns:
    
    value of initStartDate
  - setInitStartDate
```
public void setInitStartDate(Date initStartDate)
```
    Specified by:
    
    setInitStartDate in interface IEngineComponent
    
    Specified by:
    
    setInitStartDate in interface ITransform
    
    Parameters:
    
    initStartDate - The initStartDate to set
  - getExecutionStartDate
```
public Date getExecutionStartDate()
```
    Gets executionStartDate
    
    Specified by:
    
    getExecutionStartDate in interface IEngineComponent
    
    Specified by:
    
    getExecutionStartDate in interface ITransform
    
    Returns:
    
    value of executionStartDate
  - setExecutionStartDate
```
public void setExecutionStartDate(Date executionStartDate)
```
    Specified by:
    
    setExecutionStartDate in interface IEngineComponent
    
    Specified by:
    
    setExecutionStartDate in interface ITransform
    
    Parameters:
    
    executionStartDate - The executionStartDate to set
  - getFirstRowReadDate
```
public Date getFirstRowReadDate()
```
    Gets firstRowReadDate
    
    Specified by:
    
    getFirstRowReadDate in interface IEngineComponent
    
    Specified by:
    
    getFirstRowReadDate in interface ITransform
    
    Returns:
    
    value of firstRowReadDate
  - setFirstRowReadDate
```
public void setFirstRowReadDate(Date firstRowReadDate)
```
    Specified by:
    
    setFirstRowReadDate in interface IEngineComponent
    
    Specified by:
    
    setFirstRowReadDate in interface ITransform
    
    Parameters:
    
    firstRowReadDate - The firstRowReadDate to set
  - getLastRowWrittenDate
```
public Date getLastRowWrittenDate()
```
    Gets lastRowWrittenDate
    
    Specified by:
    
    getLastRowWrittenDate in interface IEngineComponent
    
    Specified by:
    
    getLastRowWrittenDate in interface ITransform
    
    Returns:
    
    value of lastRowWrittenDate
  - setLastRowWrittenDate
```
public void setLastRowWrittenDate(Date lastRowWrittenDate)
```
    Specified by:
    
    setLastRowWrittenDate in interface IEngineComponent
    
    Specified by:
    
    setLastRowWrittenDate in interface ITransform
    
    Parameters:
    
    lastRowWrittenDate - The lastRowWrittenDate to set
  - getExecutionEndDate
```
public Date getExecutionEndDate()
```
    Gets executionEndDate
    
    Specified by:
    
    getExecutionEndDate in interface IEngineComponent
    
    Specified by:
    
    getExecutionEndDate in interface ITransform
    
    Returns:
    
    value of executionEndDate
  - setExecutionEndDate
```
public void setExecutionEndDate(Date executionEndDate)
```
    Specified by:
    
    setExecutionEndDate in interface IEngineComponent
    
    Specified by:
    
    setExecutionEndDate in interface ITransform
    
    Parameters:
    
    executionEndDate - The executionEndDate to set
  - setAllowEmptyFieldNamesAndTypes
```
public void setAllowEmptyFieldNamesAndTypes(boolean allowEmptyFieldNamesAndTypes)
```
    Sets allowEmptyFieldNamesAndTypes
    
    Parameters:
    
    allowEmptyFieldNamesAndTypes - value of allowEmptyFieldNamesAndTypes
  - isAllowEmptyFieldNamesAndTypes
```
public boolean isAllowEmptyFieldNamesAndTypes()
```
    Gets allowEmptyFieldNamesAndTypes
    
    Returns:
    
    value of allowEmptyFieldNamesAndTypes

Class BaseTransform<Meta extends ITransformMeta,​Data extends ITransformData>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hop.pipeline.transform.ITransform

Field Detail

variables

log

initStartDate

executionStartDate

firstRowReadDate

lastRowWrittenDate

executionEndDate

safeStopped

first

terminator

terminatorRows

meta

data

rowListeners

deadLockCounter

metadataProvider

extensionDataMap

Constructor Detail

BaseTransform

Method Detail

init

dispose

cleanup

getProcessed

setCopy

getCopy

getErrors

setErrors

getLinesRead

incrementLinesRead

decrementLinesRead

setLinesRead

getLinesInput

incrementLinesInput

setLinesInput

getLinesOutput

incrementLinesOutput

setLinesOutput

getLinesWritten

incrementLinesWritten

decrementLinesWritten

setLinesWritten

getLinesUpdated

incrementLinesUpdated

setLinesUpdated

getLinesRejected

incrementLinesRejected

setLinesRejected

getLinesSkipped

incrementLinesSkipped

setLinesSkipped

isSelected

getTransformName

setTransformName

getDispatcher

getStatusDescription

getMeta

getData

getTransformMeta

getPipelineMeta

getPipeline

putRow

putRowTo

handlePutRowTo

putError

handlePutError

waitUntilPipelineIsStarted

getRow

setRowHandler

getRowHandler

safeModeChecking

identifyErrorOutput

safeModeChecking

Class BaseTransform<Meta extends ITransformMeta,Data extends ITransformData>