adams.flow.sink
Class RSink

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.sink.AbstractSink
                  adams.flow.sink.RSink

All Implemented Interfaces:

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

public class RSink
extends AbstractSink

A sink flow for R.

Version:

$Revision$

Author:

rsmith

See Also:

Serialized Form

Field Summary

static String	INPUT the placeholder for the input value.
protected org.rosuda.REngine.Rserve.RConnection	m_Rserve Connection to Rserve
protected RScript	m_Script Script to pass to r

Fields inherited from class adams.flow.sink.AbstractSink

BACKUP_INPUT, m_InputToken

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

RSink()

Method Summary

Class[]	accepts() List of classes that can be used as input.
void	cleanUp() Closes the Rserve connection as the panel closes.
void	defineOptions() Adds to the internal list of options.
protected String	doExecute() Executes the flow, including reading the input and returning R's output.
RScript	getRScript() Gets the script.
String	globalInfo() Info about this flow.
String	rScriptTipText() Tool tip about the script.
void	setRScript(RScript val) Sets the script.
String	setUp() Sets up the connection to Rserve.

Methods inherited from class adams.flow.sink.AbstractSink

backupState, input, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, 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, 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.flow.core.Actor

compareTo, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getQuickInfo, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setVariables, sizeOf, stopExecution, stopExecution, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_Script

protected RScript m_Script

Script to pass to r

INPUT

public static final String INPUT

the placeholder for the input value.

See Also:

Constant Field Values

m_Rserve

protected org.rosuda.REngine.Rserve.RConnection m_Rserve

Connection to Rserve

Constructor Detail

RSink

public RSink()

Method Detail

defineOptions

public void defineOptions()

Adds to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

setRScript

public void setRScript(RScript val)

Sets the script.

Parameters:

val - the script

getRScript

public RScript getRScript()

Gets the script.

Returns:

the script

rScriptTipText

public String rScriptTipText()

Tool tip about the script.

Returns:

tool tip message

accepts

public Class[] accepts()

List of classes that can be used as input.

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()

Executes the flow, including reading the input and returning R's output.

Specified by:

doExecute in class AbstractActor

globalInfo

public String globalInfo()

Info about 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