Package weka.filters.unsupervised.attribute

Class StringToNominal

java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.StringToNominal
All Implemented Interfaces:
Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler, UnsupervisedFilter
public class StringToNominal extends Filter implements UnsupervisedFilter, OptionHandler, WeightedAttributesHandler, WeightedInstancesHandler
Converts a range of string attributes (unspecified number of values) to nominal (set number of values). You should ensure that all string values that will appear are represented in the first batch of the data.

Valid options are: 

 -R <col>
  Sets the range of attribute indices ("first" and "last" are valid values
  and ranges and lists can also be used) (default "last").
 
 -V <col>
  Invert the range specified by -R.
Version:
$Revision: 14508 $
Author:
Len Trigg (len@reeltwo.com)
See Also:

  • Constructor Details

    • StringToNominal

      public StringToNominal()

  • 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

    • 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 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:
      UnsupportedAttributeTypeException - if the selected attribute a string attribute.
      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 structure has been defined.

    • batchFinished

      public boolean batchFinished()
      Signifies that this batch of input to the filter is finished. If the filter requires all instances prior to filtering, output() may now be called to retrieve the filtered instances.
      Overrides:
      batchFinished in class Filter
      Returns:
      true if there are instances pending output.
      Throws:
      IllegalStateException - if no input structure has been defined.

    • 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 a given list of options.

      Valid options are: 

       -R <col>
 Sets the range of attribute indices ("first" and "last" are valid values
 and ranges and lists can also be used) (default "last").
 
       -V <col>
  Invert the range specified by -R.
      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()
      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

    • attributeRangeTipText

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

    • getAttributeRange

      public String getAttributeRange()
      Get the range of indices of the attributes used.
      Returns:
      the index of the attribute

    • setAttributeRange

      public void setAttributeRange(String rangeList)
      Sets range of indices of the attributes used.
      Parameters:
      rangeList - the list of attribute indices

    • 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