Package adams.flow.sink.canvas

Class AbstractDataPoolPostProcessor

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.sink.canvas.AbstractDataPoolPostProcessor

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractDataPoolPostProcessor>, SizeOfHandler, Serializable

Direct Known Subclasses:

PassThrough

public abstract class AbstractDataPoolPostProcessor
extends AbstractOptionHandler
implements ShallowCopySupporter<AbstractDataPoolPostProcessor>

For post-processing DataPools, e.g., removing obsolete/expired elements.

Version:

$Revision$

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

Method Summary

Modifier and Type	Method	Description
protected String	check(DataPool pool)	Checks whether the pool can be processed,
protected abstract String	doPostProcess(DataPool pool)	Does the actual post-processing.
String	postProcess(DataPool pool)	Post-processes the data pool.
AbstractDataPoolPostProcessor	shallowCopy()	Returns a shallow copy of itself.
AbstractDataPoolPostProcessor	shallowCopy(boolean expand)	Returns a shallow copy of itself.

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.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AbstractDataPoolPostProcessor

public AbstractDataPoolPostProcessor()

Method Detail

check

protected String check(DataPool pool)

Checks whether the pool can be processed,

Parameters:

pool - the pool to check

Returns:

null if check passed, otherwise error message

doPostProcess

protected abstract String doPostProcess(DataPool pool)

Does the actual post-processing.

Parameters:

pool - the pool to process

Returns:

null if processed successfully, otherwise error message

postProcess

public String postProcess(DataPool pool)

Post-processes the data pool.

Parameters:

pool - the pool to process

Returns:

null if processed successfully, otherwise error message

shallowCopy

public AbstractDataPoolPostProcessor shallowCopy()

Returns a shallow copy of itself.

Specified by:

shallowCopy in interface ShallowCopySupporter<AbstractDataPoolPostProcessor>

Returns:

the shallow copy

shallowCopy

public AbstractDataPoolPostProcessor shallowCopy(boolean expand)

Returns a shallow copy of itself.

Specified by:

shallowCopy in interface ShallowCopySupporter<AbstractDataPoolPostProcessor>

Parameters:

expand - whether to expand variables to their current values

Returns:

the shallow copy