Package org.apache.hop.workflow.actions.start

Class ActionStart

java.lang.Object

org.apache.hop.workflow.action.ActionBase

org.apache.hop.workflow.actions.start.ActionStart

All Implemented Interfaces:

Cloneable, IAttributes, ICheckResultSource, IExtensionData, IHasLogChannel, ILoggingObject, IVariables, IResourceHolder, IAction

@Action(id="SPECIAL",
        image="ui/images/start.svg",
        name="i18n::ActionStart.Name",
        description="i18n::ActionStart.Description",
        categoryDescription="i18n:org.apache.hop.workflow:ActionCategory.Category.General",
        keywords="i18n::ActionStart.keyword",
        documentationUrl="/workflow/actions/start.html")
public class ActionStart
extends ActionBase
implements Cloneable, IAction

The start action is starting point for workflow execution.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DAILY
static String	ID	Action unique identifier"
static int	INTERVAL
static int	MONTHLY
static int	NOSCHEDULING
static int	WEEKLY

Fields inherited from class org.apache.hop.workflow.action.ActionBase

attributesMap, containerObjectId, entryTransformSetVariablesMap, extensionDataMap, log, parentWorkflow, parentWorkflowMeta

Constructor Summary

Constructors

Constructor	Description
ActionStart()
ActionStart(String name)

Method Summary

Modifier and Type	Method	Description
void	check(List<ICheckResult> remarks, WorkflowMeta workflowMeta, IVariables variables, IHopMetadataProvider metadataProvider)	Allows Action objects to check themselves for consistency
ActionStart	clone()	This method is called when a action is duplicated in HopGui.
boolean	evaluates()
Result	execute(Result previousResult, int nr)	Execute the action.
int	getDayOfMonth()
int	getHour()
int	getIntervalMinutes()
int	getIntervalSeconds()
int	getMinutes()
int	getSchedulerType()
int	getWeekDay()
boolean	isRepeat()
boolean	isStart()	Checks if the action has started
boolean	isUnconditional()	This method must return true if the action supports the unconditional outgoing hop.
void	setDayOfMonth(int dayOfMonth)
void	setHour(int hour)
void	setIntervalMinutes(int intervalMinutes)
void	setIntervalSeconds(int intervalSeconds)
void	setMinutes(int minutes)
void	setRepeat(boolean repeat)
void	setSchedulerType(int schedulerType)
void	setWeekDay(int weekDay)

Methods inherited from class org.apache.hop.workflow.action.ActionBase

clear, copyFrom, equals, exportResources, getAttribute, getAttributes, getAttributesMap, getContainerId, getDescription, getDialogClassName, getEntryTransformSetVariable, getEntryTransformSetVariablesMap, getExtensionDataMap, getFilename, getLogChannel, getLogChannelId, getLogLevel, getMetadataProvider, getName, getObjectCopy, getObjectName, getObjectType, getParent, getParentVariables, getParentWorkflow, getParentWorkflowMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getResourceDependencies, getSqlStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, getVariableBoolean, getVariableNames, getVariables, getXml, hasChanged, hashCode, initializeFrom, isBasic, isDebug, isDetailed, isEvaluation, isForcingSeparateLogging, isGatheringMetrics, isPipeline, isReferencedObjectEnabled, isRowlevel, isWorkflow, loadReferencedObject, loadXml, loadXml, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, resetErrorsBeforeExecution, resolve, resolve, resolve, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setEntryTransformSetVariable, setForcingSeparateLogging, setGatheringMetrics, setLogLevel, setMetadataProvider, setName, setParentVariables, setParentWorkflow, setParentWorkflowMeta, setPluginId, setVariable, setVariables, shareWith, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hop.workflow.action.IAction

clear, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getParentWorkflow, getParentWorkflowMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getResourceDependencies, getSqlStatements, getXml, hasChanged, isEvaluation, isPipeline, isReferencedObjectEnabled, isWorkflow, loadReferencedObject, loadXml, resetErrorsBeforeExecution, setChanged, setChanged, setDescription, setMetadataProvider, setName, setParentWorkflow, setParentWorkflowMeta, setPluginId

Methods inherited from interface org.apache.hop.core.IExtensionData

getExtensionDataMap

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

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

Field Detail

ID

public static final String ID

Action unique identifier"

See Also:

Constant Field Values

NOSCHEDULING

public static final int NOSCHEDULING

See Also:

Constant Field Values

INTERVAL

public static final int INTERVAL

See Also:

Constant Field Values

DAILY

public static final int DAILY

See Also:

Constant Field Values

WEEKLY

public static final int WEEKLY

See Also:

Constant Field Values

MONTHLY

public static final int MONTHLY

See Also:

Constant Field Values

Constructor Detail

ActionStart

public ActionStart()

ActionStart

public ActionStart(String name)

Method Detail

clone

public ActionStart clone()

Description copied from class: ActionBase

This method is called when a action is duplicated in HopGui. It needs to return a deep copy of this action object. It is essential that the implementing class creates proper deep copies if the action configuration is stored in modifiable objects, such as lists or custom helper objects.

Specified by:

clone in interface IAction

Overrides:

clone in class ActionBase

Returns:

a clone of the object

execute

public Result execute(Result previousResult,
                      int nr)
               throws HopWorkflowException

Description copied from interface: IAction

Execute the action. The previous result and number of rows are provided to the method for the purpose of chaining actions, pipelines, etc.

Specified by:

execute in interface IAction

Parameters:

previousResult - the previous result

nr - the number of rows

Returns:

the Result object from execution of this action

Throws:

HopWorkflowException

evaluates

public boolean evaluates()

isUnconditional

public boolean isUnconditional()

Description copied from class: ActionBase

This method must return true if the action supports the unconditional outgoing hop. For ActionBase, this method always returns true

Specified by:

isUnconditional in interface IAction

Overrides:

isUnconditional in class ActionBase

Returns:

true

getSchedulerType

public int getSchedulerType()

getHour

public int getHour()

getMinutes

public int getMinutes()

getWeekDay

public int getWeekDay()

getDayOfMonth

public int getDayOfMonth()

setDayOfMonth

public void setDayOfMonth(int dayOfMonth)

setHour

public void setHour(int hour)

setMinutes

public void setMinutes(int minutes)

setWeekDay

public void setWeekDay(int weekDay)

setSchedulerType

public void setSchedulerType(int schedulerType)

isStart

public boolean isStart()

Description copied from class: ActionBase

Checks if the action has started

Specified by:

isStart in interface IAction

Overrides:

isStart in class ActionBase

Returns:

true if the action has started, false otherwise

isRepeat

public boolean isRepeat()

setRepeat

public void setRepeat(boolean repeat)

getIntervalSeconds

public int getIntervalSeconds()

setIntervalSeconds

public void setIntervalSeconds(int intervalSeconds)

getIntervalMinutes

public int getIntervalMinutes()

setIntervalMinutes

public void setIntervalMinutes(int intervalMinutes)

check

public void check(List<ICheckResult> remarks,
                  WorkflowMeta workflowMeta,
                  IVariables variables,
                  IHopMetadataProvider metadataProvider)

Description copied from class: ActionBase

Allows Action objects to check themselves for consistency

Specified by:

check in interface IAction

Overrides:

check in class ActionBase

Parameters:

remarks - List of CheckResult objects indicating consistency status

workflowMeta - the metadata object for the action

variables - the variable variables to resolve string expressions with variables with

metadataProvider - the MetaStore to load common elements from