Class AddID
- java.lang.Object
-
- weka.filters.Filter
-
- weka.filters.unsupervised.attribute.AddID
-
- All Implemented Interfaces:
java.io.Serializable
,CapabilitiesHandler
,OptionHandler
,RevisionHandler
,UnsupervisedFilter
public class AddID extends Filter implements UnsupervisedFilter, OptionHandler
An instance filter that adds an ID attribute to the dataset. The new attribute contains a unique ID for each instance.
Note: The ID is not reset for the second batch of files (using -b and -r and -s). Valid options are:-C <index> Specify where to insert the ID. First and last are valid indexes.(default first)
-N <name> Name of the new attribute. (default = 'ID')
- Version:
- $Revision: 5543 $
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AddID()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
attributeNameTipText()
Returns the tip text for this propertyboolean
batchFinished()
Signify that this batch of input to the filter is finished.java.lang.String
getAttributeName()
Get the name of the attribute to be createdCapabilities
getCapabilities()
Returns the Capabilities of this filter.java.lang.String
getIDIndex()
Get the index of the attribute used.java.lang.String[]
getOptions()
Gets the current settings of the filter.java.lang.String
getRevision()
Returns the revision string.java.lang.String
globalInfo()
Returns a string describing this filterjava.lang.String
IDIndexTipText()
Returns the tip text for this propertyboolean
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[] args)
Main method for testing this class.void
setAttributeName(java.lang.String value)
Set the new attribute's namevoid
setIDIndex(java.lang.String value)
Sets index of the attribute used.boolean
setInputFormat(Instances instanceInfo)
Sets the format of the input instances.void
setOptions(java.lang.String[] options)
Parses a given list of options.-
Methods inherited from class weka.filters.Filter
batchFilterFile, filterFile, getCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, numPendingOutput, output, outputPeek, toString, useFilter, wekaStaticWrapper
-
-
-
-
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 interfaceOptionHandler
- Returns:
- an enumeration of all the available options.
-
setOptions
public void setOptions(java.lang.String[] options) throws java.lang.Exception
Parses a given list of options. Valid options are:-C <index> Specify where to insert the ID. First and last are valid indexes.(default first)
-N <name> Name of the new attribute. (default = 'ID')
- Specified by:
setOptions
in interfaceOptionHandler
- 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 interfaceOptionHandler
- Returns:
- an array of strings suitable for passing to setOptions
-
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 current attribute name
-
setAttributeName
public void setAttributeName(java.lang.String value)
Set the new attribute's name- Parameters:
value
- the new name
-
IDIndexTipText
public java.lang.String IDIndexTipText()
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getIDIndex
public java.lang.String getIDIndex()
Get the index of the attribute used.- Returns:
- the index of the attribute
-
setIDIndex
public void setIDIndex(java.lang.String value)
Sets index of the attribute used.- Parameters:
value
- the index of the attribute
-
getCapabilities
public Capabilities getCapabilities()
Returns the Capabilities of this filter.- Specified by:
getCapabilities
in interfaceCapabilitiesHandler
- Overrides:
getCapabilities
in classFilter
- Returns:
- the capabilities of this object
- See Also:
Capabilities
-
setInputFormat
public boolean setInputFormat(Instances instanceInfo) throws java.lang.Exception
Sets the format of the input instances.- Overrides:
setInputFormat
in classFilter
- 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. Filter requires all training instances be read before producing output.
-
batchFinished
public boolean batchFinished()
Signify 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 classFilter
- Returns:
- true if there are instances pending output
- Throws:
java.lang.IllegalStateException
- if no input structure has been defined
-
getRevision
public java.lang.String getRevision()
Returns the revision string.- Specified by:
getRevision
in interfaceRevisionHandler
- Overrides:
getRevision
in classFilter
- Returns:
- the revision
-
main
public static void main(java.lang.String[] args)
Main method for testing this class.- Parameters:
args
- should contain arguments to the filter: use -h for help
-
-