Package adams.gui.tools.spreadsheetprocessor.processors

Class AbstractProcessor

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.gui.tools.spreadsheetprocessor.AbstractWidget

adams.gui.tools.spreadsheetprocessor.processors.AbstractProcessor

All Implemented Interfaces:

LoggingLevelHandler, LoggingSupporter, SizeOfHandler, Serializable, Comparable<AbstractWidget>

Direct Known Subclasses:

FlowProcessor, PassThroughProcessor, QueryProcessor

public abstract class AbstractProcessor
extends AbstractWidget

Ancestor for processors.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.gui.tools.spreadsheetprocessor.AbstractWidget

m_Owner

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractProcessor()

Method Summary

Modifier and Type	Method	Description
protected void	check(SpreadSheet data, MessageCollection errors)	Hook method for performing checks.
protected abstract SpreadSheet	doProcess(SpreadSheet data, MessageCollection errors)	Processes the data.
SpreadSheet	process(SpreadSheet data, MessageCollection errors)	Processes the data.

Methods inherited from class adams.gui.tools.spreadsheetprocessor.AbstractWidget

assign, compareTo, deserialize, equals, getName, getOwner, getWidget, notifyOwner, serialize, setOwner, toString, update

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AbstractProcessor

public AbstractProcessor()

Method Detail

check

protected void check(SpreadSheet data,
                     MessageCollection errors)

Hook method for performing checks.

Parameters:

data - the data to check

errors - for storing errors

doProcess

protected abstract SpreadSheet doProcess(SpreadSheet data,
                                         MessageCollection errors)

Processes the data.

Parameters:

data - the input data

errors - for storing errors

Returns:

the generated data, null in case of an error

process

public SpreadSheet process(SpreadSheet data,
                           MessageCollection errors)

Processes the data.

Parameters:

data - the input data

errors - for storing errors

Returns:

the generated data, null in case of an error