Package adams.data.heatmapfeatures

Class AbstractMetaHeatmapFeatureGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.heatmapfeatures.AbstractHeatmapFeatureGenerator

adams.data.heatmapfeatures.AbstractMetaHeatmapFeatureGenerator

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractHeatmapFeatureGenerator>, adams.core.SizeOfHandler, Serializable, Comparable

Direct Known Subclasses:

CountValues

public abstract class AbstractMetaHeatmapFeatureGenerator
extends AbstractHeatmapFeatureGenerator

Ancestor for feature generators that use a base feature generator.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractHeatmapFeatureGenerator	m_Generator	the base feature generator.

Fields inherited from class adams.data.heatmapfeatures.AbstractHeatmapFeatureGenerator

m_Converter, m_Fields, m_Notes

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
abstract String	generatorTipText()	Returns the tip text for this property.
protected abstract AbstractHeatmapFeatureGenerator	getDefaultGenerator()	Returns the default feature generator to use.
AbstractHeatmapFeatureGenerator	getGenerator()	Returns the base feature generator to use.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
void	setGenerator(AbstractHeatmapFeatureGenerator value)	Sets the base feature generator to use.

Methods inherited from class adams.data.heatmapfeatures.AbstractHeatmapFeatureGenerator

checkData, cleanUp, compareTo, converterTipText, createHeader, destroy, equals, fieldsTipText, generate, generateRows, getConverter, getDatasetFormat, getFields, getNotes, getRowFormat, notesTipText, postProcessHeader, postProcessRow, postProcessRows, reset, setConverter, setFields, setNotes, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Generator

protected AbstractHeatmapFeatureGenerator m_Generator

the base feature generator.

Constructor Detail

AbstractMetaHeatmapFeatureGenerator

public AbstractMetaHeatmapFeatureGenerator()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class AbstractHeatmapFeatureGenerator

getDefaultGenerator

protected abstract AbstractHeatmapFeatureGenerator getDefaultGenerator()

Returns the default feature generator to use.

Returns:

the default generator

setGenerator

public void setGenerator(AbstractHeatmapFeatureGenerator value)

Sets the base feature generator to use.

Parameters:

value - the generator

getGenerator

public AbstractHeatmapFeatureGenerator getGenerator()

Returns the base feature generator to use.

Returns:

the generator

generatorTipText

public abstract String generatorTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractHeatmapFeatureGenerator

Returns:

null if no info available, otherwise short string