Package adams.data.weka.classattribute

Class ByName

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.weka.classattribute.AbstractClassAttributeHeuristic

adams.data.weka.classattribute.ByName

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class ByName
extends AbstractClassAttributeHeuristic

The first attribute name that matches the regular expression is used as class attribute.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseRegExp	m_RegExp	the regular expression to use on the name.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ByName()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
int	determineClassAttribute(weka.core.Instances data)	Determines the class attribute index for the given dataset.
BaseRegExp	getRegExp()	Returns the regular expression to use for locating the class attribute.
String	globalInfo()	Returns a string describing the object.
String	regExpTipText()	Returns the tip text for this property.
void	setRegExp(BaseRegExp value)	Sets the index of the attribute to select.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_RegExp

protected BaseRegExp m_RegExp

the regular expression to use on the name.

Constructor Detail

ByName

public ByName()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setRegExp

public void setRegExp(BaseRegExp value)

Sets the index of the attribute to select.

Parameters:

value - the index

getRegExp

public BaseRegExp getRegExp()

Returns the regular expression to use for locating the class attribute.

Returns:

the expression

regExpTipText

public String regExpTipText()

Returns the tip text for this property.

Returns:

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

determineClassAttribute

public int determineClassAttribute(weka.core.Instances data)

Determines the class attribute index for the given dataset.

Specified by:

determineClassAttribute in class AbstractClassAttributeHeuristic

Parameters:

data - the dataset to inspect

Returns:

the index, -1 if failed to determine