Class StringToNominal
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.StringToNominal
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,CommandlineRunnable,OptionHandler,RevisionHandler,WeightedAttributesHandler,WeightedInstancesHandler,UnsupervisedFilter
public class StringToNominal
extends Filter
implements UnsupervisedFilter, OptionHandler, WeightedAttributesHandler, WeightedInstancesHandler
Converts a range of string attributes (unspecified
number of values) to nominal (set number of values). You should ensure that
all string values that will appear are represented in the first batch of the
data.
Valid options are:
-R <col>
Sets the range of attribute indices ("first" and "last" are valid values
and ranges and lists can also be used) (default "last").
-V <col> Invert the range specified by -R.
- Version:
- $Revision: 14534 $
- Author:
- Len Trigg (len@reeltwo.com)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanSignifies that this batch of input to the filter is finished.Get the range of indices of the attributes used.Returns the Capabilities of this filter.String[]Gets the current settings of the filter.Returns the revision string.Returns a string describing this filterbooleanInput an instance for filtering.Returns an enumeration describing the available options.static voidMain method for testing this class.voidsetAttributeRange(String rangeList) Sets range of indices of the attributes used.booleansetInputFormat(Instances instanceInfo) Sets the format of the input instances.voidsetOptions(String[] options) Parses a given list of options.Methods inherited from class weka.filters.Filter
batchFilterFile, 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
-
Constructor Details
-
StringToNominal
public StringToNominal()
-
-
Method Details
-
globalInfo
Returns a string describing this filter- Returns:
- a description of the filter suitable for displaying in the explorer/experimenter gui
-
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:
UnsupportedAttributeTypeException- if the selected attribute a string attribute.Exception- if the input format can't be set successfully.
-
input
Input an instance for filtering. The instance is processed and made available for output immediately.- 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 structure has been defined.
-
batchFinished
public boolean batchFinished()Signifies 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:
batchFinishedin classFilter- Returns:
- true if there are instances pending output.
- Throws:
IllegalStateException- if no input structure has been defined.
-
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:-R <col> Sets the range of attribute indices ("first" and "last" are valid values and ranges and lists can also be used) (default "last").-V <col> Invert the range specified by -R.
- 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
-
attributeRangeTipText
- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getAttributeRange
Get the range of indices of the attributes used.- Returns:
- the index of the attribute
-
setAttributeRange
Sets range of indices of the attributes used.- Parameters:
rangeList- the list of attribute indices
-
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
-