Package adams.data.weka.relationname

Class AttributeIndex

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.weka.relationname.AbstractRelationNameHeuristic

adams.data.weka.relationname.AttributeIndex

All Implemented Interfaces:

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

public class AttributeIndex
extends AbstractRelationNameHeuristic

Uses the name of the specified attribute as relation name.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected WekaAttributeIndex	m_Index	the attribute index.

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
AttributeIndex()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	determineRelationName(File file, weka.core.Instances data)	Determines the relation name for the given file/dataset pair.
WekaAttributeIndex	getIndex()	Returns the index of the attribute to select.
String	globalInfo()	Returns a string describing the object.
String	indexTipText()	Returns the tip text for this property.
void	setIndex(WekaAttributeIndex 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_Index

protected WekaAttributeIndex m_Index

the attribute index.

Constructor Detail

AttributeIndex

public AttributeIndex()

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

setIndex

public void setIndex(WekaAttributeIndex value)

Sets the index of the attribute to select.

Parameters:

value - the index

getIndex

public WekaAttributeIndex getIndex()

Returns the index of the attribute to select.

Returns:

the index

indexTipText

public String indexTipText()

Returns the tip text for this property.

Returns:

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

determineRelationName

public String determineRelationName(File file,
                                    weka.core.Instances data)

Determines the relation name for the given file/dataset pair.

Specified by:

determineRelationName in class AbstractRelationNameHeuristic

Parameters:

file - the file the dataset was loaded from (maybe null)

data - the loaded dataset

Returns:

the relation name, null if failed to determine