Package adams.data.spreadsheet.rowstatistic

Class MultiRowStatistic

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.rowstatistic.AbstractRowStatistic

adams.data.spreadsheet.rowstatistic.MultiRowStatistic

All Implemented Interfaces:

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

public class MultiRowStatistic
extends AbstractRowStatistic

Combines the statistics calculated from the specified statistic generators.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-statistic <adams.data.spreadsheet.statistic.AbstractColumnStatistic> [-statistic ...] (property: statistics)
    The statistics to calculate.
    default: 
 

Version:

$Revision: 9765 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractRowStatistic[]	m_Statistics	the statistics to calculate.

Fields inherited from class adams.data.spreadsheet.rowstatistic.AbstractRowStatistic

m_ColumnIndices, m_Columns, m_LastError

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doVisit(Row row, int rowIndex)	Gets called with every row in the spreadsheet for generating the stats.
AbstractRowStatistic[]	getStatistics()	Returns the statistic generators in use.
String	globalInfo()	Returns a string describing the object.
protected SpreadSheet	postVisit(SpreadSheet sheet, int rowIndex)	Finishes up the stats generation after all the cells have been visited.
protected void	preVisit(SpreadSheet sheet, int rowIndex)	Performs initialization before the cells are being visited.
void	setStatistics(AbstractRowStatistic[] value)	Sets the statistic generators to use.
String	statisticsTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.spreadsheet.rowstatistic.AbstractRowStatistic

check, columnsTipText, createOutputHeader, doGenerate, generate, getColumns, getLastError, hasLastError, reset, setColumns

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Statistics

protected AbstractRowStatistic[] m_Statistics

the statistics to calculate.

Constructor Detail

MultiRowStatistic

public MultiRowStatistic()

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 AbstractRowStatistic

setStatistics

public void setStatistics(AbstractRowStatistic[] value)

Sets the statistic generators to use.

Parameters:

value - the generators

getStatistics

public AbstractRowStatistic[] getStatistics()

Returns the statistic generators in use.

Returns:

the generators

statisticsTipText

public String statisticsTipText()

Returns the tip text for this property.

Returns:

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

preVisit

protected void preVisit(SpreadSheet sheet,
                        int rowIndex)

Performs initialization before the cells are being visited.

Specified by:

preVisit in class AbstractRowStatistic

Parameters:

sheet - the spreadsheet to generate the stats for

rowIndex - the row index

doVisit

protected void doVisit(Row row,
                       int rowIndex)

Gets called with every row in the spreadsheet for generating the stats.

Specified by:

doVisit in class AbstractRowStatistic

Parameters:

row - the current row

rowIndex - the row index

postVisit

protected SpreadSheet postVisit(SpreadSheet sheet,
                                int rowIndex)

Finishes up the stats generation after all the cells have been visited.

Specified by:

postVisit in class AbstractRowStatistic

Parameters:

sheet - the spreadsheet to generate the stats for

rowIndex - the row index

Returns:

the generated stats