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

Carries out an R function on the input script and returns data of a particular type.

Input/output:
- generates:
java.lang.Integer

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: RSource
 

-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: 
 

-return-type <Integer|Double|DoubleArray|DoubleMatrix|String|DataFrame> (property: returnType)
    Data type of returned object
    default: Integer
 

-data-frame-columns <java.lang.String> (property: dataFrameColumns)
    The comma-separated list of dataframe column names to return only (if return 
    type is DataFrame)
    default: 
 

Version:

$Revision: 6830 $

Author:

rsmith

See Also:

Serialized Form

Field Summary

protected String	m_DataFrameColumns the comma-separated list of dataframe column names in case of .
protected org.rosuda.REngine.Rserve.RConnection	m_RConn Connection to Rserve
protected Object	m_returnedObject Object returned from r
protected RDataType	m_returnType Data type of object returned from r script
protected Rserve	m_Rserve the Rserve actor.
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_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

RSource()

Method Summary

String	dataFrameColumnsTipText() A description of the return type.
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.
String	getDataFrameColumns() Returns the comma-separated list of dataframe column names to retrieve only.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
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.
protected void	reset() Ressets the members.
String	returnTypeTipText() A description of the return type.
String	scriptTipText() Returns a description of the script.
void	setDataFrameColumns(String value) Sets the comma-separated list of dataframe column names to retrieve only.
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.
void	wrapUp() Closes the Rserve connection as the flow finishes.

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

cleanUp, compareTo, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, 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

m_returnType

protected RDataType m_returnType

Data type of object returned from r script

m_DataFrameColumns

protected String m_DataFrameColumns

the comma-separated list of dataframe column names in case of .

m_returnedObject

protected Object m_returnedObject

Object returned from r

m_RConn

protected org.rosuda.REngine.Rserve.RConnection m_RConn

Connection to Rserve

m_Rserve

protected Rserve m_Rserve

the Rserve actor.

Constructor Detail

RSource

public RSource()

Method Detail

globalInfo

public String globalInfo()

Description of the flow.

Specified by:

globalInfo in class AbstractOptionHandler

defineOptions

public void defineOptions()

Adds 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

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

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

setDataFrameColumns

public void setDataFrameColumns(String value)

Sets the comma-separated list of dataframe column names to retrieve only.

Parameters:

value - the comma-separated list

getDataFrameColumns

public String getDataFrameColumns()

Returns the comma-separated list of dataframe column names to retrieve only.

Returns:

the comma-separated list

dataFrameColumnsTipText

public String dataFrameColumnsTipText()

A description of the return type.

Returns:

string 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

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

wrapUp

public void wrapUp()

Closes the Rserve connection as the flow finishes.

Specified by:

wrapUp in interface Actor

Overrides:

wrapUp in class AbstractActor