io.onetapbeyond.renjin.r.executor

Interface RenjinResult

All Superinterfaces:

java.io.Serializable

public interface RenjinResult
extends java.io.Serializable

Executable R task result data. Generated by a call on RenjinTask.execute(). A result instance can be queried to determine success or failure of a task execution. On success, the task result data is made available on the output() method. On failure, the cause of the failure can be determined by querying the error() and cause() methods respectively. The original data inputs on the RenjinTask are made available on the input() method.

Method Summary

Modifier and Type	Method and Description
java.lang.Throwable	cause() Returns cause of error on task execution failure.
java.lang.String	error() Returns error message on task execution failure.
java.util.Map<java.lang.String,java.lang.Object>	input() Returns data inputs passed on task execution.
org.renjin.sexp.SEXP	output() Returns data outputs generated on task execution.
boolean	success() Returns status of task execution.
long	timeTaken() Returns approximate time taken (ms) by task execution.

Method Detail

success

boolean success()

Returns status of task execution.

Returns:

true if the task execution was successful, otherwise false

error

java.lang.String error()

Returns error message on task execution failure.

Returns:

error message on task execution failure, otherwise null

cause

java.lang.Throwable cause()

Returns cause of error on task execution failure.

Returns:

cause of error on task execution failure, otherwise null

timeTaken

long timeTaken()

Returns approximate time taken (ms) by task execution.

Returns:

time taken (ms) on task execution success, otherwise zero

input

java.util.Map<java.lang.String,java.lang.Object> input()

Returns data inputs passed on task execution.

Returns:

data inputs passed on task execution.

output

org.renjin.sexp.SEXP output()

Returns data outputs generated on task execution.

Returns:

data outputs generated on task execution.