Package adams.flow.transformer

Class WekaClassSelector

  • 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 WekaClassSelector
extends adams.flow.transformer.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.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.Index m_ClassIndex
      the class index.
      protected boolean m_Override
      whether to override any set class attribute.
      protected adams.core.base.BaseRegExp m_RegexName
      the regular expression on the attribute for selecting the sub-set of attributes.
      protected boolean m_Unset
      whether to unset the class index.

      • 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.
      String classIndexTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      Class[] generates()
      Returns the class of objects that it generates.
      adams.core.Index getClassIndex()
      Returns the class index.
      boolean getOverride()
      Returns whether any existing class index will be overriden or not.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      adams.core.base.BaseRegExp getRegexName()
      Returns the regular expression for selecting the attributes.
      boolean getUnset()
      Returns whether to unset the class attribute.
      String globalInfo()
      Returns a string describing the object.
      protected void initialize()
      Initializes the members.
      String overrideTipText()
      Returns the tip text for this property.
      String regexNameTipText()
      Returns the tip text for this property.
      void setClassIndex​(adams.core.Index value)
      Sets the class index.
      void setOverride​(boolean value)
      Sets whether to override any existing class index or nor.
      void setRegexName​(adams.core.base.BaseRegExp value)
      Sets the regular expression for selecting the attributes.
      void setUnset​(boolean value)
      Sets whether to unset the class attribute.
      String unsetTipText()
      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, reset, 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_ClassIndex

        protected adams.core.Index m_ClassIndex
        the class index.

      • m_Override

        protected boolean m_Override
        whether to override any set class attribute.

      • m_RegexName

        protected adams.core.base.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

      • 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

      • initialize

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

      • 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

      • 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

      • setClassIndex

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

      • getClassIndex

        public adams.core.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​(adams.core.base.BaseRegExp value)
        Sets the regular expression for selecting the attributes.
        Parameters:
        value - the regex

      • getRegexName

        public adams.core.base.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 adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message