com.github.rcaller.rstuff

Class RCaller

java.lang.Object

com.github.rcaller.rstuff.RCaller

public class RCaller
extends Object

Author:

Mehmet Hakan Satman mhsatman@yahoo.com http://stdioe.blogspot.com http://www.mhsatman.com http://code.google.com/p/rcaller

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RCaller(RCode rCode, ROutputParser parser, RStreamHandler rOutput, RStreamHandler rError, MessageSaver messageSaver, TempFileService tempFileService, RCallerOptions rCallerOptions)

Method Summary

Modifier and Type	Method and Description
static RCaller	create()
static RCaller	create(RCallerOptions rCallerOptions)
static RCaller	create(RCode rcode, RCallerOptions rCallerOptions)
void	deleteTempFiles()
String	getCranRepos()
ROutputParser	getParser()
RCallerOptions	getRCallerOptions()
RCode	getRCode()
void	redirectROutputToFile(String name, boolean appendToExisting)
void	redirectROutputToStream(OutputStream o)
void	runAndReturnResult(String var) Runs the current code and returns the R variable "var".
void	runAndReturnResultOnline(String var) Runs the current code in the existing R instance (or in a new one) and returns the R variable "var".
void	runOnly() Executes the code contained in this RCaller instance in s separate process.
void	setGraphicsTheme(GraphicsTheme theme)
void	setRCode(RCode rcode)
void	startStreamConsumers(Process process)
void	StopRCallerOnline()
boolean	stopStreamConsumers() Stops the threads that are emptying the output and error streams of the live but idle R process.

Methods inherited from class java.lang.Object

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

Constructor Detail

RCaller

protected RCaller(RCode rCode,
                  ROutputParser parser,
                  RStreamHandler rOutput,
                  RStreamHandler rError,
                  MessageSaver messageSaver,
                  TempFileService tempFileService,
                  RCallerOptions rCallerOptions)

Method Detail

create

public static RCaller create()

Returns:

default RCaller object

create

public static RCaller create(RCallerOptions rCallerOptions)

create

public static RCaller create(RCode rcode,
                             RCallerOptions rCallerOptions)

stopStreamConsumers

public boolean stopStreamConsumers()

Stops the threads that are emptying the output and error streams of the live but idle R process. If R is still working, this may cause it to hang. If R has finished execution, these threads prevent the operating system from shutting it down, so that the same process is used. Invoke this method when you have used R online and are finished with it.

Returns:

true if rOutput and rError are alive, else return false

startStreamConsumers

public void startStreamConsumers(Process process)

getCranRepos

public String getCranRepos()

getParser

public ROutputParser getParser()

getRCode

public RCode getRCode()

setRCode

public void setRCode(RCode rcode)

setGraphicsTheme

public void setGraphicsTheme(GraphicsTheme theme)

deleteTempFiles

public void deleteTempFiles()

runOnly

public void runOnly()
             throws ExecutionException

Executes the code contained in this RCaller instance in s separate process. Upon completion the process is killed and none of the R variables are returned

Throws:

ExecutionException - if R cannot be run for some reason

runAndReturnResultOnline

public void runAndReturnResultOnline(String var)
                              throws ExecutionException

Runs the current code in the existing R instance (or in a new one) and returns the R variable "var". The R process is kept alive and can be re-used by invoking this method again. When you are done with this process, you must explicitly stop it.

Parameters:

var - The R variable to return

Throws:

ExecutionException - if R cannot be started

See Also:

stopStreamConsumers()

StopRCallerOnline

public void StopRCallerOnline()

runAndReturnResult

public void runAndReturnResult(String var)
                        throws ExecutionException

Runs the current code and returns the R variable "var". The R process is terminated upon completion of this method.

Parameters:

var - the R variable to return

Throws:

ExecutionException - if R could be started; if a temporary file to store the results could not be created; if the temporary file is corrupt. The exact cause will be added to the stack trace

redirectROutputToFile

public void redirectROutputToFile(String name,
                                  boolean appendToExisting)
                           throws FileNotFoundException

Throws:

FileNotFoundException

redirectROutputToStream

public void redirectROutputToStream(OutputStream o)

getRCallerOptions

public RCallerOptions getRCallerOptions()