Class WekaStreamFilter

  • 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, adams.flow.core.PropertiesUpdater, Serializable, Comparable

    public class WekaStreamFilter
    extends adams.flow.transformer.AbstractTransformerWithPropertiesUpdating
    Filters Instance objects using the specified filter.

    Input/output:
    - accepts:
       weka.core.Instance
       weka.core.Instances
       adams.data.instance.Instance
    - generates:
       weka.core.Instance
       weka.core.Instances
       adams.data.instance.Instance


    -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: WekaStreamFilter
     
    -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
     
    -property <adams.core.base.BaseString> [-property ...] (property: properties)
        The properties to update with the values associated with the specified values.
        default:
     
    -variable <adams.core.VariableName> [-variable ...] (property: variableNames)
        The names of the variables to update the properties with.
        default:
     
    -filter <weka.filters.StreamableFilter> (property: filter)
        The stream filter to use for filtering the Instance objects.
        default: weka.filters.unsupervised.attribute.Add -N unnamed -C last
     
    -keep <boolean> (property: keepRelationName)
        If set to true, then the filter won't change the relation name of the incoming
        dataset.
        default: false
     
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String BACKUP_INITIALIZED
      the key for storing the current initialized state in the backup.
      protected weka.filters.StreamableFilter m_Filter
      the filter to apply.
      protected boolean m_Initialized
      whether the filter has been initialized.
      protected boolean m_KeepRelationName
      whether to keep the incoming relation name.
      • Fields inherited from class adams.flow.transformer.AbstractTransformerWithPropertiesUpdating

        m_Containers, m_Properties, m_VariableNames
      • 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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      Returns the class that the consumer accepts.
      protected Hashtable<String,​Object> backupState()
      Backs up the current state of the actor before update the variables.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      String filterTipText()
      Returns the tip text for this property.
      Class[] generates()
      Returns the class of objects that it generates.
      weka.filters.StreamableFilter getFilter()
      Returns the filter in use.
      boolean getKeepRelationName()
      Returns whether the filter doesn't change the relation name.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      String globalInfo()
      Returns a string describing the object.
      String keepRelationNameTipText()
      Returns the tip text for this property.
      protected void reset()
      Resets the scheme.
      protected void restoreState​(Hashtable<String,​Object> state)
      Restores the state of the actor before the variables got updated.
      void setFilter​(weka.filters.StreamableFilter value)
      Sets the filter to use.
      void setKeepRelationName​(boolean value)
      Sets whether the filter doesn't change the relation name.
      • Methods inherited from class adams.flow.transformer.AbstractTransformerWithPropertiesUpdating

        getProperties, getVariableNames, propertiesTipText, setProperties, setUpContainers, setUpContainersIfNecessary, setVariableNames, updateObject, variableNamesTipText
      • Methods inherited from class adams.flow.transformer.AbstractTransformer

        currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, 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, initialize, 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, execute, 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, wrapUp
      • 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

      • BACKUP_INITIALIZED

        public static final String BACKUP_INITIALIZED
        the key for storing the current initialized state in the backup.
        See Also:
        Constant Field Values
      • m_Filter

        protected weka.filters.StreamableFilter m_Filter
        the filter to apply.
      • m_KeepRelationName

        protected boolean m_KeepRelationName
        whether to keep the incoming relation name.
      • m_Initialized

        protected boolean m_Initialized
        whether the filter has been initialized.
    • Constructor Detail

      • WekaStreamFilter

        public WekaStreamFilter()
    • 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.transformer.AbstractTransformerWithPropertiesUpdating
      • setFilter

        public void setFilter​(weka.filters.StreamableFilter value)
        Sets the filter to use.
        Parameters:
        value - the filter
      • getFilter

        public weka.filters.StreamableFilter getFilter()
        Returns the filter in use.
        Returns:
        the filter
      • filterTipText

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

        public void setKeepRelationName​(boolean value)
        Sets whether the filter doesn't change the relation name.
        Parameters:
        value - true if the filter won't change the relation name
      • getKeepRelationName

        public boolean getKeepRelationName()
        Returns whether the filter doesn't change the relation name.
        Returns:
        true if the filter doesn't change the relation name
      • keepRelationNameTipText

        public String keepRelationNameTipText()
        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.transformer.AbstractTransformerWithPropertiesUpdating
        Returns:
        null if no info available, otherwise short string
      • backupState

        protected Hashtable<String,​Object> backupState()
        Backs up the current state of the actor before update the variables.
        Overrides:
        backupState in class adams.flow.transformer.AbstractTransformer
        Returns:
        the backup
      • restoreState

        protected void restoreState​(Hashtable<String,​Object> state)
        Restores the state of the actor before the variables got updated.
        Overrides:
        restoreState in class adams.flow.transformer.AbstractTransformer
        Parameters:
        state - the backup of the state to restore from
      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class adams.flow.transformer.AbstractTransformerWithPropertiesUpdating
      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        weka.core.Instance, weka.core.Instances, adams.data.instance.Instance
      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        weka.core.Instance, weka.core.Instances, adams.data.instance.Instance
      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message