org.ow2.proactive.scheduler.task

Class TaskIdImpl

java.lang.Object

org.ow2.proactive.scheduler.task.TaskIdImpl

All Implemented Interfaces:

Serializable, Comparable<TaskId>, TaskId

public final class TaskIdImpl
extends Object
implements TaskId

Definition of a task identification.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.ow2.proactive.scheduler.common.task.TaskId

ITERATION_SEPARATOR, REPLICATION_SEPARATOR

Method Summary

Modifier and Type	Method and Description
int	compareTo(TaskId that)
static TaskId	createTaskId(JobId jobId, String readableName, long taskId) Create task id, and set task name.
static TaskId	createTaskId(JobId jobId, String readableName, long taskId, String tag) Create task id, and set task name + tag.
boolean	equals(Object o)
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 to this id.
int	getReplicationIndex() When Control Flow actions are performed on Tasks, some tasks are replicated.
String	getTag() Return the tag of the task.
int	hashCode()
long	longValue() Returns a long representation that is unique for the job it is related to.
static TaskId	makeTaskId(String str) Make a new TaskId with the given arguments.
void	setJobId(JobId jobId)
void	setReadableName(String readableName) Set readable name of this TaskId.
void	setTag(String tag)
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 class java.lang.Object

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

Method Detail

createTaskId

public static TaskId createTaskId(JobId jobId,
                                  String readableName,
                                  long taskId)

Create task id, and set task name.

Parameters:

jobId - the id of the enclosing job.

readableName - the human readable name of the task.

taskId - the task identifier value.

Returns:

new TaskId instance.

createTaskId

public static TaskId createTaskId(JobId jobId,
                                  String readableName,
                                  long taskId,
                                  String tag)

Create task id, and set task name + tag.

Parameters:

jobId - the id of the enclosing job.

readableName - the human readable name of the task.

taskId - the task identifier value.

tag - the tag of the task.

Returns:

new TaskId instance.

getJobId

public JobId getJobId()

Returns the job identifier associated with this task.

Specified by:

getJobId in interface TaskId

Returns:

the job identifier associated with this task.

setJobId

public void setJobId(JobId jobId)

getTag

public String getTag()

Description copied from interface: TaskId

Return the tag of the task.

Specified by:

getTag in interface TaskId

Returns:

the tag of the task.

setTag

public void setTag(String tag)

getReadableName

public String getReadableName()

Return the human readable name associated to this id.

Specified by:

getReadableName in interface TaskId

Returns:

the human readable name associated to this id.

setReadableName

public void setReadableName(String readableName)

Set readable name of this TaskId.

Parameters:

readableName - the new human readable name.

compareTo

public int compareTo(TaskId that)

Specified by:

compareTo in interface Comparable<TaskId>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

value

public String value()

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

Specified by:

value in interface TaskId

Returns:

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

longValue

public long longValue()

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

Specified by:

longValue in interface TaskId

Returns:

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

getIterationIndex

public int getIterationIndex()

Description copied from interface: TaskId

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 (TaskId.getReadableName()), this methods safely extracts it and returns it as an int.

Specified by:

getIterationIndex in interface TaskId

Returns:

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

See Also:

TaskId.getIterationIndex()

getReplicationIndex

public int getReplicationIndex()

Description copied from interface: TaskId

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 (TaskId.getReadableName()), this methods safely extracts it and returns it as an int.

Specified by:

getReplicationIndex in interface TaskId

Returns:

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

See Also:

TaskId.getReplicationIndex()

toString

public String toString()

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

Specified by:

toString in interface TaskId

Overrides:

toString in class Object

Returns:

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

makeTaskId

public static TaskId makeTaskId(String str)

Make a new TaskId with the given arguments.

Parameters:

str - the string on which to base the id.

Returns:

the new taskId