/*
* AErrorBarPolicyConfigurable.java of project jchart2d, a basic
* error bar policy implementation that allows configuration of
* the dimension and direction error bars will be visible in.
* Copyright (c) 2007 - 2011 Achim Westermann, created on 08.08.2006 08:05:54.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA*
* If you modify or optimize the code in a useful way please let me know.
* Achim.Westermann@gmx.de
*
*/
package info.monitorenter.gui.chart.errorbars;
import info.monitorenter.gui.chart.IErrorBarPainter;
import info.monitorenter.gui.chart.IErrorBarPolicy;
import info.monitorenter.gui.chart.ITrace2D;
import info.monitorenter.gui.chart.ITracePoint2D;
import java.awt.Graphics;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.swing.JComponent;
import javax.swing.event.SwingPropertyChangeSupport;
/**
* A {@link info.monitorenter.gui.chart.IErrorBarPolicy} base
* implementation that is configurable by the means of showing positive/negative
* errors in x/y dimension.
*
*
* Implementations have to implement the methods
*
* {@link #internalGetNegativeXError(int, int, ITracePoint2D)}
* {@link #internalGetNegativeYError(int, int, ITracePoint2D)}
* {@link #internalGetPositiveXError(int, int, ITracePoint2D)}
* {@link #internalGetPositiveYError(int, int, ITracePoint2D)}
* .
*
* Please see the class description of
* {@link info.monitorenter.gui.chart.IErrorBarPixel} for details.
*
*
* @author Achim Westermann
*
* @version $Revision: 1.41 $
*/
public abstract class AErrorBarPolicyConfigurable implements
IErrorBarPolicy, PropertyChangeListener {
/** Generated serialVersionUID. **/
private static final long serialVersionUID = -1163969612681194656L;
/** The internal set of error bar painters delegated to. */
private final Set m_errorBarPainters = new LinkedHashSet();
/** Flag to remember if a paint iteration has ended. */
private boolean m_isEnded = false;
/**
* The last trace point coordinate that was sent to
* {@link #paintPoint(int, int, int, int, Graphics, ITracePoint2D)}.
*
* It will be needed at {@link #endPaintIteration(Graphics)} as the former
* method only uses the first set of coordinates to store in the internal list
* to avoid duplicates.
*
*/
protected ITracePoint2D m_lastPoint;
/**
* The last x coordinate that was sent to
* {@link #paintPoint(int, int, int, int, Graphics, ITracePoint2D)}.
*
* It will be needed at {@link #endPaintIteration(Graphics)} as the former
* method only uses the first set of coordinates to store in the internal list
* to avoid duplicates.
*
*/
protected int m_lastX;
/**
* The last y coordinate that was sent to
* {@link #paintPoint(int, int, int, int, Graphics, ITracePoint2D)}.
*
* It will be needed at {@link #endPaintIteration(Graphics)} as the former
* method only uses the first set of coordinates to store in the internal list
* to avoid duplicates.
*
*/
protected int m_lastY;
/**
* The instance that add support for firing PropertyChangeEvents
* and maintaining PropertyChangeListeners.
* {@link PropertyChangeListener} instances.
*/
protected PropertyChangeSupport m_propertyChangeSupport = new SwingPropertyChangeSupport(this);
/** Internal shared error bar pixel instance to save Object allocation. */
private final ErrorBarPixel m_reusedErrorBarPixel = new ErrorBarPixel(null);
/** Flag that controls display of negative errors in x dimension. */
private boolean m_showNegativeXErrors;
/** Flag that controls display of negative errors in y dimension. */
private boolean m_showNegativeYErrors;
/** Flag that controls display of positive errors in x dimension. */
private boolean m_showPositiveXErrors;
/** Flag that controls display of positive errors in y dimension. */
private boolean m_showPositiveYErrors;
/** The trace to render. */
private ITrace2D m_trace;
/**
* Defcon.
*
*/
public AErrorBarPolicyConfigurable() {
// this.m_reusedErrorBarValue = new ErrorBarValue();
// this.m_reusedErrorBarPixel.setValue(this.m_reusedErrorBarValue);
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#addErrorBarPainter(info.monitorenter.gui.chart.IErrorBarPainter)
*/
public void addErrorBarPainter(final IErrorBarPainter painter) {
this.m_errorBarPainters.add(painter);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_CONNECTION, this);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_CONNECTION_COLOR, this);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_ENDPOINT, this);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_ENDPOINT_COLOR, this);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_STARTPOINT, this);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_STARTPOINT_COLOR, this);
this.firePropertyChange(IErrorBarPolicy.PROPERTY_ERRORBARPAINTER, null, painter);
this.firePropertyChange(IErrorBarPolicy.PROPERTY_CONFIGURATION, null, null);
}
/**
* Adds a property change listener.
*
*
* @param propertyName
* The name of the property to listen on.
* @param listener
* The PropertyChangeListener to be added.
* @see info.monitorenter.gui.chart.ITrace2D#addPropertyChangeListener(java.lang.String,
* java.beans.PropertyChangeListener)
*/
public final void addPropertyChangeListener(final String propertyName,
final PropertyChangeListener listener) {
this.m_propertyChangeSupport.addPropertyChangeListener(propertyName, listener);
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#calculateErrorBar(int,
* int, info.monitorenter.gui.chart.errorbars.ErrorBarPixel,
* info.monitorenter.gui.chart.ITracePoint2D)
*/
public final void calculateErrorBar(final int xPixel, final int yPixel,
final ErrorBarPixel errorBar, final ITracePoint2D original) {
errorBar.clear();
if (this.m_showNegativeXErrors) {
errorBar.setNegativeXErrorPixel(this.internalGetNegativeXError(xPixel, yPixel, original));
}
if (this.m_showNegativeYErrors) {
errorBar.setNegativeYErrorPixel(this.internalGetNegativeYError(xPixel, yPixel, original));
}
if (this.m_showPositiveXErrors) {
errorBar.setPositiveXErrorPixel(this.internalGetPositiveXError(xPixel, yPixel, original));
}
if (this.m_showPositiveYErrors) {
errorBar.setPositiveYErrorPixel(this.internalGetPositiveYError(xPixel, yPixel, original));
}
}
/**
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
public int compareTo(final AErrorBarPolicyConfigurable o) {
return this.getClass().getName().compareTo(o.getClass().getName());
}
/**
* @see info.monitorenter.gui.chart.ITracePainter#discontinue(java.awt.Graphics)
*/
public void discontinue(final Graphics g2d) {
this.endPaintIteration(g2d);
this.startPaintIteration(g2d);
}
/**
* @see info.monitorenter.gui.chart.ITracePainter#endPaintIteration(java.awt.Graphics)
*/
public void endPaintIteration(final Graphics g2d) {
if (g2d != null) {
this.calculateErrorBar(this.getPreviousX(), this.getPreviousY(), this.m_reusedErrorBarPixel,
this.getPreviousTracePoint());
for (final IErrorBarPainter painter : this.m_errorBarPainters) {
painter.paintErrorBar(this.getPreviousX(), this.getPreviousY(), this
.getPreviousTracePoint(), g2d, this.m_reusedErrorBarPixel);
}
}
}
/**
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (this.getClass() != obj.getClass()) {
return false;
}
final AErrorBarPolicyConfigurable other = (AErrorBarPolicyConfigurable) obj;
if (this.m_errorBarPainters == null) {
if (other.m_errorBarPainters != null) {
return false;
}
} else if (!this.m_errorBarPainters.equals(other.m_errorBarPainters)) {
return false;
}
if (this.m_isEnded != other.m_isEnded) {
return false;
}
if (this.m_lastPoint == null) {
if (other.m_lastPoint != null) {
return false;
}
} else if (!this.m_lastPoint.equals(other.m_lastPoint)) {
return false;
}
if (this.m_lastX != other.m_lastX) {
return false;
}
if (this.m_lastY != other.m_lastY) {
return false;
}
if (this.m_showNegativeXErrors != other.m_showNegativeXErrors) {
return false;
}
if (this.m_showNegativeYErrors != other.m_showNegativeYErrors) {
return false;
}
if (this.m_showPositiveXErrors != other.m_showPositiveXErrors) {
return false;
}
if (this.m_showPositiveYErrors != other.m_showPositiveYErrors) {
return false;
}
return true;
}
/**
* Fires a property change event to the registered listeners.
*
*
* @param property
* one of the PROPERTY_XXX constants defined in
* {@link info.monitorenter.gui.chart.ITrace2D}.
*
* @param oldvalue
* the old value of the property.
*
* @param newvalue
* the new value of the property.
*/
protected final void firePropertyChange(final String property, final Object oldvalue,
final Object newvalue) {
this.m_propertyChangeSupport.firePropertyChange(property, oldvalue, newvalue);
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#getCustomConfigurator()
*/
public JComponent getCustomConfigurator() {
return null;
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#getErrorBarPainters()
*/
public Set getErrorBarPainters() {
return this.m_errorBarPainters;
}
/**
* Returns the previous X value that had to be painted by
* {@link #paintPoint(int, int, int, int, Graphics, ITracePoint2D)}.
*
*
* This value will be {@link Integer#MIN_VALUE} if no previous point had to be
* painted.
*
*
* @return the previous X value that had to be painted by
* {@link #paintPoint(int, int, int, int, Graphics, ITracePoint2D)}.
*/
private ITracePoint2D getPreviousTracePoint() {
final ITracePoint2D result = this.m_lastPoint;
return result;
}
/**
* Returns the previous X value that had to be painted by
* {@link #paintPoint(int, int, int, int, Graphics, ITracePoint2D)}.
*
*
* This value will be {@link Integer#MIN_VALUE} if no previous point had to be
* painted.
*
*
* @return the previous X value that had to be painted by
* {@link #paintPoint(int, int, int, int, Graphics, ITracePoint2D)}.
*/
private int getPreviousX() {
final int result = this.m_lastX;
if (this.m_isEnded) {
this.m_lastX = Integer.MIN_VALUE;
if (this.m_lastY == Integer.MIN_VALUE) {
this.m_isEnded = false;
}
}
return result;
}
/**
* Returns the previous Y value that had to be painted by
* {@link #paintPoint(int, int, int, int, Graphics, ITracePoint2D)}.
*
*
* This value will be {@link Integer#MIN_VALUE} if no previous point had to be
* painted.
*
*
* @return the previous Y value that had to be painted by
* {@link #paintPoint(int, int, int, int, Graphics, ITracePoint2D)}.
*/
private int getPreviousY() {
final int result = this.m_lastY;
if (this.m_isEnded) {
this.m_lastY = Integer.MIN_VALUE;
if (this.m_lastX == Integer.MIN_VALUE) {
this.m_isEnded = false;
}
}
return result;
}
/**
* Returns the trace error bars have to be rendered for.
*
*
* @return the trace for rendering error bars.
*/
protected final ITrace2D getTrace() {
return this.m_trace;
}
/**
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result
+ ((this.m_errorBarPainters == null) ? 0 : this.m_errorBarPainters.hashCode());
result = prime * result + (this.m_isEnded ? 1231 : 1237);
result = prime * result + ((this.m_lastPoint == null) ? 0 : this.m_lastPoint.hashCode());
result = prime * result + this.m_lastX;
result = prime * result + this.m_lastY;
result = prime * result + (this.m_showNegativeXErrors ? 1231 : 1237);
result = prime * result + (this.m_showNegativeYErrors ? 1231 : 1237);
result = prime * result + (this.m_showPositiveXErrors ? 1231 : 1237);
result = prime * result + (this.m_showPositiveYErrors ? 1231 : 1237);
return result;
}
/**
* Internally compute the negative x error for the given point as a pixel
* value (not relative to the the origin value).
*
*
* @param xPixel
* the x value in pixel for the error to render.
*
* @param yPixel
* the y value in pixel for the error to render.
*
* @param original
* the original point, possibly useful for calculations.
*
* @return the negative x error in pixel for the given point as an absolute
* value (not relative to the the origin value).
*
*/
protected abstract int internalGetNegativeXError(final int xPixel, final int yPixel,
final ITracePoint2D original);
/**
* Internally compute the negative y error for the given point as a pixel
* value (not relative to the the origin value).
*
*
* @param xPixel
* the x value in pixel for the error to render.
*
* @param yPixel
* the y value in pixel for the error to render.
*
* @return the negative y error in pixel for the given point as an absolute
* value (not relative to the the origin value).
*
* @param original
* the original point, possibly useful for calculations.
*/
protected abstract int internalGetNegativeYError(final int xPixel, final int yPixel,
final ITracePoint2D original);
/**
* Internally compute the positive x error in pixel for the given point as an
* absolute value (not relative to the the origin value).
*
*
* @param xPixel
* the x value in pixel for the error to render.
*
* @param yPixel
* the y value in pixel for the error to render.
*
* @param original
* the original point, possibly useful for calculations.
*
* @return the positive x error in pixel for the given point as an absolute
* value (not relative to the the origin value).
*/
protected abstract int internalGetPositiveXError(final int xPixel, final int yPixel,
final ITracePoint2D original);
/**
* Internally compute the positive y error in pixel for the given point as an
* absolute value (not relative to the the origin value).
*
*
* @param xPixel
* the x coordinate in pixel for the error to render.
*
* @param yPixel
* the y coordinate in pixel for the error to render.
*
* @param original
* the original point, possibly useful for calculations.
*
* @return the positive y error in pixel for the given point as an absolute
* value (not relative to the the origin value).
*/
protected abstract int internalGetPositiveYError(final int xPixel, final int yPixel,
final ITracePoint2D original);
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#isShowNegativeXErrors()
*/
public final boolean isShowNegativeXErrors() {
return this.m_showNegativeXErrors;
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#isShowNegativeYErrors()
*/
public final boolean isShowNegativeYErrors() {
return this.m_showNegativeYErrors;
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#isShowPositiveXErrors()
*/
public final boolean isShowPositiveXErrors() {
return this.m_showPositiveXErrors;
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#isShowPositiveYErrors()
*/
public final boolean isShowPositiveYErrors() {
return this.m_showPositiveYErrors;
}
/**
* @see info.monitorenter.gui.chart.IPointPainter#paintPoint(int, int, int,
* int, java.awt.Graphics, info.monitorenter.gui.chart.ITracePoint2D)
*/
public void paintPoint(final int absoluteX, final int absoluteY, final int nextX,
final int nextY, final Graphics g, final ITracePoint2D original) {
this.calculateErrorBar(nextX, nextY, this.m_reusedErrorBarPixel, original);
for (final IErrorBarPainter painter : this.m_errorBarPainters) {
painter.paintErrorBar(nextX, nextY, original, g, this.m_reusedErrorBarPixel);
}
this.m_lastX = nextX;
this.m_lastY = nextY;
this.m_lastPoint = original;
}
/**
* Just turns the property change event of subsequent configuration (like
* {@link IErrorBarPainter#PROPERTY_CONNECTION} to
* {@link IErrorBarPolicy#PROPERTY_CONFIGURATION}
* and informs outer {@link PropertyChangeListener} added with
*
* {@link #addPropertyChangeListener(String, PropertyChangeListener)}.
*
*
* @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)
*/
public void propertyChange(final PropertyChangeEvent evt) {
this.firePropertyChange(IErrorBarPolicy.PROPERTY_CONFIGURATION, evt.getOldValue(), evt
.getNewValue());
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#removeErrorBarPainter(info.monitorenter.gui.chart.IErrorBarPainter)
*/
public boolean removeErrorBarPainter(final IErrorBarPainter painter) {
final boolean result = this.m_errorBarPainters.remove(painter);
painter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_CONNECTION, this);
painter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_CONNECTION_COLOR, this);
painter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_ENDPOINT, this);
painter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_ENDPOINT_COLOR, this);
painter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_STARTPOINT, this);
painter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_STARTPOINT_COLOR, this);
if (result) {
this.firePropertyChange(IErrorBarPolicy.PROPERTY_ERRORBARPAINTER, painter, null);
this.firePropertyChange(IErrorBarPolicy.PROPERTY_CONFIGURATION, null, null);
}
return result;
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#removePropertyChangeListener(java.beans.PropertyChangeListener)
*/
public void removePropertyChangeListener(final PropertyChangeListener listener) {
this.m_propertyChangeSupport.removePropertyChangeListener(listener);
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#removePropertyChangeListener(java.lang.String,
* java.beans.PropertyChangeListener)
*/
public void removePropertyChangeListener(final String property,
final PropertyChangeListener listener) {
this.m_propertyChangeSupport.removePropertyChangeListener(property, listener);
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#setErrorBarPainter(info.monitorenter.gui.chart.IErrorBarPainter)
*/
public void setErrorBarPainter(final IErrorBarPainter painter) {
final Iterator it = this.m_errorBarPainters.iterator();
IErrorBarPainter removePainter;
while (it.hasNext()) {
removePainter = it.next();
it.remove();
removePainter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_CONNECTION, this);
removePainter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_CONNECTION_COLOR, this);
removePainter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_ENDPOINT, this);
removePainter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_ENDPOINT_COLOR, this);
removePainter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_STARTPOINT, this);
removePainter.removePropertyChangeListener(IErrorBarPainter.PROPERTY_STARTPOINT_COLOR, this);
this.firePropertyChange(IErrorBarPolicy.PROPERTY_ERRORBARPAINTER, removePainter, null);
}
this.m_errorBarPainters.add(painter);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_CONNECTION, this);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_CONNECTION_COLOR, this);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_ENDPOINT, this);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_ENDPOINT_COLOR, this);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_STARTPOINT, this);
painter.addPropertyChangeListener(IErrorBarPainter.PROPERTY_STARTPOINT_COLOR, this);
this.firePropertyChange(IErrorBarPolicy.PROPERTY_ERRORBARPAINTER, null, painter);
this.firePropertyChange(IErrorBarPolicy.PROPERTY_CONFIGURATION, null, null);
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#setShowNegativeXErrors(boolean)
*/
public final void setShowNegativeXErrors(final boolean showNegativeXErrors) {
final boolean change = this.m_showNegativeXErrors ^ showNegativeXErrors;
if (change) {
this.m_showNegativeXErrors = showNegativeXErrors;
this.firePropertyChange(IErrorBarPolicy.PROPERTY_CONFIGURATION, null, null);
}
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#setShowNegativeYErrors(boolean)
*/
public final void setShowNegativeYErrors(final boolean showNegativeYErrors) {
final boolean change = this.m_showNegativeYErrors ^ showNegativeYErrors;
if (change) {
this.m_showNegativeYErrors = showNegativeYErrors;
this.firePropertyChange(IErrorBarPolicy.PROPERTY_CONFIGURATION, null, null);
}
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#setShowPositiveXErrors(boolean)
*/
public final void setShowPositiveXErrors(final boolean showPositiveXErrors) {
final boolean change = this.m_showPositiveXErrors ^ showPositiveXErrors;
if (change) {
this.m_showPositiveXErrors = showPositiveXErrors;
this.firePropertyChange(IErrorBarPolicy.PROPERTY_CONFIGURATION, null, null);
}
}
/**
* @see info.monitorenter.gui.chart.IErrorBarPolicy#setShowPositiveYErrors(boolean)
*/
public final void setShowPositiveYErrors(final boolean showPositiveYErrors) {
final boolean change = this.m_showPositiveYErrors ^ showPositiveYErrors;
if (change) {
this.m_showPositiveYErrors = showPositiveYErrors;
this.firePropertyChange(IErrorBarPolicy.PROPERTY_CONFIGURATION, null, null);
}
}
/**
* Intended for {@link info.monitorenter.gui.chart.traces.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
* {@link ITrace2D#setErrorBarPolicy(IErrorBarPolicy)} and
* {@link ITrace2D#addErrorBarPolicy(IErrorBarPolicy)} for this feature
* instead.
*
*
* @param trace
* the trace error bars are rendered for.
*/
public void setTrace(final ITrace2D trace) {
this.m_trace = trace;
this.m_reusedErrorBarPixel.setTrace(trace);
}
/**
* @see info.monitorenter.gui.chart.ITracePainter#startPaintIteration(java.awt.Graphics)
*/
public void startPaintIteration(final Graphics g2d) {
// nop
}
}
Ads help maintain this website.