org.ow2.proactive.scheduler.common.task

Interface TaskId

All Superinterfaces:

Comparable<TaskId>, Serializable

All Known Implementing Classes:

TaskIdImpl

@PublicAPI
public interface TaskId
extends Comparable<TaskId>, Serializable

Definition of a task identification.

Since:

ProActive Scheduling 0.9

Field Summary

Fields

Modifier and Type	Field and Description
static String	ITERATION_SEPARATOR string separator in the task name for indicating the iteration index
static String	REPLICATION_SEPARATOR string separator in the task name for indicating the replication index

Method Summary

Modifier and Type	Method and Description
int	getIterationIndex() When Control Flow actions are performed on Tasks, some tasks are replicated.
JobId	getJobId() Returns the job identifier associated with this task.
String	getReadableName() Return the human readable name associated with this id.
int	getReplicationIndex() When Control Flow actions are performed on Tasks, some tasks are replicated.
String	getTag() Return the tag of the task.
long	longValue() Returns a long representation that is unique for the job it is related to.
String	toString() Returns a String representation that is unique for the scheduler instance it was built for.
String	value() Returns a String representation that is unique for the job it is related to.

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

REPLICATION_SEPARATOR

static final String REPLICATION_SEPARATOR

string separator in the task name for indicating the replication index

See Also:

Constant Field Values

ITERATION_SEPARATOR

static final String ITERATION_SEPARATOR

string separator in the task name for indicating the iteration index

See Also:

Constant Field Values

Method Detail

getJobId

JobId getJobId()

Returns the job identifier associated with this task.

Returns:

the job identifier associated with this task.

getReadableName

String getReadableName()

Return the human readable name associated with this id.

Returns:

the human readable name associated with this id.

getTag

String getTag()

Return the tag of the task.

Returns:

the tag of the task.

value

String value()

Returns a String representation that is unique for the job it is related to. Please look at toString() for a String representation unique for the scheduler instance it was built for.

Returns:

a String representation that is unique for the job it is related to only.

longValue

long longValue()

Returns a long representation that is unique for the job it is related to.

Returns:

a long representation that is unique for the job it is related to.

getIterationIndex

int getIterationIndex()

When Control Flow actions are performed on Tasks, some tasks are replicated. A task replicated by a FlowActionType.IF action is differentiated from the original by an incremented Iteration Index. This index is reflected in the readable name of the Task's id (getReadableName()), this methods safely extracts it and returns it as an int.

Returns:

the iteration number of this task if it was replicated by a IF flow operation (>= 0)

getReplicationIndex

int getReplicationIndex()

When Control Flow actions are performed on Tasks, some tasks are replicated. A task replicated by a FlowActionType.REPLICATE action is differentiated from the original by an incremented Replication Index. This index is reflected in the readable name of the Task's id (getReadableName()), this methods safely extracts it and returns it as an int.

Returns:

the iteration number of this task if it was replicated by a IF flow operation (>= 0)

toString

String toString()

Returns a String representation that is unique for the scheduler instance it was built for.

Overrides:

toString in class Object

Returns:

a String representation that is unique for the scheduler instance it was built for.