Package adams.flow.standalone.rats.output

Class OutputWithCallableTransformer

  • 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<AbstractRatOutput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, adams.flow.core.CallableActorUser, RatOutput, Serializable
    public class OutputWithCallableTransformer
extends AbstractMetaRatOutput
implements adams.flow.core.CallableActorUser
    Meta-transmitter that passes the data through the callable transformer before forwarding it to the base-transmitter. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -output <adams.flow.standalone.rats.RatOutput> (property: output)
    The transmitter to wrap.
    default: adams.flow.standalone.rats.DummyOutput
 
    -callable <adams.flow.core.CallableActorReference> (property: callableName)
    The name of the callable transformer to use.
    default: unknown
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_CallableName

        protected adams.flow.core.CallableActorReference m_CallableName
        the callable name.

      • m_CallableActor

        protected adams.flow.core.Actor m_CallableActor
        the callable actor.

      • m_Helper

        protected adams.flow.core.CallableActorHelper m_Helper
        the helper class.

    • Constructor Detail

      • OutputWithCallableTransformer

        public OutputWithCallableTransformer()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • 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 AbstractMetaRatOutput

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class adams.core.option.AbstractOptionHandler

      • setCallableName

        public void setCallableName​(adams.flow.core.CallableActorReference value)
        Sets the name of the callable transformer to use.
        Parameters:
        value - the callable name

      • getCallableName

        public adams.flow.core.CallableActorReference getCallableName()
        Returns the name of the callable transformer in use.
        Returns:
        the callable name

      • callableNameTipText

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

      • getCallableActor

        public adams.flow.core.Actor getCallableActor()
        Returns the currently set callable actor.
        Specified by:
        getCallableActor in interface adams.flow.core.CallableActorUser
        Returns:
        the actor, can be null

      • findCallableActor

        protected adams.flow.core.Actor findCallableActor()
        Tries to find the callable actor referenced by its global name.
        Returns:
        the callable actor or null if not found

      • getQuickInfo

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

      • preTransmit

        protected String preTransmit()
        Hook method before calling the base-output's transmit() method.

        Passes the input data through the callable transformer before passing it on to the base-transmitter.
        Overrides:
        preTransmit in class AbstractMetaRatOutput
        Returns:
        null if successful, otherwise error message