weka.core.stopwords

Class AbstractStopwords

java.lang.Object

weka.core.stopwords.AbstractStopwords

All Implemented Interfaces:

java.io.Serializable, OptionHandler, StopwordsHandler

Direct Known Subclasses:

AbstractFileBasedStopwords, MultiStopwords, Null, Rainbow

public abstract class AbstractStopwords
extends java.lang.Object
implements OptionHandler, StopwordsHandler, java.io.Serializable

Ancestor for stopwords classes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_Debug debugging flag.
protected boolean	m_Initialized whether the scheme has been initialized.

Constructor Summary

Constructors

Constructor and Description
AbstractStopwords()

Method Summary

Modifier and Type	Method and Description
protected void	debug(java.lang.String msg) Outputs the debug message, prefixed with classname.
java.lang.String	debugTipText() Returns the tip text for this property
protected void	error(java.lang.String msg) Outputs the error message, prefixed with classname.
boolean	getDebug() Get whether debugging is turned on.
java.lang.String[]	getOptions() Gets the current settings of the Classifier.
abstract java.lang.String	globalInfo() Returns a string describing the stopwords scheme.
protected void	initialize() Performs intialization of the scheme.
protected abstract boolean	is(java.lang.String word) Returns true if the given string is a stop word.
boolean	isStopword(java.lang.String word) Returns true if the given string is a stop word.
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
protected void	reset() Resets the scheme and the initialized state.
void	setDebug(boolean debug) Set debugging mode.
void	setOptions(java.lang.String[] options) Parses a given list of options.

Methods inherited from class java.lang.Object

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

Field Detail

m_Initialized

protected boolean m_Initialized

whether the scheme has been initialized.

m_Debug

protected boolean m_Debug

debugging flag.

Constructor Detail

AbstractStopwords

public AbstractStopwords()

Method Detail

globalInfo

public abstract java.lang.String globalInfo()

Returns a string describing the stopwords scheme.

Returns:

a description suitable for displaying in the gui

reset

protected void reset()

Resets the scheme and the initialized state.

listOptions

public java.util.Enumeration<Option> 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 a given list of options.

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 Classifier.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

setDebug

public void setDebug(boolean debug)

Set debugging mode.

Parameters:

debug - true if debug output should be printed

getDebug

public boolean getDebug()

Get whether debugging is turned on.

Returns:

true if debugging output is on

debugTipText

public java.lang.String debugTipText()

Returns the tip text for this property

Returns:

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

error

protected void error(java.lang.String msg)

Outputs the error message, prefixed with classname.

Parameters:

msg - the message to output

debug

protected void debug(java.lang.String msg)

Outputs the debug message, prefixed with classname.

Parameters:

msg - the message to output

initialize

protected void initialize()

Performs intialization of the scheme.

Default implementation does nothing.

is

protected abstract boolean is(java.lang.String word)

Returns true if the given string is a stop word.

Parameters:

word - the word to test

Returns:

true if the word is a stopword

isStopword

public boolean isStopword(java.lang.String word)

Returns true if the given string is a stop word.

Specified by:

isStopword in interface StopwordsHandler

Parameters:

word - the word to test

Returns:

true if the word is a stopword