Package adams.data.binning.postprocessing

Class MinBinSize

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.binning.postprocessing.AbstractBinPostProcessing

adams.data.binning.postprocessing.MinBinSize

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, BinPostProcessing, Serializable

public class MinBinSize
extends AbstractBinPostProcessing

Ensures that bins have the specified minimum number of objects stored.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_MinSize	the minimum size.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected <T> List<Bin<T>>	doPostProcessBins(List<Bin<T>> bins)	Post-processes the bins.
int	getMinSize()	Returns the minimum number of objects in a bin.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	minSizeTipText()	Returns the tip text for this property.
void	setMinSize(int value)	Sets the minimum number of objects in a bin.

Methods inherited from class adams.data.binning.postprocessing.AbstractBinPostProcessing

check, postProcessBins

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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_MinSize

protected int m_MinSize

the minimum size.

Constructor Detail

MinBinSize

public MinBinSize()

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

setMinSize

public void setMinSize(int value)

Sets the minimum number of objects in a bin.

Parameters:

value - the minimum

getMinSize

public int getMinSize()

Returns the minimum number of objects in a bin.

Returns:

the minimum

minSizeTipText

public String minSizeTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractBinPostProcessing

Returns:

null if no info available, otherwise short string

doPostProcessBins

protected <T> List<Bin<T>> doPostProcessBins(List<Bin<T>> bins)

Post-processes the bins.

Specified by:

doPostProcessBins in class AbstractBinPostProcessing

Parameters:

bins - the bins to post-process

Returns:

the updated bins

Throws:

IllegalStateException - if post-processing failed