Class Add
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.Add
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,CommandlineRunnable,OptionHandler,RevisionHandler,WeightedAttributesHandler,WeightedInstancesHandler,StreamableFilter,UnsupervisedFilter
public class Add
extends Filter
implements UnsupervisedFilter, StreamableFilter, OptionHandler, WeightedInstancesHandler, WeightedAttributesHandler
An instance filter that adds a new attribute to the
dataset. The new attribute will contain all missing values.
Valid options are:
-T <NUM|NOM|STR|DAT> The type of attribute to create: NUM = Numeric attribute NOM = Nominal attribute STR = String attribute DAT = Date attribute (default: NUM)
-C <index> Specify where to insert the column. First and last are valid indexes.(default: last)
-N <name> Name of the new attribute. (default: 'Unnamed')
-L <label1,label2,...> Create nominal attribute with given labels (default: numeric attribute)
-F <format> The format of the date values (see ISO-8601) (default: yyyy-MM-dd'T'HH:mm:ss)
-W <double> The weight for the new attribute (default: 1.0)*
- Version:
- $Revision: 14534 $
- Author:
- Len Trigg (trigg@cs.waikato.ac.nz)
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the tip text for this property.Returns the tip text for this property.Returns the tip text for this propertyReturns the tip text for this property.Get the index of the attribute used.Get the name of the attribute to be created.Gets the type of attribute to generate.Returns the Capabilities of this filter.Get the date format, complying to ISO-8601.Get the list of labels for nominal attribute creation.String[]Gets the current settings of the filter.Returns the revision string.doubleGet the weight of the attribute used.Returns a string describing this filter.booleanInput an instance for filtering.Returns an enumeration describing the available options.static voidMain method for testing this class.Returns the tip text for this property.voidsetAttributeIndex(String attIndex) Sets index of the attribute used.voidsetAttributeName(String name) Set the new attribute's name.voidsetAttributeType(SelectedTag value) Sets the type of attribute to generate.voidsetDateFormat(String value) Set the date format, complying to ISO-8601.booleansetInputFormat(Instances instanceInfo) Sets the format of the input instances.voidsetNominalLabels(String labelList) Set the labels for nominal attribute creation.voidsetOptions(String[] options) Parses a given list of options.voidsetWeight(double weight) Sets weight of the attribute used.Returns the tip text for this property.Methods inherited from class weka.filters.Filter
batchFilterFile, batchFinished, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper
-
Field Details
-
TAGS_TYPE
the attribute type.
-
-
Constructor Details
-
Add
public Add()
-
-
Method Details
-
globalInfo
Returns a string describing this filter.- Returns:
- a description of the filter suitable for displaying in the explorer/experimenter gui
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classFilter- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options. Valid options are:-T <NUM|NOM|STR|DAT> The type of attribute to create: NUM = Numeric attribute NOM = Nominal attribute STR = String attribute DAT = Date attribute (default: NUM)
-C <index> Specify where to insert the column. First and last are valid indexes.(default: last)
-N <name> Name of the new attribute. (default: 'Unnamed')
-L <label1,label2,...> Create nominal attribute with given labels (default: numeric attribute)
-F <format> The format of the date values (see ISO-8601) (default: yyyy-MM-dd'T'HH:mm:ss)
-W <double> The weight for the new attribute (default: 1.0)
- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classFilter- Parameters:
options- the list of options as an array of strings- Throws:
Exception- if an option is not supported
-
getOptions
Gets the current settings of the filter.- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classFilter- Returns:
- an array of strings suitable for passing to setOptions
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classFilter- Returns:
- the capabilities of this object
- See Also:
-
setInputFormat
Sets the format of the input instances.- Overrides:
setInputFormatin 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:
Exception- if the format couldn't be set successfully
-
input
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:
inputin classFilter- 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.
-
attributeNameTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getAttributeName
Get the name of the attribute to be created.- Returns:
- the new attribute name
-
setAttributeName
Set the new attribute's name.- Parameters:
name- the new name
-
attributeIndexTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getAttributeIndex
Get the index of the attribute used.- Returns:
- the index of the attribute
-
setAttributeIndex
Sets index of the attribute used.- Parameters:
attIndex- the index of the attribute
-
weightTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getWeight
public double getWeight()Get the weight of the attribute used.- Returns:
- the weight of the attribute
-
setWeight
public void setWeight(double weight) Sets weight of the attribute used.- Parameters:
weight- the weight of the attribute
-
nominalLabelsTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getNominalLabels
Get the list of labels for nominal attribute creation.- Returns:
- the list of labels for nominal attribute creation
-
setNominalLabels
Set the labels for nominal attribute creation.- Parameters:
labelList- a comma separated list of labels- Throws:
IllegalArgumentException- if the labelList was invalid
-
attributeTypeTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setAttributeType
Sets the type of attribute to generate.- Parameters:
value- the attribute type
-
getAttributeType
Gets the type of attribute to generate.- Returns:
- the current attribute type.
-
dateFormatTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getDateFormat
Get the date format, complying to ISO-8601.- Returns:
- the date format
-
setDateFormat
Set the date format, complying to ISO-8601.- Parameters:
value- a comma separated list of labels
-
getRevision
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Overrides:
getRevisionin classFilter- Returns:
- the revision
-
main
Main method for testing this class.- Parameters:
argv- should contain arguments to the filter: use -h for help
-