Class AddValues
- java.lang.Object
-
- weka.filters.Filter
-
- weka.filters.unsupervised.attribute.AddValues
-
- All Implemented Interfaces:
java.io.Serializable
,CapabilitiesHandler
,OptionHandler
,RevisionHandler
,StreamableFilter
,UnsupervisedFilter
public class AddValues extends Filter implements UnsupervisedFilter, StreamableFilter, OptionHandler
Adds the labels from the given list to an attribute if they are missing. The labels can also be sorted in an ascending manner. If no labels are provided then only the (optional) sorting applies. Valid options are:-C <col> Sets the attribute index (default last).
-L <label1,label2,...> Comma-separated list of labels to add. (default: none)
-S Turns on the sorting of the labels.
Based on code from AddValues.- Version:
- $Revision: 6897 $
- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
AddValues
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AddValues()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
attributeIndexTipText()
Returns the tip text for this propertyjava.lang.String
getAttributeIndex()
Get the index of the attribute used.Capabilities
getCapabilities()
Returns the Capabilities of this filter.java.lang.String
getLabels()
Get the comma-separated list of labels that are added.java.lang.String[]
getOptions()
Gets the current settings of the filter.java.lang.String
getRevision()
Returns the revision string.boolean
getSort()
Gets whether the labels are sorted or not.java.lang.String
globalInfo()
Returns a string describing this filterboolean
input(Instance instance)
Input an instance for filtering.java.lang.String
labelsTipText()
Returns the tip text for this propertyjava.util.Enumeration
listOptions()
Returns an enumeration describing the available options.static void
main(java.lang.String[] args)
Main method for testing and running this class.void
setAttributeIndex(java.lang.String attIndex)
Sets index of the attribute used.boolean
setInputFormat(Instances instanceInfo)
Sets the format of the input instances.void
setLabels(java.lang.String value)
Sets the comma-separated list of labels.void
setOptions(java.lang.String[] options)
Parses a given list of options.void
setSort(boolean value)
Sets whether the labels are sorted.java.lang.String
sortTipText()
Returns the tip text for this property-
Methods inherited from class weka.filters.Filter
batchFilterFile, batchFinished, 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 <col> Sets the attribute index (default last).
-L <label1,label2,...> Comma-separated list of labels to add. (default: none)
-S Turns on the sorting of the labels.
- 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
-
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 input format can't be set successfully
-
input
public boolean input(Instance instance)
Input an instance for filtering. The instance is processed and made available for output immediately.
-
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.- Parameters:
attIndex
- the index of the attribute
-
labelsTipText
public java.lang.String labelsTipText()
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getLabels
public java.lang.String getLabels()
Get the comma-separated list of labels that are added.- Returns:
- the list of labels
-
setLabels
public void setLabels(java.lang.String value)
Sets the comma-separated list of labels.- Parameters:
value
- the list
-
sortTipText
public java.lang.String sortTipText()
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getSort
public boolean getSort()
Gets whether the labels are sorted or not.- Returns:
- true if the labels are sorted
-
setSort
public void setSort(boolean value)
Sets whether the labels are sorted.- Parameters:
value
- if true the labels are sorted
-
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 and running this class.- Parameters:
args
- should contain arguments to the filter: use -h for help
-
-