Class MergeManyValues

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

Merges many values of a nominal attribute into one value.

Valid options are:

 -C <col>
  Sets the attribute index
  (default: last)
 
 -L <label>
  Sets the label of the newly merged classes
  (default: 'merged')
 
 -R <range>
  Sets the merge range. 'first and 'last' are accepted as well.'
  E.g.: first-5,7,9,20-last
  (default: 1,2)
 
Version:
$Revision: 14508 $
Author:
Kathryn Hempstalk (kah18 at cs.waikato.ac.nz)
See Also:
  • Constructor Details

    • MergeManyValues

      public MergeManyValues()
  • Method Details

    • globalInfo

      public String globalInfo()
      Returns a string describing this filter
      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 PotentialClassIgnorer
      Returns:
      an enumeration of all the available options.
    • setOptions

      public void setOptions(String[] options) throws Exception
      Parses a given list of options.

      Valid options are:

       -C <col>
        Sets the attribute index
        (default: last)
       
       -L <label>
        Sets the label of the newly merged classes
        (default: 'merged')
       
       -R <range>
        Sets the merge range. 'first and 'last' are accepted as well.'
        E.g.: first-5,7,9,20-last
        (default: 1,2)
       
      Specified by:
      setOptions in interface OptionHandler
      Overrides:
      setOptions in class PotentialClassIgnorer
      Parameters:
      options - the list of options as an array of strings
      Throws:
      Exception - if an option is not supported
    • getOptions

      public String[] getOptions()
      Gets the current settings of the filter.
      Specified by:
      getOptions in interface OptionHandler
      Overrides:
      getOptions in class PotentialClassIgnorer
      Returns:
      an array of strings suitable for passing to setOptions
    • 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:
    • setInputFormat

      public boolean setInputFormat(Instances instanceInfo) throws Exception
      Sets the format of the input instances.
      Overrides:
      setInputFormat in class PotentialClassIgnorer
      Parameters:
      instanceInfo - an Instances object containing the input instance structure (any instances contained in the object are ignored - only the structure is required).
      Returns:
      true if the outputFormat may be collected immediately
      Throws:
      Exception - if the input format can't be set successfully
    • input

      public boolean input(Instance instance)
      Input an instance for filtering. The instance is processed and made available for output immediately.
      Overrides:
      input in class Filter
      Parameters:
      instance - the input instance
      Returns:
      true if the filtered instance may now be collected with output().
      Throws:
      IllegalStateException - if no input format has been set.
    • attributeIndexTipText

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

      public String getAttributeIndex()
      Get the index of the attribute used.
      Returns:
      the index of the attribute
    • setAttributeIndex

      public void setAttributeIndex(String attIndex)
      Sets index of the attribute used.
      Parameters:
      attIndex - the index of the attribute
    • labelTipText

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

      public String getLabel()
      Get the label for the new merged class.
      Returns:
      the label for the merged class.
    • setLabel

      public void setLabel(String alabel)
      Sets label of the merged class.
      Parameters:
      alabel - the new label.
    • getMergeValueRange

      public String getMergeValueRange()
      Get the range of the merge values used.
      Returns:
      the range of the merge values
    • mergeValueRangeTipText

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

      public void setMergeValueRange(String range)
      Sets range of the merge values used.
      Parameters:
      range - the range of the merged values
    • getRevision

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

      public static void main(String[] args)
      Main method for executing this filter.
      Parameters:
      args - use -h to display all options