org.ow2.proactive.scheduler.task

Class TaskResultImpl

java.lang.Object

org.ow2.proactive.scheduler.task.TaskResultImpl

All Implemented Interfaces:

Serializable, TaskResult

public class TaskResultImpl
extends Object
implements TaskResult

Class representing the task result. A task result can be an exception or a serializable object that you have to cast into your own type. Before getting the object it is recommended that you call the hadException() method. It will tell you if an exception occurred in the task that generate this result.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
TaskResultImpl(TaskId id, byte[] serializedValue, byte[] serializedException, TaskLogs output, boolean isRaw)
TaskResultImpl(TaskId id, byte[] serializedValue, byte[] serializedException, TaskLogs output, Map<String,String> metadata, Map<String,byte[]> propagatedVariables, boolean isRaw)
TaskResultImpl(TaskId id, Serializable value, TaskLogs output, long execDuration) Return a new instance of task result represented by a task id, its result and its output.
TaskResultImpl(TaskId id, Throwable exception)
TaskResultImpl(TaskId id, Throwable exception, TaskLogs output, long execDuration) Return a new instance of task result represented by a task id and its exception.

Method Summary

Modifier and Type	Method and Description
FlowAction	getAction() If a FlowScript was executed on this task, its result is stored so that the action can be performed later when processed by the core.
Throwable	getException() Retrieve the exception threw by the task.
String	getExceptionMessage() Return the exception message, if any, used by dozer mappings.
Map<String,String>	getMetadata() Get metadata associated with this result.
TaskLogs	getOutput() Return the output of the execution, including stdout and stderr.
String	getPreviewerClassName() Get the previewerClassName.
Map<String,byte[]>	getPropagatedVariables() Returns a map of propagated variables.
Map<String,Serializable>	getResultMap() Returns a map of job results
byte[]	getSerializedException() Get the serializedException.
byte[]	getSerializedValue() Get the serializedValue.
long	getTaskDuration() Get the real task duration.
TaskId	getTaskId() To get the id of the task.
Serializable	getValue() Get the value of the task.
Map<String,Serializable>	getVariables() Returns the deserialized version of the propagated variables
boolean	hadException() To know if an exception has occurred on this task.
boolean	isRaw() Returns true if this result contains raw data (i.e.
void	setAction(FlowAction act) If a FlowScript was executed on this task, its result is stored so that the action can be performed later when processed by the core.
void	setException(Throwable ex)
void	setLogs(TaskLogs l)
void	setMetadata(Map<String,String> metadata)
void	setPreviewerClassName(String descClass) Set the class that is able to describe this result.
void	setPropagatedVariables(Map<String,byte[]> propagatedVariables) Sets the propagated variables.
void	setResultMap(Map<String,Serializable> resultMap)
String	toString()
Serializable	value() Get the value of the task.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.apache.log4j.Logger logger

Constructor Detail

TaskResultImpl

public TaskResultImpl(TaskId id,
                      byte[] serializedValue,
                      byte[] serializedException,
                      TaskLogs output,
                      Map<String,String> metadata,
                      Map<String,byte[]> propagatedVariables,
                      boolean isRaw)

TaskResultImpl

public TaskResultImpl(TaskId id,
                      byte[] serializedValue,
                      byte[] serializedException,
                      TaskLogs output,
                      boolean isRaw)

TaskResultImpl

public TaskResultImpl(TaskId id,
                      Throwable exception)

TaskResultImpl

public TaskResultImpl(TaskId id,
                      Serializable value,
                      TaskLogs output,
                      long execDuration)

Return a new instance of task result represented by a task id, its result and its output.

Parameters:

id - the identification of the task that send this result.

value - the result of the task.

output - the output of the task.

execDuration - the execution duration of the task itself

TaskResultImpl

public TaskResultImpl(TaskId id,
                      Throwable exception,
                      TaskLogs output,
                      long execDuration)

Return a new instance of task result represented by a task id and its exception.

Parameters:

id - the identification of the task that send this result.

exception - the exception that occurred in the task.

output - the output of the task.

execDuration - the execution duration of the task itself

Method Detail

getAction

public FlowAction getAction()

If a FlowScript was executed on this task, its result is stored so that the action can be performed later when processed by the core. return the Action to perform for this task

Specified by:

getAction in interface TaskResult

Returns:

the Control Flow action embedded in this TaskResult

setAction

public void setAction(FlowAction act)

If a FlowScript was executed on this task, its result is stored so that the action can be performed later when processed by the core.

Parameters:

act - an Control Flow action to embed in this TaskResult

setLogs

public void setLogs(TaskLogs l)

Parameters:

l - logs of the task

hadException

public boolean hadException()

Description copied from interface: TaskResult

To know if an exception has occurred on this task.

Specified by:

hadException in interface TaskResult

Returns:

true if an exception occurred, false if not.

See Also:

TaskResult.hadException()

setException

public void setException(Throwable ex)

getTaskId

public TaskId getTaskId()

Description copied from interface: TaskResult

To get the id of the task.

Specified by:

getTaskId in interface TaskResult

Returns:

the id of the task.

See Also:

TaskResult.getTaskId()

value

public Serializable value()
                   throws Throwable

Description copied from interface: TaskResult

Get the value of the task. Throw the exception if the task generate

Specified by:

value in interface TaskResult

Returns:

the value of the task.

Throws:

Throwable - If the value has generate an exception.

See Also:

TaskResult.value()

getValue

public Serializable getValue()
                      throws Throwable

Description copied from interface: TaskResult

Get the value of the task. Returns null if an exception occurred during the task execution

Specified by:

getValue in interface TaskResult

Returns:

the value of the task.

Throws:

Throwable

getException

public Throwable getException()

Description copied from interface: TaskResult

Retrieve the exception threw by the task. If the task didn't throw an exception, null is returned

Specified by:

getException in interface TaskResult

Returns:

the exception threw by the task.

See Also:

TaskResult.getException()

getExceptionMessage

public String getExceptionMessage()

Return the exception message, if any, used by dozer mappings.

Returns:

setPreviewerClassName

public void setPreviewerClassName(String descClass)

Set the class that is able to describe this result. See ResultPreview.

Parameters:

descClass - the name of the class that is able to describe this result.

getSerializedValue

public byte[] getSerializedValue()

Get the serializedValue.

Specified by:

getSerializedValue in interface TaskResult

Returns:

the serializedValue.

getMetadata

public Map<String,String> getMetadata()

Description copied from interface: TaskResult

Get metadata associated with this result. Metadata let the task add additional information bound to the result. It is the responsibility of the business-code to define the metadata semantics. For example, if the result contains binary data, the metadata map could contain the binary content type, or the name of the file if the result needs to be written on disk.

Specified by:

getMetadata in interface TaskResult

Returns:

a map of metadata

setMetadata

public void setMetadata(Map<String,String> metadata)

getSerializedException

public byte[] getSerializedException()

Get the serializedException.

Returns:

the serializedException.

getOutput

public TaskLogs getOutput()

Description copied from interface: TaskResult

Return the output of the execution, including stdout and stderr.

Specified by:

getOutput in interface TaskResult

Returns:

the output of the execution, including stdout and stderr.

See Also:

TaskResult.getOutput()

getPreviewerClassName

public String getPreviewerClassName()

Get the previewerClassName.

Returns:

the previewerClassName.

getTaskDuration

public long getTaskDuration()

Get the real task duration. This duration is the CPU time usage of the associated executable.

Returns:

the real task duration.

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

setPropagatedVariables

public void setPropagatedVariables(Map<String,byte[]> propagatedVariables)

Sets the propagated variables.

Parameters:

propagatedVariables - a map of propagated variables

getPropagatedVariables

public Map<String,byte[]> getPropagatedVariables()

Returns a map of propagated variables.

Specified by:

getPropagatedVariables in interface TaskResult

Returns:

a map of byte arrays

getVariables

public Map<String,Serializable> getVariables()
                                      throws IOException,
                                             ClassNotFoundException

Description copied from interface: TaskResult

Returns the deserialized version of the propagated variables

Specified by:

getVariables in interface TaskResult

Returns:

a map of variables

Throws:

IOException

ClassNotFoundException

isRaw

public boolean isRaw()

Description copied from interface: TaskResult

Returns true if this result contains raw data (i.e. a byte array) instead of an object

Specified by:

isRaw in interface TaskResult

Returns:

result object type

getResultMap

public Map<String,Serializable> getResultMap()

Description copied from interface: TaskResult

Returns a map of job results

Specified by:

getResultMap in interface TaskResult

Returns:

merged map of job results

setResultMap

public void setResultMap(Map<String,Serializable> resultMap)