All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.filters.StringToNominalFilter

java.lang.Object
    |
    +----weka.filters.Filter
            |
            +----weka.filters.StringToNominalFilter

public class StringToNominalFilter
extends Filter
implements OptionHandler
Converts a string attribute (i.e. unspecified number of values) to nominal (i.e. set number of values). You should ensure that all string values that will appear are represented in the dataset.

Valid filter-specific options are:

-C col
Index of the attribute to be changed. (default last)

Version:
$Revision: 1.6 $
Author:
Len Trigg (len@intelligenesis.net)

Constructor Index

 o StringToNominalFilter()
 

Method Index

 o batchFinished()
Signifies that this batch of input to the filter is finished.
 o getAttributeIndex()
Get the index of the attribute used.
 o getOptions()
Gets the current settings of the filter.
 o input(Instance)
Input an instance for filtering.
 o listOptions()
Returns an enumeration describing the available options.
 o main(String[])
Main method for testing this class.
 o setAttributeIndex(int)
Sets index of the attribute used.
 o setInputFormat(Instances)
Sets the format of the input instances.
 o setOptions(String[])
Parses the options for this object.

Constructor Detail

 o StringToNominalFilter
public StringToNominalFilter()

Method Detail

 o setInputFormat
public boolean setInputFormat(Instances instanceInfo) throws java.lang.Exception
          Sets the format of the input instances.
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.
java.lang.Exception - if the input format can't be set successfully.
Overrides:
setInputFormat in class Filter
 o input
public boolean input(Instance instance)
          Input an instance for filtering. The instance is processed and made available for output immediately.
Parameters:
instance - the input instance.
Returns:
true if the filtered instance may now be collected with output().
Throws:
java.lang.IllegalStateException - if no input structure has been defined.
Overrides:
input in class Filter
 o 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.
Returns:
true if there are instances pending output.
Throws:
java.lang.IllegalStateException - if no input structure has been defined.
Overrides:
batchFinished in class Filter
 o listOptions
public java.util.Enumeration listOptions()
          Returns an enumeration describing the available options.
Returns:
an enumeration of all the available options.
 o setOptions
public void setOptions(java.lang.String options[]) throws java.lang.Exception
          Parses the options for this object. Valid options are:

-C col
The column containing the values to be merged. (default last)

Parameters:
options - the list of options as an array of strings
Throws:
java.lang.Exception - if an option is not supported
 o getOptions
public java.lang.String[] getOptions()
          Gets the current settings of the filter.
Returns:
an array of strings suitable for passing to setOptions
 o getAttributeIndex
public int getAttributeIndex()
          Get the index of the attribute used.
Returns:
the index of the attribute
 o setAttributeIndex
public void setAttributeIndex(int attIndex)
          Sets index of the attribute used.
Parameters:
index - the index of the attribute
 o main
public static void main(java.lang.String argv[])
          Main method for testing this class.
Parameters:
argv - should contain arguments to the filter: use -h for help

All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home