Package adams.flow.transformer

Class MOAFilter

  • 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, adams.flow.core.InputConsumer, adams.flow.core.OutputProducer, Serializable, Comparable
    public class MOAFilter
extends adams.flow.transformer.AbstractTransformer
    Applies a MOA stream filter to the incoming MOA instances.

    Input/output:
    - accepts:
       com.yahoo.labs.samoa.instances.Instance
       com.yahoo.labs.samoa.instances.Instances
    - generates:
       com.yahoo.labs.samoa.instances.Instance
       com.yahoo.labs.samoa.instances.Instances


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: MOAFilter
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -filter <moa.options.ClassOption> (property: streamFilter)
    The stream filter to use for filtering the instances.
    default: moa.streams.filters.AddNoiseFilter
    Applies a MOA stream filter to the incoming MOA instances.
    Author:
    Corey Sterling (csterlin at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected moa.streams.filters.StreamFilter m_ActualStreamFilter
      The actual stream filter object.
      protected MOAFilter.FixedInstanceStream m_FixedInstanceStream
      The fixed instance stream to stream the incoming instances.
      protected moa.options.ClassOption m_StreamFilter
      The stream filter to use.

      • Fields inherited from class adams.flow.transformer.AbstractTransformer

        BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

      • 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
      MOAFilter()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()  
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()  
      Class[] generates()  
      protected moa.streams.filters.StreamFilter getCurrentStreamFilter()
      Returns the current stream filter, based on the class option.
      protected moa.streams.ExampleStream getDefaultFilter()
      Returns the default stream filter.
      protected moa.options.ClassOption getDefaultOption()
      Returns the default class option.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      moa.options.ClassOption getStreamFilter()
      Returns the data filter in use.
      String globalInfo()
      Returns a string describing the object.
      protected void initialize()
      Initializes the members.
      protected void reset()
      Initializes the members.
      void setStreamFilter​(moa.options.ClassOption value)
      Sets the stream filter to use.
      String streamFilterTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.flow.transformer.AbstractTransformer

        backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState, wrapUp

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

        annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, 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, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

      • 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

        cleanUp, compareTo, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

      • 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

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • m_StreamFilter

        protected moa.options.ClassOption m_StreamFilter
        The stream filter to use.

      • m_ActualStreamFilter

        protected moa.streams.filters.StreamFilter m_ActualStreamFilter
        The actual stream filter object.

      • m_FixedInstanceStream

        protected MOAFilter.FixedInstanceStream m_FixedInstanceStream
        The fixed instance stream to stream the incoming instances.

    • Constructor Detail

      • MOAFilter

        public MOAFilter()

    • 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 adams.flow.core.AbstractActor

      • reset

        protected void reset()
        Initializes the members.
        Overrides:
        reset in class adams.flow.core.AbstractActor

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.flow.core.AbstractActor

      • 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

      • getDefaultFilter

        protected moa.streams.ExampleStream getDefaultFilter()
        Returns the default stream filter.
        Returns:
        the filter

      • getDefaultOption

        protected moa.options.ClassOption getDefaultOption()
        Returns the default class option.
        Returns:
        the option

      • setStreamFilter

        public void setStreamFilter​(moa.options.ClassOption value)
        Sets the stream filter to use.
        Parameters:
        value - the stream filter

      • getStreamFilter

        public moa.options.ClassOption getStreamFilter()
        Returns the data filter in use.
        Returns:
        the data filter

      • streamFilterTipText

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

      • getCurrentStreamFilter

        protected moa.streams.filters.StreamFilter getCurrentStreamFilter()
        Returns the current stream filter, based on the class option.
        Returns:
        the stream filter
        See Also:
        getStreamFilter()

      • doExecute

        protected String doExecute()
        Specified by:
        doExecute in class adams.flow.core.AbstractActor

      • accepts

        public Class[] accepts()

      • generates

        public Class[] generates()