Class RenameNominalValues
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.RenameNominalValues
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,CommandlineRunnable,OptionHandler,RevisionHandler,WeightedAttributesHandler,WeightedInstancesHandler,StreamableFilter,UnsupervisedFilter
public class RenameNominalValues
extends Filter
implements UnsupervisedFilter, StreamableFilter, OptionHandler, WeightedInstancesHandler, WeightedAttributesHandler
Renames the values of nominal attributes.
Valid options are:
-R Attributes to act on. Can be either a range string (e.g. 1,2,6-10) OR a comma-separated list of named attributes (default none)
-V Invert matching sense (i.e. act on all attributes other than those specified)
-N Nominal labels and their replacement values. E.g. red:blue, black:white, fred:bob
-I Ignore case when matching nominal values
- Version:
- $Revision: 15531 $
- Author:
- Mark Hall (mhall{[at]}pentaho{[dot]}com)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the Capabilities of this filter.booleanbooleanGet whether the supplied columns are to be removed or keptString[]Gets the current settings of the filter.Returns the revision string.Global help infoReturns the tip text for this propertybooleanInput an instance for filtering.Returns the tip text for this propertyReturns an enumeration describing the available options.static voidMain method for testing this class.Returns the tip text for this propertyvoidsetIgnoreCase(boolean ignore) booleansetInputFormat(Instances instanceInfo) Sets the format of the input instances.voidsetInvertSelection(boolean invert) Set whether selected columns should be removed or kept.voidsetOptions(String[] options) Parses a given list of options.voidsetSelectedAttributes(String atts) voidReturns the tip text for this propertyMethods 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
-
Constructor Details
-
RenameNominalValues
public RenameNominalValues()
-
-
Method Details
-
globalInfo
Global help info- Returns:
- the help info for this filter
-
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 structure has been defined.
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classFilter- Returns:
- the capabilities of this object
- See Also:
-
selectedAttributesTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setSelectedAttributes
-
getSelectedAttributes
-
valueReplacementsTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setValueReplacements
-
getValueReplacements
-
invertSelectionTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getInvertSelection
public boolean getInvertSelection()Get whether the supplied columns are to be removed or kept- Returns:
- true if the supplied columns will be kept
-
setInvertSelection
public void setInvertSelection(boolean invert) Set whether selected columns should be removed or kept. If true the selected columns are kept and unselected columns are deleted. If false selected columns are deleted and unselected columns are kept.- Parameters:
invert- the new invert setting
-
ignoreCaseTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setIgnoreCase
public void setIgnoreCase(boolean ignore) -
getIgnoreCase
public boolean getIgnoreCase() -
listOptions
Description copied from class:FilterReturns 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 Attributes to act on. Can be either a range string (e.g. 1,2,6-10) OR a comma-separated list of named attributes (default none)
-V Invert matching sense (i.e. act on all attributes other than those specified)
-N Nominal labels and their replacement values. E.g. red:blue, black:white, fred:bob
-I Ignore case when matching nominal values
- 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
Description copied from class:FilterGets the current settings of the filter.- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classFilter- Returns:
- an array of strings suitable for passing to setOptions
-
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
-