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')
- Author:
- Len Trigg (trigg@cs.waikato.ac.nz)
-
AddFilter()
-
-
attributeIndexTipText()
- Returns the tip text for this property
-
attributeNameTipText()
- Returns the tip text for this property
-
getAttributeIndex()
- Get the index where the attribute will be inserted
-
getAttributeName()
- Get the name of the attribute to be created
-
getNominalLabels()
- Get the list of labels for nominal attribute creation
-
getOptions()
- Gets the current settings of the filter.
-
globalInfo()
- Returns a string describing this filter
-
input(Instance)
- Input an instance for filtering.
-
listOptions()
- Returns an enumeration describing the available options
-
main(String[])
- Main method for testing this class.
-
nominalLabelsTipText()
- Returns the tip text for this property
-
setAttributeIndex(int)
- Set the index where the attribute will be inserted
-
setAttributeName(String)
-
Set the new attribute's name
-
setInputFormat(Instances)
- Sets the format of the input instances.
-
setNominalLabels(String)
- Set the labels for nominal attribute creation.
-
setOptions(String[])
- Parses a list of options for this object.
AddFilter
public AddFilter()
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 listOptions()
- Returns an enumeration describing the available options
- Returns:
- an enumeration of all the available options
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
getOptions
public String[] getOptions()
- Gets the current settings of the filter.
- Returns:
- an array of strings suitable for passing to setOptions
setInputFormat
public boolean setInputFormat(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:
- setInputFormat in class Filter
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.
- 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 defined.
- Overrides:
- input in class Filter
attributeNameTipText
public String attributeNameTipText()
- Returns the tip text for this property
- Returns:
- tip text for this property suitable for
displaying in the explorer/experimenter gui
getAttributeName
public String getAttributeName()
- Get the name of the attribute to be created
- Returns:
- the new attribute name
setAttributeName
public void setAttributeName(String name)
- Set the new attribute's name
- Parameters:
- name - the new name
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 int getAttributeIndex()
- Get the index where the attribute will be inserted
- Returns:
- the attribute insertion index
setAttributeIndex
public void setAttributeIndex(int attributeIndex)
- Set the index where the attribute will be inserted
- Parameters:
- attributeIndex - the insertion index (-1 means last)
nominalLabelsTipText
public String nominalLabelsTipText()
- Returns the tip text for this property
- Returns:
- tip text for this property suitable for
displaying in the explorer/experimenter gui
getNominalLabels
public String getNominalLabels()
- Get the list of labels for nominal attribute creation
- Returns:
- the list of labels for nominal attribute creation
setNominalLabels
public void setNominalLabels(String labelList)
- Set the labels for nominal attribute creation.
- Parameters:
- labelList - a comma separated list of labels
- Throws: IllegalArgumentException
- if the labelList was invalid
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