Package adams.flow.transformer.predictioncheck

Class AbstractPredictionCheck

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.predictioncheck.AbstractPredictionCheck

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable

Direct Known Subclasses:

MinProbability, PassThrough, Range

public abstract class AbstractPredictionCheck
extends adams.core.option.AbstractOptionHandler
implements adams.core.QuickInfoSupporter

Ancestor for prediction checks.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(EvaluationContainer cont)	Hook method for checks.
EvaluationContainer	checkPrediction(EvaluationContainer cont)	Performs checks on the prediction.
abstract EvaluationContainer	doCheckPrediction(EvaluationContainer cont)	Performs the actual checks on the prediction.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.

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

AbstractPredictionCheck

public AbstractPredictionCheck()

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 adams.core.QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected String check(EvaluationContainer cont)

Hook method for checks.

Parameters:

cont - the container to check

Returns:

null if successful, otherwise error message

doCheckPrediction

public abstract EvaluationContainer doCheckPrediction(EvaluationContainer cont)

Performs the actual checks on the prediction.

Parameters:

cont - the container to check

Returns:

the updated container

checkPrediction

public EvaluationContainer checkPrediction(EvaluationContainer cont)

Performs checks on the prediction.

Parameters:

cont - the container to check

Returns:

the updated container