java.lang.Object
- org.apache.hop.pipeline.Pipeline

All Implemented Interfaces:

IExecutor, IExtensionData, IHasLogChannel, ILoggingObject, INamedParameterDefinitions, INamedParameters, IVariables, IPipelineEngine<PipelineMeta>

Direct Known Subclasses:

LocalPipelineEngine, LocalSinglePipelineEngine
```
public abstract class Pipeline
extends Object
implements IVariables, INamedParameters, IHasLogChannel, ILoggingObject, IExecutor, IExtensionData, IPipelineEngine<PipelineMeta>
```
This class represents the information and operations associated with the execution of a Pipeline. It loads, instantiates, initializes, runs, and monitors the execution of the pipeline contained in the specified PipelineMeta object.

Field Summary

Fields
Modifier and Type	Field	Description
`protected String[]`	`arguments`	The command line arguments for the pipeline.
`static String`	`CONFIGURATION_IN_EXPORT_FILENAME`	Constant specifying a filename containing XML to inject into a ZIP file created during resource export.
`protected String`	`containerObjectId`	The container object id.
`protected List<IExecutionDataSampler<? extends IExecutionDataSamplerStore>>`	`dataSamplers`	Plugins can use this to add additional data samplers to the pipeline.
`protected boolean`	`feedbackShown`	Whether the feedback is shown.
`protected int`	`feedbackSize`	The feedback size.
`protected ILogChannel`	`log`	The log channel interface.
`protected int`	`logCommitSize`	The log commit size.
`protected LogLevel`	`logLevel`	The log level.
`protected IHopMetadataProvider`	`metadataProvider`	The MetaStore to use
`static IEngineMetric`	`METRIC_BUFFER_IN`
`static IEngineMetric`	`METRIC_BUFFER_OUT`
`static IEngineMetric`	`METRIC_ERROR`
`static IEngineMetric`	`METRIC_FLUSH_BUFFER`
`static IEngineMetric`	`METRIC_INIT`
`static IEngineMetric`	`METRIC_INPUT`
`static String`	`METRIC_NAME_BUFFER_IN`
`static String`	`METRIC_NAME_BUFFER_OUT`
`static String`	`METRIC_NAME_ERROR`
`static String`	`METRIC_NAME_FLUSH_BUFFER`
`static String`	`METRIC_NAME_INIT`
`static String`	`METRIC_NAME_INPUT`
`static String`	`METRIC_NAME_OUTPUT`
`static String`	`METRIC_NAME_READ`
`static String`	`METRIC_NAME_REJECTED`
`static String`	`METRIC_NAME_UPDATED`
`static String`	`METRIC_NAME_WRITTEN`
`static IEngineMetric`	`METRIC_OUTPUT`
`static IEngineMetric`	`METRIC_READ`
`static IEngineMetric`	`METRIC_REJECTED`
`static IEngineMetric`	`METRIC_UPDATED`
`static IEngineMetric`	`METRIC_WRITTEN`
`protected PipelineMeta`	`pipelineMeta`	The pipeline metadata to execute.
`protected PipelineRunConfiguration`	`pipelineRunConfiguration`
`protected String`	`pluginId`
`protected List<ResultFile>`	`resultFiles`
`protected List<RowMetaAndData>`	`resultRows`
`List<IRowSet>`	`rowsets`	A list of all the row sets.
`protected int`	`rowSetSize`
`static String`	`STRING_FINISHED`	Constant indicating a pipeline status of Finished.
`static String`	`STRING_FINISHED_WITH_ERRORS`	Constant indicating a pipeline status of Finished (with errors).
`static String`	`STRING_HALTING`	Constant indicating a pipeline status of Halting.
`static String`	`STRING_INITIALIZING`	Constant indicating a pipeline status of Initializing.
`static String`	`STRING_PAUSED`	Constant indicating a pipeline status of Paused.
`static String`	`STRING_PREPARING`	Constant indicating a pipeline status of Preparing for execution.
`static String`	`STRING_RUNNING`	Constant indicating a pipeline status of Running.
`static String`	`STRING_STOPPED`	Constant indicating a pipeline status of Stopped.
`static String`	`STRING_STOPPED_WITH_ERRORS`	Constant indicating a pipeline status of Stopped (with errors).
`static String`	`STRING_WAITING`	Constant indicating a pipeline status of Waiting.
`static int`	`TYPE_DISP_1_1`	Constant indicating a dispatch type of 1-to-1.
`static int`	`TYPE_DISP_1_N`	Constant indicating a dispatch type of 1-to-N.
`static int`	`TYPE_DISP_N_1`	Constant indicating a dispatch type of N-to-1.
`static int`	`TYPE_DISP_N_M`	Constant indicating a dispatch type of N-to-M.
`static int`	`TYPE_DISP_N_N`	Constant indicating a dispatch type of N-to-N.

Fields inherited from interface org.apache.hop.pipeline.engine.IPipelineEngine
PIPELINE_IN_PREVIEW_MODE

Constructor Summary

Constructors
Constructor	Description
`Pipeline()`	Instantiates a new pipeline.
`Pipeline(PipelineMeta pipelineMeta)`	Initializes a pipeline from pipeline meta-data defined in memory.
`Pipeline(PipelineMeta pipelineMeta, IVariables variables, ILoggingObject parent)`	Initializes a pipeline from pipeline meta-data defined in memory.
`Pipeline(Parent parent, String name, String filename, IHopMetadataProvider metadataProvider)`	Instantiates a new pipeline using any of the provided parameters including the variable bindings, a name and a filename.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`activateParameters(IVariables variables)`	Activates all parameters by setting their values.
`void`	`addActiveSubPipeline(String subPipelineName, IPipelineEngine subPipeline)`	Add an active sub-pipeline to allow drill-down in the GUI
`void`	`addActiveSubWorkflow(String subWorkflowName, IWorkflowEngine<WorkflowMeta> subWorkflow)`	Add an active sub-workflow to allow drill-down in the GUI
`<Store extends IExecutionDataSamplerStore,Sampler extends IExecutionDataSampler<Store>> void`	`addExecutionDataSampler(Sampler sampler)`	Plugins can add individual data samplers which will act upon the rows passing through the transforms in the pipeline.
`void`	`addExecutionFinishedListener(IExecutionFinishedListener executionFinishedListener)`	Adds a pipeline finished listener.
`void`	`addExecutionStartedListener(IExecutionStartedListener executionStartedListener)`	Adds a pipeline started listener.
`void`	`addExecutionStoppedListener(IExecutionStoppedListener executionStoppedListener)`	Adds a pipeline stopped listener.
`void`	`addFinishedListener(IExecutionFinishedListener<IPipelineEngine<PipelineMeta>> listener)`
`void`	`addParameterDefinition(String key, String defValue, String description)`	Adds a parameter definition to this pipeline.
`void`	`addPipelineStoppedListener(IExecutionStoppedListener<IPipelineEngine<PipelineMeta>> pipelineStoppedListener)`	Adds a stop-event listener to the pipeline.
`RowProducer`	`addRowProducer(String transformName, int copynr)`	This adds a row producer to the pipeline that just got set up.
`void`	`addStartedListener(IExecutionStartedListener<IPipelineEngine<PipelineMeta>> listener)`
`protected void`	`addTransformPerformanceSnapShot()`	Adds a transform performance snapshot.
`void`	`beginProcessing()`	Begin processing.
`void`	`calculateBatchIdAndDateRange()`	Calculate the batch id and date range for the pipeline.
`void`	`cleanup()`	This method performs any cleanup operations, typically called after the pipeline has finished.
`void`	`clearError()`	Clear the error in the pipeline, clear all the rows from all the row sets, to make sure the pipeline can continue with other data.
`void`	`clearParameterValues()`	Clear the values of all parameters.
`void`	`copyFrom(IVariables variables)`	Copies variables from a given variable variables to this pipeline.
`void`	`copyParametersFromDefinitions(INamedParameterDefinitions definitions)`
`IPipelineEngineRunConfiguration`	`createDefaultPipelineEngineRunConfiguration()`	Ask the engine to generate a default pipeline engine configuration for this engine
`void`	`doTopologySortOfTransforms()`
`void`	`execute()`	Executes the pipeline.
`IEngineComponent`	`findComponent(String name, int copyNr)`	Find a component by name and copy nr
`IRowSet`	`findRowSet(String from, int fromcopy, String to, int tocopy)`	Finds the IRowSet between two transforms (or copies of transforms).
`ITransform`	`findRunThread(String transformName)`	Find the run thread for the transform with the specified name.
`void`	`firePipelineExecutionFinishedListeners()`	Make attempt to fire all registered finished listeners if possible.
`void`	`firePipelineExecutionStartedListeners()`	Fires the start-event listeners (if any are registered).
`void`	`firePipelineExecutionStoppedListeners()`
`IPipelineEngine`	`getActiveSubPipeline(String subPipelineName)`	Get the active sub-pipeline with the given name
`Map<String,IPipelineEngine>`	`getActiveSubPipelines()`	Gets activeSubPipelines
`IWorkflowEngine<WorkflowMeta>`	`getActiveSubWorkflow(String subWorkflowName)`	Get the active sub-workflow with the given name
`Map<String,IWorkflowEngine<WorkflowMeta>>`	`getActiveSubWorkflows()`	Gets the active sub-workflows.
`List<IEngineComponent>`	`getComponentCopies(String name)`	Find all component copies by name
`String`	`getComponentLogText(String componentName, int copyNr)`	Retrieve the logging text of a particular component in the engine
`List<IEngineComponent>`	`getComponents()`	Get a list of components
`String`	`getContainerId()`	Gets the container object ID.
`List<IExecutionDataSampler<? extends IExecutionDataSamplerStore>>`	`getDataSamplers()`	Gets dataSamplers
`EngineMetrics`	`getEngineMetrics()`	Collect metrics from the various components in the engine.
`EngineMetrics`	`getEngineMetrics(String componentName, int copyNr)`	Get the engine metrics for a specific component name and/or copy nr
`int`	`getErrors()`	Gets the number of errors that have occurred during execution of the pipeline.
`String`	`getExecutingServer()`	Gets the name of the executing server.
`String`	`getExecutingUser()`	Gets the name of the executing user.
`Date`	`getExecutionEndDate()`	Gets executionEndDate
`List<IExecutionFinishedListener<IPipelineEngine<PipelineMeta>>>`	`getExecutionFinishedListeners()`	Gets executionFinishedListeners
`Date`	`getExecutionStartDate()`	Gets executionStartDate
`List<IExecutionStartedListener<IPipelineEngine<PipelineMeta>>>`	`getExecutionStartedListeners()`	Gets executionStartedListeners
`List<IExecutionStoppedListener<IPipelineEngine<PipelineMeta>>>`	`getExecutionStoppedListeners()`	Gets the list of stop-event listeners for the pipeline.
`Map<String,Object>`	`getExtensionDataMap()`	A map in which the various transforms and plugins can store objects to remember during the lifecycle of the pipeline.
`int`	`getFeedbackSize()`	Gets feedbackSize
`String`	`getFilename()`	Gets the filename of the pipeline, or null if no filename exists
`ILogChannel`	`getLogChannel()`	Gets the log channel interface for the pipeline.
`String`	`getLogChannelId()`	Gets the log channel ID.
`List<LoggingHierarchy>`	`getLoggingHierarchy()`	Gets the logging hierarchy.
`LogLevel`	`getLogLevel()`	Gets the log level.
`IHopMetadataProvider`	`getMetadataProvider()`
`String`	`getName()`	Gets the name of the pipeline.
`String`	`getObjectCopy()`	Gets the object copy.
`String`	`getObjectName()`	Gets the object name.
`LoggingObjectType`	`getObjectType()`	Gets the object type.
`String`	`getParameterDefault(String key)`	Gets the default value of the specified parameter.
`String`	`getParameterDescription(String key)`	Gets the description of the specified parameter.
`String`	`getParameterValue(String key)`	Gets the value of the specified parameter.
`ILoggingObject`	`getParent()`	Gets the parent logging object interface.
`IPipelineEngine`	`getParentPipeline()`	Gets the parent pipeline, which is null if no parent pipeline exists.
`IVariables`	`getParentVariables()`	Gets the parent variable variables.
`IWorkflowEngine<WorkflowMeta>`	`getParentWorkflow()`	Gets the parent workflow, or null if there is no parent.
`PipelineMeta`	`getPipelineMeta()`	Gets the meta-data for the pipeline.
`PipelineRunConfiguration`	`getPipelineRunConfiguration()`	Gets pipelineRunConfiguration
`EngineComponent.ComponentExecutionStatus[]`	`getPipelineTransformExecutionStatusLookup()`	Checks the execution status of each transform in the pipelines.
`boolean[]`	`getPipelineTransformIsRunningLookup()`	Checks whether the pipeline transforms are running lookup.
`String`	`getPluginId()`	Gets pluginId
`Result`	`getPreviousResult()`	Get the execution result of a previous execution in a workflow
`Date`	`getRegistrationDate()`	Gets the registration date.
`Result`	`getResult()`	Gets the result of the pipeline.
`List<ResultFile>`	`getResultFiles()`
`List<RowMetaAndData>`	`getResultRows()`
`List<IRowSet>`	`getRowsets()`	Gets the rowsets for the pipeline.
`int`	`getRowSetSize()`	Gets rowSetSize
`ITransform`	`getRunThread(int i)`	Gets the run thread for the transform at the specified index.
`ITransform`	`getRunThread(String name, int copy)`	Gets the run thread for the transform with the specified name and copy number.
`javax.servlet.http.HttpServletRequest`	`getServletRequest()`
`javax.servlet.http.HttpServletResponse`	`getServletResponse()`
`String`	`getStatus()`	Gets the status of the pipeline (Halting, Finished, Paused, etc.)
`ITransform`	`getTransform(String name, int copyNr)`	Find the ITransform (thread) by looking it up using the name.
`ITransformData`	`getTransformData(String name, int copyNr)`	Finds the ITransformData (currently) associated with the specified transform.
`Map<String,List<PerformanceSnapShot>>`	`getTransformPerformanceSnapShots()`	Gets a named list (map) of transform performance snapshots.
`List<TransformMetaDataCombi>`	`getTransforms()`	Gets a list of transforms in the pipeline.
`List<ITransform>`	`getTransforms(String name)`	Find the available executing transform copies for the transform with the specified name
`String`	`getVariable(String variableName)`	Gets the value of the specified variable, or returns a default value if no such variable exists.
`String`	`getVariable(String variableName, String defaultValue)`	Gets the value of the specified variable, or returns a default value if no such variable exists.
`boolean`	`getVariableBoolean(String variableName, boolean defaultValue)`	Returns a boolean representation of the specified variable after performing any necessary substitution.
`String[]`	`getVariableNames()`	Gets a list of variable names for the pipeline.
`IVariables`	`getVariables()`	Gets variables
`boolean`	`hasHaltedComponents()`	Checks whether the pipeline has any components that are halted.
`boolean`	`hasTransformStarted(String sname, int copy)`	Checks whether the specified transform (or transform copy) has started.
`void`	`initializeFrom(IVariables parent)`	Sets the values of the pipeline's variables to the values from the parent variables.
`boolean`	`isFeedbackShown()`	Gets feedbackShown
`boolean`	`isFinished()`	Checks if the pipeline is finished\.
`boolean`	`isFinishedOrStopped()`
`boolean`	`isForcingSeparateLogging()`
`boolean`	`isGatheringMetrics()`
`boolean`	`isInitializing()`	Checks whether the pipeline is initializing.
`boolean`	`isPaused()`	Checks if the pipeline is paused.
`boolean`	`isPreparing()`	Checks whether the pipeline is preparing for execution.
`boolean`	`isPreview()`	Checks whether the pipeline is being previewed.
`boolean`	`isReadyToStart()`	Checks whether the pipeline is ready to start (i.e.
`boolean`	`isRunning()`	Checks whether the pipeline is running.
`boolean`	`isSafeModeEnabled()`	Checks whether safe mode is enabled.
`boolean`	`isSortingTransformsTopologically()`	Gets sortingTransformsTopologically
`boolean`	`isStopped()`	Checks if the pipeline is stopped.
`String[]`	`listParameters()`	Gets a list of the parameters for the pipeline.
`int`	`nrTransforms()`	Gets the number of transforms in this pipeline.
`void`	`pauseExecution()`	Pauses the pipeline (pause all transforms).
`void`	`prepareExecution()`	Prepares the pipeline for execution.
`void`	`removeAllParameters()`	Remove all parameters.
`String`	`resolve(String aString)`	Substitutes any variable values into the given string, and returns the resolved string.
`String[]`	`resolve(String[] aString)`	Substitutes any variable values into each of the given strings, and returns an array containing the resolved string(s).
`String`	`resolve(String aString, IRowMeta rowMeta, Object[] rowData)`
`void`	`resumeExecution()`	Resumes running the pipeline after a pause (resume all transforms).
`void`	`retrieveComponentOutput(IVariables variables, String componentName, int copyNr, int nrRows, IPipelineComponentRowsReceived rowsReceived)`	Retrieve output rows from a component copy.
`void`	`safeStop()`	Stops only input transforms so that all downstream transforms can finish processing rows that have already been input
`void`	`setActiveSubPipelines(Map<String,IPipelineEngine> activeSubPipelines)`
`void`	`setActiveSubWorkflows(Map<String,IWorkflowEngine<WorkflowMeta>> activeSubWorkflows)`
`void`	`setContainerId(String containerId)`	Sets the container object ID.
`void`	`setDataSamplers(List<IExecutionDataSampler<? extends IExecutionDataSamplerStore>> dataSamplers)`	Sets dataSamplers
`void`	`setExecutingServer(String executingServer)`	Sets the name of the executing server.
`void`	`setExecutingUser(String executingUser)`	Sets the name of the executing user.
`void`	`setExecutionEndDate(Date executionEndDate)`
`void`	`setExecutionFinishedListeners(List<IExecutionFinishedListener<IPipelineEngine<PipelineMeta>>> executionFinishedListeners)`
`void`	`setExecutionStartDate(Date executionStartDate)`
`void`	`setExecutionStartedListeners(List<IExecutionStartedListener<IPipelineEngine<PipelineMeta>>> executionStartedListeners)`
`void`	`setExecutionStoppedListeners(List<IExecutionStoppedListener<IPipelineEngine<PipelineMeta>>> executionStoppedListeners)`	Sets the list of stop-event listeners for the pipeline.
`void`	`setFeedbackShown(boolean feedbackShown)`
`void`	`setFeedbackSize(int feedbackSize)`
`protected void`	`setFinished(boolean finished)`
`void`	`setForcingSeparateLogging(boolean forcingSeparateLogging)`
`void`	`setGatheringMetrics(boolean gatheringMetrics)`
`void`	`setInitializing(boolean initializing)`	Sets whether the pipeline is initializing.
`protected void`	`setInternalEntryCurrentDirectory(boolean hasFilename)`
`void`	`setInternalHopVariables(IVariables var)`	Sets the internal Hop variables.
`void`	`setLogChannel(ILogChannel log)`	Sets the log channel interface for the pipeline.
`void`	`setLogLevel(LogLevel logLevel)`	Sets the log level.
`void`	`setMetadataProvider(IHopMetadataProvider metadataProvider)`
`void`	`setParameterValue(String key, String value)`	Sets the value for the specified parameter.
`void`	`setParent(ILoggingObject parent)`	Sets the parent logging object.
`void`	`setParentPipeline(IPipelineEngine parentPipeline)`	Sets the parent pipeline.
`void`	`setParentVariables(IVariables parent)`	Sets the parent variable variables.
`void`	`setParentWorkflow(IWorkflowEngine<WorkflowMeta> parentWorkflow)`	Sets the parent workflow for the pipeline.
`void`	`setPaused(boolean paused)`
`void`	`setPipelineMeta(PipelineMeta pipelineMeta)`	Sets the meta-data for the pipeline.
`void`	`setPipelineRunConfiguration(PipelineRunConfiguration pipelineRunConfiguration)`
`void`	`setPluginId(String pluginId)`
`void`	`setPreparing(boolean preparing)`	Sets whether the pipeline is preparing for execution.
`void`	`setPreview(boolean preview)`	Sets whether the pipeline is being previewed.
`void`	`setPreviousResult(Result previousResult)`	Inform the pipeline about a previous execution result in a workflow or pipeline
`protected void`	`setReadyToStart(boolean ready)`
`void`	`setResultFiles(List<ResultFile> resultFiles)`
`void`	`setResultRows(List<RowMetaAndData> resultRows)`
`void`	`setRowSetSize(int rowSetSize)`
`void`	`setRunning(boolean running)`	Sets whether the pipeline is running.
`void`	`setSafeModeEnabled(boolean safeModeEnabled)`	Turn on safe mode during running: the pipeline will run slower but with more checking enabled.
`void`	`setServletReponse(javax.servlet.http.HttpServletResponse response)`	Sets encoding of HttpServletResponse according to System encoding.Check if system encoding is null or an empty and set it to HttpServletResponse when not and writes error to log if null.
`void`	`setServletRequest(javax.servlet.http.HttpServletRequest request)`
`void`	`setSortingTransformsTopologically(boolean sortingTransformsTopologically)`
`void`	`setStopped(boolean stopped)`
`void`	`setTransformPerformanceSnapShots(Map<String,List<PerformanceSnapShot>> transformPerformanceSnapShots)`	Sets the named list (map) of transform performance snapshots.
`protected void`	`setTransforms(List<TransformMetaDataCombi> transforms)`
`void`	`setVariable(String variableName, String variableValue)`	Sets the value of the specified variable to the specified value.
`void`	`setVariables(Map<String,String> map)`	Injects variables using the given Map.
`void`	`setVariables(IVariables variables)`
`void`	`shareWith(IVariables variables)`	Shares a variable variables from another variable variables.
`void`	`startThreads()`	Starts the threads prepared by prepareThreads().
`void`	`stopAll()`	Stops all transforms from running, and alerts any registered listeners.
`void`	`stopTransform(TransformMetaDataCombi combi, boolean safeStop)`
`String`	`toString()`	Gets a string representation of the pipeline.
`void`	`waitUntilFinished()`	Waits until all RunThreads have finished.

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.engine.IPipelineEngine
getEngineCapabilities, getStatusDescription, pipelineCompleted

- Field Detail
  - METRIC_NAME_INPUT
```
public static final String METRIC_NAME_INPUT
```
    See Also:
    
    Constant Field Values
  - METRIC_NAME_OUTPUT
```
public static final String METRIC_NAME_OUTPUT
```
    See Also:
    
    Constant Field Values
  - METRIC_NAME_ERROR
```
public static final String METRIC_NAME_ERROR
```
    See Also:
    
    Constant Field Values
  - METRIC_NAME_READ
```
public static final String METRIC_NAME_READ
```
    See Also:
    
    Constant Field Values
  - METRIC_NAME_WRITTEN
```
public static final String METRIC_NAME_WRITTEN
```
    See Also:
    
    Constant Field Values
  - METRIC_NAME_UPDATED
```
public static final String METRIC_NAME_UPDATED
```
    See Also:
    
    Constant Field Values
  - METRIC_NAME_REJECTED
```
public static final String METRIC_NAME_REJECTED
```
    See Also:
    
    Constant Field Values
  - METRIC_NAME_BUFFER_IN
```
public static final String METRIC_NAME_BUFFER_IN
```
    See Also:
    
    Constant Field Values
  - METRIC_NAME_BUFFER_OUT
```
public static final String METRIC_NAME_BUFFER_OUT
```
    See Also:
    
    Constant Field Values
  - METRIC_NAME_FLUSH_BUFFER
```
public static final String METRIC_NAME_FLUSH_BUFFER
```
    See Also:
    
    Constant Field Values
  - METRIC_NAME_INIT
```
public static final String METRIC_NAME_INIT
```
    See Also:
    
    Constant Field Values
  - pluginId
```
protected String pluginId
```
  - pipelineRunConfiguration
```
protected PipelineRunConfiguration pipelineRunConfiguration
```
  - log
```
protected ILogChannel log
```
    The log channel interface.
  - logLevel
```
protected LogLevel logLevel
```
    The log level.
  - containerObjectId
```
protected String containerObjectId
```
    The container object id.
  - logCommitSize
```
protected int logCommitSize
```
    The log commit size.
  - pipelineMeta
```
protected PipelineMeta pipelineMeta
```
    The pipeline metadata to execute.
  - metadataProvider
```
protected IHopMetadataProvider metadataProvider
```
    The MetaStore to use
  - rowsets
```
public List<IRowSet> rowsets
```
    A list of all the row sets.
  - TYPE_DISP_1_1
```
public static final int TYPE_DISP_1_1
```
    Constant indicating a dispatch type of 1-to-1.
    
    See Also:
    
    Constant Field Values
  - TYPE_DISP_1_N
```
public static final int TYPE_DISP_1_N
```
    Constant indicating a dispatch type of 1-to-N.
    
    See Also:
    
    Constant Field Values
  - TYPE_DISP_N_1
```
public static final int TYPE_DISP_N_1
```
    Constant indicating a dispatch type of N-to-1.
    
    See Also:
    
    Constant Field Values
  - TYPE_DISP_N_N
```
public static final int TYPE_DISP_N_N
```
    Constant indicating a dispatch type of N-to-N.
    
    See Also:
    
    Constant Field Values
  - TYPE_DISP_N_M
```
public static final int TYPE_DISP_N_M
```
    Constant indicating a dispatch type of N-to-M.
    
    See Also:
    
    Constant Field Values
  - STRING_FINISHED
```
public static final String STRING_FINISHED
```
    Constant indicating a pipeline status of Finished.
    
    See Also:
    
    Constant Field Values
  - STRING_FINISHED_WITH_ERRORS
```
public static final String STRING_FINISHED_WITH_ERRORS
```
    Constant indicating a pipeline status of Finished (with errors).
    
    See Also:
    
    Constant Field Values
  - STRING_RUNNING
```
public static final String STRING_RUNNING
```
    Constant indicating a pipeline status of Running.
    
    See Also:
    
    Constant Field Values
  - STRING_PAUSED
```
public static final String STRING_PAUSED
```
    Constant indicating a pipeline status of Paused.
    
    See Also:
    
    Constant Field Values
  - STRING_PREPARING
```
public static final String STRING_PREPARING
```
    Constant indicating a pipeline status of Preparing for execution.
    
    See Also:
    
    Constant Field Values
  - STRING_INITIALIZING
```
public static final String STRING_INITIALIZING
```
    Constant indicating a pipeline status of Initializing.
    
    See Also:
    
    Constant Field Values
  - STRING_WAITING
```
public static final String STRING_WAITING
```
    Constant indicating a pipeline status of Waiting.
    
    See Also:
    
    Constant Field Values
  - STRING_STOPPED
```
public static final String STRING_STOPPED
```
    Constant indicating a pipeline status of Stopped.
    
    See Also:
    
    Constant Field Values
  - STRING_STOPPED_WITH_ERRORS
```
public static final String STRING_STOPPED_WITH_ERRORS
```
    Constant indicating a pipeline status of Stopped (with errors).
    
    See Also:
    
    Constant Field Values
  - STRING_HALTING
```
public static final String STRING_HALTING
```
    Constant indicating a pipeline status of Halting.
    
    See Also:
    
    Constant Field Values
  - CONFIGURATION_IN_EXPORT_FILENAME
```
public static final String CONFIGURATION_IN_EXPORT_FILENAME
```
    Constant specifying a filename containing XML to inject into a ZIP file created during resource export.
    
    See Also:
    
    Constant Field Values
  - dataSamplers
```
protected List<IExecutionDataSampler<? extends IExecutionDataSamplerStore>> dataSamplers
```
    Plugins can use this to add additional data samplers to the pipeline.
  - resultRows
```
protected List<RowMetaAndData> resultRows
```
  - resultFiles
```
protected List<ResultFile> resultFiles
```
  - arguments
```
protected String[] arguments
```
    The command line arguments for the pipeline.
  - rowSetSize
```
protected int rowSetSize
```
  - feedbackShown
```
protected boolean feedbackShown
```
    Whether the feedback is shown.
  - feedbackSize
```
protected int feedbackSize
```
    The feedback size.
  - METRIC_INPUT
```
public static final IEngineMetric METRIC_INPUT
```
  - METRIC_READ
```
public static final IEngineMetric METRIC_READ
```
  - METRIC_WRITTEN
```
public static final IEngineMetric METRIC_WRITTEN
```
  - METRIC_OUTPUT
```
public static final IEngineMetric METRIC_OUTPUT
```
  - METRIC_UPDATED
```
public static final IEngineMetric METRIC_UPDATED
```
  - METRIC_REJECTED
```
public static final IEngineMetric METRIC_REJECTED
```
  - METRIC_ERROR
```
public static final IEngineMetric METRIC_ERROR
```
  - METRIC_BUFFER_IN
```
public static final IEngineMetric METRIC_BUFFER_IN
```
  - METRIC_BUFFER_OUT
```
public static final IEngineMetric METRIC_BUFFER_OUT
```
  - METRIC_INIT
```
public static final IEngineMetric METRIC_INIT
```
  - METRIC_FLUSH_BUFFER
```
public static final IEngineMetric METRIC_FLUSH_BUFFER
```
- Constructor Detail
  - Pipeline
```
public Pipeline()
```
    Instantiates a new pipeline.
  - Pipeline
```
public Pipeline(PipelineMeta pipelineMeta)
```
    Initializes a pipeline from pipeline meta-data defined in memory.
    
    Parameters:
    
    pipelineMeta - the pipeline meta-data to use.
  - Pipeline
```
public Pipeline(PipelineMeta pipelineMeta,
                IVariables variables,
                ILoggingObject parent)
```
    Initializes a pipeline from pipeline meta-data defined in memory. Also take into account the parent log channel interface (workflow or pipeline) for logging lineage purposes.
    
    Parameters:
    
    pipelineMeta - the pipeline meta-data to use.
    
    variables - The variables to inherit from
    
    parent - the parent workflow that is executing this pipeline
  - Pipeline
```
public Pipeline(Parent parent,
                String name,
                String filename,
                IHopMetadataProvider metadataProvider)
         throws HopException
```
    Instantiates a new pipeline using any of the provided parameters including the variable bindings, a name and a filename. This contstructor loads the specified pipeline from a file.
    
    Parameters:
    
    parent - the parent variable variables and named params
    
    name - the name of the pipeline
    
    filename - the filename containing the pipeline definition
    
    metadataProvider - The MetaStore to use when referencing metadata objects
    
    Throws:
    
    HopException - if any error occurs during loading, parsing, or creation of the pipeline
- Method Detail
  - setParent
```
public void setParent(ILoggingObject parent)
```
    Sets the parent logging object.
    
    Specified by:
    
    setParent in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    parent - the new parent
  - getLogChannel
```
public ILogChannel getLogChannel()
```
    Gets the log channel interface for the pipeline.
    
    Specified by:
    
    getLogChannel in interface IHasLogChannel
    
    Specified by:
    
    getLogChannel in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    the log channel
    
    See Also:
    
    IHasLogChannel.getLogChannel()
  - setLogChannel
```
public void setLogChannel(ILogChannel log)
```
    Sets the log channel interface for the pipeline.
    
    Specified by:
    
    setLogChannel in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    log - the new log channel interface
  - getName
```
public String getName()
```
    Gets the name of the pipeline.
    
    Returns:
    
    the pipeline name
  - execute
```
public void execute()
             throws HopException
```
    Executes the pipeline. This method will prepare the pipeline for execution and then start all the threads associated with the pipeline and its transforms.
    
    Specified by:
    
    execute in interface IPipelineEngine<PipelineMeta>
    
    Throws:
    
    HopException - if the pipeline could not be prepared (initialized)
  - prepareExecution
```
public void prepareExecution()
                      throws HopException
```
    Prepares the pipeline for execution. This includes setting the arguments and parameters as well as preparing and tracking the transforms and hops in the pipeline.
    
    Specified by:
    
    prepareExecution in interface IPipelineEngine<PipelineMeta>
    
    Throws:
    
    HopException - in case the pipeline could not be prepared (initialized)
  - startThreads
```
public void startThreads()
                  throws HopException
```
    Starts the threads prepared by prepareThreads(). Before you start the threads, you can add RowListeners to them.
    
    Specified by:
    
    startThreads in interface IPipelineEngine<PipelineMeta>
    
    Throws:
    
    HopException - if there is a communication error with a remote output socket.
  - firePipelineExecutionFinishedListeners
```
public void firePipelineExecutionFinishedListeners()
                                            throws HopException
```
    Make attempt to fire all registered finished listeners if possible.
    
    Specified by:
    
    firePipelineExecutionFinishedListeners in interface IPipelineEngine<PipelineMeta>
    
    Throws:
    
    HopException - if any errors occur during notification
  - firePipelineExecutionStartedListeners
```
public void firePipelineExecutionStartedListeners()
                                           throws HopException
```
    Fires the start-event listeners (if any are registered).
    
    Specified by:
    
    firePipelineExecutionStartedListeners in interface IPipelineEngine<PipelineMeta>
    
    Throws:
    
    HopException - if any errors occur during notification
  - addTransformPerformanceSnapShot
```
protected void addTransformPerformanceSnapShot()
```
    Adds a transform performance snapshot.
  - cleanup
```
public void cleanup()
```
    This method performs any cleanup operations, typically called after the pipeline has finished.
    
    Specified by:
    
    cleanup in interface IPipelineEngine<PipelineMeta>
  - waitUntilFinished
```
public void waitUntilFinished()
```
    Waits until all RunThreads have finished.
    
    Specified by:
    
    waitUntilFinished in interface IPipelineEngine<PipelineMeta>
  - getErrors
```
public int getErrors()
```
    Gets the number of errors that have occurred during execution of the pipeline.
    
    Specified by:
    
    getErrors in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    the number of errors
  - isFinished
```
public boolean isFinished()
```
    Checks if the pipeline is finished\.
    
    Specified by:
    
    isFinished in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    true if the pipeline is finished, false otherwise
  - setFinished
```
protected void setFinished(boolean finished)
```
  - isFinishedOrStopped
```
public boolean isFinishedOrStopped()
```
  - findRowSet
```
public IRowSet findRowSet(String from,
                          int fromcopy,
                          String to,
                          int tocopy)
```
    Finds the IRowSet between two transforms (or copies of transforms).
    
    Specified by:
    
    findRowSet in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    from - the name of the "from" transform
    
    fromcopy - the copy number of the "from" transform
    
    to - the name of the "to" transform
    
    tocopy - the copy number of the "to" transform
    
    Returns:
    
    the row set, or null if none found
  - hasTransformStarted
```
public boolean hasTransformStarted(String sname,
                                   int copy)
```
    Checks whether the specified transform (or transform copy) has started.
    
    Parameters:
    
    sname - the transform name
    
    copy - the copy number
    
    Returns:
    
    true the specified transform (or transform copy) has started, false otherwise
  - safeStop
```
public void safeStop()
```
    Stops only input transforms so that all downstream transforms can finish processing rows that have already been input
  - stopAll
```
public void stopAll()
```
    Stops all transforms from running, and alerts any registered listeners.
    
    Specified by:
    
    stopAll in interface IPipelineEngine<PipelineMeta>
  - stopTransform
```
public void stopTransform(TransformMetaDataCombi combi,
                          boolean safeStop)
```
  - firePipelineExecutionStoppedListeners
```
public void firePipelineExecutionStoppedListeners()
```
    Specified by:
    
    firePipelineExecutionStoppedListeners in interface IPipelineEngine<PipelineMeta>
  - nrTransforms
```
public int nrTransforms()
```
    Gets the number of transforms in this pipeline.
    
    Returns:
    
    the number of transforms
  - getPipelineTransformIsRunningLookup
```
public boolean[] getPipelineTransformIsRunningLookup()
```
    Checks whether the pipeline transforms are running lookup.
    
    Returns:
    
    a boolean array associated with the transform list, indicating whether that transform is running a lookup.
  - getPipelineTransformExecutionStatusLookup
```
public EngineComponent.ComponentExecutionStatus[] getPipelineTransformExecutionStatusLookup()
```
    Checks the execution status of each transform in the pipelines.
    
    Returns:
    
    an array associated with the transform list, indicating the status of that transform.
  - getRunThread
```
public ITransform getRunThread(int i)
```
    Gets the run thread for the transform at the specified index.
    
    Parameters:
    
    i - the index of the desired transform
    
    Returns:
    
    a ITransform object corresponding to the run thread for the specified transform
  - getRunThread
```
public ITransform getRunThread(String name,
                               int copy)
```
    Gets the run thread for the transform with the specified name and copy number.
    
    Parameters:
    
    name - the transform name
    
    copy - the copy number
    
    Returns:
    
    a ITransform object corresponding to the run thread for the specified transform
  - calculateBatchIdAndDateRange
```
public void calculateBatchIdAndDateRange()
                                  throws HopPipelineException
```
    Calculate the batch id and date range for the pipeline.
    
    Throws:
    
    HopPipelineException - if there are any errors during calculation
  - beginProcessing
```
public void beginProcessing()
                     throws HopPipelineException
```
    Begin processing. Also handle logging operations related to the start of the pipeline
    
    Throws:
    
    HopPipelineException - the hop pipeline exception
  - getResult
```
public Result getResult()
```
    Gets the result of the pipeline. The Result object contains such measures as the number of errors, number of lines read/written/input/output/updated/rejected, etc.
    
    Specified by:
    
    getResult in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    the Result object containing resulting measures from execution of the pipeline
  - findRunThread
```
public ITransform findRunThread(String transformName)
```
    Find the run thread for the transform with the specified name.
    
    Parameters:
    
    transformName - the transform name
    
    Returns:
    
    a ITransform object corresponding to the run thread for the specified transform
  - isSortingTransformsTopologically
```
public boolean isSortingTransformsTopologically()
```
    Gets sortingTransformsTopologically
    
    Returns:
    
    value of sortingTransformsTopologically
  - setSortingTransformsTopologically
```
public void setSortingTransformsTopologically(boolean sortingTransformsTopologically)
```
    Parameters:
    
    sortingTransformsTopologically - The sortingTransformsTopologically to set
  - getPipelineMeta
```
public PipelineMeta getPipelineMeta()
```
    Gets the meta-data for the pipeline.
    
    Specified by:
    
    getPipelineMeta in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    Returns the pipeline meta-data
  - setPipelineMeta
```
public void setPipelineMeta(PipelineMeta pipelineMeta)
```
    Sets the meta-data for the pipeline.
    
    Specified by:
    
    setPipelineMeta in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    pipelineMeta - The pipeline meta-data to set.
  - getRowsets
```
public List<IRowSet> getRowsets()
```
    Gets the rowsets for the pipeline.
    
    Returns:
    
    a list of rowsets
  - getTransforms
```
public List<TransformMetaDataCombi> getTransforms()
```
    Gets a list of transforms in the pipeline.
    
    Returns:
    
    a list of the transforms in the pipeline
  - setTransforms
```
protected void setTransforms(List<TransformMetaDataCombi> transforms)
```
  - toString
```
public String toString()
```
    Gets a string representation of the pipeline.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation of the pipeline
    
    See Also:
    
    Object.toString()
  - getTransform
```
public ITransform getTransform(String name,
                               int copyNr)
```
    Find the ITransform (thread) by looking it up using the name.
    
    Parameters:
    
    name - The name of the transform to look for
    
    copyNr - The copy number of the transform to look for
    
    Returns:
    
    the ITransform or null if nothing was found.
  - getTransforms
```
public List<ITransform> getTransforms(String name)
```
    Find the available executing transform copies for the transform with the specified name
    
    Parameters:
    
    name - The transform name
    
    Returns:
    
    the list of executing transform copies found or null if no transforms are available yet (incorrect usage)
  - setSafeModeEnabled
```
public void setSafeModeEnabled(boolean safeModeEnabled)
```
    Turn on safe mode during running: the pipeline will run slower but with more checking enabled.
    
    Parameters:
    
    safeModeEnabled - true for safe mode
  - isSafeModeEnabled
```
public boolean isSafeModeEnabled()
```
    Checks whether safe mode is enabled.
    
    Specified by:
    
    isSafeModeEnabled in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    Returns true if the safe mode is enabled: the pipeline will run slower but with more checking enabled
  - addRowProducer
```
public RowProducer addRowProducer(String transformName,
                                  int copynr)
                           throws HopException
```
    This adds a row producer to the pipeline that just got set up. It is preferable to run this BEFORE execute() but after prepareExecution()
    
    Parameters:
    
    transformName - The transform to produce rows for
    
    copynr - The copynr of the transform to produce row for (normally 0 unless you have multiple copies running)
    
    Returns:
    
    the row producer
    
    Throws:
    
    HopException - in case the thread/transform to produce rows for could not be found.
    
    See Also:
    
    execute(), prepareExecution()
  - getParentWorkflow
```
public IWorkflowEngine<WorkflowMeta> getParentWorkflow()
```
    Gets the parent workflow, or null if there is no parent.
    
    Specified by:
    
    getParentWorkflow in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    the parent workflow, or null if there is no parent
  - setParentWorkflow
```
public void setParentWorkflow(IWorkflowEngine<WorkflowMeta> parentWorkflow)
```
    Sets the parent workflow for the pipeline.
    
    Specified by:
    
    setParentWorkflow in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    parentWorkflow - The parent workflow to set
  - getTransformData
```
public ITransformData getTransformData(String name,
                                       int copyNr)
```
    Finds the ITransformData (currently) associated with the specified transform.
    
    Parameters:
    
    name - The name of the transform to look for
    
    copyNr - The copy number (0 based) of the transform
    
    Returns:
    
    The ITransformData or null if non found.
  - hasHaltedComponents
```
public boolean hasHaltedComponents()
```
    Checks whether the pipeline has any components that are halted.
    
    Specified by:
    
    hasHaltedComponents in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    true if one or more components are halted, false otherwise
  - getStatus
```
public String getStatus()
```
    Gets the status of the pipeline (Halting, Finished, Paused, etc.)
    
    Returns:
    
    the status of the pipeline
  - isInitializing
```
public boolean isInitializing()
```
    Checks whether the pipeline is initializing.
    
    Returns:
    
    true if the pipeline is initializing, false otherwise
  - setInitializing
```
public void setInitializing(boolean initializing)
```
    Sets whether the pipeline is initializing.
    
    Parameters:
    
    initializing - true if the pipeline is initializing, false otherwise
  - isPreparing
```
public boolean isPreparing()
```
    Checks whether the pipeline is preparing for execution.
    
    Specified by:
    
    isPreparing in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    true if the pipeline is preparing for execution, false otherwise
  - setPreparing
```
public void setPreparing(boolean preparing)
```
    Sets whether the pipeline is preparing for execution.
    
    Parameters:
    
    preparing - true if the pipeline is preparing for execution, false otherwise
  - isRunning
```
public boolean isRunning()
```
    Checks whether the pipeline is running.
    
    Specified by:
    
    isRunning in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    true if the pipeline is running, false otherwise
  - setRunning
```
public void setRunning(boolean running)
```
    Sets whether the pipeline is running.
    
    Parameters:
    
    running - true if the pipeline is running, false otherwise
  - isReadyToStart
```
public boolean isReadyToStart()
```
    Checks whether the pipeline is ready to start (i.e. execution preparation was successful)
    
    Specified by:
    
    isReadyToStart in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    true if the pipeline was prepared for execution successfully, false otherwise
    
    See Also:
    
    prepareExecution()
  - setReadyToStart
```
protected void setReadyToStart(boolean ready)
```
  - setInternalHopVariables
```
public void setInternalHopVariables(IVariables var)
```
    Sets the internal Hop variables.
    
    Specified by:
    
    setInternalHopVariables in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    var - the new internal hop variables
  - setInternalEntryCurrentDirectory
```
protected void setInternalEntryCurrentDirectory(boolean hasFilename)
```
  - copyFrom
```
public void copyFrom(IVariables variables)
```
    Copies variables from a given variable variables to this pipeline.
    
    Specified by:
    
    copyFrom in interface IVariables
    
    Parameters:
    
    variables - the variable variables
    
    See Also:
    
    IVariables.copyFrom(IVariables)
  - resolve
```
public String resolve(String aString)
```
    Substitutes any variable values into the given string, and returns the resolved string.
    
    Specified by:
    
    resolve in interface IVariables
    
    Parameters:
    
    aString - the string to resolve against environment variables
    
    Returns:
    
    the string after variables have been resolved/susbstituted
    
    See Also:
    
    IVariables.resolve(String)
  - resolve
```
public String[] resolve(String[] aString)
```
    Substitutes any variable values into each of the given strings, and returns an array containing the resolved string(s).
    
    Specified by:
    
    resolve in interface IVariables
    
    Parameters:
    
    aString - an array of strings to resolve against environment variables
    
    Returns:
    
    the array of strings after variables have been resolved/susbstituted
    
    See Also:
    
    IVariables.resolve(String[])
  - resolve
```
public String resolve(String aString,
                      IRowMeta rowMeta,
                      Object[] rowData)
               throws HopValueException
```
    Specified by:
    
    resolve in interface IVariables
    
    Throws:
    
    HopValueException
  - getParentVariables
```
public IVariables getParentVariables()
```
    Gets the parent variable variables.
    
    Specified by:
    
    getParentVariables in interface IVariables
    
    Returns:
    
    the parent variable variables
    
    See Also:
    
    IVariables.getParentVariables()
  - setParentVariables
```
public void setParentVariables(IVariables parent)
```
    Sets the parent variable variables.
    
    Specified by:
    
    setParentVariables in interface IVariables
    
    Parameters:
    
    parent - the new parent variable variables
    
    See Also:
    
    IVariables.setParentVariables( IVariables)
  - getVariable
```
public String getVariable(String variableName,
                          String defaultValue)
```
    Gets the value of the specified variable, or returns a default value if no such variable exists.
    
    Specified by:
    
    getVariable in interface IVariables
    
    Parameters:
    
    variableName - the variable name
    
    defaultValue - the default value
    
    Returns:
    
    the value of the specified variable, or returns a default value if no such variable exists
    
    See Also:
    
    IVariables.getVariable(String, String)
  - getVariable
```
public String getVariable(String variableName)
```
    Gets the value of the specified variable, or returns a default value if no such variable exists.
    
    Specified by:
    
    getVariable in interface IVariables
    
    Parameters:
    
    variableName - the variable name
    
    Returns:
    
    the value of the specified variable, or returns a default value if no such variable exists
    
    See Also:
    
    IVariables.getVariable(String)
  - getVariableBoolean
```
public boolean getVariableBoolean(String variableName,
                                  boolean defaultValue)
```
    Returns a boolean representation of the specified variable after performing any necessary substitution. Truth values include case-insensitive versions of "Y", "YES", "TRUE" or "1".
    
    Specified by:
    
    getVariableBoolean in interface IVariables
    
    Parameters:
    
    variableName - the variable name
    
    defaultValue - the default value
    
    Returns:
    
    a boolean representation of the specified variable after performing any necessary substitution
    
    See Also:
    
    IVariables.getVariableBoolean(String, boolean)
  - initializeFrom
```
public void initializeFrom(IVariables parent)
```
    Sets the values of the pipeline's variables to the values from the parent variables.
    
    Specified by:
    
    initializeFrom in interface IVariables
    
    Parameters:
    
    parent - the parent
    
    See Also:
    
    IVariables.initializeFrom( IVariables)
  - getVariableNames
```
public String[] getVariableNames()
```
    Gets a list of variable names for the pipeline.
    
    Specified by:
    
    getVariableNames in interface IVariables
    
    Returns:
    
    a list of variable names
    
    See Also:
    
    IVariables.getVariableNames()
  - setVariable
```
public void setVariable(String variableName,
                        String variableValue)
```
    Sets the value of the specified variable to the specified value.
    
    Specified by:
    
    setVariable in interface IVariables
    
    Parameters:
    
    variableName - the variable name
    
    variableValue - the variable value
    
    See Also:
    
    IVariables.setVariable(String, String)
  - shareWith
```
public void shareWith(IVariables variables)
```
    Shares a variable variables from another variable variables. This means that the object should take over the variables used as argument.
    
    Specified by:
    
    shareWith in interface IVariables
    
    Parameters:
    
    variables - the variable variables
    
    See Also:
    
    IVariables.shareWith(IVariables)
  - setVariables
```
public void setVariables(Map<String,String> map)
```
    Injects variables using the given Map. The behavior should be that the properties object will be stored and at the time the IVariables is initialized (or upon calling this method if the variables is already initialized). After injecting the link of the properties object should be removed.
    
    Specified by:
    
    setVariables in interface IVariables
    
    Parameters:
    
    map - the property map
    
    See Also:
    
    IVariables.setVariables(Map)
  - pauseExecution
```
public void pauseExecution()
```
    Pauses the pipeline (pause all transforms).
    
    Specified by:
    
    pauseExecution in interface IPipelineEngine<PipelineMeta>
  - resumeExecution
```
public void resumeExecution()
```
    Resumes running the pipeline after a pause (resume all transforms).
    
    Specified by:
    
    resumeExecution in interface IPipelineEngine<PipelineMeta>
  - isPreview
```
public boolean isPreview()
```
    Checks whether the pipeline is being previewed.
    
    Specified by:
    
    isPreview in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    true if the pipeline is being previewed, false otherwise
  - setPreview
```
public void setPreview(boolean preview)
```
    Sets whether the pipeline is being previewed.
    
    Specified by:
    
    setPreview in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    preview - true if the pipeline is being previewed, false otherwise
  - getTransformPerformanceSnapShots
```
public Map<String,List<PerformanceSnapShot>> getTransformPerformanceSnapShots()
```
    Gets a named list (map) of transform performance snapshots.
    
    Returns:
    
    a named list (map) of transform performance snapshots
  - setTransformPerformanceSnapShots
```
public void setTransformPerformanceSnapShots(Map<String,List<PerformanceSnapShot>> transformPerformanceSnapShots)
```
    Sets the named list (map) of transform performance snapshots.
    
    Parameters:
    
    transformPerformanceSnapShots - a named list (map) of transform performance snapshots to set
  - addExecutionStartedListener
```
public void addExecutionStartedListener(IExecutionStartedListener executionStartedListener)
```
    Adds a pipeline started listener.
    
    Specified by:
    
    addExecutionStartedListener in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    executionStartedListener - the pipeline started listener
  - addExecutionFinishedListener
```
public void addExecutionFinishedListener(IExecutionFinishedListener executionFinishedListener)
```
    Adds a pipeline finished listener.
    
    Specified by:
    
    addExecutionFinishedListener in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    executionFinishedListener - the pipeline finished listener
  - addExecutionStoppedListener
```
public void addExecutionStoppedListener(IExecutionStoppedListener executionStoppedListener)
```
    Adds a pipeline stopped listener.
    
    Specified by:
    
    addExecutionStoppedListener in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    executionStoppedListener - the pipeline stopped listener
  - setExecutionStoppedListeners
```
public void setExecutionStoppedListeners(List<IExecutionStoppedListener<IPipelineEngine<PipelineMeta>>> executionStoppedListeners)
```
    Sets the list of stop-event listeners for the pipeline.
    
    Parameters:
    
    executionStoppedListeners - the list of stop-event listeners to set
  - getExecutionStoppedListeners
```
public List<IExecutionStoppedListener<IPipelineEngine<PipelineMeta>>> getExecutionStoppedListeners()
```
    Gets the list of stop-event listeners for the pipeline. This is not concurrent safe. Please note this is mutable implementation only for backward compatibility reasons.
    
    Returns:
    
    the list of stop-event listeners
  - addPipelineStoppedListener
```
public void addPipelineStoppedListener(IExecutionStoppedListener<IPipelineEngine<PipelineMeta>> pipelineStoppedListener)
```
    Adds a stop-event listener to the pipeline.
    
    Parameters:
    
    pipelineStoppedListener - the stop-event listener to add
  - isPaused
```
public boolean isPaused()
```
    Checks if the pipeline is paused.
    
    Specified by:
    
    isPaused in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    true if the pipeline is paused, false otherwise
  - setPaused
```
public void setPaused(boolean paused)
```
  - isStopped
```
public boolean isStopped()
```
    Checks if the pipeline is stopped.
    
    Specified by:
    
    isStopped in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    true if the pipeline is stopped, false otherwise
  - setStopped
```
public void setStopped(boolean stopped)
```
  - addParameterDefinition
```
public void addParameterDefinition(String key,
                                   String defValue,
                                   String description)
                            throws DuplicateParamException
```
    Adds a parameter definition to this pipeline.
    
    Specified by:
    
    addParameterDefinition in interface INamedParameterDefinitions
    
    Parameters:
    
    key - the name of the parameter
    
    defValue - the default value for the parameter
    
    description - the description of the parameter
    
    Throws:
    
    DuplicateParamException - the duplicate param exception
    
    See Also:
    
    INamedParameterDefinitions.addParameterDefinition(String, String, String)
  - getParameterDefault
```
public String getParameterDefault(String key)
                           throws UnknownParamException
```
    Gets the default value of the specified parameter.
    
    Specified by:
    
    getParameterDefault in interface INamedParameterDefinitions
    
    Parameters:
    
    key - the name of the parameter
    
    Returns:
    
    the default value of the parameter
    
    Throws:
    
    UnknownParamException - if the parameter does not exist
    
    See Also:
    
    INamedParameterDefinitions.getParameterDefault(String)
  - getParameterDescription
```
public String getParameterDescription(String key)
                               throws UnknownParamException
```
    Gets the description of the specified parameter.
    
    Specified by:
    
    getParameterDescription in interface INamedParameterDefinitions
    
    Parameters:
    
    key - the name of the parameter
    
    Returns:
    
    the parameter description
    
    Throws:
    
    UnknownParamException - if the parameter does not exist
    
    See Also:
    
    INamedParameterDefinitions.getParameterDescription(String)
  - getParameterValue
```
public String getParameterValue(String key)
                         throws UnknownParamException
```
    Gets the value of the specified parameter.
    
    Specified by:
    
    getParameterValue in interface INamedParameters
    
    Parameters:
    
    key - the name of the parameter
    
    Returns:
    
    the parameter value
    
    Throws:
    
    UnknownParamException - if the parameter does not exist
    
    See Also:
    
    INamedParameters.getParameterValue(String)
  - listParameters
```
public String[] listParameters()
```
    Gets a list of the parameters for the pipeline.
    
    Specified by:
    
    listParameters in interface INamedParameterDefinitions
    
    Returns:
    
    an array of strings containing the names of all parameters for the pipeline
    
    See Also:
    
    INamedParameterDefinitions.listParameters()
  - setParameterValue
```
public void setParameterValue(String key,
                              String value)
                       throws UnknownParamException
```
    Sets the value for the specified parameter.
    
    Specified by:
    
    setParameterValue in interface INamedParameters
    
    Parameters:
    
    key - the name of the parameter
    
    value - the name of the value
    
    Throws:
    
    UnknownParamException - if the parameter does not exist
    
    See Also:
    
    INamedParameters.setParameterValue(String, String)
  - removeAllParameters
```
public void removeAllParameters()
```
    Remove all parameters.
    
    Specified by:
    
    removeAllParameters in interface INamedParameterDefinitions
    
    Specified by:
    
    removeAllParameters in interface INamedParameters
    
    See Also:
    
    INamedParameters.removeAllParameters()
  - clearParameterValues
```
public void clearParameterValues()
```
    Clear the values of all parameters.
    
    Specified by:
    
    clearParameterValues in interface INamedParameters
    
    See Also:
    
    INamedParameters.clearParameterValues()
  - activateParameters
```
public void activateParameters(IVariables variables)
```
    Activates all parameters by setting their values. If no values already exist, the method will attempt to set the parameter to the default value. If no default value exists, the method will set the value of the parameter to the empty string ("").
    
    Specified by:
    
    activateParameters in interface INamedParameters
  - copyParametersFromDefinitions
```
public void copyParametersFromDefinitions(INamedParameterDefinitions definitions)
```
    Specified by:
    
    copyParametersFromDefinitions in interface INamedParameters
  - getParentPipeline
```
public IPipelineEngine getParentPipeline()
```
    Gets the parent pipeline, which is null if no parent pipeline exists.
    
    Specified by:
    
    getParentPipeline in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    a reference to the parent pipeline's Pipeline object, or null if no parent pipeline exists
  - setParentPipeline
```
public void setParentPipeline(IPipelineEngine parentPipeline)
```
    Sets the parent pipeline.
    
    Specified by:
    
    setParentPipeline in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    parentPipeline - the parentPipeline to set
  - getObjectName
```
public String getObjectName()
```
    Gets the object name.
    
    Specified by:
    
    getObjectName in interface ILoggingObject
    
    Returns:
    
    the object name
    
    See Also:
    
    ILoggingObject.getObjectName()
  - getObjectCopy
```
public String getObjectCopy()
```
    Gets the object copy. For Pipeline, this always returns null
    
    Specified by:
    
    getObjectCopy in interface ILoggingObject
    
    Returns:
    
    null
    
    See Also:
    
    ILoggingObject.getObjectCopy()
  - getFilename
```
public String getFilename()
```
    Gets the filename of the pipeline, or null if no filename exists
    
    Specified by:
    
    getFilename in interface ILoggingObject
    
    Returns:
    
    the filename
    
    See Also:
    
    ILoggingObject.getFilename()
  - getLogChannelId
```
public String getLogChannelId()
```
    Gets the log channel ID.
    
    Specified by:
    
    getLogChannelId in interface ILoggingObject
    
    Specified by:
    
    getLogChannelId in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    the log channel ID
    
    See Also:
    
    ILoggingObject.getLogChannelId()
  - getObjectType
```
public LoggingObjectType getObjectType()
```
    Gets the object type. For Pipeline, this always returns LoggingObjectType.PIPELINE
    
    Specified by:
    
    getObjectType in interface ILoggingObject
    
    Returns:
    
    the object type
    
    See Also:
    
    ILoggingObject.getObjectType()
  - getParent
```
public ILoggingObject getParent()
```
    Gets the parent logging object interface.
    
    Specified by:
    
    getParent in interface ILoggingObject
    
    Returns:
    
    the parent
    
    See Also:
    
    ILoggingObject.getParent()
  - getLogLevel
```
public LogLevel getLogLevel()
```
    Gets the log level.
    
    Specified by:
    
    getLogLevel in interface ILoggingObject
    
    Specified by:
    
    getLogLevel in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    the log level
    
    See Also:
    
    ILoggingObject.getLogLevel()
  - setLogLevel
```
public void setLogLevel(LogLevel logLevel)
```
    Sets the log level.
    
    Specified by:
    
    setLogLevel in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    logLevel - the new log level
  - getLoggingHierarchy
```
public List<LoggingHierarchy> getLoggingHierarchy()
```
    Gets the logging hierarchy.
    
    Returns:
    
    the logging hierarchy
  - addActiveSubPipeline
```
public void addActiveSubPipeline(String subPipelineName,
                                 IPipelineEngine subPipeline)
```
    Description copied from interface: IPipelineEngine
    
    Add an active sub-pipeline to allow drill-down in the GUI
    
    Specified by:
    
    addActiveSubPipeline in interface IPipelineEngine<PipelineMeta>
  - getActiveSubPipeline
```
public IPipelineEngine getActiveSubPipeline(String subPipelineName)
```
    Description copied from interface: IPipelineEngine
    
    Get the active sub-pipeline with the given name
    
    Specified by:
    
    getActiveSubPipeline in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    The active pipeline engine or null if it was not found
  - addActiveSubWorkflow
```
public void addActiveSubWorkflow(String subWorkflowName,
                                 IWorkflowEngine<WorkflowMeta> subWorkflow)
```
    Description copied from interface: IPipelineEngine
    
    Add an active sub-workflow to allow drill-down in the GUI
    
    Specified by:
    
    addActiveSubWorkflow in interface IPipelineEngine<PipelineMeta>
  - getActiveSubWorkflow
```
public IWorkflowEngine<WorkflowMeta> getActiveSubWorkflow(String subWorkflowName)
```
    Description copied from interface: IPipelineEngine
    
    Get the active sub-workflow with the given name
    
    Specified by:
    
    getActiveSubWorkflow in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    The active workflow or null if nothing was found
  - getActiveSubWorkflows
```
public Map<String,IWorkflowEngine<WorkflowMeta>> getActiveSubWorkflows()
```
    Gets the active sub-workflows.
    
    Returns:
    
    a map (by name) of the active sub-workflows
  - getContainerId
```
public String getContainerId()
```
    Gets the container object ID.
    
    Specified by:
    
    getContainerId in interface ILoggingObject
    
    Returns:
    
    the HopServer object ID
  - setContainerId
```
public void setContainerId(String containerId)
```
    Sets the container object ID.
    
    Specified by:
    
    setContainerId in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    containerId - the HopServer object ID to set
  - getRegistrationDate
```
public Date getRegistrationDate()
```
    Gets the registration date. For Pipeline, this always returns null
    
    Specified by:
    
    getRegistrationDate in interface ILoggingObject
    
    Returns:
    
    null
  - getExecutingServer
```
public String getExecutingServer()
```
    Gets the name of the executing server.
    
    Specified by:
    
    getExecutingServer in interface IExecutor
    
    Returns:
    
    the executingServer
  - setExecutingServer
```
public void setExecutingServer(String executingServer)
```
    Sets the name of the executing server.
    
    Specified by:
    
    setExecutingServer in interface IExecutor
    
    Parameters:
    
    executingServer - the executingServer to set
  - getExecutingUser
```
public String getExecutingUser()
```
    Gets the name of the executing user.
    
    Specified by:
    
    getExecutingUser in interface IExecutor
    
    Returns:
    
    the executingUser
  - setExecutingUser
```
public void setExecutingUser(String executingUser)
```
    Sets the name of the executing user.
    
    Specified by:
    
    setExecutingUser in interface IExecutor
    
    Parameters:
    
    executingUser - the executingUser to set
  - 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
  - getResultFiles
```
public List<ResultFile> getResultFiles()
```
  - setResultFiles
```
public void setResultFiles(List<ResultFile> resultFiles)
```
  - getResultRows
```
public List<RowMetaAndData> getResultRows()
```
  - setResultRows
```
public void setResultRows(List<RowMetaAndData> resultRows)
```
  - getPreviousResult
```
public Result getPreviousResult()
```
    Description copied from interface: IPipelineEngine
    
    Get the execution result of a previous execution in a workflow
    
    Specified by:
    
    getPreviousResult in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    the previous execution result
  - setPreviousResult
```
public void setPreviousResult(Result previousResult)
```
    Description copied from interface: IPipelineEngine
    
    Inform the pipeline about a previous execution result in a workflow or pipeline
    
    Specified by:
    
    setPreviousResult in interface IPipelineEngine<PipelineMeta>
  - clearError
```
public void clearError()
```
    Clear the error in the pipeline, clear all the rows from all the row sets, to make sure the pipeline can continue with other data. This is intended for use when running single threaded.
  - getMetadataProvider
```
public IHopMetadataProvider getMetadataProvider()
```
    Specified by:
    
    getMetadataProvider in interface IPipelineEngine<PipelineMeta>
  - setMetadataProvider
```
public void setMetadataProvider(IHopMetadataProvider metadataProvider)
```
    Specified by:
    
    setMetadataProvider in interface IPipelineEngine<PipelineMeta>
  - setServletReponse
```
public void setServletReponse(javax.servlet.http.HttpServletResponse response)
```
    Sets encoding of HttpServletResponse according to System encoding.Check if system encoding is null or an empty and set it to HttpServletResponse when not and writes error to log if null. Throw IllegalArgumentException if input parameter is null.
    
    Parameters:
    
    response - the HttpServletResponse to set encoding, mayn't be null
  - getServletResponse
```
public javax.servlet.http.HttpServletResponse getServletResponse()
```
  - setServletRequest
```
public void setServletRequest(javax.servlet.http.HttpServletRequest request)
```
  - getServletRequest
```
public javax.servlet.http.HttpServletRequest getServletRequest()
```
  - doTopologySortOfTransforms
```
public void doTopologySortOfTransforms()
```
  - getExecutionStartDate
```
public Date getExecutionStartDate()
```
    Gets executionStartDate
    
    Specified by:
    
    getExecutionStartDate in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    value of executionStartDate
  - setExecutionStartDate
```
public void setExecutionStartDate(Date executionStartDate)
```
    Parameters:
    
    executionStartDate - The executionStartDate to set
  - getExecutionEndDate
```
public Date getExecutionEndDate()
```
    Gets executionEndDate
    
    Specified by:
    
    getExecutionEndDate in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    value of executionEndDate
  - setExecutionEndDate
```
public void setExecutionEndDate(Date executionEndDate)
```
    Parameters:
    
    executionEndDate - The executionEndDate to set
  - getExtensionDataMap
```
public Map<String,Object> getExtensionDataMap()
```
    Description copied from interface: IPipelineEngine
    
    A map in which the various transforms and plugins can store objects to remember during the lifecycle of the pipeline. TODO This is obviously harder to do in a clustered or remote execution environment. As such it's not clear that it makes sense to leave this method here over time
    
    Specified by:
    
    getExtensionDataMap in interface IExtensionData
    
    Specified by:
    
    getExtensionDataMap in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    The extension data map to use
  - getEngineMetrics
```
public EngineMetrics getEngineMetrics()
```
    Description copied from interface: IPipelineEngine
    
    Collect metrics from the various components in the engine.
    
    Specified by:
    
    getEngineMetrics in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    The engine metrics
  - getEngineMetrics
```
public EngineMetrics getEngineMetrics(String componentName,
                                      int copyNr)
```
    Description copied from interface: IPipelineEngine
    
    Get the engine metrics for a specific component name and/or copy nr
    
    Specified by:
    
    getEngineMetrics in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    componentName - the name of the component or null for all components
    
    copyNr - The copy nr to select or a negative number for all components
    
    Returns:
    
    The engine metrics for the given
  - getComponentLogText
```
public String getComponentLogText(String componentName,
                                  int copyNr)
```
    Description copied from interface: IPipelineEngine
    
    Retrieve the logging text of a particular component in the engine
    
    Specified by:
    
    getComponentLogText in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    componentName - The name of the component (transform)
    
    copyNr - The copy number if multiple components are running in parallel (0 based).
    
    Returns:
    
    The logging text
  - getComponents
```
public List<IEngineComponent> getComponents()
```
    Description copied from interface: IPipelineEngine
    
    Get a list of components
    
    Specified by:
    
    getComponents in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    The list of components in the engine
  - findComponent
```
public IEngineComponent findComponent(String name,
                                      int copyNr)
```
    Description copied from interface: IPipelineEngine
    
    Find a component by name and copy nr
    
    Specified by:
    
    findComponent in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    name - The name of the component to look for (transform)
    
    copyNr - The copy number to match
    
    Returns:
    
    The component or null if nothing was found
  - getComponentCopies
```
public List<IEngineComponent> getComponentCopies(String name)
```
    Description copied from interface: IPipelineEngine
    
    Find all component copies by name
    
    Specified by:
    
    getComponentCopies in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    name - The name of the component to look for (transform)
    
    Returns:
    
    The list of components found
  - getPluginId
```
public String getPluginId()
```
    Gets pluginId
    
    Specified by:
    
    getPluginId in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    value of pluginId
  - setPluginId
```
public void setPluginId(String pluginId)
```
    Specified by:
    
    setPluginId in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    pluginId - The pluginId to set
  - createDefaultPipelineEngineRunConfiguration
```
public IPipelineEngineRunConfiguration createDefaultPipelineEngineRunConfiguration()
```
    Description copied from interface: IPipelineEngine
    
    Ask the engine to generate a default pipeline engine configuration for this engine
    
    Specified by:
    
    createDefaultPipelineEngineRunConfiguration in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    a new pipeline engine run configuration
  - retrieveComponentOutput
```
public void retrieveComponentOutput(IVariables variables,
                                    String componentName,
                                    int copyNr,
                                    int nrRows,
                                    IPipelineComponentRowsReceived rowsReceived)
                             throws HopException
```
    Description copied from interface: IPipelineEngine
    
    Retrieve output rows from a component copy. Pass the rows to the rows received lambda.
    
    Specified by:
    
    retrieveComponentOutput in interface IPipelineEngine<PipelineMeta>
    
    Throws:
    
    HopException
  - addStartedListener
```
public void addStartedListener(IExecutionStartedListener<IPipelineEngine<PipelineMeta>> listener)
                        throws HopException
```
    Throws:
    
    HopException
  - addFinishedListener
```
public void addFinishedListener(IExecutionFinishedListener<IPipelineEngine<PipelineMeta>> listener)
                         throws HopException
```
    Throws:
    
    HopException
  - getRowSetSize
```
public int getRowSetSize()
```
    Gets rowSetSize
    
    Returns:
    
    value of rowSetSize
  - setRowSetSize
```
public void setRowSetSize(int rowSetSize)
```
    Parameters:
    
    rowSetSize - The rowSetSize to set
  - isFeedbackShown
```
public boolean isFeedbackShown()
```
    Gets feedbackShown
    
    Specified by:
    
    isFeedbackShown in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    value of feedbackShown
  - setFeedbackShown
```
public void setFeedbackShown(boolean feedbackShown)
```
    Parameters:
    
    feedbackShown - The feedbackShown to set
  - getFeedbackSize
```
public int getFeedbackSize()
```
    Gets feedbackSize
    
    Specified by:
    
    getFeedbackSize in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    value of feedbackSize
  - setFeedbackSize
```
public void setFeedbackSize(int feedbackSize)
```
    Parameters:
    
    feedbackSize - The feedbackSize to set
  - getExecutionStartedListeners
```
public List<IExecutionStartedListener<IPipelineEngine<PipelineMeta>>> getExecutionStartedListeners()
```
    Gets executionStartedListeners
    
    Returns:
    
    value of executionStartedListeners
  - setExecutionStartedListeners
```
public void setExecutionStartedListeners(List<IExecutionStartedListener<IPipelineEngine<PipelineMeta>>> executionStartedListeners)
```
    Parameters:
    
    executionStartedListeners - The executionStartedListeners to set
  - getExecutionFinishedListeners
```
public List<IExecutionFinishedListener<IPipelineEngine<PipelineMeta>>> getExecutionFinishedListeners()
```
    Gets executionFinishedListeners
    
    Returns:
    
    value of executionFinishedListeners
  - setExecutionFinishedListeners
```
public void setExecutionFinishedListeners(List<IExecutionFinishedListener<IPipelineEngine<PipelineMeta>>> executionFinishedListeners)
```
    Parameters:
    
    executionFinishedListeners - The executionFinishedListeners to set
  - getPipelineRunConfiguration
```
public PipelineRunConfiguration getPipelineRunConfiguration()
```
    Gets pipelineRunConfiguration
    
    Specified by:
    
    getPipelineRunConfiguration in interface IPipelineEngine<PipelineMeta>
    
    Returns:
    
    value of pipelineRunConfiguration
  - setPipelineRunConfiguration
```
public void setPipelineRunConfiguration(PipelineRunConfiguration pipelineRunConfiguration)
```
    Specified by:
    
    setPipelineRunConfiguration in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    pipelineRunConfiguration - The pipelineRunConfiguration to set
  - getActiveSubPipelines
```
public Map<String,IPipelineEngine> getActiveSubPipelines()
```
    Gets activeSubPipelines
    
    Returns:
    
    value of activeSubPipelines
  - setActiveSubPipelines
```
public void setActiveSubPipelines(Map<String,IPipelineEngine> activeSubPipelines)
```
    Parameters:
    
    activeSubPipelines - The activeSubPipelines to set
  - setActiveSubWorkflows
```
public void setActiveSubWorkflows(Map<String,IWorkflowEngine<WorkflowMeta>> activeSubWorkflows)
```
    Parameters:
    
    activeSubWorkflows - The activeSubWorkflows to set
  - getVariables
```
public IVariables getVariables()
```
    Gets variables
    
    Returns:
    
    value of variables
  - setVariables
```
public void setVariables(IVariables variables)
```
    Parameters:
    
    variables - The variables to set
  - getDataSamplers
```
public List<IExecutionDataSampler<? extends IExecutionDataSamplerStore>> getDataSamplers()
```
    Gets dataSamplers
    
    Returns:
    
    value of dataSamplers
  - setDataSamplers
```
public void setDataSamplers(List<IExecutionDataSampler<? extends IExecutionDataSamplerStore>> dataSamplers)
```
    Sets dataSamplers
    
    Parameters:
    
    dataSamplers - value of dataSamplers
  - addExecutionDataSampler
```
public <Store extends IExecutionDataSamplerStore,Sampler extends IExecutionDataSampler<Store>> void addExecutionDataSampler(Sampler sampler)
```
    Description copied from interface: IPipelineEngine
    
    Plugins can add individual data samplers which will act upon the rows passing through the transforms in the pipeline. The execution information collected at this level will be sent to the execution information location if any is defined in the run configuration used to execute this pipeline.
    
    Specified by:
    
    addExecutionDataSampler in interface IPipelineEngine<PipelineMeta>
    
    Parameters:
    
    sampler - The sampler to use

Class Pipeline

Field Summary

Fields inherited from interface org.apache.hop.pipeline.engine.IPipelineEngine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hop.pipeline.engine.IPipelineEngine

Field Detail

METRIC_NAME_INPUT

METRIC_NAME_OUTPUT

METRIC_NAME_ERROR

METRIC_NAME_READ

METRIC_NAME_WRITTEN

METRIC_NAME_UPDATED

METRIC_NAME_REJECTED

METRIC_NAME_BUFFER_IN

METRIC_NAME_BUFFER_OUT

METRIC_NAME_FLUSH_BUFFER

METRIC_NAME_INIT

pluginId

pipelineRunConfiguration

log

logLevel

containerObjectId

logCommitSize

pipelineMeta

metadataProvider

rowsets

TYPE_DISP_1_1

TYPE_DISP_1_N

TYPE_DISP_N_1

TYPE_DISP_N_N

TYPE_DISP_N_M

STRING_FINISHED

STRING_FINISHED_WITH_ERRORS

STRING_RUNNING

STRING_PAUSED

STRING_PREPARING

STRING_INITIALIZING

STRING_WAITING

STRING_STOPPED

STRING_STOPPED_WITH_ERRORS

STRING_HALTING

CONFIGURATION_IN_EXPORT_FILENAME

dataSamplers

resultRows

resultFiles

arguments

rowSetSize

feedbackShown

feedbackSize

METRIC_INPUT

METRIC_READ

METRIC_WRITTEN

METRIC_OUTPUT

METRIC_UPDATED

METRIC_REJECTED

METRIC_ERROR

METRIC_BUFFER_IN

METRIC_BUFFER_OUT

METRIC_INIT

METRIC_FLUSH_BUFFER

Constructor Detail

Pipeline

Pipeline

Pipeline

Pipeline

Method Detail

setParent

getLogChannel

setLogChannel

getName

execute

prepareExecution

startThreads

firePipelineExecutionFinishedListeners

firePipelineExecutionStartedListeners

addTransformPerformanceSnapShot

cleanup

waitUntilFinished