Package adams.gui.visualization.stats.zscore

Class AbstractZScoreOverlay

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.stats.zscore.AbstractZScoreOverlay

All Implemented Interfaces:

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

Direct Known Subclasses:

Mean, StdDev

public abstract class AbstractZScoreOverlay
extends AbstractOptionHandler

Abstract superclass for overlays on the z score graph.

Version:

$Revision$

Author:

msf8

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	m_Color	colour to draw the overlay line
protected SpreadSheet	m_Data	Instances object containing the data
protected AbstractZOverlayPaintlet	m_Paintlet	Paintlet for the plotting
protected ZScore	m_Parent	parent z score plot to plot data on
protected float	m_Thickness	Thickness of overlay

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

Method Summary

Modifier and Type	Method	Description
String	colorTipText()	Tip text for the color property
void	defineOptions()	Adds options to the internal list of options.
Color	getColor()	get the color of the overlay
AbstractZOverlayPaintlet	getPaintlet()	get the paintlet used to plot the overlay
protected ZScore	getParent()	get the parent of the overlay
float	getThickness()	Get the thickness of the overlay
void	setColor(Color val)	Set the color of the overlay
void	setData(SpreadSheet value)	Set the instances for the overlay
void	setParent(ZScore val)	set the parent for the overlay
void	setThickness(float val)	Set the thickness of the overlay
abstract void	setUp()	set up the overlay and it's paintlet
AbstractZScoreOverlay	shallowCopy()	create a shallow copy of an overlay
AbstractZScoreOverlay	shallowCopy(boolean expand)	create a shallow copy of an overlay
abstract String	shortName()	Return a short name for the overlay to display in the key
String	thicknessTipText()	Return a tip text for the thickness property

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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_Parent

protected ZScore m_Parent

parent z score plot to plot data on

m_Data

protected SpreadSheet m_Data

Instances object containing the data

m_Paintlet

protected AbstractZOverlayPaintlet m_Paintlet

Paintlet for the plotting

m_Color

protected Color m_Color

colour to draw the overlay line

m_Thickness

protected float m_Thickness

Thickness of overlay

Constructor Detail

AbstractZScoreOverlay

public AbstractZScoreOverlay()

Method Detail

defineOptions

public void defineOptions()

Description copied from class: AbstractOptionHandler

Adds options to the internal list of options. Derived classes must override this method to add additional options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setThickness

public void setThickness(float val)

Set the thickness of the overlay

Parameters:

val - Thickness in pixels

getThickness

public float getThickness()

Get the thickness of the overlay

Returns:

Thickness in pixels

thicknessTipText

public String thicknessTipText()

Return a tip text for the thickness property

Returns:

Tip text string

setUp

public abstract void setUp()

set up the overlay and it's paintlet

getParent

protected ZScore getParent()

get the parent of the overlay

Returns:

parent z score plot

setParent

public void setParent(ZScore val)

set the parent for the overlay

Parameters:

val - parent z score plot

setData

public void setData(SpreadSheet value)

Set the instances for the overlay

Parameters:

value - Instances for plotting

getPaintlet

public AbstractZOverlayPaintlet getPaintlet()

get the paintlet used to plot the overlay

Returns:

Paintlet used

shallowCopy

public AbstractZScoreOverlay shallowCopy()

create a shallow copy of an overlay

Returns:

Copy of the overlay

shallowCopy

public AbstractZScoreOverlay shallowCopy(boolean expand)

create a shallow copy of an overlay

Parameters:

expand - whether to expand variables to their current values

Returns:

Copy of the overlay

shortName

public abstract String shortName()

Return a short name for the overlay to display in the key

Returns:

setColor

public void setColor(Color val)

Set the color of the overlay

Parameters:

val - Color for the overlay

getColor

public Color getColor()

get the color of the overlay

Returns:

Color of overlay

colorTipText

public String colorTipText()

Tip text for the color property

Returns:

String to describe this property