Package adams.gui.visualization.object.objectannotations.cleaning

Class AbstractAnnotationCleaner

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.objectannotations.cleaning.AbstractAnnotationCleaner

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, AnnotationCleaner, Serializable

Direct Known Subclasses:

Filter, OverlapRemoval, PassThrough

public abstract class AbstractAnnotationCleaner
extends AbstractOptionHandler
implements AnnotationCleaner

Ancestor for annotation cleaners.

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 cleaner 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
AbstractAnnotationCleaner()

Method Summary

Modifier and Type	Method	Description
protected String	check(LocatedObjects objects)	Hook method for checks.
LocatedObjects	cleanAnnotations(LocatedObjects objects, MessageCollection errors)	Cleans the annotations.
void	defineOptions()	Adds options to the internal list of options.
protected abstract LocatedObjects	doCleanAnnotations(LocatedObjects objects, MessageCollection errors)	Cleans the annotations.
String	enabledTipText()	Returns the tip text for this property.
protected String	generateQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
boolean	getEnabled()	Returns whether the data cleaner is enabled.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
void	setEnabled(boolean value)	Sets whether the data cleaner is enabled.

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 cleaner is enabled.

Constructor Detail

AbstractAnnotationCleaner

public AbstractAnnotationCleaner()

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 the data cleaner is enabled.

Parameters:

value - true if enabled

getEnabled

public boolean getEnabled()

Returns whether the data cleaner is enabled.

Returns:

true if enabled

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.

generateQuickInfo

protected String generateQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.
Default implementation returns null.

Returns:

null if no info available, otherwise short string

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected String check(LocatedObjects objects)

Hook method for checks.

Parameters:

objects - the annotations to check

Returns:

null if checks passed, otherwise error message

doCleanAnnotations

protected abstract LocatedObjects doCleanAnnotations(LocatedObjects objects,
                                                     MessageCollection errors)

Cleans the annotations.

Parameters:

objects - the annotations to clean

errors - for recording errors

Returns:

the (potentially) cleaned annotations

cleanAnnotations

public LocatedObjects cleanAnnotations(LocatedObjects objects,
                                       MessageCollection errors)

Cleans the annotations.

Specified by:

cleanAnnotations in interface AnnotationCleaner

Parameters:

objects - the annotations to clean

errors - for recording errors

Returns:

the (potentially) cleaned annotations