|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweka.filters.Filter
weka.filters.unsupervised.attribute.AddID
public class AddID
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).
-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')
Constructor Summary | |
---|---|
AddID()
|
Method Summary | |
---|---|
java.lang.String |
attributeNameTipText()
Returns the tip text for this property |
boolean |
batchFinished()
Signify that this batch of input to the filter is finished. |
java.lang.String |
getAttributeName()
Get the name of the attribute to be created |
Capabilities |
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 filter |
java.lang.String |
IDIndexTipText()
Returns the tip text for this property |
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[] args)
Main method for testing this class. |
void |
setAttributeName(java.lang.String value)
Set the new attribute's name |
void |
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 |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AddID()
Method Detail |
---|
public java.lang.String globalInfo()
public java.util.Enumeration listOptions()
listOptions
in interface OptionHandler
public void setOptions(java.lang.String[] options) throws java.lang.Exception
-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')
setOptions
in interface OptionHandler
options
- the list of options as an array of strings
java.lang.Exception
- if an option is not supportedpublic java.lang.String[] getOptions()
getOptions
in interface OptionHandler
public java.lang.String attributeNameTipText()
public java.lang.String getAttributeName()
public void setAttributeName(java.lang.String value)
value
- the new namepublic java.lang.String IDIndexTipText()
public java.lang.String getIDIndex()
public void setIDIndex(java.lang.String value)
value
- the index of the attributepublic Capabilities getCapabilities()
getCapabilities
in interface CapabilitiesHandler
getCapabilities
in class Filter
Capabilities
public boolean setInputFormat(Instances instanceInfo) throws java.lang.Exception
setInputFormat
in class Filter
instanceInfo
- an Instances object containing the input instance
structure (any instances contained in the object are ignored - only the
structure is required).
java.lang.Exception
- if the format couldn't be set successfullypublic boolean input(Instance instance)
input
in class Filter
instance
- the input instance
java.lang.IllegalStateException
- if no input format has been set.public boolean batchFinished()
batchFinished
in class Filter
java.lang.IllegalStateException
- if no input structure has been definedpublic java.lang.String getRevision()
getRevision
in interface RevisionHandler
getRevision
in class Filter
public static void main(java.lang.String[] args)
args
- should contain arguments to the filter: use -h for help
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |