adams.flow.standalone
Class RStandalone

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.standalone.AbstractStandalone
                  adams.flow.standalone.RStandalone

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, Actor, ErrorHandler, Serializable, Comparable

public class RStandalone
extends AbstractStandalone

A standalone flow for R.

Version:

$Revision$

Author:

rsmith

See Also:

Serialized Form

Field Summary

protected ProcessBuilder	builder Used to build the process that will run JRI if it is needed.
protected boolean	m_JRI Whether to use Rserve or JRI.
protected org.rosuda.REngine.Rserve.RConnection	m_Rserve Connection to Rserve
protected RScript	m_Script Script to send to Rserve.

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

RStandalone()

Method Summary

void	cleanUp() Closes the Rserve connection as the panel closes.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Connects to Rserve and feeds it the script.
boolean	getJRI() Return whether to use JRI or not.
RScript	getScript() Returns the script.
String	globalInfo() Overall description of this flow.
String	JRITipText() Help message about this option.
static void	main(String[] args) Main method is only called when this is started in a new process for JRI.
String	ScriptTipText() Description of the script.
void	setJRI(boolean jri) Set whether to use JRI or not.
void	setScript(RScript script) Sets the script to be fed into R.
String	setUp() Sets up the connection to Rserve.

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getQuickInfo, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_Script

protected RScript m_Script

Script to send to Rserve.

m_Rserve

protected org.rosuda.REngine.Rserve.RConnection m_Rserve

Connection to Rserve

m_JRI

protected boolean m_JRI

Whether to use Rserve or JRI.

builder

protected ProcessBuilder builder

Used to build the process that will run JRI if it is needed.

Constructor Detail

RStandalone

public RStandalone()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

getScript

public RScript getScript()

Returns the script.

Returns:

the script

setScript

public void setScript(RScript script)

Sets the script to be fed into R.

Parameters:

script - the script to be fed to R

ScriptTipText

public String ScriptTipText()

Description of the script.

Returns:

string version of the description

getJRI

public boolean getJRI()

Return whether to use JRI or not.

Returns:

whether to use JRI

setJRI

public void setJRI(boolean jri)

Set whether to use JRI or not.

Parameters:

jri - whether to use JRI

JRITipText

public String JRITipText()

Help message about this option.

Returns:

the message

setUp

public String setUp()

Sets up the connection to Rserve.

Specified by:

setUp in interface Actor

Overrides:

setUp in class AbstractActor

doExecute

protected String doExecute()

Connects to Rserve and feeds it the script.

Specified by:

doExecute in class AbstractActor

main

public static void main(String[] args)

Main method is only called when this is started in a new process for JRI.

Parameters:

args - command-line arguments

globalInfo

public String globalInfo()

Overall description of this flow.

Specified by:

globalInfo in class AbstractOptionHandler

cleanUp

public void cleanUp()

Closes the Rserve connection as the panel closes.

Specified by:

cleanUp in interface CleanUpHandler

Specified by:

cleanUp in interface Actor

Overrides:

cleanUp in class AbstractActor