Package weka.filters.unsupervised.attribute

Class RenameNominalValues

java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.RenameNominalValues
All Implemented Interfaces:
Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler, StreamableFilter, UnsupervisedFilter
public class RenameNominalValues extends Filter implements UnsupervisedFilter, StreamableFilter, OptionHandler, WeightedInstancesHandler, WeightedAttributesHandler
Renames the values of nominal attributes.

Valid options are: 

 -R
  Attributes to act on. Can be either a range
  string (e.g. 1,2,6-10) OR a comma-separated list of named attributes
  (default none)
 
 -V
  Invert matching sense (i.e. act on all attributes other than those specified)
 
 -N
  Nominal labels and their replacement values.
  E.g. red:blue, black:white, fred:bob
 
 -I
  Ignore case when matching nominal values
Version:
$Revision: 15530 $
Author:
Mark Hall (mhall{[at]}pentaho{[dot]}com)
See Also:

  • Constructor Details

    • RenameNominalValues

      public RenameNominalValues()

  • Method Details

    • globalInfo

      public String globalInfo()
      Global help info
      Returns:
      the help info for this filter

    • setInputFormat

      public boolean setInputFormat(Instances instanceInfo) throws Exception
      Sets the format of the input instances.
      Overrides:
      setInputFormat in class Filter
      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 format couldn't be set successfully

    • input

      public boolean input(Instance instance)
      Input an instance for filtering. Ordinarily the instance is processed and made available for output immediately. Some filters require all instances be read before producing output.
      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 structure has been defined.

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

    • selectedAttributesTipText

      public String selectedAttributesTipText()
      Returns the tip text for this property
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui

    • setSelectedAttributes

      public void setSelectedAttributes(String atts)

    • getSelectedAttributes

      public String getSelectedAttributes()

    • valueReplacementsTipText

      public String valueReplacementsTipText()
      Returns the tip text for this property
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui

    • setValueReplacements

      public void setValueReplacements(String v)

    • getValueReplacements

      public String getValueReplacements()

    • 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

    • getInvertSelection

      public boolean getInvertSelection()
      Get whether the supplied columns are to be removed or kept
      Returns:
      true if the supplied columns will be kept

    • setInvertSelection

      public void setInvertSelection(boolean invert)
      Set whether selected columns should be removed or kept. If true the selected columns are kept and unselected columns are deleted. If false selected columns are deleted and unselected columns are kept.
      Parameters:
      invert - the new invert setting

    • ignoreCaseTipText

      public String ignoreCaseTipText()
      Returns the tip text for this property
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui

    • setIgnoreCase

      public void setIgnoreCase(boolean ignore)

    • getIgnoreCase

      public boolean getIgnoreCase()

    • listOptions

      public Enumeration<Option> listOptions()
      Description copied from class: Filter
      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 a given list of options.

      Valid options are: 

       -R
  Attributes to act on. Can be either a range
  string (e.g. 1,2,6-10) OR a comma-separated list of named attributes
  (default none)
 
       -V
  Invert matching sense (i.e. act on all attributes other than those specified)
 
       -N
  Nominal labels and their replacement values.
  E.g. red:blue, black:white, fred:bob
 
       -I
  Ignore case when matching nominal values
      Specified by:
      setOptions in interface OptionHandler
      Overrides:
      setOptions in class Filter
      Parameters:
      options - the list of options as an array of strings
      Throws:
      Exception - if an option is not supported

    • getOptions

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

    • 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[] argv)
      Main method for testing this class.
      Parameters:
      argv - should contain arguments to the filter: use -h for help