Package adams.flow.transformer.locateobjects

Class AbstractMetaObjectLocator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.locateobjects.AbstractObjectLocator

adams.flow.transformer.locateobjects.AbstractMetaObjectLocator

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Stoppable, Serializable

Direct Known Subclasses:

ChangeCanvasSize, CroppedLocator, SizeFilter

public abstract class AbstractMetaObjectLocator
extends AbstractObjectLocator

Ancestor for object locators that enhance a base locator.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractObjectLocator	m_Locator	the base locator.

Fields inherited from class adams.flow.transformer.locateobjects.AbstractObjectLocator

m_CanvasColor, m_CanvasHeight, m_CanvasWidth, m_CenterOnCanvas, m_Errors, m_Stopped, m_Warnings

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

Method Summary

Modifier and Type	Method	Description
protected void	check(BufferedImage image)	Checks whether the input can be used.
void	defineOptions()	Adds options to the internal list of options.
AbstractObjectLocator	getLocator()	Returns the base locator.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	locatorTipText()	Returns the tip text for this property.
void	setLocator(AbstractObjectLocator value)	Sets the base locator.

Methods inherited from class adams.flow.transformer.locateobjects.AbstractObjectLocator

addError, addWarning, annotate, canvasColorTipText, canvasHeightTipText, canvasWidthTipText, centerOnCanvas, centerOnCanvasTipText, cleanUp, destroy, doLocate, getCanvasColor, getCanvasHeight, getCanvasWidth, getCenterOnCanvas, getDefaultCanvasColor, getDefaultCanvasHeight, getDefaultCanvasWidth, getDefaultCenterOnCanvas, getErrors, getWarnings, hasErrors, hasWarnings, initialize, locate, reset, setCanvasColor, setCanvasHeight, setCanvasWidth, setCenterOnCanvas, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, 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

Field Detail

m_Locator

protected AbstractObjectLocator m_Locator

the base locator.

Constructor Detail

AbstractMetaObjectLocator

public AbstractMetaObjectLocator()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractObjectLocator

setLocator

public void setLocator(AbstractObjectLocator value)

Sets the base locator.

Parameters:

value - the locator

getLocator

public AbstractObjectLocator getLocator()

Returns the base locator.

Returns:

the locator

locatorTipText

public String locatorTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractObjectLocator

Returns:

null if no info available, otherwise short string

check

protected void check(BufferedImage image)

Checks whether the input can be used.

Ensures that base locator is set.

Overrides:

check in class AbstractObjectLocator

Parameters:

image - the image to check