Package adams.gui.visualization.image.interactionlogging

Class AbstractInteractionLoggingFilter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.image.interactionlogging.AbstractInteractionLoggingFilter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, InteractionLoggingFilter, Serializable

Direct Known Subclasses:

All, IDFilter, Null

public abstract class AbstractInteractionLoggingFilter
extends AbstractOptionHandler
implements InteractionLoggingFilter

Ancestor for interaction logging filters.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Enabled	whether the logger is enabled.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(InteractionEvent e)	Check method before logging the event.
void	defineOptions()	Adds options to the internal list of options.
protected abstract void	doFilterInteractionLog(InteractionEvent e)	Filters the interaction logging.
String	enabledTipText()	Returns the tip text for this property.
void	filterInteractionLog(InteractionEvent e)	Filters the interaction logging.
boolean	getEnabled()	Returns whether to enable the filter.
void	setEnabled(boolean value)	Sets whether to enable the filter.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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, getOptionManager, toCommandLine

Field Detail

m_Enabled

protected boolean m_Enabled

whether the logger is enabled.

Constructor Detail

AbstractInteractionLoggingFilter

public AbstractInteractionLoggingFilter()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setEnabled

public void setEnabled(boolean value)

Sets whether to enable the filter.

Parameters:

value - true if enable

getEnabled

public boolean getEnabled()

Returns whether to enable the filter.

Returns:

true if to enable

enabledTipText

public String enabledTipText()

Returns the tip text for this property.

Returns:

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

check

protected String check(InteractionEvent e)

Check method before logging the event.

Parameters:

e - the event to check

Returns:

null if checks passed, otherwise error message

doFilterInteractionLog

protected abstract void doFilterInteractionLog(InteractionEvent e)

Filters the interaction logging.

Parameters:

e - the interaction event

filterInteractionLog

public void filterInteractionLog(InteractionEvent e)

Filters the interaction logging.

Specified by:

filterInteractionLog in interface InteractionLoggingFilter

Parameters:

e - the interaction event