Package org.apache.hop.workflow.engine

Interface IWorkflowEngine<T extends WorkflowMeta>

All Superinterfaces:

IExtensionData, ILoggingObject, INamedParameterDefinitions, INamedParameters, IVariables

All Known Implementing Classes:

LocalWorkflowEngine, RemoteWorkflowEngine, Workflow

public interface IWorkflowEngine<T extends WorkflowMeta>
extends IVariables, ILoggingObject, INamedParameters, IExtensionData

Method Summary

Modifier and Type	Method	Description
void	addActionListener(IActionListener<T> refreshJobEntryListener)
void	addWorkflowFinishedListener(IExecutionFinishedListener<IWorkflowEngine<T>> finishedListener)
void	addWorkflowStartedListener(IExecutionStartedListener<IWorkflowEngine<T>> finishedListener)
IWorkflowEngineRunConfiguration	createDefaultWorkflowEngineRunConfiguration()
void	fireWorkflowFinishListeners()
void	fireWorkflowStartedListeners()
List<IActionListener>	getActionListeners()
List<ActionResult>	getActionResults()
Set<ActionMeta>	getActiveActions()
String	getContainerId()
Date	getExecutionEndDate()
Date	getExecutionStartDate()
Map<String,Object>	getExtensionDataMap()
ILogChannel	getLogChannel()
IHopMetadataProvider	getMetadataProvider()
IPipelineEngine<PipelineMeta>	getParentPipeline()
IWorkflowEngine<WorkflowMeta>	getParentWorkflow()
Result	getResult()
String	getStatusDescription()
List<IExecutionFinishedListener<IWorkflowEngine<T>>>	getWorkflowFinishedListeners()
T	getWorkflowMeta()
String	getWorkflowName()
WorkflowRunConfiguration	getWorkflowRunConfiguration()
List<IExecutionStartedListener<IWorkflowEngine<T>>>	getWorkflowStartedListeners()
WorkflowTracker	getWorkflowTracker()
boolean	isActive()
boolean	isFinished()
boolean	isInitialized()
boolean	isInteractive()
boolean	isStopped()
void	setContainerId(String toString)
void	setFinished(boolean b)
void	setInteractive(boolean interactive)
void	setInternalHopVariables()
void	setLogLevel(LogLevel logLevel)
void	setMetadataProvider(IHopMetadataProvider metadataProvider)
void	setParentPipeline(IPipelineEngine<PipelineMeta> pipeline)
void	setParentWorkflow(IWorkflowEngine<WorkflowMeta> workflow)
void	setResult(Result result)
void	setSourceRows(List<RowMetaAndData> sourceRows)
void	setStartActionMeta(ActionMeta actionMeta)
void	setStopped(boolean b)
void	setWorkflowMeta(T workflowMeta)
void	setWorkflowRunConfiguration(WorkflowRunConfiguration workflowRunConfiguration)
Result	startExecution()
void	stopExecution()

Methods inherited from interface org.apache.hop.core.logging.ILoggingObject

getFilename, getLogChannelId, getLogLevel, getObjectCopy, getObjectName, getObjectType, getParent, getRegistrationDate, isForcingSeparateLogging, isGatheringMetrics, setForcingSeparateLogging, setGatheringMetrics

Methods inherited from interface org.apache.hop.core.parameters.INamedParameterDefinitions

addParameterDefinition, getParameterDefault, getParameterDescription, listParameters

Methods inherited from interface org.apache.hop.core.parameters.INamedParameters

activateParameters, clearParameterValues, copyParametersFromDefinitions, getParameterValue, removeAllParameters, setParameterValue

Methods inherited from interface org.apache.hop.core.variables.IVariables

copyFrom, getParentVariables, getVariable, getVariable, getVariableBoolean, getVariableNames, initializeFrom, resolve, resolve, resolve, setParentVariables, setVariable, setVariables, shareWith

Method Detail

getWorkflowName

String getWorkflowName()

startExecution

Result startExecution()

getResult

Result getResult()

setResult

void setResult(Result result)

stopExecution

void stopExecution()

isInitialized

boolean isInitialized()

isActive

boolean isActive()

isFinished

boolean isFinished()

setFinished

void setFinished(boolean b)

isStopped

boolean isStopped()

setStopped

void setStopped(boolean b)

setLogLevel

void setLogLevel(LogLevel logLevel)

getExecutionStartDate

Date getExecutionStartDate()

getExecutionEndDate

Date getExecutionEndDate()

addWorkflowStartedListener

void addWorkflowStartedListener(IExecutionStartedListener<IWorkflowEngine<T>> finishedListener)

getWorkflowFinishedListeners

List<IExecutionFinishedListener<IWorkflowEngine<T>>> getWorkflowFinishedListeners()

addWorkflowFinishedListener

void addWorkflowFinishedListener(IExecutionFinishedListener<IWorkflowEngine<T>> finishedListener)

getWorkflowStartedListeners

List<IExecutionStartedListener<IWorkflowEngine<T>>> getWorkflowStartedListeners()

isInteractive

boolean isInteractive()

setInteractive

void setInteractive(boolean interactive)

getActiveActions

Set<ActionMeta> getActiveActions()

getExtensionDataMap

Map<String,Object> getExtensionDataMap()

Specified by:

getExtensionDataMap in interface IExtensionData

addActionListener

void addActionListener(IActionListener<T> refreshJobEntryListener)

getActionListeners

List<IActionListener> getActionListeners()

setStartActionMeta

void setStartActionMeta(ActionMeta actionMeta)

getWorkflowMeta

T getWorkflowMeta()

setWorkflowMeta

void setWorkflowMeta(T workflowMeta)

getWorkflowTracker

WorkflowTracker getWorkflowTracker()

getActionResults

List<ActionResult> getActionResults()

getLogChannel

ILogChannel getLogChannel()

setWorkflowRunConfiguration

void setWorkflowRunConfiguration(WorkflowRunConfiguration workflowRunConfiguration)

getWorkflowRunConfiguration

WorkflowRunConfiguration getWorkflowRunConfiguration()

createDefaultWorkflowEngineRunConfiguration

IWorkflowEngineRunConfiguration createDefaultWorkflowEngineRunConfiguration()

setParentWorkflow

void setParentWorkflow(IWorkflowEngine<WorkflowMeta> workflow)

getParentWorkflow

IWorkflowEngine<WorkflowMeta> getParentWorkflow()

setParentPipeline

void setParentPipeline(IPipelineEngine<PipelineMeta> pipeline)

getParentPipeline

IPipelineEngine<PipelineMeta> getParentPipeline()

setInternalHopVariables

void setInternalHopVariables()

setSourceRows

void setSourceRows(List<RowMetaAndData> sourceRows)

fireWorkflowFinishListeners

void fireWorkflowFinishListeners()
                          throws HopException

Throws:

HopException

fireWorkflowStartedListeners

void fireWorkflowStartedListeners()
                           throws HopException

Throws:

HopException

setContainerId

void setContainerId(String toString)

getContainerId

String getContainerId()

Specified by:

getContainerId in interface ILoggingObject

getStatusDescription

String getStatusDescription()

setMetadataProvider

void setMetadataProvider(IHopMetadataProvider metadataProvider)

getMetadataProvider

IHopMetadataProvider getMetadataProvider()