Package adams.gui.visualization.xchart.marker

Class AbstractMarkerGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.xchart.marker.AbstractMarkerGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

Circle, Cross, Default, Diamond, None, Oval, Plus, Rectangle, Square, Trapezoid, TriangleDown, TriangleUp

public abstract class AbstractMarkerGenerator
extends AbstractOptionHandler

Generates a marker to be used for marking data points (eg in a scatter plot).

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected String	check()	Hook method for checks.
protected abstract org.knowm.xchart.style.markers.Marker	doGenerate()	Generates the marker.
org.knowm.xchart.style.markers.Marker	generate()	Generates the marker.

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

Constructor Detail

AbstractMarkerGenerator

public AbstractMarkerGenerator()

Method Detail

check

protected String check()

Hook method for checks.

Returns:

null if checks passed successful, otherwise error message

doGenerate

protected abstract org.knowm.xchart.style.markers.Marker doGenerate()

Generates the marker.

Returns:

the shape, null if none generated

generate

public org.knowm.xchart.style.markers.Marker generate()

Generates the marker.

Returns:

the marker, null if none generated

Throws:

IllegalStateException - if checks fail

See Also:

check()