org.ow2.proactive.scheduler.common.job

Class TaskFlowJob

java.lang.Object

org.ow2.proactive.scheduler.common.task.CommonAttribute

org.ow2.proactive.scheduler.common.job.Job

org.ow2.proactive.scheduler.common.job.TaskFlowJob

All Implemented Interfaces:

Serializable

@PublicAPI
public class TaskFlowJob
extends Job

Use this class to create your job if you want to define a task flow job.
A task flow job or data flow job, is a job that can contain one or more task(s) with the dependencies you want.
To make this type of job, just use the default no arg constructor, and set the properties you want to set.
Then add tasks with the given method addTask(Task) in order to fill the job with your own tasks.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Field Summary

Fields inherited from class org.ow2.proactive.scheduler.common.job.Job

bucketName, description, globalGenericInformation, globalSpace, globalVariables, inputSpace, JOB_DDL, JOB_EXEC_TIME, label, name, outputSpace, priority, projectName, startAt, submissionMode, unresolvedVariables, userSpace, variables, visualization, workflowTags

Fields inherited from class org.ow2.proactive.scheduler.common.task.CommonAttribute

DEFAULT_TASK_RETRY_DELAY, GENERIC_INFO_START_AT_KEY, genericInformation, maxNumberOfExecution, onTaskError, restartTaskOnError, taskRetryDelay, unresolvedGenericInformation

Constructor Summary

Constructors

Constructor and Description
TaskFlowJob() ProActive Empty Constructor

Method Summary

Modifier and Type	Method and Description
void	addTask(Task task) Add a task to this task flow job. The task name must not be null as it is not by default. The task name must also be different for each task as it is used to identify each task result. If not set, the task name will be a generated one : 'task_X' (where X is the Xth added task number)
void	addTasks(List<Task> tasks) Add a list of tasks to this task flow job.
String	display()
Set<Task>	findRootTasks() Find root tasks for this workflow Root tasks are tasks without parent and not targets of a If, Else or Continuation branch
Set<Task>	findTerminalTasks() Find terminal tasks for this workflow Terminal tasks are tasks without children and not source of a If or Else branch
JobId	getId() To get the id
Task	getTask(String name) Get the task corresponding to the given name.
ArrayList<Task>	getTasks() To get the list of tasks.
JobType	getType() To get the type of this job

Methods inherited from class org.ow2.proactive.scheduler.common.job.Job

getBucketName, getDescription, getGlobalGenericInformation, getGlobalSpace, getGlobalVariables, getInputSpace, getJobContent, getJobDeadline, getJobExpectedExecutionTime, getLabel, getName, getOutputSpace, getParentId, getPriority, getProjectName, getStartAt, getSubmissionMode, getUnresolvedVariables, getUserSpace, getVariables, getVariablesAsReplacementMap, getVisualization, getWorkflowTags, setBucketName, setDescription, setGlobalGenericInformation, setGlobalSpace, setGlobalVariables, setInputSpace, setJobContent, setLabel, setName, setOutputSpace, setParentId, setPriority, setProjectName, setStartAt, setSubmissionMode, setUnresolvedVariables, setUserSpace, setVariables, setVisualization, setWorkflowTags, toString, verifyVariableMap

Methods inherited from class org.ow2.proactive.scheduler.common.task.CommonAttribute

addGenericInformation, addGenericInformations, applyReplacementsOnGenericInformation, getGenericInformation, getMaxNumberOfExecution, getMaxNumberOfExecutionProperty, getOnTaskErrorProperty, getRestartTaskOnError, getRestartTaskOnErrorProperty, getTaskRetryDelay, getTaskRetryDelayProperty, getUnresolvedGenericInformation, setGenericInformation, setMaxNumberOfExecution, setOnTaskError, setRestartTaskOnError, setTaskRetryDelay, setUnresolvedGenericInformation

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskFlowJob

public TaskFlowJob()

ProActive Empty Constructor

Method Detail

getType

public JobType getType()

Description copied from class: Job

To get the type of this job

Specified by:

getType in class Job

Returns:

the type of this job

See Also:

Job.getType()

addTask

public void addTask(Task task)
             throws UserException

Add a task to this task flow job.
The task name must not be null as it is not by default.
The task name must also be different for each task as it is used to identify each task result.

If not set, the task name will be a generated one : 'task_X' (where X is the Xth added task number)

Parameters:

task - the task to add.

Throws:

UserException - if a problem occurred while the task is being added.

addTasks

public void addTasks(List<Task> tasks)
              throws UserException

Add a list of tasks to this task flow job. The task names must not be null as it is not by default.
The task names must also be different for each task as it is used to identify each task result.

If not set, the task names will be generated : 'task_X' (where X is the Xth added task number)

Parameters:

tasks - the list of tasks to add.

Throws:

UserException - if a problem occurred while the task is being added.

getTasks

public ArrayList<Task> getTasks()

To get the list of tasks.

Returns:

the list of tasks.

findTerminalTasks

public Set<Task> findTerminalTasks()

Find terminal tasks for this workflow Terminal tasks are tasks without children and not source of a If or Else branch

Returns:

a set of terminal tasks

findRootTasks

public Set<Task> findRootTasks()

Find root tasks for this workflow Root tasks are tasks without parent and not targets of a If, Else or Continuation branch

Returns:

a set of terminal tasks

getTask

public Task getTask(String name)

Get the task corresponding to the given name.

Parameters:

name - the name of the task to look for.

Returns:

the task corresponding to the given name.

getId

public JobId getId()

Description copied from class: Job

To get the id

Specified by:

getId in class Job

Returns:

the id

See Also:

Job.getId()

display

public String display()

Overrides:

display in class Job