Package adams.flow.transformer

Class ClassSelector

  • 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 ClassSelector
extends AbstractTransformer
    Sets (or unsets) the class index/indices. Can either honour already existing ones or override them.

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet
    - generates:
       adams.ml.data.Dataset


    -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: ClassSelector
 
    -annotation <adams.core.base.BaseText> (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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -class <adams.data.spreadsheet.SpreadSheetColumnRange> (property: classIndex)
    The attribute(s) to act as class attribute(s).
    default: last
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; apart from column names (case-sensitive), the following placeholders can be used as well: first, second, third, last_2, last_1, last
 
    -override <boolean> (property: override)
    If set to true, then any existing class index will get removed first; otherwise 
    the class index/indices will get added.
    default: false
 
    -unset <boolean> (property: unset)
    Unsets any class attribute.
    default: false
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Override

        protected boolean m_Override
        whether to override any set class attribute.

      • m_Unset

        protected boolean m_Unset
        whether to unset the class index.

    • Constructor Detail

      • ClassSelector

        public ClassSelector()

    • Method Detail

      • setClassIndex

        public void setClassIndex​(SpreadSheetColumnRange value)
        Sets the range of class attributes.
        Parameters:
        value - the range

      • getClassIndex

        public SpreadSheetColumnRange getClassIndex()
        Returns the class attribute range.
        Returns:
        the range

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

      • 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:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

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