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

Class weka.filters.AddFilter 

java.lang.Object
   |
   +----weka.filters.Filter
           |
           +----weka.filters.AddFilter
public class AddFilter
extends Filter
implements OptionHandler
An instance filter that adds a new attribute to the dataset. The new attribute contains all missing values.

Valid filter-specific options are:

-C index
Specify where to insert the column. First and last are valid indexes. (default last)

-L label1,label2,...
Create nominal attribute with the given labels (default numeric attribute)

-N name
Name of the new attribute. (default = 'Unnamed')

Version:
$Revision: 1.4 $
Author:
Len Trigg (trigg@cs.waikato.ac.nz)

Constructor Index

o AddFilter()

Method Index

o getAttributeIndex()
Get the index where the attribute will be inserted
o getAttributeName()
Get the name of the attribute to be created
o getNominalLabels()
Get the list of labels for nominal attribute creation
o getOptions()
Gets the current settings of the filter.
o input(Instance)
Input an instance for filtering.
o inputFormat(Instances)
Sets the format of the input instances.
o listOptions()
Returns an enumeration describing the available options
o main(String[])
Main method for testing this class.
o setAttributeIndex(int)
Set the index where the attribute will be inserted
o setAttributeName(String)
Set the new attribute's name
o setNominalLabels(String)
Set the labels for nominal attribute creation.
o setOptions(String[])
Parses a list of options for this object.

Constructors

o AddFilter 
 public AddFilter()

Methods

o listOptions 
 public Enumeration listOptions()
Returns an enumeration describing the available options

Returns:
an enumeration of all the available options
o setOptions 
 public void setOptions(String options[]) throws Exception
Parses a list of options for this object. Valid options are:

-C index
Specify where to insert the column. First and last are valid indexes. (default last)

-L label1,label2,...
Create nominal attribute with the given labels (default numeric attribute)

-N name
Name of the new attribute. (default = 'Unnamed')

Parameters:
options - the list of options as an array of strings
Throws: Exception
if an option is not supported
o getOptions 
 public String[] getOptions()
Gets the current settings of the filter.

Returns:
an array of strings suitable for passing to setOptions
o inputFormat 
 public boolean inputFormat(Instances instanceInfo) throws 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: Exception
if the format couldn't be set successfully
Overrides:
inputFormat in class Filter
o input 
 public boolean input(Instance instance) throws Exception
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.

Parameters:
instance - the input instance
Returns:
true if the filtered instance may now be collected with output().
Throws: Exception
if the input instance was not of the correct format or if there was a problem with the filtering.
Overrides:
input in class Filter
o getAttributeName 
 public String getAttributeName()
Get the name of the attribute to be created

Returns:
the new attribute name
o setAttributeName 
 public void setAttributeName(String name)
Set the new attribute's name

Parameters:
name - the new name
o getAttributeIndex 
 public int getAttributeIndex()
Get the index where the attribute will be inserted

Returns:
the attribute insertion index
o setAttributeIndex 
 public void setAttributeIndex(int attributeIndex)
Set the index where the attribute will be inserted

Parameters:
attributeIndex - the insertion index (-1 means last)
o getNominalLabels 
 public String getNominalLabels()
Get the list of labels for nominal attribute creation

Returns:
the list of labels for nominal attribute creation
o setNominalLabels 
 public void setNominalLabels(String labelList) throws Exception
Set the labels for nominal attribute creation.

Parameters:
labelList - a comma separated list of labels
Throws: Exception
if the labelList was invalid
o 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 
All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home