Package adams.gui.visualization.stats.paintlet

Class AbstractZOverlayPaintlet

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractPaintlet

adams.gui.visualization.core.AbstractStrokePaintlet

adams.gui.visualization.stats.paintlet.AbstractColorPaintlet

adams.gui.visualization.stats.paintlet.AbstractZOverlayPaintlet

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, Paintlet, Serializable

Direct Known Subclasses:

MeanPaintlet, StdDevPaintlet

public abstract class AbstractZOverlayPaintlet
extends AbstractColorPaintlet

abstract class for creating z score overlay paintlets.

Version:

$Revision$

Author:

msf8

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AxisPanel	m_AxisBottom	x axis of plot
protected AxisPanel	m_AxisLeft	y axis of plot
protected boolean	m_Calculated	whether the overlay has been calcualated
protected int	m_Ind	index of the attribute being displayed

Fields inherited from class adams.gui.visualization.stats.paintlet.AbstractColorPaintlet

m_Color, m_Data

Fields inherited from class adams.gui.visualization.core.AbstractStrokePaintlet

m_StrokeThickness

Fields inherited from class adams.gui.visualization.core.AbstractPaintlet

m_Enabled, m_Initializing, m_Panel, m_RepaintOnChange

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

Method Summary

Modifier and Type	Method	Description
void	calculate()	calculates the data for the paintlet, doesn't handle the drawing of the data
protected void	doPerformPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.
protected abstract void	drawData(Graphics g)	Draw the overlay onto the z score plot, only calculates the value to position in this method
boolean	getCalculated()	Get whether the paintlet has been calculated
PaintEvent.PaintMoment	getPaintMoment()	Returns when this paintlet is to be executed.
protected void	initialize()	Initializes the members.
void	parameters(SpreadSheet data, int ind)	Pass the paramters required by the overlay paintlet
void	setCalculated(boolean val)	set whether the paintlet has been calculated
abstract void	setStd(double val)	set the number of standard deviations for the overlay only relevant for the stddev overlay

Methods inherited from class adams.gui.visualization.stats.paintlet.AbstractColorPaintlet

colorTipText, defineOptions, getColor, getData, setColor, setData

Methods inherited from class adams.gui.visualization.core.AbstractStrokePaintlet

applyStroke, getStrokeThickness, getStrokeWidth, performPaint, setStrokeThickness, strokeThicknessTipText

Methods inherited from class adams.gui.visualization.core.AbstractPaintlet

canPaint, finishInit, forCommandLine, forName, getPaintlets, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, isInitializing, memberChanged, memberChanged, paint, repaint, setEnabled, setPanel, setPanel, setRepaintOnChange, shallowCopy, shallowCopy, updatePanel

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, 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_Calculated

protected boolean m_Calculated

whether the overlay has been calcualated

m_Ind

protected int m_Ind

index of the attribute being displayed

m_AxisLeft

protected AxisPanel m_AxisLeft

y axis of plot

m_AxisBottom

protected AxisPanel m_AxisBottom

x axis of plot

Constructor Detail

AbstractZOverlayPaintlet

public AbstractZOverlayPaintlet()

Method Detail

getPaintMoment

public PaintEvent.PaintMoment getPaintMoment()

Description copied from class: AbstractPaintlet

Returns when this paintlet is to be executed.

Specified by:

getPaintMoment in interface Paintlet

Specified by:

getPaintMoment in class AbstractPaintlet

Returns:

when this paintlet is to be executed

initialize

protected void initialize()

Description copied from class: AbstractPaintlet

Initializes the members.

Overrides:

initialize in class AbstractPaintlet

setStd

public abstract void setStd(double val)

set the number of standard deviations for the overlay only relevant for the stddev overlay

Parameters:

val - number of std dev from mean

parameters

public void parameters(SpreadSheet data,
                       int ind)

Pass the paramters required by the overlay paintlet

Parameters:

data - Instances to be plotted

ind - index of the attribute within the instacnes

doPerformPaint

protected void doPerformPaint(Graphics g,
                              PaintEvent.PaintMoment moment)

The paint routine of the paintlet.

Specified by:

doPerformPaint in class AbstractStrokePaintlet

Parameters:

g - the graphics context to use for painting

moment - what PaintEvent.PaintMoment is currently being painted

drawData

protected abstract void drawData(Graphics g)

Draw the overlay onto the z score plot, only calculates the value to position in this method

Parameters:

g - graphics to draw on

calculate

public void calculate()

calculates the data for the paintlet, doesn't handle the drawing of the data

setCalculated

public void setCalculated(boolean val)

set whether the paintlet has been calculated

Parameters:

val - Truen if paintlet calculated

getCalculated

public boolean getCalculated()

Get whether the paintlet has been calculated

Returns:

True if paintlet calculated