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

Carries out an R function on the input script.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: RStandalone
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-script <adams.core.scripting.RScript> (property: script)
    Script to pass into R.
    default: 
 

Version:

$Revision: 6830 $

Author:

rsmith

See Also:

Serialized Form

Field Summary

protected org.rosuda.REngine.Rserve.RConnection	m_RConn Connection to Rserve
protected Rserve	m_Rserve the Rserve actor.
protected RScript	m_Script The R script.

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_ScopeHandler, 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	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Connects to Rserve and feeds it the script.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
RScript	getScript() Returns the script.
String	globalInfo() Overall description of this flow.
protected void	reset() Ressets the members.
String	scriptTipText() Description of the script.
void	setScript(RScript script) Sets the script to be fed into R.
String	setUp() Sets up the connection to Rserve.
void	wrapUp() Closes the Rserve connection as the panel closes.

Methods inherited from class adams.flow.core.AbstractActor

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

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

The R script.

m_RConn

protected org.rosuda.REngine.Rserve.RConnection m_RConn

Connection to Rserve

m_Rserve

protected Rserve m_Rserve

the Rserve actor.

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

reset

protected void reset()

Ressets the members.

Overrides:

reset 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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Specified by:

getQuickInfo in interface Actor

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

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

globalInfo

public String globalInfo()

Overall description of this flow.

Specified by:

globalInfo in class AbstractOptionHandler

wrapUp

public void wrapUp()

Closes the Rserve connection as the panel closes.

Specified by:

wrapUp in interface Actor

Overrides:

wrapUp in class AbstractActor