Package adams.gui.visualization.image.interactionlogging

Class IDFilter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.image.interactionlogging.AbstractInteractionLoggingFilter

adams.gui.visualization.image.interactionlogging.IDFilter

All Implemented Interfaces:

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

public class IDFilter
extends AbstractInteractionLoggingFilter

Logs all events.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Invert	whether to invert the matching sense.
protected BaseRegExp	m_RegExp	the regular expression to use for matching the IDs.

Fields inherited from class adams.gui.visualization.image.interactionlogging.AbstractInteractionLoggingFilter

m_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
IDFilter()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doFilterInteractionLog(InteractionEvent e)	Logs the interaction.
boolean	getInvert()	Returns whether to invert the matching.
BaseRegExp	getRegExp()	Returns the regular expression to apply to the ID.
String	globalInfo()	Returns a string describing the object.
String	invertTipText()	Returns the tip text for this property.
String	regexpTipText()	Returns the tip text for this property.
void	setInvert(boolean value)	Sets whether to invert the matching.
void	setRegExp(BaseRegExp value)	Sets the regular expression to apply to the ID.

Methods inherited from class adams.gui.visualization.image.interactionlogging.AbstractInteractionLoggingFilter

check, enabledTipText, filterInteractionLog, getEnabled, setEnabled

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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_RegExp

protected BaseRegExp m_RegExp

the regular expression to use for matching the IDs.

m_Invert

protected boolean m_Invert

whether to invert the matching sense.

Constructor Detail

IDFilter

public IDFilter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractInteractionLoggingFilter

setRegExp

public void setRegExp(BaseRegExp value)

Sets the regular expression to apply to the ID.

Parameters:

value - the expression

getRegExp

public BaseRegExp getRegExp()

Returns the regular expression to apply to the ID.

Returns:

the expression

regexpTipText

public String regexpTipText()

Returns the tip text for this property.

Returns:

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

setInvert

public void setInvert(boolean value)

Sets whether to invert the matching.

Parameters:

value - true if to invert

getInvert

public boolean getInvert()

Returns whether to invert the matching.

Returns:

true if to invert

invertTipText

public String invertTipText()

Returns the tip text for this property.

Returns:

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

doFilterInteractionLog

protected void doFilterInteractionLog(InteractionEvent e)

Logs the interaction.

Specified by:

doFilterInteractionLog in class AbstractInteractionLoggingFilter

Parameters:

e - the interaction event