info.monitorenter.gui.chart.errorbars
Class AErrorBarPolicyConfigurable

java.lang.Object
  info.monitorenter.gui.chart.errorbars.AErrorBarPolicyConfigurable

All Implemented Interfaces:

IErrorBarPolicy, IPointPainter, ITracePainter, PropertyChangeListener, Serializable, Comparable, EventListener

Direct Known Subclasses:

ErrorBarPolicyAbsoluteSummation, ErrorBarPolicyRelative

public abstract class AErrorBarPolicyConfigurable
extends Object
implements IErrorBarPolicy, PropertyChangeListener

A IErrorBarPolicy base implementation that is configurable by the means of showing positive/negative errors in x/y dimension.

Implementations have to implement the methods
internalGetNegativeXError(int, int, TracePoint2D)
internalGetNegativeYError(int, int, TracePoint2D)
internalGetPositiveXError(int, int, TracePoint2D)
internalGetPositiveYError(int, int, TracePoint2D)
.

Please see the class description of IErrorBarPixel for details.

Version:

$Revision: 1.23 $

Author:

Achim Westermann

See Also:

Serialized Form

Field Summary

protected TracePoint2D	m_lastPoint The last trace point coordinate that was sent to paintPoint(int, int, int, int, Graphics2D, TracePoint2D).
protected int	m_lastX The last x coordinate that was sent to paintPoint(int, int, int, int, Graphics2D, TracePoint2D).
protected int	m_lastY The last y coordinate that was sent to paintPoint(int, int, int, int, Graphics2D, TracePoint2D).
protected PropertyChangeSupport	m_propertyChangeSupport The instance that add support for firing PropertyChangeEvents and maintaining PropertyChangeListeners.

Fields inherited from interface info.monitorenter.gui.chart.IErrorBarPolicy

PROPERTY_CONFIGURATION, PROPERTY_ERRORBARPAINTER

Constructor Summary

AErrorBarPolicyConfigurable()
Defcon.

Method Summary

void	addErrorBarPainter(IErrorBarPainter painter) Adds the given error bar painter to the list of painters of this instance.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a property change listener.
void	calculateErrorBar(int xPixel, int yPixel, ErrorBarPixel errorBar, TracePoint2D original) Calculates the errors of the given errorbar according to the point to render and the configuration of this instance.
int	compareTo(Object arg0)
void	discontinue(Graphics2D g2d, ITrace2D trace) Invoked to inform the painter that a discontinue in the trace to # paint has occured.
void	endPaintIteration(Graphics2D g2d) Invoked to inform implementations that a paint iteration ends for the corresponding ITrace2D.
protected void	firePropertyChange(String property, Object oldvalue, Object newvalue) Fires a property change event to the registered listeners.
JComponent	getCustomConfigurator() Allows an implementation to return a JComponent that takes care of custom configuration properties for the UI support of error bar policies.
Set	getErrorBarPainters() Returns the set of IErrorBarPainter to use.
protected ITrace2D	getTrace() Returns the trace error bars have to be rendered for.
protected abstract int	internalGetNegativeXError(int xPixel, int yPixel, TracePoint2D original) Internally compute the negative x error for the given point as a pixel value (not relative to the the origin value).
protected abstract int	internalGetNegativeYError(int xPixel, int yPixel, TracePoint2D original) Internally compute the negative y error for the given point as a pixel value (not relative to the the origin value).
protected abstract int	internalGetPositiveXError(int xPixel, int yPixel, TracePoint2D original) Internally compute the positive x error in pixel for the given point as an absolute value (not relative to the the origin value).
protected abstract int	internalGetPositiveYError(int xPixel, int yPixel, TracePoint2D original) Internally compute the positive y error in pixel for the given point as an absolute value (not relative to the the origin value).
boolean	isShowNegativeXErrors() Returns true if negative errors in x dimension are shown.
boolean	isShowNegativeYErrors() Returns true if negative errors in y dimension are shown.
boolean	isShowPositiveXErrors() Returns true if positive errors in x dimension are shown.
boolean	isShowPositiveYErrors() Returns true if positive errors in y dimension are shown.
void	paintPoint(int absoluteX, int absoluteY, int nextX, int nextY, Graphics2D g, TracePoint2D original) Paint the point given by absolute coordinates on the given graphic context.
void	propertyChange(PropertyChangeEvent evt) Just turns the property change event of subsequent configuration (like IErrorBarPainter.PROPERTY_CONNECTION to IErrorBarPolicy.PROPERTY_CONFIGURATION and informs outer PropertyChangeListener addes with addPropertyChangeListener(String, PropertyChangeListener).
boolean	removeErrorBarPainter(IErrorBarPainter painter) Removes the given error bar painter.
void	removePropertyChangeListener(PropertyChangeListener listener) Deregisters a property change listener that has been registerd for listening on all properties.
void	removePropertyChangeListener(String property, PropertyChangeListener listener) Removes a property change listener for listening on the given property.
void	setErrorBarPainter(IErrorBarPainter painter) Makes the given error bar painter the sole painter for error bars of this instance.
void	setShowNegativeXErrors(boolean showNegativeXErrors) Set whether negative errors in x dimension should be shown.
void	setShowNegativeYErrors(boolean showNegativeYErrors) Set whether negative errors in y dimension should be shown.
void	setShowPositiveXErrors(boolean showPositiveXErrors) Set whether positive errors in x dimension should be shown.
void	setShowPositiveYErrors(boolean showPositiveYErrors) Set whether positive errors in y dimension should be shown.
void	setTrace(ITrace2D trace) Intended for ATrace2D only that will register itself to the instances added to it.
void	startPaintIteration(Graphics2D g2d, ITrace2D trace) Invoked to inform implementations that a paint iteration starts for the corresponding ITrace2D.

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.monitorenter.gui.chart.IErrorBarPolicy

getXError, getYError

Field Detail

m_lastPoint

protected TracePoint2D m_lastPoint

The last trace point coordinate that was sent to paintPoint(int, int, int, int, Graphics2D, TracePoint2D).

It will be needed at endPaintIteration(Graphics2D) as the former method only uses the first set of coordinates to store in the internal list to avoid duplicates.

m_lastX

protected int m_lastX

The last x coordinate that was sent to paintPoint(int, int, int, int, Graphics2D, TracePoint2D).

It will be needed at endPaintIteration(Graphics2D) as the former method only uses the first set of coordinates to store in the internal list to avoid duplicates.

m_lastY

protected int m_lastY

The last y coordinate that was sent to paintPoint(int, int, int, int, Graphics2D, TracePoint2D).

It will be needed at endPaintIteration(Graphics2D) as the former method only uses the first set of coordinates to store in the internal list to avoid duplicates.

m_propertyChangeSupport

protected PropertyChangeSupport m_propertyChangeSupport

The instance that add support for firing PropertyChangeEvents and maintaining PropertyChangeListeners. PropertyChangeListener instances.

Constructor Detail

AErrorBarPolicyConfigurable

public AErrorBarPolicyConfigurable()

Defcon.

Method Detail

addErrorBarPainter

public void addErrorBarPainter(IErrorBarPainter painter)

Description copied from interface: IErrorBarPolicy

Adds the given error bar painter to the list of painters of this instance.

Specified by:

addErrorBarPainter in interface IErrorBarPolicy

Parameters:

painter - the painter to use.

See Also:

IErrorBarPolicy.addErrorBarPainter(info.monitorenter.gui.chart.IErrorBarPainter)

addPropertyChangeListener

public final void addPropertyChangeListener(String propertyName,
                                            PropertyChangeListener listener)

Adds a property change listener.

Specified by:

addPropertyChangeListener in interface IErrorBarPolicy

Parameters:

propertyName - The name of the property to listen on.

listener - The PropertyChangeListener to be added.

See Also:

ITrace2D.addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)

calculateErrorBar

public final void calculateErrorBar(int xPixel,
                                    int yPixel,
                                    ErrorBarPixel errorBar,
                                    TracePoint2D original)

Description copied from interface: IErrorBarPolicy

Calculates the errors of the given errorbar according to the point to render and the configuration of this instance.

Specified by:

calculateErrorBar in interface IErrorBarPolicy

Parameters:

xPixel - the x value in pixel to render an error bar for.

yPixel - the y value in pixel to render an error bar for.

errorBar - an error bar to use: This is for design reasons as internally this method is used too with a reused instance.

original - the original point, possibly useful for calculations.

See Also:

IErrorBarPolicy.calculateErrorBar(int, int, info.monitorenter.gui.chart.errorbars.ErrorBarPixel, info.monitorenter.gui.chart.TracePoint2D)

compareTo

public int compareTo(Object arg0)

Specified by:

compareTo in interface Comparable

See Also:

Comparable.compareTo(java.lang.Object)

discontinue

public void discontinue(Graphics2D g2d,
                        ITrace2D trace)

Description copied from interface: ITracePainter

Invoked to inform the painter that a discontinue in the trace to # paint has occured.

This only has to be implemented by painters that collect several points of IPointPainter.paintPoint(int, int, int, int, Graphics2D, TracePoint2D) to draw them as polygons (e.g.: Graphics.drawPolyline(int[], int[], int)).

Specified by:

discontinue in interface ITracePainter

Parameters:

g2d - provided in case pending paint operations have to be performed.

trace - the trace to discontinue painting of.

See Also:

ITracePainter.discontinue(java.awt.Graphics2D, info.monitorenter.gui.chart.ITrace2D)

endPaintIteration

public void endPaintIteration(Graphics2D g2d)

Description copied from interface: ITracePainter

Invoked to inform implementations that a paint iteration ends for the corresponding ITrace2D.

Specified by:

endPaintIteration in interface ITracePainter

Parameters:

g2d - provided in case pending paint operations have to be performed.

See Also:

ITracePainter.endPaintIteration(java.awt.Graphics2D)

firePropertyChange

protected final void firePropertyChange(String property,
                                        Object oldvalue,
                                        Object newvalue)

Fires a property change event to the registered listeners.

Parameters:

property - one of the PROPERTY_XXX constants defined in ITrace2D.

oldvalue - the old value of the property.

newvalue - the new value of the property.

getCustomConfigurator

public JComponent getCustomConfigurator()

Description copied from interface: IErrorBarPolicy

Allows an implementation to return a JComponent that takes care of custom configuration properties for the UI support of error bar policies.

Returns a JComponent that - stand alone - takes care of configuring custom properties or null if nothing is required. This will be integrated in the error bar wizard UI of jchart2d.

Specified by:

getCustomConfigurator in interface IErrorBarPolicy

Returns:

a JComponent that - stand alone - takes care of configuring custom properties or null if nothing is required.

See Also:

IErrorBarPolicy.getCustomConfigurator()

getErrorBarPainters

public Set getErrorBarPainters()

Description copied from interface: IErrorBarPolicy

Returns the set of IErrorBarPainter to use.

Specified by:

getErrorBarPainters in interface IErrorBarPolicy

Returns:

the set of IErrorBarPainter to use.

See Also:

IErrorBarPolicy.getErrorBarPainters()

getTrace

protected final ITrace2D getTrace()

Returns the trace error bars have to be rendered for.

Returns:

the trace for rendering error bars.

internalGetNegativeXError

protected abstract int internalGetNegativeXError(int xPixel,
                                                 int yPixel,
                                                 TracePoint2D original)

Internally compute the negative x error for the given point as a pixel value (not relative to the the origin value).

Parameters:

xPixel - the x value in pixel for the error to render.

yPixel - the y value in pixel for the error to render.

original - the original point, possibly useful for calculations.

Returns:

the negative x error in pixel for the given point as an absolute value (not relative to the the origin value).

internalGetNegativeYError

protected abstract int internalGetNegativeYError(int xPixel,
                                                 int yPixel,
                                                 TracePoint2D original)

Internally compute the negative y error for the given point as a pixel value (not relative to the the origin value).

Parameters:

xPixel - the x value in pixel for the error to render.

yPixel - the y value in pixel for the error to render.

original - the original point, possibly useful for calculations.

Returns:

the negative y error in pixel for the given point as an absolute value (not relative to the the origin value).

internalGetPositiveXError

protected abstract int internalGetPositiveXError(int xPixel,
                                                 int yPixel,
                                                 TracePoint2D original)

Internally compute the positive x error in pixel for the given point as an absolute value (not relative to the the origin value).

Parameters:

xPixel - the x value in pixel for the error to render.

yPixel - the y value in pixel for the error to render.

original - the original point, possibly useful for calculations.

Returns:

the positive x error in pixel for the given point as an absolute value (not relative to the the origin value).

internalGetPositiveYError

protected abstract int internalGetPositiveYError(int xPixel,
                                                 int yPixel,
                                                 TracePoint2D original)

Internally compute the positive y error in pixel for the given point as an absolute value (not relative to the the origin value).

Parameters:

xPixel - the x coordinate in pixel for the error to render.

yPixel - the y coordinate in pixel for the error to render.

original - the original point, possibly useful for calculations.

Returns:

the positive y error in pixel for the given point as an absolute value (not relative to the the origin value).

isShowNegativeXErrors

public final boolean isShowNegativeXErrors()

Description copied from interface: IErrorBarPolicy

Returns true if negative errors in x dimension are shown.

Specified by:

isShowNegativeXErrors in interface IErrorBarPolicy

Returns:

true if negative errors in x dimension are shown.

See Also:

IErrorBarPolicy.isShowNegativeXErrors()

isShowNegativeYErrors

public final boolean isShowNegativeYErrors()

Description copied from interface: IErrorBarPolicy

Returns true if negative errors in y dimension are shown.

Specified by:

isShowNegativeYErrors in interface IErrorBarPolicy

Returns:

true if negative errors in y dimension are shown.

See Also:

IErrorBarPolicy.isShowNegativeYErrors()

isShowPositiveXErrors

public final boolean isShowPositiveXErrors()

Description copied from interface: IErrorBarPolicy

Returns true if positive errors in x dimension are shown.

Specified by:

isShowPositiveXErrors in interface IErrorBarPolicy

Returns:

true if positive errors in x dimension are shown.

See Also:

IErrorBarPolicy.isShowPositiveXErrors()

isShowPositiveYErrors

public final boolean isShowPositiveYErrors()

Description copied from interface: IErrorBarPolicy

Returns true if positive errors in y dimension are shown.

Specified by:

isShowPositiveYErrors in interface IErrorBarPolicy

Returns:

true if positive errors in y dimension are shown.

See Also:

IErrorBarPolicy.isShowPositiveYErrors()

paintPoint

public void paintPoint(int absoluteX,
                       int absoluteY,
                       int nextX,
                       int nextY,
                       Graphics2D g,
                       TracePoint2D original)

Description copied from interface: IPointPainter

Paint the point given by absolute coordinates on the given graphic context.

The next coordinates are also provided to allow to check how much distance is available for the graphic representation of the current point.

Note that by contract the TracePoint2D argument is only guaranteed to be non-null in case the instance is used as a painter for ITracePainter subtypes. If you plan to use your implementation also for a subcomponent of an IErrorBarPainter (e.g. IErrorBarPainter.setConnectionPainter(IPointPainter)) then you have to implement "null - safe" for that argument.

Specified by:

paintPoint in interface IPointPainter

Parameters:

absoluteX - the ready to use x value for the point to paint.

absoluteY - the ready to use y value for the point to paint.

nextX - the ready to use next x value for the point to paint.

nextY - the ready to use next y value for the point to paint.

g - the graphic context to paint on.

original - just for information, for painting this should be irrelevant and it should not be changed too!

See Also:

IPointPainter.paintPoint(int, int, int, int, java.awt.Graphics2D, info.monitorenter.gui.chart.TracePoint2D)

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Just turns the property change event of subsequent configuration (like IErrorBarPainter.PROPERTY_CONNECTION to IErrorBarPolicy.PROPERTY_CONFIGURATION and informs outer PropertyChangeListener addes with addPropertyChangeListener(String, PropertyChangeListener).

Specified by:

propertyChange in interface PropertyChangeListener

See Also:

PropertyChangeListener.propertyChange(java.beans.PropertyChangeEvent)

removeErrorBarPainter

public boolean removeErrorBarPainter(IErrorBarPainter painter)

Description copied from interface: IErrorBarPolicy

Removes the given error bar painter.

Specified by:

removeErrorBarPainter in interface IErrorBarPolicy

Parameters:

painter - the error bar painter to remove.

Returns:

true if the given error bar painter was removed, comparison by the means of the equals operation.

See Also:

IErrorBarPolicy.removeErrorBarPainter(info.monitorenter.gui.chart.IErrorBarPainter)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: IErrorBarPolicy

Deregisters a property change listener that has been registerd for listening on all properties.

Specified by:

removePropertyChangeListener in interface IErrorBarPolicy

Parameters:

listener - a listener that will only be informed if the property identified by the argument propertyName changes

See Also:

IErrorBarPolicy.removePropertyChangeListener(java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(String property,
                                         PropertyChangeListener listener)

Description copied from interface: IErrorBarPolicy

Removes a property change listener for listening on the given property.

Specified by:

removePropertyChangeListener in interface IErrorBarPolicy

Parameters:

property - one of the constants with teh PROPERTY_ prefix defined in this class or subclasses.

listener - the listener for this property change.

See Also:

IErrorBarPolicy.removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)

setErrorBarPainter

public void setErrorBarPainter(IErrorBarPainter painter)

Description copied from interface: IErrorBarPolicy

Makes the given error bar painter the sole painter for error bars of this instance.

Specified by:

setErrorBarPainter in interface IErrorBarPolicy

Parameters:

painter - the painter to use.

See Also:

IErrorBarPolicy.setErrorBarPainter(info.monitorenter.gui.chart.IErrorBarPainter)

setShowNegativeXErrors

public final void setShowNegativeXErrors(boolean showNegativeXErrors)

Description copied from interface: IErrorBarPolicy

Set whether negative errors in x dimension should be shown.

Specified by:

setShowNegativeXErrors in interface IErrorBarPolicy

Parameters:

showNegativeXErrors - if true negative errors in x dimension will be shown.

See Also:

IErrorBarPolicy.setShowNegativeXErrors(boolean)

setShowNegativeYErrors

public final void setShowNegativeYErrors(boolean showNegativeYErrors)

Description copied from interface: IErrorBarPolicy

Set whether negative errors in y dimension should be shown.

Specified by:

setShowNegativeYErrors in interface IErrorBarPolicy

Parameters:

showNegativeYErrors - if true negative errors in y dimension will be shown.

See Also:

IErrorBarPolicy.setShowNegativeYErrors(boolean)

setShowPositiveXErrors

public final void setShowPositiveXErrors(boolean showPositiveXErrors)

Description copied from interface: IErrorBarPolicy

Set whether positive errors in x dimension should be shown.

Specified by:

setShowPositiveXErrors in interface IErrorBarPolicy

Parameters:

showPositiveXErrors - if true positive errors in x dimension will be shown.

See Also:

IErrorBarPolicy.setShowPositiveXErrors(boolean)

setShowPositiveYErrors

public final void setShowPositiveYErrors(boolean showPositiveYErrors)

Description copied from interface: IErrorBarPolicy

Set whether positive errors in y dimension should be shown.

Specified by:

setShowPositiveYErrors in interface IErrorBarPolicy

Parameters:

showPositiveYErrors - if true positive errors in y dimension will be shown.

See Also:

IErrorBarPolicy.setShowPositiveYErrors(boolean)

setTrace

public void setTrace(ITrace2D trace)

Intended for ATrace2D only that will register itself to the instances added to it.

This is support for error bar policies that need information about the whole trace (e.g. median value). It has nothing to do with the kind of error bar policy to be used by a trace. See ITrace2D.setErrorBarPolicy(IErrorBarPolicy) and ITrace2D.addErrorBarPolicy(IErrorBarPolicy) for this feature instead.

Specified by:

setTrace in interface IErrorBarPolicy

Parameters:

trace - the trace error bars are rendered for.

startPaintIteration

public void startPaintIteration(Graphics2D g2d,
                                ITrace2D trace)

Description copied from interface: ITracePainter

Invoked to inform implementations that a paint iteration starts for the corresponding ITrace2D.

Specified by:

startPaintIteration in interface ITracePainter

Parameters:

g2d - provided in case pending paint operations have to be performed.

trace - the TracePoint2D to paint in this iteration.

See Also:

ITracePainter.startPaintIteration(java.awt.Graphics2D, info.monitorenter.gui.chart.ITrace2D)