Package adams.data.statistics

Class AbstractOptionalSampleArrayStatistic<T extends Serializable>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.statistics.AbstractArrayStatistic<T>

adams.data.statistics.AbstractOptionalSampleArrayStatistic<T>

Type Parameters:

T - the type of array

All Implemented Interfaces:

AdditionalInformationHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractArrayStatistic>, SizeOfHandler, OptionalSampleArrayStatistic, Serializable

Direct Known Subclasses:

ArrayStandardDeviation, ArrayStandardize, ArrayStandardScores

public abstract class AbstractOptionalSampleArrayStatistic<T extends Serializable>
extends AbstractArrayStatistic<T>
implements OptionalSampleArrayStatistic

Abstract super class for array statistics that can interprete the arrays either as samples or populations.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.statistics.AbstractArrayStatistic

AbstractArrayStatistic.StatisticContainer<T extends Serializable>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_IsSample	whether the arrays are samples or populations.

Fields inherited from class adams.data.statistics.AbstractArrayStatistic

m_Data

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
boolean	getIsSample()	Returns whether the arrays represent samples instead of populations.
String	isSampleTipText()	Returns the tip text for this property.
void	setIsSample(boolean value)	Sets whether the arrays represent samples instead of populations.

Methods inherited from class adams.data.statistics.AbstractArrayStatistic

add, calculate, check, checkEqualLength, clear, doCalculate, forCommandLine, forName, get, getAdditionalInformation, getMax, getMin, getStatistics, initialize, remove, set, shallowCopy, shallowCopy, size, toString

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine

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_IsSample

protected boolean m_IsSample

whether the arrays are samples or populations.

Constructor Detail

AbstractOptionalSampleArrayStatistic

public AbstractOptionalSampleArrayStatistic()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setIsSample

public void setIsSample(boolean value)

Sets whether the arrays represent samples instead of populations.

Specified by:

setIsSample in interface OptionalSampleArrayStatistic

Parameters:

value - true if arrays are samples and not populations

getIsSample

public boolean getIsSample()

Returns whether the arrays represent samples instead of populations.

Specified by:

getIsSample in interface OptionalSampleArrayStatistic

Returns:

true if arrays are samples and not populations

isSampleTipText

public String isSampleTipText()

Returns the tip text for this property.

Specified by:

isSampleTipText in interface OptionalSampleArrayStatistic

Returns:

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