Package adams.flow.transformer

Class WekaStreamFilter

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, PropertiesUpdater, Serializable, Comparable
    public class WekaStreamFilter
extends 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 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

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

      • 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 AbstractActor
        Returns:
        null if everything is fine, otherwise error message