weka.filters.unsupervised.attribute
Class Add

java.lang.Object
  extended byweka.filters.Filter
      extended byweka.filters.unsupervised.attribute.Add
All Implemented Interfaces:
OptionHandler, java.io.Serializable, StreamableFilter, UnsupervisedFilter

public class Add
extends Filter
implements UnsupervisedFilter, StreamableFilter, 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.2 $
Author:
Len Trigg (trigg@cs.waikato.ac.nz)
See Also:
Serialized Form

Field Summary
protected  int m_AttributeType
          Record the type of attribute to insert
private  SingleIndex m_Insert
          The location to insert the new attribute
protected  FastVector m_Labels
          The list of labels for nominal attribute
protected  java.lang.String m_Name
          The name for the new attribute
 
Fields inherited from class weka.filters.Filter
m_NewBatch
 
Constructor Summary
Add()
           
 
Method Summary
 java.lang.String attributeIndexTipText()
          Returns the tip text for this property
 java.lang.String attributeNameTipText()
          Returns the tip text for this property
 java.lang.String getAttributeIndex()
          Get the index of the attribute used.
 java.lang.String getAttributeName()
          Get the name of the attribute to be created
 java.lang.String getNominalLabels()
          Get the list of labels for nominal attribute creation
 java.lang.String[] getOptions()
          Gets the current settings of the filter.
 java.lang.String globalInfo()
          Returns a string describing this filter
 boolean input(Instance instance)
          Input an instance for filtering.
 java.util.Enumeration listOptions()
          Returns an enumeration describing the available options.
static void main(java.lang.String[] argv)
          Main method for testing this class.
 java.lang.String nominalLabelsTipText()
          Returns the tip text for this property
 void setAttributeIndex(java.lang.String attIndex)
          Sets index of the attribute used.
 void setAttributeName(java.lang.String name)
          Set the new attribute's name
 boolean setInputFormat(Instances instanceInfo)
          Sets the format of the input instances.
 void setNominalLabels(java.lang.String labelList)
          Set the labels for nominal attribute creation.
 void setOptions(java.lang.String[] options)
          Parses a list of options for this object.
 
Methods inherited from class weka.filters.Filter
batchFilterFile, batchFinished, bufferInput, copyStringValues, copyStringValues, filterFile, flushInput, getInputFormat, getInputStringIndex, getOutputFormat, getOutputStringIndex, getStringIndices, inputFormat, inputFormatPeek, isOutputFormatDefined, numPendingOutput, output, outputFormat, outputFormatPeek, outputPeek, push, resetQueue, setOutputFormat, useFilter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_AttributeType

protected int m_AttributeType
Record the type of attribute to insert


m_Name

protected java.lang.String m_Name
The name for the new attribute


m_Insert

private SingleIndex m_Insert
The location to insert the new attribute


m_Labels

protected FastVector m_Labels
The list of labels for nominal attribute

Constructor Detail

Add

public Add()
Method Detail

globalInfo

public java.lang.String globalInfo()
Returns a string describing this filter

Returns:
a description of the filter suitable for displaying in the explorer/experimenter gui

listOptions

public java.util.Enumeration listOptions()
Returns an enumeration describing the available options.

Specified by:
listOptions in interface OptionHandler
Returns:
an enumeration of all the available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.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')

Specified by:
setOptions in interface OptionHandler
Parameters:
options - the list of options as an array of strings
Throws:
java.lang.Exception - if an option is not supported

getOptions

public java.lang.String[] getOptions()
Gets the current settings of the filter.

Specified by:
getOptions in interface OptionHandler
Returns:
an array of strings suitable for passing to setOptions

setInputFormat

public boolean setInputFormat(Instances instanceInfo)
                       throws java.lang.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:
java.lang.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:
java.lang.IllegalStateException - if no input format has been defined.

attributeNameTipText

public java.lang.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 java.lang.String getAttributeName()
Get the name of the attribute to be created

Returns:
the new attribute name

setAttributeName

public void setAttributeName(java.lang.String name)
Set the new attribute's name

Parameters:
name - the new name

attributeIndexTipText

public java.lang.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 java.lang.String getAttributeIndex()
Get the index of the attribute used.

Returns:
the index of the attribute

setAttributeIndex

public void setAttributeIndex(java.lang.String attIndex)
Sets index of the attribute used.


nominalLabelsTipText

public java.lang.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 java.lang.String getNominalLabels()
Get the list of labels for nominal attribute creation

Returns:
the list of labels for nominal attribute creation

setNominalLabels

public void setNominalLabels(java.lang.String labelList)
Set the labels for nominal attribute creation.

Parameters:
labelList - a comma separated list of labels
Throws:
java.lang.IllegalArgumentException - if the labelList was invalid

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