info.monitorenter.gui.chart.tracepoints

Class TracePoint2D

java.lang.Object

java.awt.geom.Point2D

java.awt.geom.Point2D.Double

info.monitorenter.gui.chart.tracepoints.TracePoint2D

All Implemented Interfaces:

ITracePoint2D, Serializable, Cloneable, Comparable<ITracePoint2D>

Direct Known Subclasses:

CandleStick

public class TracePoint2D
extends Point2D.Double
implements ITracePoint2D

A specialized version of java.awt.Point2D.Double who carries two further values: double scaledX and double scaledY which allow the Chart2D to cache the scaled values (between 0.0 and 1.0) without having to keep a copy of the aggregators (ITrace2D) complete tracepoints.

This avoids the necessity to care for the correct order of a set of scaled tracepoints copied for caching purposes. Especially in the case of new TracePoint2D instances added to a ITrace2D instance managed by a Chart2D there remains no responsibility for sorting the cached copy. This allows that the managing Chart2D may just rescale the newly added tracepoint instead of searching for the correct order of the new tracepoint by value - comparisons of x and y: The TracePoint2D passed to the method traceChanged(Chart2DDataChangeEvent e) coded in the argument is the original.

Why caching of scaled values for the coordinates?
This takes more RAM but else for every repaint() invocation of the Chart2D would force all tracepoints of all traces to be rescaled again.

A TracePoint2D will inform it's listener of type ITrace on changes of the internal values.

Version:

$Revision: 1.34 $

Author:

Achim Westermann Achim.Westermann@gmx.de

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.geom.Point2D

Point2D.Double, Point2D.Float

Nested classes/interfaces inherited from interface info.monitorenter.gui.chart.ITracePoint2D

ITracePoint2D.STATE

Field Summary

Fields inherited from class java.awt.geom.Point2D.Double

x, y

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TracePoint2D() Intended for TracePointProviderDefault only.
	TracePoint2D(double xValue, double yValue) Construct a TracePoint2D whose coords are initalized to (x,y).

Method Summary

Modifier and Type	Method and Description
boolean	addAdditionalPointPainter(IPointPainter<?> additionalPointPainter) Adds a point painter that additionally (to the pointer painters of the trace (ITrace2D.getTracePainters() )) paint this point.
Object	clone() Returns a cloned instance (deep copy).
int	compareTo(ITracePoint2D obj)
boolean	equals(Object obj)
Set<IPointPainter<?>>	getAdditionalPointPainters() Returns the point painter that additionally (to the trace painter of the chart) paint this point.
double	getEuclidDistance(double xNormalized, double yNormalized) Returns the Euclid distance of this point's normalized values ( ITracePoint2D.getScaledX(), ITracePoint2D.getScaledY()) to the given normalized coordinates.
ITrace2D	getListener() Returns the listener trace connected to this trace point.
double	getManhattanDistance(double xNormalized, double yNormalized) Returns the Manhattan distance of this point's normalized values ( ITracePoint2D.getScaledX(), ITracePoint2D.getScaledY()) to the given normalized coordinates.
double[]	getNormalizedHighlightSweetSpotCoordinates() Returns the normalized coordinates of this point that should be highlighted or null if new double[]{this.getX(), this.getY()}; is the position to highlight.
double	getScaledX()
double	getScaledY()
String	getTooltipText() Returns the tool tip text that should be displayed in case this trace point is selected to show a tool tip.
double	getX() Returns the x value.
double	getY() Returns the y value.
int	hashCode()
boolean	isDiscontinuation() Returns true if ITracePoint2D.getX() and/or ITracePoint2D.getY() is Double.NaN which signals a discontinuation.
boolean	isVisble() Returns true if ITracePoint2D.getScaledX() AND ITracePoint2D.getScaledY() is in the range [0.0..1.0] and ITracePoint2D.isDiscontinuation() returns false.
boolean	removeAdditionalPointPainter(IPointPainter<?> pointPainter) Removes a point painter that additionally (to the pointer painters of the trace (ITrace2D.getTracePainters() )) paint this point.
Set<IPointPainter<?>>	removeAllAdditionalPointPainters() Removes all point painters that additionally (to the pointer painters of the trace (ITrace2D.getTracePainters() )) paint this point.
void	setListener(ITrace2D listener) Allows ITrace2D instances to register (or de-register) themselves with this point to receive (or stop receiving) change information via ITrace2D#firePointChanged(ITracePoint2D, STATE, Object, Object) events.
void	setLocation(double xValue, double yValue) This method overloads the method of java.awt.geom.Point2D.Double to fire a property change event to listeners of the corresponding ITrace2D instances via their method ITrace2D#firePointChanged(ITracePoint2D, STATE, Object, Object) (with int argument set to ITracePoint2D.STATE.CHANGED).
void	setScaledX(double scaledX) Only intended for Chart2D!!!.
void	setScaledY(double scaledY) Only intended for Chart2D!!!.
String	toString()

Methods inherited from class java.awt.geom.Point2D

distance, distance, distance, distanceSq, distanceSq, distanceSq, setLocation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TracePoint2D

protected TracePoint2D()

Intended for TracePointProviderDefault only.

TracePoint2D

public TracePoint2D(double xValue,
                    double yValue)

Construct a TracePoint2D whose coords are initalized to (x,y).

Parameters:

xValue - the x value to use.

yValue - the y value to use.

Method Detail

addAdditionalPointPainter

public final boolean addAdditionalPointPainter(IPointPainter<?> additionalPointPainter)

Description copied from interface: ITracePoint2D

Adds a point painter that additionally (to the pointer painters of the trace (ITrace2D.getTracePainters() )) paint this point.

No clone will be taken. Outside modifications of the argument later on will also affect this instances state!

Caution! This is a low level mechanism that is also used by the highlighting mechanism. It is being utilized by the Chart2D.enablePointHighlighting(boolean) which will use some mouse motion listener to remove outdated highlighters and add highlighters to the new point in focus by taking the highlighter configured in the trace.
So to use point highlighting for traces you should not re-program it at this level but just use ITrace2D.addPointHighlighter(IPointPainter) and Chart2D.enablePointHighlighting(boolean).

Specified by:

addAdditionalPointPainter in interface ITracePoint2D

Parameters:

additionalPointPainter - a point painter that will additionally (to the trace painter of the chart) paint this point.

Returns:

true if this point painter was accepted (not contained before by the means of Comparable.compareTo(Object) .

See Also:

ITracePoint2D.addAdditionalPointPainter(info.monitorenter.gui.chart.IPointPainter)

clone

public Object clone()

Description copied from interface: ITracePoint2D

Returns a cloned instance (deep copy).

Specified by:

clone in interface ITracePoint2D

Overrides:

clone in class Point2D

Returns:

a cloned instance (deep copy)

See Also:

ITracePoint2D.clone()

compareTo

public int compareTo(ITracePoint2D obj)

Specified by:

compareTo in interface Comparable<ITracePoint2D>

See Also:

info.monitorenter.gui.chart.ITracePoint2D#compareTo(info.monitorenter.gui.chart.ITracePoint2D)

equals

public boolean equals(Object obj)

Overrides:

equals in class Point2D

See Also:

Point2D.equals(java.lang.Object)

getAdditionalPointPainters

public final Set<IPointPainter<?>> getAdditionalPointPainters()

Description copied from interface: ITracePoint2D

Returns the point painter that additionally (to the trace painter of the chart) paint this point.

The original list is returned so painters may be added or removed (even all painters may be cleared).

Specified by:

getAdditionalPointPainters in interface ITracePoint2D

Returns:

the point painters that additionally (to the trace painter of the chart) paint this point.

See Also:

ITracePoint2D.getAdditionalPointPainters()

getEuclidDistance

public double getEuclidDistance(double xNormalized,
                                double yNormalized)

Description copied from interface: ITracePoint2D

Returns the Euclid distance of this point's normalized values ( ITracePoint2D.getScaledX(), ITracePoint2D.getScaledY()) to the given normalized coordinates.

Specified by:

getEuclidDistance in interface ITracePoint2D

Parameters:

xNormalized - the normalized x coordinate between 0 and 1.0 to measure the Euclid distance to.

yNormalized - the normalized y coordinate between 0 and 1.0 to measure the Euclid distance to.

Returns:

the Euclid distance of this point's normalized values ( ITracePoint2D.getScaledX(), ITracePoint2D.getScaledY()) to the given normalized coordinates.

See Also:

ITracePoint2D.getEuclidDistance(double, double)

getListener

public final ITrace2D getListener()

Description copied from interface: ITracePoint2D

Returns the listener trace connected to this trace point.

Specified by:

getListener in interface ITracePoint2D

Returns:

the listener trace connected to this trace point.

See Also:

ITracePoint2D.getListener()

getManhattanDistance

public double getManhattanDistance(double xNormalized,
                                   double yNormalized)

Description copied from interface: ITracePoint2D

Returns the Manhattan distance of this point's normalized values ( ITracePoint2D.getScaledX(), ITracePoint2D.getScaledY()) to the given normalized coordinates.

Specified by:

getManhattanDistance in interface ITracePoint2D

Parameters:

xNormalized - the normalized x coordinate between 0 and 1.0 to measure the Manhattan distance to.

yNormalized - the normalized y coordinate between 0 and 1.0 to measure the Manhattan distance to.

Returns:

the Manhattan distance of this point's normalized values ( ITracePoint2D.getScaledX(), ITracePoint2D.getScaledY()) to the given normalized coordinates.

See Also:

ITracePoint2D.getManhattanDistance(double, double)

getNormalizedHighlightSweetSpotCoordinates

public double[] getNormalizedHighlightSweetSpotCoordinates()

Description copied from interface: ITracePoint2D

Returns the normalized coordinates of this point that should be highlighted or null if new double[]{this.getX(), this.getY()}; is the position to highlight.

Trace point implementations (like CandleStick) render larger spaces than their center coordinate. Those may return the area of interest that should be highlighted.

Specified by:

getNormalizedHighlightSweetSpotCoordinates in interface ITracePoint2D

Returns:

the normalized coordinates of this point that should be highlighted or null if not different from ITracePoint2D.getX() and ITracePoint2D.getY().

See Also:

ITracePoint2D.getNormalizedHighlightSweetSpotCoordinates()

getScaledX

public final double getScaledX()

Specified by:

getScaledX in interface ITracePoint2D

Returns:

the scaledX.

See Also:

ITracePoint2D.getScaledX()

getScaledY

public final double getScaledY()

Specified by:

getScaledY in interface ITracePoint2D

Returns:

the scaledY.

See Also:

ITracePoint2D.getScaledY()

getTooltipText

public String getTooltipText()

Description copied from interface: ITracePoint2D

Returns the tool tip text that should be displayed in case this trace point is selected to show a tool tip.

Specified by:

getTooltipText in interface ITracePoint2D

Returns:

the tool tip text that should be displayed in case this trace point is selected to show a tool tip.

See Also:

ITracePoint2D.getTooltipText()

getX

public double getX()

Description copied from interface: ITracePoint2D

Returns the x value.

Specified by:

getX in interface ITracePoint2D

Overrides:

getX in class Point2D.Double

Returns:

the x value.

See Also:

ITracePoint2D.getX()

getY

public double getY()

Description copied from interface: ITracePoint2D

Returns the y value.

Specified by:

getY in interface ITracePoint2D

Overrides:

getY in class Point2D.Double

Returns:

the y value.

See Also:

ITracePoint2D.getY()

hashCode

public int hashCode()

Overrides:

hashCode in class Point2D

See Also:

Point2D.hashCode()

isDiscontinuation

public boolean isDiscontinuation()

Description copied from interface: ITracePoint2D

Returns true if ITracePoint2D.getX() and/or ITracePoint2D.getY() is Double.NaN which signals a discontinuation.

Specified by:

isDiscontinuation in interface ITracePoint2D

Returns:

true if ITracePoint2D.getX() and/or ITracePoint2D.getY() is Double.NaN which signals a discontinuation.

See Also:

ITracePoint2D.isDiscontinuation()

isVisble

public boolean isVisble()

Description copied from interface: ITracePoint2D

Returns true if ITracePoint2D.getScaledX() AND ITracePoint2D.getScaledY() is in the range [0.0..1.0] and ITracePoint2D.isDiscontinuation() returns false.

This call only makes sense after the point has been added to a trace.

Specified by:

isVisble in interface ITracePoint2D

Returns:

true if ITracePoint2D.getScaledX() AND ITracePoint2D.getScaledY() is in the range [0.0..1.0] and ITracePoint2D.isDiscontinuation() returns false.

See Also:

ITracePoint2D.isVisble()

removeAdditionalPointPainter

public boolean removeAdditionalPointPainter(IPointPainter<?> pointPainter)

Description copied from interface: ITracePoint2D

Removes a point painter that additionally (to the pointer painters of the trace (ITrace2D.getTracePainters() )) paint this point.

Specified by:

removeAdditionalPointPainter in interface ITracePoint2D

Parameters:

pointPainter - a point painter that currently is used to additionally (to the trace painter of the chart) paint this point.

Returns:

true if this point painter was removed (contained before by the means of Comparable.compareTo(Object) .

See Also:

ITracePoint2D.removeAdditionalPointPainter(info.monitorenter.gui.chart.IPointPainter)

removeAllAdditionalPointPainters

public Set<IPointPainter<?>> removeAllAdditionalPointPainters()

Description copied from interface: ITracePoint2D

Removes all point painters that additionally (to the pointer painters of the trace (ITrace2D.getTracePainters() )) paint this point.

Specified by:

removeAllAdditionalPointPainters in interface ITracePoint2D

Returns:

all instances that were used before this call.

See Also:

ITracePoint2D.removeAllAdditionalPointPainters()

setListener

public final void setListener(ITrace2D listener)

Description copied from interface: ITracePoint2D

Allows ITrace2D instances to register (or de-register) themselves with this point to receive (or stop receiving) change information via ITrace2D#firePointChanged(ITracePoint2D, STATE, Object, Object) events.

Specified by:

setListener in interface ITracePoint2D

Parameters:

listener - The instance that will be informed about changes or null to deregister.

See Also:

ITracePoint2D.setListener(info.monitorenter.gui.chart.ITrace2D)

setLocation

public void setLocation(double xValue,
                        double yValue)

Description copied from interface: ITracePoint2D

This method overloads the method of java.awt.geom.Point2D.Double to fire a property change event to listeners of the corresponding ITrace2D instances via their method ITrace2D#firePointChanged(ITracePoint2D, STATE, Object, Object) (with int argument set to ITracePoint2D.STATE.CHANGED).

Specified by:

setLocation in interface ITracePoint2D

Overrides:

setLocation in class Point2D.Double

Parameters:

xValue - the new x-coordinate for this point.

yValue - the new y-coordinate for this point.

See Also:

ITracePoint2D.setLocation(double, double)

setScaledX

public final void setScaledX(double scaledX)

Description copied from interface: ITracePoint2D

Only intended for Chart2D!!!.

Specified by:

setScaledX in interface ITracePoint2D

Parameters:

scaledX - the scaledX to set

See Also:

ITracePoint2D.setScaledX(double)

setScaledY

public final void setScaledY(double scaledY)

Description copied from interface: ITracePoint2D

Only intended for Chart2D!!!.

Specified by:

setScaledY in interface ITracePoint2D

Parameters:

scaledY - the scaledY to set

See Also:

ITracePoint2D.setScaledY(double)

toString

public String toString()

Overrides:

toString in class Point2D.Double

See Also:

info.monitorenter.gui.chart.ITracePoint2D#toString()