Package adams.data.spreadsheet.rowstatistic

Class Percentile

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.rowstatistic.AbstractRowStatistic

adams.data.spreadsheet.rowstatistic.AbstractDoubleArrayRowStatistic

adams.data.spreadsheet.rowstatistic.Percentile

All Implemented Interfaces:

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

public class Percentile
extends AbstractDoubleArrayRowStatistic

Calculates the specified percentile.

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

-percentile <double> (property: percentile)
    The percentile to use (0-1).
    default: 0.25
    minimum: 0.0
    maximum: 1.0
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_Percentile	the percentile.

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

m_Values

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
double	getPercentile()	Returns the percentile in use.
String	globalInfo()	Returns a string describing the object.
String	percentileTipText()	Returns the tip text for this property.
protected SpreadSheet	postVisit(SpreadSheet sheet, int colIndex)	Finishes up the stats generation after all the cells have been visited.
void	setPercentile(double value)	Sets the percentile to use.

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

doVisit, preVisit

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_Percentile

protected double m_Percentile

the percentile.

Constructor Detail

Percentile

public Percentile()

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

setPercentile

public void setPercentile(double value)

Sets the percentile to use.

Parameters:

value - the percentile (0-1)

getPercentile

public double getPercentile()

Returns the percentile in use.

Returns:

the percentile (0-1)

percentileTipText

public String percentileTipText()

Returns the tip text for this property.

Returns:

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

postVisit

protected SpreadSheet postVisit(SpreadSheet sheet,
                                int colIndex)

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

colIndex - the column index

Returns:

the generated stats