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

Class Filter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

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

adams.gui.visualization.object.objectannotations.cleaning.Filter

All Implemented Interfaces:

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

public class Filter
extends AbstractAnnotationCleaner

Applies the object finder to clean the annotations.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ObjectFinder	m_Finder	the object finder to use.

Fields inherited from class adams.gui.visualization.object.objectannotations.cleaning.AbstractAnnotationCleaner

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected LocatedObjects	doCleanAnnotations(LocatedObjects objects, MessageCollection errors)	Cleans the annotations.
String	finderTipText()	Returns the tip text for this property.
protected String	generateQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
ObjectFinder	getFinder()	Returns the finder to use for filtering the annotations.
String	globalInfo()	Returns a string describing the object.
void	setFinder(ObjectFinder value)	Sets the finder to use for filtering the annotations.

Methods inherited from class adams.gui.visualization.object.objectannotations.cleaning.AbstractAnnotationCleaner

check, cleanAnnotations, enabledTipText, getEnabled, getQuickInfo, 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_Finder

protected ObjectFinder m_Finder

the object finder to use.

Constructor Detail

Filter

public Filter()

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 AbstractAnnotationCleaner

setFinder

public void setFinder(ObjectFinder value)

Sets the finder to use for filtering the annotations.

Parameters:

value - the finder

getFinder

public ObjectFinder getFinder()

Returns the finder to use for filtering the annotations.

Returns:

the finder

finderTipText

public String finderTipText()

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.

Overrides:

generateQuickInfo in class AbstractAnnotationCleaner

Returns:

null if no info available, otherwise short string

doCleanAnnotations

protected LocatedObjects doCleanAnnotations(LocatedObjects objects,
                                            MessageCollection errors)

Cleans the annotations.

Specified by:

doCleanAnnotations in class AbstractAnnotationCleaner

Parameters:

objects - the annotations to clean

errors - for recording errors

Returns:

the (potentially) cleaned annotations