Package adams.data.spreadsheet.colstatistic

Class LabelCounts

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.colstatistic.AbstractColumnStatistic

adams.data.spreadsheet.colstatistic.LabelCounts

All Implemented Interfaces:

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

public class LabelCounts
extends AbstractColumnStatistic

Counts how often a label (ie string) occurs.

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

-prefix <java.lang.String> (property: prefix)
    The prefix to use for the label, eg, to distinguish them from other statistics.
    default: 
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected HashMap<String,Integer>	m_Counts	the label counts.
protected String	m_Prefix	the prefix to use.

Fields inherited from class adams.data.spreadsheet.colstatistic.AbstractColumnStatistic

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

Method Summary

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

Methods inherited from class adams.data.spreadsheet.colstatistic.AbstractColumnStatistic

check, createOutputHeader, doGenerate, generate, 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_Prefix

protected String m_Prefix

the prefix to use.

m_Counts

protected HashMap<String,Integer> m_Counts

the label counts.

Constructor Detail

LabelCounts

public LabelCounts()

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

setPrefix

public void setPrefix(String value)

Sets the prefix to use for the labels.

Parameters:

value - the prefix

getPrefix

public String getPrefix()

Returns the prefix to use for the labels.

Returns:

the prefix

prefixTipText

public String prefixTipText()

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 colIndex)

Performs initialization before the cells are being visited.

Specified by:

preVisit in class AbstractColumnStatistic

Parameters:

sheet - the spreadsheet to generate the stats for

colIndex - the column index

doVisit

protected void doVisit(Row row,
                       int colIndex)

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

Specified by:

doVisit in class AbstractColumnStatistic

Parameters:

row - the current row

colIndex - the column index

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 AbstractColumnStatistic

Parameters:

sheet - the spreadsheet to generate the stats for

colIndex - the column index

Returns:

the generated stats