org.ow2.proactive.scheduler.common.job

Class JobState

java.lang.Object

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

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

org.ow2.proactive.scheduler.common.job.JobState

All Implemented Interfaces:

Serializable, Comparable<JobState>

Direct Known Subclasses:

ClientJobState, JobStateImpl

@PublicAPI
public abstract class JobState
extends Job
implements Comparable<JobState>

This class contains all informations about the state of the job. It also provides methods and static fields to order the jobs if you hold them in a list. It references the list of task contains in the job.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASC_ORDER Used to sort according to ascendant order
static int	DESC_ORDER Used to sort according to descendant order
static int	FINISHED_RANK
static int	PENDING_RANK
static int	RUNNING_RANK
static int	SORT_BY_DESCRIPTION Used to sort by description
static int	SORT_BY_ID Used to sort by id
static int	SORT_BY_NAME Used to sort by name
static int	SORT_BY_OWNER Used to sort by owner
static int	SORT_BY_PRIORITY Used to sort by priority
static int	SORT_BY_PROJECT Used to sort by project name
static int	SORT_BY_STATUS Used to sort by status
static int	SORT_BY_TYPE Used to sort by type

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
JobState() ProActive default constructor

Method Summary

Modifier and Type	Method and Description
int	compareTo(JobState job)
boolean	equals(Object o)
long	getCumulatedCoreTime() To get the cumulatedCoreTime
abstract String	getDomain() To get the domain name of the job.
long	getFinishedTime() To get the finishedTime
abstract Map<TaskId,TaskState>	getHMTasks() To get the tasks as a hash map.
JobId	getId() To get the id
long	getInErrorTime()
abstract JobInfo	getJobInfo() To get the jobInfo of this job.
String	getName() To get the name of the job.
int	getNumberOfFailedTasks() To get the numberOfFailedTask
int	getNumberOfFaultyTasks() To get the numberOfFailedTask
int	getNumberOfFinishedTasks() To get the numberOfFinishedTask
int	getNumberOfInErrorTasks() To get the numberOfInErrorTask
int	getNumberOfNodes() Returns the number of nodes used by the job since the beginning of its execution
int	getNumberOfNodesInParallel() Returns the number of nodes in parallel used by the job since the beginning of its execution
int	getNumberOfPendingTasks() To get the numberOfPendingTask
int	getNumberOfRunningTasks() To get the numberOfRunningTask
abstract String	getOwner() To get the owner of the job.
JobPriority	getPriority() To get the priority of the job.
long	getRemovedTime() To get the removedTime
Map<String,String>	getRuntimeGenericInformation() Returns job generic information, where job variables, PA_JOB_ID, PA_JOB_NAME and PA_USER were replaced
long	getStartTime() To get the startTime
JobStatus	getStatus() To get the status of the job.
String	getSubmissionMode() Returns the portal name via the job was submitted
long	getSubmittedTime() To get the submittedTime
List<String>	getTags() To get the list of available tags in a job.
List<String>	getTags(String prefix) To get the list of available tags in a job and that matches a given prefix.
TaskStatesPage	getTaskByTagByStatusPaginated(int offset, int limit, String tag, String statusFilter)
TaskStatesPage	getTaskByTagPaginated(String tag, int offset, int limit) To get the paginated filtered tasks by a given tag.
abstract List<TaskState>	getTasks() To get the tasks as an array list.
List<TaskState>	getTasksByTag(String tag) To get the task as an array list and filtered by a given tag.
TaskStatesPage	getTasksPaginated(int offset, int limit) To get the paginated tasks.
TaskStatesPage	getTasksPaginated(String statusFilter, int offset, int limit)
abstract String	getTenant() To get the tenant of the job owner.
int	getTotalNumberOfTasks() To get the totalNumberOfTasks
int	hashCode()
boolean	isFinished() To know if the job is finished or not.
boolean	isToBeRemoved() Get the toBeRemoved property.
static void	setSortingBy(int sortBy) Set the field to sort on.
static void	setSortingOrder(int order) Set the order for the next sort.
String	toString()
abstract void	update(JobInfo jobInfo) To update the content of this job with a jobInfo.
abstract void	update(TaskInfo info) Set the jobInfo contained in the TaskInfo to this job.

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

display, getBucketName, getDescription, getGlobalGenericInformation, getGlobalSpace, getGlobalVariables, getInputSpace, getJobContent, getJobDeadline, getJobExpectedExecutionTime, getLabel, getOutputSpace, getParentId, getProjectName, getStartAt, getType, 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, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PENDING_RANK

public static int PENDING_RANK

RUNNING_RANK

public static int RUNNING_RANK

FINISHED_RANK

public static int FINISHED_RANK

SORT_BY_ID

public static final int SORT_BY_ID

Used to sort by id

See Also:

Constant Field Values

SORT_BY_NAME

public static final int SORT_BY_NAME

Used to sort by name

See Also:

Constant Field Values

SORT_BY_PRIORITY

public static final int SORT_BY_PRIORITY

Used to sort by priority

See Also:

Constant Field Values

SORT_BY_TYPE

public static final int SORT_BY_TYPE

Used to sort by type

See Also:

Constant Field Values

SORT_BY_DESCRIPTION

public static final int SORT_BY_DESCRIPTION

Used to sort by description

See Also:

Constant Field Values

SORT_BY_OWNER

public static final int SORT_BY_OWNER

Used to sort by owner

See Also:

Constant Field Values

SORT_BY_STATUS

public static final int SORT_BY_STATUS

Used to sort by status

See Also:

Constant Field Values

SORT_BY_PROJECT

public static final int SORT_BY_PROJECT

Used to sort by project name

See Also:

Constant Field Values

ASC_ORDER

public static final int ASC_ORDER

Used to sort according to ascendant order

See Also:

Constant Field Values

DESC_ORDER

public static final int DESC_ORDER

Used to sort according to descendant order

See Also:

Constant Field Values

Constructor Detail

JobState

public JobState()

ProActive default constructor

Method Detail

update

public abstract void update(TaskInfo info)

Set the jobInfo contained in the TaskInfo to this job.

Parameters:

info - a taskInfo containing a job info.

update

public abstract void update(JobInfo jobInfo)

To update the content of this job with a jobInfo.

Parameters:

jobInfo - the jobInfo to set

setSortingBy

public static void setSortingBy(int sortBy)

Set the field to sort on.

Parameters:

sortBy - the field on which the sort will be made.

setSortingOrder

public static void setSortingOrder(int order)

Set the order for the next sort.

Parameters:

order -

compareTo

public int compareTo(JobState job)

Specified by:

compareTo in interface Comparable<JobState>

Parameters:

job - The internal job to be compared.

Returns:

a negative integer, zero, or a positive integer as this job is less than, equal to, or greater than the specified job.

See Also:

Comparable.compareTo(java.lang.Object)

getJobInfo

public abstract JobInfo getJobInfo()

To get the jobInfo of this job.

Returns:

the jobInfo of this job.

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()

getPriority

public JobPriority getPriority()

Description copied from class: Job

To get the priority of the job.

Overrides:

getPriority in class Job

Returns:

the priority of the job.

See Also:

Job.getPriority()

getTasks

public abstract List<TaskState> getTasks()

To get the tasks as an array list.

Returns:

the tasks contains in this job.

getHMTasks

public abstract Map<TaskId,TaskState> getHMTasks()

To get the tasks as a hash map.

Returns:

the tasks as a hash map

getTasksByTag

public List<TaskState> getTasksByTag(String tag)

To get the task as an array list and filtered by a given tag.

Parameters:

tag - the used to filter the tasks.

Returns:

the set of filtered task states.

getTasksPaginated

public TaskStatesPage getTasksPaginated(int offset,
                                        int limit)

To get the paginated tasks. The tasks are paginated with the following rule: [offset,limit[

Parameters:

offset - the starting index of the sublist of tasks to get

limit - the last index (non inclusive) of the sublist of tasks to get

Returns:

a TaskStatePage which includes subset of tasks and the total number of all tasks

getTasksPaginated

public TaskStatesPage getTasksPaginated(String statusFilter,
                                        int offset,
                                        int limit)

getTaskByTagPaginated

public TaskStatesPage getTaskByTagPaginated(String tag,
                                            int offset,
                                            int limit)

To get the paginated filtered tasks by a given tag. The filtered tasks are paginated with the following rule: [offset,limit[

Parameters:

tag - used to filter the tasks

offset - the starting index of the sublist of tasks to get

limit - the last index (non inclusive) of the sublist of tasks to get

Returns:

a TaskStatePage which includes subset of filtered tasks and the total number of all filtered tasks

getTaskByTagByStatusPaginated

public TaskStatesPage getTaskByTagByStatusPaginated(int offset,
                                                    int limit,
                                                    String tag,
                                                    String statusFilter)

getTags

public List<String> getTags()

To get the list of available tags in a job.

Returns:

the list of tags.

getTags

public List<String> getTags(String prefix)

To get the list of available tags in a job and that matches a given prefix.

Parameters:

prefix - the prefix used to filter the tags.

Returns:

the list of tags.

getNumberOfFinishedTasks

public int getNumberOfFinishedTasks()

To get the numberOfFinishedTask

Returns:

the numberOfFinishedTask

isFinished

public boolean isFinished()

To know if the job is finished or not.

Returns:

true if the job is finished, false otherwise.

getFinishedTime

public long getFinishedTime()

To get the finishedTime

Returns:

the finishedTime

getNumberOfPendingTasks

public int getNumberOfPendingTasks()

To get the numberOfPendingTask

Returns:

the numberOfPendingTask

getNumberOfRunningTasks

public int getNumberOfRunningTasks()

To get the numberOfRunningTask

Returns:

the numberOfRunningTask

getNumberOfFailedTasks

public int getNumberOfFailedTasks()

To get the numberOfFailedTask

Returns:

the numberOfFailedTask

getNumberOfFaultyTasks

public int getNumberOfFaultyTasks()

To get the numberOfFailedTask

Returns:

the numberOfFailedTask

getNumberOfInErrorTasks

public int getNumberOfInErrorTasks()

To get the numberOfInErrorTask

Returns:

the numberOfInErrorTask

getStartTime

public long getStartTime()

To get the startTime

Returns:

the startTime

getInErrorTime

public long getInErrorTime()

getTotalNumberOfTasks

public int getTotalNumberOfTasks()

To get the totalNumberOfTasks

Returns:

the totalNumberOfTasks

getRemovedTime

public long getRemovedTime()

To get the removedTime

Returns:

the removedTime

getSubmittedTime

public long getSubmittedTime()

To get the submittedTime

Returns:

the submittedTime

getCumulatedCoreTime

public long getCumulatedCoreTime()

To get the cumulatedCoreTime

Returns:

the cumulatedCoreTime

getNumberOfNodes

public int getNumberOfNodes()

Returns the number of nodes used by the job since the beginning of its execution

Returns:

the numberOfNodes

getNumberOfNodesInParallel

public int getNumberOfNodesInParallel()

Returns the number of nodes in parallel used by the job since the beginning of its execution

Returns:

the numberOfNodes in parallel

getSubmissionMode

public String getSubmissionMode()

Returns the portal name via the job was submitted

Overrides:

getSubmissionMode in class Job

Returns:

the portal name

getStatus

public JobStatus getStatus()

To get the status of the job.

Returns:

the status of the job.

getOwner

public abstract String getOwner()

To get the owner of the job.

Returns:

the owner of the job.

getTenant

public abstract String getTenant()

To get the tenant of the job owner.

Returns:

the tenant of the job owner.

getDomain

public abstract String getDomain()

To get the domain name of the job.

Returns:

the domain name of the job owner.

isToBeRemoved

public boolean isToBeRemoved()

Get the toBeRemoved property. If this method returns true, this job is about to be removed from scheduler.

Returns:

the toBeRemoved property.

getName

public String getName()

Description copied from class: Job

To get the name of the job.

Overrides:

getName in class Job

Returns:

the name of the job.

See Also:

Job.getName()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Job

See Also:

Object.toString()

getRuntimeGenericInformation

public Map<String,String> getRuntimeGenericInformation()

Returns job generic information, where job variables, PA_JOB_ID, PA_JOB_NAME and PA_USER were replaced