org.ow2.proactive.scheduler.job

Class JobResultImpl

java.lang.Object

org.ow2.proactive.scheduler.job.JobResultImpl

All Implemented Interfaces:

Serializable, JobResult

public class JobResultImpl
extends Object
implements JobResult

Class representing a job result. A job result is a map of task result. The key of the map is the name of the task on which to get the result. To identify the job result, it provides the id of the job in the scheduler and the job name.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobResultImpl() ProActive empty constructor

Method Summary

Modifier and Type	Method and Description
void	addTaskResult(String taskName, TaskResult taskResult, boolean isPrecious) -- For internal use only -- Add a new task result to this job result. Used by the scheduler to fill your job result.
void	addToAllResults(String taskName) Add this new (from replication) task result to the list of known tasks.
Map<String,TaskResult>	getAllResults() Return every task results of this job as a mapping between user task name (in XML job description) and its task result. User that wants to get a specific result may get this map and ask for a specific mapping or use the JobResult.getResult(String) method.
Map<String,TaskResult>	getExceptionResults() Return only the task results that have generated an exception. User that wants to get a specific result may get this map and ask for a specific mapping.
JobId	getJobId() To get the id of the job corresponding to this result.
JobInfo	getJobInfo() Return the information of the corresponding job
String	getName() To get the name of the job that has generate this result.
Map<String,TaskResult>	getPreciousResults() Return only the precious results of this job as a mapping between user task name (in XML job description) and its task result. User that wants to get a specific result may get this map and ask for a specific mapping.
TaskResult	getResult(String taskName) Return the task Result corresponding to the given name.
Map<String,Serializable>	getResultMap() Each task can contribute to this map.
boolean	hadException() Returns true if the job has generated an exception, false if not.
void	removeResult(String taskName) Remove the result of the given task in this jobResult.
void	setJobInfo(JobInfo jobInfo) Set the job info for this result
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JobResultImpl

public JobResultImpl()

ProActive empty constructor

Method Detail

getJobId

public JobId getJobId()

Description copied from interface: JobResult

To get the id of the job corresponding to this result.

Specified by:

getJobId in interface JobResult

Returns:

the id of the job corresponding to this result.

See Also:

JobResult.getJobId()

getName

public String getName()

Description copied from interface: JobResult

To get the name of the job that has generate this result.

Specified by:

getName in interface JobResult

Returns:

the name of the job that has generate this result.

See Also:

JobResult.getName()

getJobInfo

public JobInfo getJobInfo()

Description copied from interface: JobResult

Return the information of the corresponding job

Specified by:

getJobInfo in interface JobResult

Returns:

the information of the corresponding job

See Also:

JobResult.getJobInfo()

setJobInfo

public void setJobInfo(JobInfo jobInfo)

Set the job info for this result

Parameters:

jobInfo - the current job info to set

addTaskResult

public void addTaskResult(String taskName,
                          TaskResult taskResult,
                          boolean isPrecious)

-- For internal use only -- Add a new task result to this job result.
Used by the scheduler to fill your job result.

Parameters:

taskName - user define name (in XML) of the task.

taskResult - the corresponding result of the task.

isPrecious - true if this taskResult is a precious one. It will figure out in the precious result list.

addToAllResults

public void addToAllResults(String taskName)

Add this new (from replication) task result to the list of known tasks.

Parameters:

taskName - the name of the new task to add

getAllResults

public Map<String,TaskResult> getAllResults()

Description copied from interface: JobResult

Return every task results of this job as a mapping between user task name (in XML job description) and its task result.
User that wants to get a specific result may get this map and ask for a specific mapping or use the JobResult.getResult(String) method.

Specified by:

getAllResults in interface JobResult

Returns:

the task result as a map.

See Also:

JobResult.getAllResults()

getExceptionResults

public Map<String,TaskResult> getExceptionResults()

Description copied from interface: JobResult

Return only the task results that have generated an exception.
User that wants to get a specific result may get this map and ask for a specific mapping.

Specified by:

getExceptionResults in interface JobResult

Returns:

the precious results as a map.

See Also:

JobResult.getExceptionResults()

getPreciousResults

public Map<String,TaskResult> getPreciousResults()

Description copied from interface: JobResult

Return only the precious results of this job as a mapping between user task name (in XML job description) and its task result.
User that wants to get a specific result may get this map and ask for a specific mapping.

Specified by:

getPreciousResults in interface JobResult

Returns:

the precious results as a map.

See Also:

JobResult.getPreciousResults()

getResultMap

public Map<String,Serializable> getResultMap()

Description copied from interface: JobResult

Each task can contribute to this map.

Specified by:

getResultMap in interface JobResult

Returns:

merged map of job results

See Also:

JobResult.getResultMap()

getResult

public TaskResult getResult(String taskName)
                     throws UnknownTaskException

Description copied from interface: JobResult

Return the task Result corresponding to the given name. A result is returned if the taskName exist and if the result is available. Null is returned if the task is not finished (has no result).

Specified by:

getResult in interface JobResult

Parameters:

taskName - the task name of the result to get.

Returns:

the result corresponding to the given task name, null if not found or not finished.

Throws:

UnknownTaskException - if the given task name does not exist in this job

See Also:

JobResult.getResult(java.lang.String)

hadException

public boolean hadException()

Description copied from interface: JobResult

Returns true if the job has generated an exception, false if not.

Specified by:

hadException in interface JobResult

Returns:

true if the job has generated an exception.

See Also:

JobResult.hadException()

removeResult

public void removeResult(String taskName)
                  throws UnknownTaskException

Description copied from interface: JobResult

Remove the result of the given task in this jobResult.

Specified by:

removeResult in interface JobResult

Parameters:

taskName - the identification name of the task.

Throws:

UnknownTaskException - if the given task name does not exist in this job

See Also:

JobResult.removeResult(java.lang.String)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()