Package adams.data.heatmapfeatures

Class AbstractHeatmapFeatureGeneratorWithSkippableMissingValues

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.heatmapfeatures.AbstractHeatmapFeatureGenerator

adams.data.heatmapfeatures.AbstractHeatmapFeatureGeneratorWithSkippableMissingValues

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:

Histogram, Mean, Median, StandardDeviation

public abstract class AbstractHeatmapFeatureGeneratorWithSkippableMissingValues
extends AbstractHeatmapFeatureGenerator

Ancestor for feature generators that can decide whether to skip missing values.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_SkipMissing	whether to skip missing values.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
boolean	getSkipMissing()	Returns whether to exclude missing values from the histogram calculation.
void	setSkipMissing(boolean value)	Sets whether to exclude missing values from the histogram calculation.
String	skipMissingTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.heatmapfeatures.AbstractHeatmapFeatureGenerator

checkData, cleanUp, compareTo, converterTipText, createHeader, destroy, equals, fieldsTipText, generate, generateRows, getConverter, getDatasetFormat, getFields, getNotes, getQuickInfo, 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_SkipMissing

protected boolean m_SkipMissing

whether to skip missing values.

Constructor Detail

AbstractHeatmapFeatureGeneratorWithSkippableMissingValues

public AbstractHeatmapFeatureGeneratorWithSkippableMissingValues()

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

setSkipMissing

public void setSkipMissing(boolean value)

Sets whether to exclude missing values from the histogram calculation.

Parameters:

value - true if to skip

getSkipMissing

public boolean getSkipMissing()

Returns whether to exclude missing values from the histogram calculation.

Returns:

true if to skip

skipMissingTipText

public String skipMissingTipText()

Returns the tip text for this property.

Returns:

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