adams.gui.visualization.stats.scatterplot
Class AbstractScatterPlotOverlay

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

Diagonal, Lowess

public abstract class AbstractScatterPlotOverlay
extends AbstractOptionHandler

Abstract superclass for overlays on the scatterplot graph.

Version:

$Revision: 4584 $

Author:

msf8

See Also:

Serialized Form

Field Summary

protected Color	m_Color Color of the overlay
protected Instances	m_Instances Instances object containing data
protected AbstractOverlayPaintlet	m_Paintlet Paintlet to do the drawing
protected AbstractScatterPlot	m_Parent parent scatter plot to plot data on
protected float	m_Thickness Thickness for overlay line

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

AbstractScatterPlotOverlay()

Method Summary

String	colorTipText() Tip text for the color property
void	defineOptions()
Color	getColor() Get the color for this overlay
AbstractOverlayPaintlet	getPaintlet() Get the paintlet that is doing the drawing
protected AbstractScatterPlot	getParent() Return the scatter plot parent the overlay is being drawn on
float	getThickness() Get the thickness of the overlay
void	inst(Instances inst) Pass the instances to the overlay object
String	name() Returns a string to display info on the overlay
void	setColor(Color val) Set the color for this overlay
void	setParent(AbstractScatterPlot val) Set the scatterplot that this overlay is being drawn on
void	setThickness(float val) Set the thickness of the overlay
abstract void	setUp() set up the overlay and it's paintlet
AbstractScatterPlotOverlay	shallowCopy() Returns a shallow copy of itself, i.e., based on the commandline options.
AbstractScatterPlotOverlay	shallowCopy(boolean expand) Returns a shallow copy of itself, i.e., based on the commandline options.
String	thicknessTipText() Return a tip text for the thickness property

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, globalInfo, initialize, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Parent

protected AbstractScatterPlot m_Parent

parent scatter plot to plot data on

m_Instances

protected Instances m_Instances

Instances object containing data

m_Paintlet

protected AbstractOverlayPaintlet m_Paintlet

Paintlet to do the drawing

m_Thickness

protected float m_Thickness

Thickness for overlay line

m_Color

protected Color m_Color

Color of the overlay

Constructor Detail

AbstractScatterPlotOverlay

public AbstractScatterPlotOverlay()

Method Detail

name

public String name()

Returns a string to display info on the overlay

defineOptions

public void defineOptions()

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 AbstractScatterPlot getParent()

Return the scatter plot parent the overlay is being drawn on

Returns:

scatter plot

setParent

public void setParent(AbstractScatterPlot val)

Set the scatterplot that this overlay is being drawn on

inst

public void inst(Instances inst)

Pass the instances to the overlay object

Parameters:

inst - Instances to be plotted

getPaintlet

public AbstractOverlayPaintlet getPaintlet()

Get the paintlet that is doing the drawing

Returns:

paintlet doing the drawing

shallowCopy

public AbstractScatterPlotOverlay shallowCopy()

Returns a shallow copy of itself, i.e., based on the commandline options.

Returns:

the shallow copy

shallowCopy

public AbstractScatterPlotOverlay shallowCopy(boolean expand)

Returns a shallow copy of itself, i.e., based on the commandline options.

Returns:

the shallow copy

setColor

public void setColor(Color val)

Set the color for this overlay

Parameters:

val - Color of overlay

getColor

public Color getColor()

Get the color for this overlay

Returns:

Color used for overlay

colorTipText

public String colorTipText()

Tip text for the color property

Returns:

String describing the property