Package adams.flow.transformer.draw

Class AbstractDrawOperation

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.draw.AbstractDrawOperation

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractBarcodeEncoder, AbstractColorDrawOperation, AbstractDrawObjectsFromReport, AnnotationsAndPredictions, Barcode, Image, ObjectAnnotationsFromReport

public abstract class AbstractDrawOperation
extends AbstractOptionHandler
implements QuickInfoSupporter

Ancestor to all draw operations.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Actor	m_Owner	the owner of the operation.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(BufferedImageContainer image)	Checks the image.
protected abstract String	doDraw(BufferedImageContainer image)	Performs the actual draw operation.
String	draw(BufferedImageContainer image)	Performs the draw operation on the image.
Actor	getOwner()	Returns the owner.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
void	setOwner(Actor value)	Sets the owner.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, 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.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Owner

protected Actor m_Owner

the owner of the operation.

Constructor Detail

AbstractDrawOperation

public AbstractDrawOperation()

Method Detail

setOwner

public void setOwner(Actor value)

Sets the owner.

Parameters:

value - the owning actor

getOwner

public Actor getOwner()

Returns the owner.

Returns:

the owner, null if none set

getQuickInfo

public String getQuickInfo()

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

Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected String check(BufferedImageContainer image)

Checks the image.

Default implementation only checks whether an owner and image is present.

Parameters:

image - the image to check

Returns:

null if OK, otherwise error message

doDraw

protected abstract String doDraw(BufferedImageContainer image)

Performs the actual draw operation.

Parameters:

image - the image to draw on

Returns:

null if OK, otherwise error message

draw

public String draw(BufferedImageContainer image)

Performs the draw operation on the image.

Parameters:

image - the image to draw on

Returns:

null if OK, otherwise error message