Package adams.flow.standalone.rats.output

Class OutputWithExternalTransformer

  • 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.ExternalActorFileHandler, adams.flow.core.ExternalActorHandler, RatOutput, Serializable
    public class OutputWithExternalTransformer
extends AbstractMetaRatOutput
implements adams.flow.core.ExternalActorHandler
    Meta-transmitter that passes the data through the external 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
 
    -file <adams.core.io.FlowFile> (property: actorFile)
    The file containing the external transformer.
    default: ${CWD}
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ActorFile

        protected adams.core.io.FlowFile m_ActorFile
        the file the external actor is stored in.

      • m_ExternalActor

        protected adams.flow.core.Actor m_ExternalActor
        the external actor itself.

    • Constructor Detail

      • OutputWithExternalTransformer

        public OutputWithExternalTransformer()

    • 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

      • 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

      • setActorFile

        public void setActorFile​(adams.core.io.FlowFile value)
        Sets the file containing the external actor.
        Specified by:
        setActorFile in interface adams.flow.core.ExternalActorFileHandler
        Parameters:
        value - the actor file

      • getActorFile

        public adams.core.io.FlowFile getActorFile()
        Returns the file containing the external actor.
        Specified by:
        getActorFile in interface adams.flow.core.ExternalActorFileHandler
        Returns:
        the actor file

      • actorFileTipText

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

      • setUpExternalActor

        public String setUpExternalActor()
        Sets up the external actor.
        Specified by:
        setUpExternalActor in interface adams.flow.core.ExternalActorHandler
        Returns:
        null if everything is fine, otherwise error message

      • getExternalActor

        public adams.flow.core.Actor getExternalActor()
        Returns the internal actor.
        Specified by:
        getExternalActor in interface adams.flow.core.ExternalActorHandler
        Returns:
        the actor, null if not available

      • 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

      • cleanUpExternalActor

        public void cleanUpExternalActor()
        Cleans up the external actor.
        Specified by:
        cleanUpExternalActor in interface adams.flow.core.ExternalActorHandler