Package adams.gui.visualization.object.annotator

Class AbstractReportBasedAnnotator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.annotator.AbstractAnnotator

adams.gui.visualization.object.annotator.AbstractReportBasedAnnotator

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ObjectPrefixHandler, Serializable

Direct Known Subclasses:

AbstractPointAnnotator, AbstractRectangleBasedAnnotator

public abstract class AbstractReportBasedAnnotator
extends AbstractAnnotator
implements ObjectPrefixHandler

Ancestor for annotators that use reports to store the annotations in.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Prefix	the prefix for the objects.

Fields inherited from class adams.gui.visualization.object.annotator.AbstractAnnotator

m_Owner, m_Selecting

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected int	findLastIndex(Report report)	Determines the last index used with the given prefix.
protected abstract String	getDefaultPrefix()	Returns the default prefix to use for the objects.
String	getPrefix()	Returns the prefix to use for the objects.
String	prefixTipText()	Returns the tip text for this property.
protected boolean	removeIndex(Report report, int index)	Removes the specified index from the report.
void	setPrefix(String value)	Sets the prefix to use for the objects.
protected Map<String,Object>	valuesForIndex(Report report, int index)	Returns all the values stored in the report under this index.

Methods inherited from class adams.gui.visualization.object.annotator.AbstractAnnotator

annotationsChanged, applyStroke, cleanUp, doInstall, doPaintSelection, doUninstall, getCurrentLabel, getOwner, getStrokeWidth, hasCurrentLabel, initialize, install, labelChanged, paintSelection, setOwner, uninstall

Methods inherited from class adams.core.option.AbstractOptionHandler

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

protected String m_Prefix

the prefix for the objects.

Constructor Detail

AbstractReportBasedAnnotator

public AbstractReportBasedAnnotator()

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

getDefaultPrefix

protected abstract String getDefaultPrefix()

Returns the default prefix to use for the objects.

Returns:

the default

setPrefix

public void setPrefix(String value)

Sets the prefix to use for the objects.

Specified by:

setPrefix in interface ObjectPrefixHandler

Parameters:

value - the prefix

getPrefix

public String getPrefix()

Returns the prefix to use for the objects.

Specified by:

getPrefix in interface ObjectPrefixHandler

Returns:

the prefix

prefixTipText

public String prefixTipText()

Returns the tip text for this property.

Specified by:

prefixTipText in interface ObjectPrefixHandler

Returns:

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

valuesForIndex

protected Map<String,Object> valuesForIndex(Report report,
                                                  int index)

Returns all the values stored in the report under this index.

Parameters:

report - the report to look up the index in

index - the index to retrieve the values for

Returns:

the values

removeIndex

protected boolean removeIndex(Report report,
                              int index)

Removes the specified index from the report.

Returns:

true if successfully removed

findLastIndex

protected int findLastIndex(Report report)

Determines the last index used with the given prefix.