weka.filters.unsupervised.attribute
Class SwapValues

java.lang.Object
  weka.filters.Filter
      weka.filters.unsupervised.attribute.SwapValues

All Implemented Interfaces:

OptionHandler, java.io.Serializable, StreamableFilter, UnsupervisedFilter

public class SwapValues

extends Filter

implements UnsupervisedFilter, StreamableFilter, OptionHandler

Swaps two values of a nominal attribute.

Valid filter-specific options are:

-C col
Index of the attribute to be changed. (default last)

-F index
Index of the first value (default first).

-S index
Index of the second value (default last).

Version:

$Revision: 1.4 $

Author:

Eibe Frank (eibe@cs.waikato.ac.nz)

See Also:

Serialized Form

Field Summary

private SingleIndex	m_AttIndex The attribute's index setting.
private SingleIndex	m_FirstIndex The first value's index setting.
private SingleIndex	m_SecondIndex The second value's index setting.

Fields inherited from class weka.filters.Filter

m_NewBatch

Constructor Summary

SwapValues()

Method Summary

java.lang.String	attributeIndexTipText()
java.lang.String	firstValueIndexTipText()
java.lang.String	getAttributeIndex() Get the index of the attribute used.
java.lang.String	getFirstValueIndex() Get the index of the first value used.
java.lang.String[]	getOptions() Gets the current settings of the filter.
java.lang.String	getSecondValueIndex() Get the index of the second value used.
java.lang.String	globalInfo() Returns a string describing this filter
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[] argv) Main method for testing this class.
java.lang.String	secondValueIndexTipText()
void	setAttributeIndex(java.lang.String attIndex) Sets index of the attribute used.
void	setFirstValueIndex(java.lang.String firstIndex) Sets index of the first value used.
boolean	setInputFormat(Instances instanceInfo) Sets the format of the input instances.
void	setOptions(java.lang.String[] options) Parses the options for this object.
private void	setOutputFormat() Set the output format.
void	setSecondValueIndex(java.lang.String secondIndex) Sets index of the second value used.

Methods inherited from class weka.filters.Filter

batchFilterFile, batchFinished, bufferInput, copyStringValues, copyStringValues, filterFile, flushInput, getInputFormat, getInputStringIndex, getOutputFormat, getOutputStringIndex, getStringIndices, inputFormat, inputFormatPeek, isOutputFormatDefined, numPendingOutput, output, outputFormat, outputFormatPeek, outputPeek, push, resetQueue, setOutputFormat, useFilter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_AttIndex

private SingleIndex m_AttIndex

The attribute's index setting.

m_FirstIndex

private SingleIndex m_FirstIndex

The first value's index setting.

m_SecondIndex

private SingleIndex m_SecondIndex

The second value's index setting.

Constructor Detail

SwapValues

public SwapValues()

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

setInputFormat

public boolean setInputFormat(Instances instanceInfo)
                       throws java.lang.Exception

Sets the format of the input instances.

Overrides:

setInputFormat in class Filter

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 is not nominal or if it only has one value.

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.

Overrides:

input in class Filter

Parameters:

instance - the input instance

Returns:

true if the filtered instance may now be collected with output().

Throws:

java.lang.IllegalStateException - if no input structure has been defined.

listOptions

public java.util.Enumeration listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses the options for this object. Valid options are:

-C col
The column containing the values to be merged. (default last)

-F index
Index of the first value (default first).

-S index
Index of the second value (default last).

Specified by:

setOptions in interface OptionHandler

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 interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

attributeIndexTipText

public java.lang.String attributeIndexTipText()

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.

firstValueIndexTipText

public java.lang.String firstValueIndexTipText()

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

getFirstValueIndex

public java.lang.String getFirstValueIndex()

Get the index of the first value used.

Returns:

the index of the first value

setFirstValueIndex

public void setFirstValueIndex(java.lang.String firstIndex)

Sets index of the first value used.

secondValueIndexTipText

public java.lang.String secondValueIndexTipText()

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

getSecondValueIndex

public java.lang.String getSecondValueIndex()

Get the index of the second value used.

Returns:

the index of the second value

setSecondValueIndex

public void setSecondValueIndex(java.lang.String secondIndex)

Sets index of the second value used.

setOutputFormat

private void setOutputFormat()

Set the output format. Swapss the desired nominal attribute values in the header and calls setOutputFormat(Instances) appropriately.

main

public static void main(java.lang.String[] argv)

Main method for testing this class.

Parameters:

argv - should contain arguments to the filter: use -h for help