Class SortLabels

All Implemented Interfaces:
Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler, StreamableFilter

public class SortLabels extends SimpleStreamFilter implements WeightedInstancesHandler, WeightedAttributesHandler
A simple filter for sorting the labels of nominal attributes.

Valid options are:

 -D
  Turns on output of debugging information.
 
 -R <index1,index2-index4,...>
  Specify list of attributes to process.
  (default: select all nominal attributes)
 
 -V
  Inverts the matching sense of the selection.
 
 -S <CASE|NON-CASE>
  Determines the type of sorting:
  CASE = Case-sensitive
  NON-CASE = Case-insensitive
  (default: CASE)
 
Version:
$Revision: 14508 $
Author:
fracpete (fracpete at waikato dot ac dot nz)
See Also:
  • Field Details

    • SORT_CASESENSITIVE

      public static final int SORT_CASESENSITIVE
      sorts the strings case-sensitive.
      See Also:
    • SORT_CASEINSENSITIVE

      public static final int SORT_CASEINSENSITIVE
      sorts the strings case-insensitive.
      See Also:
    • TAGS_SORTTYPE

      public static final Tag[] TAGS_SORTTYPE
      Tag allowing selection of sort type.
  • Constructor Details

    • SortLabels

      public SortLabels()
  • Method Details

    • globalInfo

      public String globalInfo()
      Returns a string describing this filter.
      Specified by:
      globalInfo in class SimpleFilter
      Returns:
      a description of the filter suitable for displaying in the explorer/experimenter gui
    • listOptions

      public Enumeration<Option> listOptions()
      Returns an enumeration describing the available options.
      Specified by:
      listOptions in interface OptionHandler
      Overrides:
      listOptions in class Filter
      Returns:
      an enumeration of all the available options.
    • setOptions

      public void setOptions(String[] options) throws Exception
      Parses the options for this object.

      Valid options are:

       -D
        Turns on output of debugging information.
       
       -R <index1,index2-index4,...>
        Specify list of attributes to process.
        (default: select all nominal attributes)
       
       -V
        Inverts the matching sense of the selection.
       
       -S <CASE|NON-CASE>
        Determines the type of sorting:
        CASE = Case-sensitive
        NON-CASE = Case-insensitive
        (default: CASE)
       
      Specified by:
      setOptions in interface OptionHandler
      Overrides:
      setOptions in class Filter
      Parameters:
      options - the options to use
      Throws:
      Exception - if setting of options fails
    • getOptions

      public String[] getOptions()
      Gets the current settings of the classifier.
      Specified by:
      getOptions in interface OptionHandler
      Overrides:
      getOptions in class Filter
      Returns:
      an array of strings suitable for passing to setOptions
    • attributeIndicesTipText

      public String attributeIndicesTipText()
      Returns the tip text for this property.
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • setAttributeIndices

      public void setAttributeIndices(String value)
      Set the range of attributes to process.
      Parameters:
      value - the new range.
    • getAttributeIndices

      public String getAttributeIndices()
      Gets the current selected attributes.
      Returns:
      current selection.
    • invertSelectionTipText

      public String invertSelectionTipText()
      Returns the tip text for this property.
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • setInvertSelection

      public void setInvertSelection(boolean value)
      Sets whether selected columns should be processed or skipped.
      Parameters:
      value - the new invert setting
    • getInvertSelection

      public boolean getInvertSelection()
      Gets whether the supplied columns are to be processed or skipped.
      Returns:
      true if the supplied columns will be kept
    • sortTypeTipText

      public String sortTypeTipText()
      Returns the tip text for this property.
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • setSortType

      public void setSortType(SelectedTag type)
      Sets the sort type to be used.
      Parameters:
      type - the type of sorting
    • getSortType

      public SelectedTag getSortType()
      Gets the sort type to be used.
      Returns:
      the sort type
    • getCapabilities

      public Capabilities getCapabilities()
      Returns the Capabilities of this filter.
      Specified by:
      getCapabilities in interface CapabilitiesHandler
      Overrides:
      getCapabilities in class Filter
      Returns:
      the capabilities of this object
      See Also:
    • getRevision

      public String getRevision()
      Returns the revision string.
      Specified by:
      getRevision in interface RevisionHandler
      Overrides:
      getRevision in class Filter
      Returns:
      the revision
    • main

      public static void main(String[] args)
      runs the filter with the given arguments.
      Parameters:
      args - the commandline arguments