org.ow2.proactive.scheduler.common.task.flow

Class FlowScript

java.lang.Object

org.ow2.proactive.scripting.Script<FlowAction>

org.ow2.proactive.scheduler.common.task.flow.FlowScript

All Implemented Interfaces:

Serializable

@PublicAPI
public class FlowScript
extends Script<FlowAction>

Dynamic evaluation of this script determines at runtime if a specific Control Flow operation should be performed in a TaskFlow.

This class wraps information around a Script to determine which FlowAction is attached to this script.

When using the action type FlowActionType.REPLICATE, the value of the replicateRunsVariable determines the number of parallel runs.

Since:

ProActive Scheduling 2.2

See Also:

FlowAction, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	branchSelectionVariable Name of the variable to set in the script to determine which one of the IF or ELSE branch is selected in an IF control flow action
static String	elseBranchSelectedVariable Value to set branchSelectionVariable to signify the ELSE branch should be selected
static String	ifBranchSelectedVariable Value to set branchSelectionVariable to signify the IF branch should be selected
static String	loopVariable Name of the boolean variable to set in the script to determine if a LOOP action is enabled or if the execution should continue
static String	replicateRunsVariable Name of the Integer variable to set in the script to determine the number of parallel runs of a REPLICATE action
static String	resultVariable Name of the variable that will be set in the script's environment to contain the result of the Task executed along this script

Fields inherited from class org.ow2.proactive.scripting.Script

ARGUMENTS_NAME, DEFAULT_OUTPUT_MAX_SIZE, id, logger, MD5, parameters, script, scriptEngineLookupName, url

Constructor Summary

Constructors

Constructor and Description
FlowScript() Hibernate default constructor, use createContinueFlowScript(), createLoopFlowScript(Script, String) or createReplicateFlowScript(Script) to create a FlowScript
FlowScript(FlowScript fl) Copy constructor

Method Summary

Modifier and Type	Method and Description
static FlowScript	createContinueFlowScript()
static FlowScript	createIfFlowScript(Script<?> script, String targetIf, String targetElse, String targetCont) Creates a Control Flow Script configured to perform an IF control flow action
static FlowScript	createIfFlowScript(String script, String targetIf, String targetElse, String targetCont) Creates a Control Flow Script configured to perform an IF control flow action the code will be run using a javascript engine
static FlowScript	createIfFlowScript(String script, String engine, String targetIf, String targetElse, String targetCont) Creates a Control Flow Script configured to perform an IF control flow action
static FlowScript	createLoopFlowScript(Script<?> script, String target) Creates a Control Flow Script configured to perform a LOOP control flow action
static FlowScript	createLoopFlowScript(String script, String target) Creates a Control Flow Script configured to perform a LOOP control flow action the code will be run using a javascript engine
static FlowScript	createLoopFlowScript(String script, String engine, String target) Creates a Control Flow Script configured to perform a LOOP control flow action
static FlowScript	createReplicateFlowScript(Script<?> script) Creates a Control Flow Script configured to perform a REPLICATE control flow action
static FlowScript	createReplicateFlowScript(String script) Creates a Control Flow Script configured to perform a REPLICATE control flow action the code will be run using a javascript engine
static FlowScript	createReplicateFlowScript(String script, String engine) Creates a Control Flow Script configured to perform a Replicate control flow action
String	getActionContinuation() If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetContinuation is the Task on which both if and else branches will join after either one has been executed.
String	getActionTarget() If the Action type (see getActionType()) of this FlowScript is FlowActionType.LOOP, the target is the entry point of the next loop iteration.
String	getActionTargetElse() If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetElse is the branch executed when the If condition fails.
String	getActionType() The Action Type does not have any effect on the execution of the script, but will be used after the execution to determine what Control Flow Action should be performed on the TaskFlow.
protected String	getDefaultScriptName()
String	getId() String identifying the script.
protected Reader	getReader() The reader used to read the script.
protected ScriptResult<FlowAction>	getResult(Object evalResult, Bindings bindings) Return the variable awaited from the script execution
protected void	prepareSpecialBindings(Bindings bindings) Specify the variable awaited from the script execution
void	setActionContinuation(String target) If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetContinuation is the Task on which both if and else branches will join after either one has been executed.
void	setActionContinuation(Task target) If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetContinuation is the Task on which both if and else branches will join after either one has been executed.
void	setActionTarget(String target) If the Action type (see getActionType()) of this FlowScript is FlowActionType.LOOP, the target is the entry point of the next loop iteration.
void	setActionTarget(Task target) If the Action type (see getActionType()) of this FlowScript is FlowActionType.LOOP, the target is the entry point of the next loop iteration.
void	setActionTargetElse(String target) If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetElse is the branch executed when the If condition fails.
void	setActionTargetElse(Task target) If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetElse is the branch executed when the If condition fails.
void	setActionType(FlowActionType type) The Action Type does not have any effect on the execution of the script, but will be used after the execution to determine what Control Flow Action should be performed on the TaskFlow.
void	setActionType(String actionType) The Action Type does not have any effect on the execution of the script, but will be used after the execution to determine what Control Flow Action should be performed on the TaskFlow.

Methods inherited from class org.ow2.proactive.scripting.Script

createScriptEngine, digest, display, equals, execute, execute, fetchScript, fetchScriptWithExceptionHandling, fetchUrlIfNeeded, getEngineName, getParameters, getScript, getScriptName, getScriptUrl, hashCode, overrideDefaultScriptName, prepareBindings, readFile, setScript, toString

Methods inherited from class java.lang.Object

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

Field Detail

resultVariable

public static final String resultVariable

Name of the variable that will be set in the script's environment to contain the result of the Task executed along this script

See Also:

Constant Field Values

loopVariable

public static final String loopVariable

Name of the boolean variable to set in the script to determine if a LOOP action is enabled or if the execution should continue

See Also:

Constant Field Values

replicateRunsVariable

public static final String replicateRunsVariable

Name of the Integer variable to set in the script to determine the number of parallel runs of a REPLICATE action

See Also:

Constant Field Values

branchSelectionVariable

public static final String branchSelectionVariable

Name of the variable to set in the script to determine which one of the IF or ELSE branch is selected in an IF control flow action

See Also:

Constant Field Values

ifBranchSelectedVariable

public static final String ifBranchSelectedVariable

Value to set branchSelectionVariable to signify the IF branch should be selected

See Also:

Constant Field Values

elseBranchSelectedVariable

public static final String elseBranchSelectedVariable

Value to set branchSelectionVariable to signify the ELSE branch should be selected

See Also:

Constant Field Values

Constructor Detail

FlowScript

public FlowScript()

Hibernate default constructor, use createContinueFlowScript(), createLoopFlowScript(Script, String) or createReplicateFlowScript(Script) to create a FlowScript

FlowScript

public FlowScript(FlowScript fl)
           throws InvalidScriptException

Copy constructor

Parameters:

fl - Source script

Throws:

InvalidScriptException

Method Detail

getDefaultScriptName

protected String getDefaultScriptName()

Specified by:

getDefaultScriptName in class Script<FlowAction>

createContinueFlowScript

public static FlowScript createContinueFlowScript()
                                           throws InvalidScriptException

Throws:

InvalidScriptException

createLoopFlowScript

public static FlowScript createLoopFlowScript(String script,
                                              String target)
                                       throws InvalidScriptException

Creates a Control Flow Script configured to perform a LOOP control flow action the code will be run using a javascript engine

Parameters:

script - code of the Javascript script

target - target of the LOOP action

Returns:

a newly allocated and configured Control Flow Script

Throws:

InvalidScriptException

createLoopFlowScript

public static FlowScript createLoopFlowScript(String script,
                                              String engine,
                                              String target)
                                       throws InvalidScriptException

Creates a Control Flow Script configured to perform a LOOP control flow action

Parameters:

script - code of the script

engine - engine running the script

target - target of the LOOP action

Returns:

a newly allocated and configured Control Flow Script

Throws:

InvalidScriptException

createLoopFlowScript

public static FlowScript createLoopFlowScript(Script<?> script,
                                              String target)
                                       throws InvalidScriptException

Creates a Control Flow Script configured to perform a LOOP control flow action

Parameters:

script - the script to execute

target - target of the LOOP action

Returns:

a newly allocated and configured Control Flow Script

Throws:

InvalidScriptException

createIfFlowScript

public static FlowScript createIfFlowScript(String script,
                                            String targetIf,
                                            String targetElse,
                                            String targetCont)
                                     throws InvalidScriptException

Creates a Control Flow Script configured to perform an IF control flow action the code will be run using a javascript engine

Parameters:

script - code of the Javascript script

targetIf - IF branch

targetElse - ELSE branch

targetCont - CONTINUATION branch, can be null

Returns:

a newly allocated and configured Control Flow Script

Throws:

InvalidScriptException

createIfFlowScript

public static FlowScript createIfFlowScript(String script,
                                            String engine,
                                            String targetIf,
                                            String targetElse,
                                            String targetCont)
                                     throws InvalidScriptException

Creates a Control Flow Script configured to perform an IF control flow action

Parameters:

script - code of the script

engine - engine running the script

targetIf - IF branch

targetElse - ELSE branch

targetCont - CONTINUATION branch, can be null

Returns:

a newly allocated and configured Control Flow Script

Throws:

InvalidScriptException

createIfFlowScript

public static FlowScript createIfFlowScript(Script<?> script,
                                            String targetIf,
                                            String targetElse,
                                            String targetCont)
                                     throws InvalidScriptException

Creates a Control Flow Script configured to perform an IF control flow action

Parameters:

script - the script to execute

targetIf - IF branch

targetElse - ELSE branch

targetCont - CONTINUATION branch, can be null

Returns:

a newly allocated and configured Control Flow Script

Throws:

InvalidScriptException

createReplicateFlowScript

public static FlowScript createReplicateFlowScript(String script)
                                            throws InvalidScriptException

Creates a Control Flow Script configured to perform a REPLICATE control flow action the code will be run using a javascript engine

Parameters:

script - code of the Javascript script

Returns:

a newly allocated and configured Control Flow Script

Throws:

InvalidScriptException

createReplicateFlowScript

public static FlowScript createReplicateFlowScript(String script,
                                                   String engine)
                                            throws InvalidScriptException

Creates a Control Flow Script configured to perform a Replicate control flow action

Parameters:

script - code of the script

engine - engine running the script

Returns:

a newly allocated and configured Control Flow Script

Throws:

InvalidScriptException

createReplicateFlowScript

public static FlowScript createReplicateFlowScript(Script<?> script)
                                            throws InvalidScriptException

Creates a Control Flow Script configured to perform a REPLICATE control flow action

Parameters:

script - the script to execute

Returns:

a newly allocated and configured Control Flow Script

Throws:

InvalidScriptException

setActionType

public void setActionType(String actionType)

The Action Type does not have any effect on the execution of the script, but will be used after the execution to determine what Control Flow Action should be performed on the TaskFlow.

Parameters:

actionType - the String representation of the new ActionType of this script,

See Also:

FlowActionType.parse(String)

setActionType

public void setActionType(FlowActionType type)

The Action Type does not have any effect on the execution of the script, but will be used after the execution to determine what Control Flow Action should be performed on the TaskFlow.

Parameters:

type - the ActionType of this script,

getActionType

public String getActionType()

The Action Type does not have any effect on the execution of the script, but will be used after the execution to determine what Control Flow Action should be performed on the TaskFlow.

Returns:

the String representation of the ActionType of this script,

See Also:

FlowActionType.parse(String)

setActionTarget

public void setActionTarget(String target)

If the Action type (see getActionType()) of this FlowScript is FlowActionType.LOOP, the target is the entry point of the next loop iteration. If the Action type is FlowActionType.IF, the target is the branch executed when the If condition succeeds.

This value has no effect on the execution of the script

Parameters:

target - the main target of the action of this script.

setActionTarget

public void setActionTarget(Task target)

If the Action type (see getActionType()) of this FlowScript is FlowActionType.LOOP, the target is the entry point of the next loop iteration. If the Action type is FlowActionType.IF, the target is the branch executed when the If condition succeeds.

This value has no effect on the execution of the script

Parameters:

target - the main target of the action of this script.

getActionTarget

public String getActionTarget()

If the Action type (see getActionType()) of this FlowScript is FlowActionType.LOOP, the target is the entry point of the next loop iteration. If the Action type is FlowActionType.IF, the target is the branch executed when the If condition succeeds.

This value has no effect on the execution of the script

Returns:

the main target of the action of this script

setActionTargetElse

public void setActionTargetElse(String target)

If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetElse is the branch executed when the If condition fails.

This value has no effect on the execution of the script

Parameters:

target - the Else target of the action of this script

setActionTargetElse

public void setActionTargetElse(Task target)

If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetElse is the branch executed when the If condition fails.

This value has no effect on the execution of the script

Parameters:

target - the Else target of the action of this script

getActionTargetElse

public String getActionTargetElse()

If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetElse is the branch executed when the If condition fails.

This value has no effect on the execution of the script

Returns:

the Else target of the action of this script

setActionContinuation

public void setActionContinuation(String target)

If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetContinuation is the Task on which both if and else branches will join after either one has been executed.

This value has no effect on the execution of the script

Parameters:

target - the Continuation target of the action of this script

setActionContinuation

public void setActionContinuation(Task target)

If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetContinuation is the Task on which both if and else branches will join after either one has been executed.

This value has no effect on the execution of the script

Parameters:

target - the Continuation target of the action of this script

getActionContinuation

public String getActionContinuation()

If the Action type (see getActionType()) of this FlowScript is FlowActionType.IF, the targetContinuation is the Task on which both if and else branches will join after either one has been executed.

This value has no effect on the execution of the script

Returns:

the Continuation target of the action of this script

getId

public String getId()

Description copied from class: Script

String identifying the script.

Overrides:

getId in class Script<FlowAction>

Returns:

a String identifying the script.

getReader

protected Reader getReader()

Description copied from class: Script

The reader used to read the script.

Overrides:

getReader in class Script<FlowAction>

getResult

protected ScriptResult<FlowAction> getResult(Object evalResult,
                                             Bindings bindings)

Description copied from class: Script

Return the variable awaited from the script execution

Specified by:

getResult in class Script<FlowAction>

prepareSpecialBindings

protected void prepareSpecialBindings(Bindings bindings)

Description copied from class: Script

Specify the variable awaited from the script execution

Specified by:

prepareSpecialBindings in class Script<FlowAction>