Package adams.data.statistics

Class MultiArrayStatistic<T extends Number>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.statistics.AbstractArrayStatistic<T>

adams.data.statistics.MultiArrayStatistic<T>

Type Parameters:

T - the data to process

All Implemented Interfaces:

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

public class MultiArrayStatistic<T extends Number>
extends AbstractArrayStatistic<T>

Merges the spreadsheets generated by its sub-statistics into a single one.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-statistic <adams.data.statistics.AbstractArrayStatistic [options]> [-statistic ...] (property: subStatistics)
    The base statistics to accumulate in a single spreadsheet (side-by-side).
    default: adams.data.statistics.ArrayMedian
 

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 AbstractArrayStatistic[]	m_SubStatistics	the statistics to perform and merge into single spreadsheet.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected AbstractArrayStatistic.StatisticContainer	doCalculate()	Generates the actual result.
int	getMax()	Returns the maximum number of arrays that need to be present.
int	getMin()	Returns the minimum number of arrays that need to be present.
AbstractArrayStatistic[]	getSubStatistics()	Returns the base statistics to use.
String	globalInfo()	Returns a string describing the object.
void	setSubStatistics(AbstractArrayStatistic[] value)	Sets the base statistics to use.
String	subStatisticsTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.statistics.AbstractArrayStatistic

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

Methods inherited from class adams.core.option.AbstractOptionHandler

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

protected AbstractArrayStatistic[] m_SubStatistics

the statistics to perform and merge into single spreadsheet.

Constructor Detail

MultiArrayStatistic

public MultiArrayStatistic()

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

setSubStatistics

public void setSubStatistics(AbstractArrayStatistic[] value)

Sets the base statistics to use.

Parameters:

value - the statistics

getSubStatistics

public AbstractArrayStatistic[] getSubStatistics()

Returns the base statistics to use.

Returns:

the statistics

subStatisticsTipText

public String subStatisticsTipText()

Returns the tip text for this property.

Returns:

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

getMin

public int getMin()

Returns the minimum number of arrays that need to be present. -1 for unbounded.

Specified by:

getMin in class AbstractArrayStatistic<T extends Number>

Returns:

the minimum number, -1 for unbounded

getMax

public int getMax()

Returns the maximum number of arrays that need to be present. -1 for unbounded.

Specified by:

getMax in class AbstractArrayStatistic<T extends Number>

Returns:

the maximum number, -1 for unbounded

doCalculate

protected AbstractArrayStatistic.StatisticContainer doCalculate()

Generates the actual result.

Specified by:

doCalculate in class AbstractArrayStatistic<T extends Number>

Returns:

the generated result