info.monitorenter.gui.chart.tracepoints

Class CandleStick

java.lang.Object

java.awt.geom.Point2D

java.awt.geom.Point2D.Double

info.monitorenter.gui.chart.tracepoints.TracePoint2D

info.monitorenter.gui.chart.tracepoints.CandleStick

All Implemented Interfaces:

ITracePoint2D, Serializable, Cloneable, Comparable<ITracePoint2D>

public class CandleStick
extends TracePoint2D

Faked tracepoint that adds the properties to contain all data for a candlestick.

See http://en.wikipedia.org/wiki/Candlestick_chart

This implementation only works correctly with a special candlestick point painter.

The original TracePoint2D.getY() method is mapped to getStart(). The original TracePoint2D.getX() method is sufficient to be related to all other y values as a candlestick has a single point in time (x value).

Author:

Achim Westermann

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

Constructor and Description
CandleStick(double xValue, double startY, double endY, double highY, double lowY) Constructor with every argument needed.

Method Summary

Modifier and Type	Method and Description
double	getEnd() Returns the end y value.
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.
protected double	getEuclidDistance(double xNormalized, double yNormalized, double myScaledX, double myScaledY) Internal helper that returns the eculid distance between the given "outside" coordinates (mouse move) and the "inside" coordinates.
double	getHigh() Returns the high y value.
double	getLow() Returns the low y value.
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	getManhattanDistance(double xNormalized, double yNormalized, double myScaledX, double myScaledY) Internal helper that returns the manhattan distance between the given "outside" coordinates (mouse move) and the "inside" 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	getStart() Returns the start y value.
String	getTooltipText() Returns the tool tip text that should be displayed in case this trace point is selected to show a tool tip.
protected double	scaleX(double value) Helper to scale the additional values in this trace.
protected double	scaleY(double value) Helper to scale the additional values in this trace.

Methods inherited from class info.monitorenter.gui.chart.tracepoints.TracePoint2D

addAdditionalPointPainter, clone, compareTo, equals, getAdditionalPointPainters, getListener, getScaledX, getScaledY, getX, getY, hashCode, isDiscontinuation, isVisble, removeAdditionalPointPainter, removeAllAdditionalPointPainters, setListener, setLocation, setScaledX, setScaledY, 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

CandleStick

public CandleStick(double xValue,
                   double startY,
                   double endY,
                   double highY,
                   double lowY)

Constructor with every argument needed.

See http://en.wikipedia.org/wiki/Candlestick_chart

Parameters:

xValue - the x coordinate.

startY - the start y value.

endY - the end y value.

highY - the high y value.

lowY - the low y value.

Method Detail

getEnd

public double getEnd()

Returns the end y value.

Returns:

the end y value.

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

Overrides:

getEuclidDistance in class TracePoint2D

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:

TracePoint2D.getEuclidDistance(double, double)

getEuclidDistance

protected final double getEuclidDistance(double xNormalized,
                                         double yNormalized,
                                         double myScaledX,
                                         double myScaledY)

Internal helper that returns the eculid distance between the given "outside" coordinates (mouse move) and the "inside" coordinates. "Inside" coordinates means: The tracepoint may have several areas of interest like this candle stick. So finding the shortest distance to it may be the question which area of interest is closest: The start value, the end value, the high value or the low value.

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.

myScaledX - the normalized x "inside" coordinate between 0 and 1.0 to measure the Euclid distance to.

myScaledY - the normalized y "inside" coordinate between 0 and 1.0 to measure the Euclid distance to.

Returns:

the eculid distance between the given "outside" coordinates (mouse move) and the "inside" coordinates.

getHigh

public double getHigh()

Returns the high y value.

Returns:

the high y value.

getLow

public double getLow()

Returns the low y value.

Returns:

the low y value.

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

Overrides:

getManhattanDistance in class TracePoint2D

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:

TracePoint2D.getManhattanDistance(double, double)

getManhattanDistance

public double getManhattanDistance(double xNormalized,
                                   double yNormalized,
                                   double myScaledX,
                                   double myScaledY)

Internal helper that returns the manhattan distance between the given "outside" coordinates (mouse move) and the "inside" coordinates. "Inside" coordinates means: The tracepoint may have several areas of interest like this candle stick. So finding the shortest distance to it may be the question which area of interest is closest: The start value, the end value, the high value or the low value.

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.

myScaledX - the normalized x "inside" coordinate between 0 and 1.0 to measure the manhattan distance to.

myScaledY - the normalized y "inside" coordinate between 0 and 1.0 to measure the manhattan distance to.

Returns:

the manhattan distance between the given "outside" coordinates (mouse move) and the "inside" coordinates.

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

Overrides:

getNormalizedHighlightSweetSpotCoordinates in class TracePoint2D

Returns:

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

See Also:

TracePoint2D.getNormalizedHighlightSweetSpotCoordinates()

getStart

public double getStart()

Returns the start y value.

Note: this is the reused inherited TracePoint2D.getY().

Returns:

the start y value.

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

Overrides:

getTooltipText in class TracePoint2D

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

scaleX

protected double scaleX(double value)

Helper to scale the additional values in this trace.

FIXME: Think about caching or move this to the axis code along with setters? Should be profiled.

Parameters:

value - the internal value to scale.

Returns:

the scaled value.

scaleY

protected double scaleY(double value)

Helper to scale the additional values in this trace.

FIXME: Think about caching or move this to the axis code along with setters? Should be profiled.

Parameters:

value - the internal value to scale.

Returns:

the scaled value.