Package adams.data.spreadsheet.rowscore

Class EqualWidthBins

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.rowscore.AbstractRowScore

adams.data.spreadsheet.rowscore.AbstractMetaRowScore

adams.data.spreadsheet.rowscore.EqualWidthBins

All Implemented Interfaces:

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

public class EqualWidthBins
extends AbstractMetaRowScore

Splits the row into bins with (more or less) same size and applies the base score algorithm to each of the bins.

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

-row-score <adams.data.spreadsheet.rowscore.AbstractRowScore> (property: rowScore)
    The row score algorithm to apply to the each of the bins.
    default: adams.data.spreadsheet.rowscore.ArrayStatistic -statistic adams.data.statistics.ArrayMean
 

-num-bins <int> (property: numBins)
    The number of bins to use.
    default: 1
    minimum: 1
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_NumBins	the number of bins to apply the base score to.

Fields inherited from class adams.data.spreadsheet.rowscore.AbstractMetaRowScore

m_RowScore

Fields inherited from class adams.data.spreadsheet.rowscore.AbstractRowScore

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected Double[]	doCalculateScore(SpreadSheet sheet, int rowIndex)	Performs the actual calculation of the row score.
int	getNumBins()	Returns the number of bins.
int	getNumScores()	Returns how many score values will get generated.
String	globalInfo()	Returns a string describing the object.
String	numBinsTipText()	Returns the tip text for this property.
String	rowScoreTipText()	Returns the tip text for this property.
void	setNumBins(int value)	Sets the number of bins.

Methods inherited from class adams.data.spreadsheet.rowscore.AbstractMetaRowScore

getDefaultRowScore, getRowScore, setRowScore

Methods inherited from class adams.data.spreadsheet.rowscore.AbstractRowScore

calculateScore, check, getLastError, hasLastError

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Field Detail

m_NumBins

protected int m_NumBins

the number of bins to apply the base score to.

Constructor Detail

EqualWidthBins

public EqualWidthBins()

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 AbstractMetaRowScore

rowScoreTipText

public String rowScoreTipText()

Returns the tip text for this property.

Specified by:

rowScoreTipText in class AbstractMetaRowScore

Returns:

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

setNumBins

public void setNumBins(int value)

Sets the number of bins.

Parameters:

value - the number of bins

getNumBins

public int getNumBins()

Returns the number of bins.

Returns:

the number of bins

numBinsTipText

public String numBinsTipText()

Returns the tip text for this property.

Returns:

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

getNumScores

public int getNumScores()

Returns how many score values will get generated.

Overrides:

getNumScores in class AbstractMetaRowScore

Returns:

the number of scores

doCalculateScore

protected Double[] doCalculateScore(SpreadSheet sheet,
                                    int rowIndex)

Performs the actual calculation of the row score.

Specified by:

doCalculateScore in class AbstractRowScore

Parameters:

sheet - the spreadsheet to generate the score for

rowIndex - the row index

Returns:

the generated score, null in case of an error