Package org.apache.hop.workflow.engines.local

Class LocalWorkflowEngine

java.lang.Object

org.apache.hop.core.variables.Variables

org.apache.hop.workflow.Workflow

org.apache.hop.workflow.engines.local.LocalWorkflowEngine

All Implemented Interfaces:

IExecutor, IExtensionData, IHasLogChannel, ILoggingObject, INamedParameterDefinitions, INamedParameters, IVariables, IWorkflowEngine<WorkflowMeta>

@WorkflowEnginePlugin(id="Local",
                      name="Hop local workflow engine",
                      description="Executes your workflow locally")
public class LocalWorkflowEngine
extends Workflow
implements IWorkflowEngine<WorkflowMeta>

Field Summary

Fields inherited from class org.apache.hop.workflow.Workflow

actionListeners, actionResults, activeActions, CONFIGURATION_IN_EXPORT_FILENAME, containerObjectId, errors, executingServer, executingUser, executionEndDate, executionStartDate, extensionDataMap, interactive, log, logLevel, maxActionsLogged, metadataProvider, namedParams, parentLoggingObject, parentPipeline, parentWorkflow, PKG, result, sourceRows, startActionMeta, startActionResult, status, workflowFinishedListeners, workflowMeta, workflowRunConfiguration, workflowStartedListeners, workflowTracker

Constructor Summary

Constructors

Constructor	Description
LocalWorkflowEngine()
LocalWorkflowEngine(WorkflowMeta workflowMeta)
LocalWorkflowEngine(WorkflowMeta workflowMeta, ILoggingObject parent)

Method Summary

Modifier and Type	Method	Description
IWorkflowEngineRunConfiguration	createDefaultWorkflowEngineRunConfiguration()
void	lookupExecutionInformationLocation()	This method looks up the execution information location specified in the run configuration.
void	registerWorkflowExecutionInformation()	If needed, register this workflow at the specified execution information location.
Result	startExecution()
void	startExecutionInfoTimer()
void	stopExecutionInfoTimer()

Methods inherited from class org.apache.hop.workflow.Workflow

activateParameters, addActionListener, addErrors, addParameterDefinition, addWorkflowFinishedListener, addWorkflowStartedListener, beginProcessing, clearParameterValues, copyParametersFromDefinitions, executeFromStart, fireWorkflowFinishListeners, fireWorkflowStartedListeners, getActionListeners, getActionResults, getActiveActions, getContainerId, getErrors, getExecutingServer, getExecutingUser, getExecutionEndDate, getExecutionStartDate, getExtensionDataMap, getFilename, getLogChannel, getLogChannelId, getLogLevel, getMetadataProvider, getObjectCopy, getObjectName, getObjectType, getParameterDefault, getParameterDescription, getParameterValue, getParent, getParentLoggingObject, getParentPipeline, getParentVariables, getParentWorkflow, getRegistrationDate, getResult, getSourceRows, getStartActionMeta, getStartActionResult, getStatusDescription, getWorkflowFinishedListeners, getWorkflowMeta, getWorkflowName, getWorkflowRunConfiguration, getWorkflowStartedListeners, getWorkflowTracker, isActive, isFinished, isForcingSeparateLogging, isGatheringMetrics, isInitialized, isInteractive, isStopped, listParameters, removeActionListener, removeAllParameters, resetErrors, setActive, setContainerId, setExecutingServer, setExecutingUser, setExecutionEndDate, setExecutionStartDate, setFinished, setForcingSeparateLogging, setGatheringMetrics, setInitialized, setInteractive, setInternalHopVariables, setInternalHopVariables, setLogLevel, setMetadataProvider, setParameterValue, setParentLoggingObject, setParentPipeline, setParentWorkflow, setResult, setSourceRows, setStartActionMeta, setStartActionResult, setStopped, setWorkflowFinishedListeners, setWorkflowMeta, setWorkflowRunConfiguration, setWorkflowStartedListeners, setWorkflowTracker, stopExecution, toString

Methods inherited from class org.apache.hop.core.variables.Variables

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

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface org.apache.hop.workflow.engine.IWorkflowEngine

addActionListener, addWorkflowFinishedListener, addWorkflowStartedListener, fireWorkflowFinishListeners, fireWorkflowStartedListeners, getActionListeners, getActionResults, getActiveActions, getContainerId, getExecutionEndDate, getExecutionStartDate, getExtensionDataMap, getLogChannel, getMetadataProvider, getParentPipeline, getParentWorkflow, getResult, getStatusDescription, getWorkflowFinishedListeners, getWorkflowMeta, getWorkflowName, getWorkflowRunConfiguration, getWorkflowStartedListeners, getWorkflowTracker, isActive, isFinished, isInitialized, isInteractive, isStopped, setContainerId, setFinished, setInteractive, setInternalHopVariables, setLogLevel, setMetadataProvider, setParentPipeline, setParentWorkflow, setResult, setSourceRows, setStartActionMeta, setStopped, setWorkflowMeta, setWorkflowRunConfiguration, stopExecution

Constructor Detail

LocalWorkflowEngine

public LocalWorkflowEngine()

LocalWorkflowEngine

public LocalWorkflowEngine(WorkflowMeta workflowMeta)

LocalWorkflowEngine

public LocalWorkflowEngine(WorkflowMeta workflowMeta,
                           ILoggingObject parent)

Method Detail

createDefaultWorkflowEngineRunConfiguration

public IWorkflowEngineRunConfiguration createDefaultWorkflowEngineRunConfiguration()

Specified by:

createDefaultWorkflowEngineRunConfiguration in interface IWorkflowEngine<WorkflowMeta>

startExecution

public Result startExecution()

Specified by:

startExecution in interface IWorkflowEngine<WorkflowMeta>

Overrides:

startExecution in class Workflow

lookupExecutionInformationLocation

public void lookupExecutionInformationLocation()

This method looks up the execution information location specified in the run configuration.

Throws:

HopException - In case something fundamental went wrong.

registerWorkflowExecutionInformation

public void registerWorkflowExecutionInformation()

If needed, register this workflow at the specified execution information location. The name of the location is specified in the run configuration.

Throws:

HopException - In case something goes wrong

startExecutionInfoTimer

public void startExecutionInfoTimer()

stopExecutionInfoTimer

public void stopExecutionInfoTimer()
                            throws HopException

Throws:

HopException