Package adams.flow.transformer

Class WekaClassSelector

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class WekaClassSelector
extends AbstractTransformer
    Sets the class index. Can either honour an already existing one or override it. Also, one can apply the index on a subset of attributes defined by a regular expression applied to the attribute names (one can set the class index to the last attribute that starts with 'att_').

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


    Valid options are: 

    -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: WekaClassSelector
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
 
    -stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 
    -class <adams.core.Index> (property: classIndex)
    The index within the attribute subset defined by the regular expression 
    ('first' and 'last' are accepted as well).
    default: last
 
    -override (property: override)
    If set to true, then any existing class index will be overriden; otherwise 
    the class index will only be set if not already set.
 
    -regex <adams.core.base.BaseRegExp> (property: regexName)
    The regular expression used for selecting the subset of attributes.
    default: .*
 
    -unset (property: unset)
    Unsets the class attribute.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ClassIndex

        protected Index m_ClassIndex
        the class index.

      • m_Override

        protected boolean m_Override
        whether to override any set class attribute.

      • m_RegexName

        protected BaseRegExp m_RegexName
        the regular expression on the attribute for selecting the sub-set of attributes.

      • m_Unset

        protected boolean m_Unset
        whether to unset the class index.

    • Constructor Detail

      • WekaClassSelector

        public WekaClassSelector()

    • Method Detail

      • setClassIndex

        public void setClassIndex​(Index value)
        Sets the class index.
        Parameters:
        value - the index

      • getClassIndex

        public Index getClassIndex()
        Returns the class index.
        Returns:
        the index

      • classIndexTipText

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

      • setOverride

        public void setOverride​(boolean value)
        Sets whether to override any existing class index or nor.
        Parameters:
        value - if true then any class index will be override

      • getOverride

        public boolean getOverride()
        Returns whether any existing class index will be overriden or not.
        Returns:
        true if any class index will be overriden

      • overrideTipText

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

      • setRegexName

        public void setRegexName​(BaseRegExp value)
        Sets the regular expression for selecting the attributes.
        Parameters:
        value - the regex

      • getRegexName

        public BaseRegExp getRegexName()
        Returns the regular expression for selecting the attributes.
        Returns:
        the regex

      • regexNameTipText

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

      • setUnset

        public void setUnset​(boolean value)
        Sets whether to unset the class attribute.
        Parameters:
        value - true if to unset

      • getUnset

        public boolean getUnset()
        Returns whether to unset the class attribute.
        Returns:
        true if to unset

      • unsetTipText

        public String unsetTipText()
        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