Package weka.core.tokenizers.cleaners

Class MultiCleaner

java.lang.Object

weka.core.tokenizers.cleaners.AbstractTokenCleaner

weka.core.tokenizers.cleaners.MultiCleaner

All Implemented Interfaces:

Serializable, weka.core.OptionHandler, TokenCleaner

public class MultiCleaner
extends AbstractTokenCleaner

Combines multiple cleaners, applies them sequentially.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLEANER
protected TokenCleaner[]	m_Cleaners	the cleaners to use.

Constructor Summary

Constructors

Constructor	Description
MultiCleaner()

Method Summary

Modifier and Type	Method	Description
String	clean(String token)	Determines whether a token is clean or not.
String	cleanersTipText()	Returns the tip text for this property.
TokenCleaner[]	getCleaners()	Returns the cleaners to use.
protected TokenCleaner[]	getDefaultCleaners()	Returns the default token cleaners.
String[]	getOptions()	Gets the current option settings for the OptionHandler.
String	globalInfo()	Returns a string describing the cleaner.
Enumeration	listOptions()	Returns an enumeration describing the available options.
void	setCleaners(TokenCleaner[] value)	Sets the cleaners to use.
void	setOptions(String[] options)	Sets the OptionHandler's options using the given list.

Methods inherited from class weka.core.tokenizers.cleaners.AbstractTokenCleaner

reset

Methods inherited from class java.lang.Object

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

Field Detail

CLEANER

public static final String CLEANER

See Also:

Constant Field Values

m_Cleaners

protected TokenCleaner[] m_Cleaners

the cleaners to use.

Constructor Detail

MultiCleaner

public MultiCleaner()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the cleaner.

Specified by:

globalInfo in class AbstractTokenCleaner

Returns:

a description suitable for displaying in the explorer/experimenter gui

listOptions

public Enumeration listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class AbstractTokenCleaner

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(String[] options)
                throws Exception

Sets the OptionHandler's options using the given list. All options will be set (or reset) during this call (i.e. incremental setting of options is not possible).

Specified by:

setOptions in interface weka.core.OptionHandler

Overrides:

setOptions in class AbstractTokenCleaner

Parameters:

options - the list of options as an array of strings

Throws:

Exception - if an option is not supported

getOptions

public String[] getOptions()

Gets the current option settings for the OptionHandler.

Specified by:

getOptions in interface weka.core.OptionHandler

Overrides:

getOptions in class AbstractTokenCleaner

Returns:

the list of current option settings as an array of strings

getDefaultCleaners

protected TokenCleaner[] getDefaultCleaners()

Returns the default token cleaners.

Returns:

the default

setCleaners

public void setCleaners(TokenCleaner[] value)

Sets the cleaners to use.

Parameters:

value - the cleaners

getCleaners

public TokenCleaner[] getCleaners()

Returns the cleaners to use.

Returns:

the cleaners

cleanersTipText

public String cleanersTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

clean

public String clean(String token)

Determines whether a token is clean or not.

Specified by:

clean in interface TokenCleaner

Specified by:

clean in class AbstractTokenCleaner

Parameters:

token - the token to check

Returns:

the clean token or null to ignore