AbstractBinPostProcessing (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.binning.postprocessing.AbstractBinPostProcessing

All Implemented Interfaces:

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

Direct Known Subclasses:

MinBinSize, PassThrough
```
public abstract class AbstractBinPostProcessing
extends AbstractOptionHandler
implements BinPostProcessing
```
Ancestor for schemes for post-processing bins.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- 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

AbstractBinPostProcessing()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected <T> String`	`check(List<Bin<T>> bins)`	Hook method for performing checks before post-processing.
`protected abstract <T> List<Bin<T>>`	`doPostProcessBins(List<Bin<T>> bins)`	Post-processes the bins.
`String`	`getQuickInfo()`	Returns a quick info about the object, which can be displayed in the GUI.
`<T> List<Bin<T>>`	`postProcessBins(List<Bin<T>> bins)`	Post-processes the bins.

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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, defineOptions, getOptionManager, toCommandLine

- Constructor Detail
  - AbstractBinPostProcessing
```
public AbstractBinPostProcessing()
```
- Method Detail
  - getQuickInfo
```
public String getQuickInfo()
```
    Returns a quick info about the object, which can be displayed in the GUI.
    Default implementation returns null.
    
    Specified by:
    
    getQuickInfo in interface QuickInfoSupporter
    
    Returns:
    
    null if no info available, otherwise short string
  - check
```
protected <T> String check(List<Bin<T>> bins)
```
    Hook method for performing checks before post-processing.
    
    Parameters:
    
    bins - the bins to check
    
    Returns:
    
    null if successful, otherwise error message
  - doPostProcessBins
```
protected abstract <T> List<Bin<T>> doPostProcessBins(List<Bin<T>> bins)
```
    Post-processes the bins.
    
    Parameters:
    
    bins - the bins to post-process
    
    Returns:
    
    the updated bins
    
    Throws:
    
    IllegalStateException - if post-processing failed
  - postProcessBins
```
public <T> List<Bin<T>> postProcessBins(List<Bin<T>> bins)
```
    Post-processes the bins.
    
    Specified by:
    
    postProcessBins in interface BinPostProcessing
    
    Parameters:
    
    bins - the bins to post-process
    
    Returns:
    
    the updated bins
    
    Throws:
    
    IllegalStateException - if check or post-processing failed