adams.flow.source
Class RSource

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.source.AbstractSource
                  adams.flow.source.RSource

All Implemented Interfaces:

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

public class RSource
extends AbstractSource

A source flow for R

Version:

$Revision$

Author:

rsmith

See Also:

Serialized Form

Field Summary

protected Object	m_returnedObject Object returned from r
protected RDataType	m_returnType Data type of object returned from r script
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.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

RSource()

Method Summary

void	cleanUp() Closes the Rserve connection as the panel closes.
void	defineOptions() Adds to the internal list of options.
protected String	doExecute() Connects with Rserve and feeds it the script and returns the resulting data.
Class[]	generates() Returns the datatype this flow is set to return.
RDataType	getReturnType() Returns the return type.
RScript	getScript() Returns to script.
String	globalInfo() Description of the flow.
boolean	hasPendingOutput() Returns true if the is pending output.
Token	output() Turns the returned object into a token to be passed through the system.
String	returnTypeTipText() A description of the return type.
String	ScriptTipText() Returns a description of the script.
void	setReturnType(RDataType val) Determines the return type of the flow.
void	setScript(RScript val) Sets the script to be fed to 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.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, wrapUp

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

m_returnType

protected RDataType m_returnType

Data type of object returned from r script

m_returnedObject

protected Object m_returnedObject

Object returned from r

m_Rserve

protected org.rosuda.REngine.Rserve.RConnection m_Rserve

Connection to Rserve

Constructor Detail

RSource

public RSource()

Method Detail

defineOptions

public void defineOptions()

Adds to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

setReturnType

public void setReturnType(RDataType val)

Determines the return type of the flow.

Parameters:

val - the return type

getReturnType

public RDataType getReturnType()

Returns the return type.

Returns:

the return type

returnTypeTipText

public String returnTypeTipText()

A description of the return type.

Returns:

string description

setScript

public void setScript(RScript val)

Sets the script to be fed to R.

Parameters:

val - the script to be fed to R

getScript

public RScript getScript()

Returns to script.

Returns:

string version of the script

ScriptTipText

public String ScriptTipText()

Returns a description of the script.

Returns:

string description

generates

public Class[] generates()

Returns the datatype this flow is set to return.

output

public Token output()

Turns the returned object into a token to be passed through the system.

hasPendingOutput

public boolean hasPendingOutput()

Returns true if the is pending output.

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 with Rserve and feeds it the script and returns the resulting data.

Specified by:

doExecute in class AbstractActor

globalInfo

public String globalInfo()

Description of the 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