Package adams.flow.standalone

Class Rserve

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, Serializable, Comparable
    public class Rserve
extends adams.flow.standalone.AbstractStandalone
    Establishes a connection to the Rserve server.

    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: Rserve
 
    -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.
 
    -host <java.lang.String> (property: host)
    The host the Rserve server is running on.
    default: localhost
 
    -port <int> (property: port)
    The port the Rserve server is listening on.
    default: 6311
    minimum: 0
    maximum: 65535
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.rosuda.REngine.Rserve.RConnection m_Connection
      the connection in use.
      protected String m_Host
      the Rserve host.
      protected int m_Port
      the Rserve port.
      protected boolean m_Shutdown
      whether we need to shutdown the server.

      • 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_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Constructor Summary

      Constructors 
      Constructor Description
      Rserve()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void closeConnection​(org.rosuda.REngine.Rserve.RConnection conn)
      Closes the connection to Rserve properly.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Connects to Rserve and feeds it the script.
      String getHost()
      Returns the Rserve host.
      int getPort()
      Returns the Rserve port.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      String globalInfo()
      Overall description of this flow.
      String hostTipText()
      Returns the tip text for this property.
      org.rosuda.REngine.Rserve.RConnection newConnection()
      Returns a new connection to the Rserve server.
      String portTipText()
      Returns the tip text for this property.
      void setHost​(String value)
      Sets the Rserve host.
      void setPort​(int value)
      Sets the Rserve port.

      • Methods inherited from class adams.flow.standalone.AbstractStandalone

        preExecute

      • Methods inherited from class adams.flow.core.AbstractActor

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

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

      • Methods inherited from interface adams.flow.core.Actor

        toCommandLine

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel, setLoggingLevel

      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager

    • Field Detail

      • m_Host

        protected String m_Host
        the Rserve host.

      • m_Port

        protected int m_Port
        the Rserve port.

      • m_Connection

        protected org.rosuda.REngine.Rserve.RConnection m_Connection
        the connection in use.

      • m_Shutdown

        protected boolean m_Shutdown
        whether we need to shutdown the server.

    • Constructor Detail

      • Rserve

        public Rserve()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Overall description of this flow.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.flow.core.AbstractActor

      • setHost

        public void setHost​(String value)
        Sets the Rserve host.
        Parameters:
        value - the host

      • getHost

        public String getHost()
        Returns the Rserve host.
        Returns:
        the host

      • hostTipText

        public String hostTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setPort

        public void setPort​(int value)
        Sets the Rserve port.
        Parameters:
        value - the port

      • getPort

        public int getPort()
        Returns the Rserve port.
        Returns:
        the port

      • portTipText

        public String portTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.flow.core.Actor
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.core.AbstractActor
        Returns:
        null if no info available, otherwise short string

      • newConnection

        public org.rosuda.REngine.Rserve.RConnection newConnection()
        Returns a new connection to the Rserve server.
        Returns:
        the connection, null if failed to create connection

      • closeConnection

        public void closeConnection​(org.rosuda.REngine.Rserve.RConnection conn)
        Closes the connection to Rserve properly.
        Parameters:
        conn - the connection to close

      • doExecute

        protected String doExecute()
        Connects to Rserve and feeds it the script.
        Specified by:
        doExecute in class adams.flow.core.AbstractActor