Package adams.flow.transformer.summarystatistics

Class AbstractSummaryStatistic

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.summarystatistics.AbstractSummaryStatistic

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCategoricalSummaryStatistic, AbstractGeneralSummaryStatistic, AbstractNumericSummaryStatistic

public abstract class AbstractSummaryStatistic
extends AbstractOptionHandler
implements SummaryStatistic

Ancestor for summary statistics.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
double[]	calculate()	Calculates the summary statistics.
protected String	check()	Hook method for performing checks before calculating statistic.
void	clear()	Clears all input.
protected abstract double[]	doCalculate()	Calculates the summary statistics.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

Methods inherited from interface adams.flow.transformer.summarystatistics.SummaryStatistic

getNames

Constructor Detail

AbstractSummaryStatistic

public AbstractSummaryStatistic()

Method Detail

clear

public void clear()

Clears all input.
Default implementation does nothing.

Specified by:

clear in interface SummaryStatistic

check

protected String check()

Hook method for performing checks before calculating statistic.
Default implementation returns null.

Returns:

null if successful, otherwise error message

doCalculate

protected abstract double[] doCalculate()

Calculates the summary statistics.

Returns:

the statistics

calculate

public double[] calculate()

Calculates the summary statistics.

Specified by:

calculate in interface SummaryStatistic

Returns:

the statistics

See Also:

SummaryStatistic.getNames()