weka.filters
Class SwapAttributeValuesFilter

java.lang.Object
  |
  +--weka.filters.Filter
        |
        +--weka.filters.SwapAttributeValuesFilter

All Implemented Interfaces:

OptionHandler, java.io.Serializable

public class SwapAttributeValuesFilter

extends Filter

implements 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).

Author:

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

See Also:

Serialized Form

Fields inherited from class weka.filters.Filter

m_NewBatch

Constructor Summary

SwapAttributeValuesFilter()

Method Summary

int	getAttributeIndex() Get the index of the attribute used.
int	getFirstValueIndex() Get the index of the first value used.
java.lang.String[]	getOptions() Gets the current settings of the filter.
int	getSecondValueIndex() Get the index of the second value used.
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.
void	setAttributeIndex(int attIndex) Sets index of the attribute used.
void	setFirstValueIndex(int 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.
void	setSecondValueIndex(int 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, 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

Constructor Detail

SwapAttributeValuesFilter

public SwapAttributeValuesFilter()

Method Detail

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

getAttributeIndex

public int getAttributeIndex()

Get the index of the attribute used.

Returns:

the index of the attribute

setAttributeIndex

public void setAttributeIndex(int attIndex)

Sets index of the attribute used.

Parameters:

index - the index of the attribute

getFirstValueIndex

public int getFirstValueIndex()

Get the index of the first value used.

Returns:

the index of the first value

setFirstValueIndex

public void setFirstValueIndex(int firstIndex)

Sets index of the first value used.

Parameters:

index - the index of the first value

getSecondValueIndex

public int getSecondValueIndex()

Get the index of the second value used.

Returns:

the index of the second value

setSecondValueIndex

public void setSecondValueIndex(int secondIndex)

Sets index of the second value used.

Parameters:

index - the index of the second value

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