Class Trace2DDebugger
- java.lang.Object
-
- info.monitorenter.gui.chart.traces.Trace2DDebugger
-
- All Implemented Interfaces:
ITrace2D
,java.beans.PropertyChangeListener
,java.io.Serializable
,java.lang.Comparable<ITrace2D>
,java.util.EventListener
public class Trace2DDebugger extends java.lang.Object implements ITrace2D
A decorator for any ITrace2D implementation. Useful if your chart looks unexpected and the problem may be related to the data that is added. It prints every point added to the console.Use it by decorating the ITrace2D you normally use:
// Create a chart: Chart2D chart = new Chart2D(); // Create an ITrace: <b>ITrace2D trace = new Trace2DDebugger(new Trace2DSimple()); // add data... ... // chart.addTrace(trace);
One can use
setXRange(Range)
,setYRange(Range)
to let this instance throw an Exception if bounds for legal data are exceeded.- Version:
- $Revision: 1.34 $
- Author:
- Achim Westermann
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface info.monitorenter.gui.chart.ITrace2D
ITrace2D.DistancePoint
-
-
Field Summary
-
Fields inherited from interface info.monitorenter.gui.chart.ITrace2D
PROPERTY_COLOR, PROPERTY_ERRORBARPOLICY, PROPERTY_ERRORBARPOLICY_CONFIGURATION, PROPERTY_LABEL, PROPERTY_MAX_X, PROPERTY_MAX_Y, PROPERTY_MIN_X, PROPERTY_MIN_Y, PROPERTY_NAME, PROPERTY_PAINTERS, PROPERTY_PHYSICALUNITS, PROPERTY_POINT_CHANGED, PROPERTY_POINT_HIGHLIGHTERS_CHANGED, PROPERTY_STROKE, PROPERTY_TRACEPOINT, PROPERTY_VISIBLE, PROPERTY_ZINDEX, Z_INDEX_MIN, ZINDEX_MAX
-
-
Constructor Summary
Constructors Constructor Description Trace2DDebugger(ITrace2D debug)
Creates an instance to debug the given trace for valid points added.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addComputingTrace(ITrace2D trace)
Adds a trace that "should" compute values from the points added viaITrace2D.addPoint(ITracePoint2D)
boolean
addErrorBarPolicy(IErrorBarPolicy<?> errorBarPolicy)
Adds the given error bar policy to the internal set of error bar policies.boolean
addPoint(double x, double y)
Adds a trace point to the internal data.boolean
addPoint(ITracePoint2D p)
Adds the givenTracePoint2D
to the internal data.boolean
addPointHighlighter(IPointPainter<?> highlighter)
Adds the given point painter to the internal set of point highlighters.void
addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
Registers a property change listener that will be informed about changes of the property identified by the givenpropertyName
.boolean
addTracePainter(ITracePainter<?> painter)
Adds the given trace painter to the internal set of trace painters.int
compareTo(ITrace2D o)
boolean
containsTracePainter(ITracePainter<?> painter)
Returns true if the given painter is contained in this compound painter.void
firePointChanged(ITracePoint2D changed, int state)
Method to trigger by
,TracePoint2D.setLocation(double, double)
orITrace2D.addPoint(ITracePoint2D)
ITrace2D.removePoint(ITracePoint2D)
java.awt.Color
getColor()
Because the color is data common to a trace of aChart2D
it is stored here.java.util.Set<IErrorBarPolicy<?>>
getErrorBarPolicies()
Returns theSet<
that will be used to render error bars for this trace.IErrorBarPolicy
>boolean
getHasErrorBars()
Returns true if this trace has error bars configured.java.lang.String
getLabel()
Callback method for theChart2D
that returns aString
describing the label of theITrace2D
that will be displayed below the drawing area of theChart2D
.int
getMaxSize()
Returns the maximum amount ofTracePoint2D
instances that may be added.double
getMaxX()
Returns the maximum value to be displayed on the x- axis of theChart2D
.double
getMaxY()
Returns the maximum value to be displayed on the y- axis of the Chart2D.double
getMinX()
Returns the minimum value to be displayed on the x- axis of the Chart2D.double
getMinY()
Returns the minimum value to be displayed on the y- axis of the Chart2D.java.lang.String
getName()
Returns the name of this trace.ITrace2D.DistancePoint
getNearestPointEuclid(double x, double y)
Returns the nearest point to the given normalized value coordinates of this trace in Euclid distance.ITrace2D.DistancePoint
getNearestPointManhattan(double x, double y)
Returns the nearest point to the given normalized value coordinates of this trace in Manhattan distance.java.lang.String
getPhysicalUnits()
Returns the concatenation[x: "
.ITrace2D.getPhysicalUnitsX()
", y: "ITrace2D.getPhysicalUnitsY()
"]java.lang.String
getPhysicalUnitsX()
Returns the physical unit string value for the x dimension.java.lang.String
getPhysicalUnitsY()
Returns the physical unit string value for the y dimension.java.util.Set<IPointPainter<?>>
getPointHighlighters()
Returns theSet<
that may be used to highlight points of this trace.IPointPainter
>java.beans.PropertyChangeListener[]
getPropertyChangeListeners(java.lang.String property)
Returns all property change listeners for the given property.Chart2D
getRenderer()
int
getSize()
Returns the amount ofTracePoint2D
instances currently contained.java.awt.Stroke
getStroke()
Returns the Stroke that is used to render this instance.java.util.Set<ITracePainter<?>>
getTracePainters()
Returns theSet<
that will be used to paint this trace.ITracePainter
>Range
getXRange()
Returns the range of valid points of the x axis.Range
getYRange()
Returns the range of valid points of the y axis.java.lang.Integer
getZIndex()
The z-index defines the order in which this instance will be painted.boolean
isEmpty()
Returns false if internal
instances are contained or true if not.TracePoint2D
boolean
isVisible()
Returns true if this instance should be rendered.java.util.Iterator<ITracePoint2D>
iterator()
Returns anIterator
over the internalTracePoint2D
void
propertyChange(java.beans.PropertyChangeEvent evt)
java.util.Set<IPointPainter<?>>
removeAllPointHighlighters()
Clears all internal point highlighters used.void
removeAllPoints()
Removes all internalTracePoint2D
.ITrace2D.isEmpty()
will return true afterwards.boolean
removeComputingTrace(ITrace2D trace)
Remove a trace that "should" compute values from the points added via
.ITrace2D.addPoint(ITracePoint2D)
boolean
removeErrorBarPolicy(IErrorBarPolicy<?> errorBarPolicy)
Removes the given error bar policy from the internal set of error bar policies.boolean
removePoint(ITracePoint2D point)
Removes the given point from this trace.boolean
removePointHighlighter(IPointPainter<?> highlighter)
Removes the given point highlighter, if it's class is contained.void
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Unregisters a property change listener that has been registered for listening on all properties.void
removePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener)
Removes a property change listener for listening on the given property.boolean
removeTracePainter(ITracePainter<?> painter)
Removes the given trace painter, if it's class is contained and if more painters are remaining.void
setColor(java.awt.Color color)
Set ajava.awt.Color
for this trace.java.util.Set<IErrorBarPolicy<?>>
setErrorBarPolicy(IErrorBarPolicy<?> errorBarPolicy)
Replaces all internal error bar policies by the new one.void
setName(java.lang.String name)
Assingns a specific name to theITrace2D
which will be displayed by theChart2D
.void
setPhysicalUnits(java.lang.String xunit, java.lang.String yunit)
Assigns a specific String representing the physical unit to theITrace2D
(e.g.java.util.Set<IPointPainter<?>>
setPointHighlighter(IPointPainter<?> highlighter)
Replaces all internal point highlighters by the new one.void
setRenderer(Chart2D renderer)
This is a callback fromChart2D.addTrace(ITrace2D)
and must not be invoked from elsewhere (needed for synchronization).void
setStroke(java.awt.Stroke stroke)
Allows to specify the rendering of the ITrace2D.java.util.Set<ITracePainter<?>>
setTracePainter(ITracePainter<?> painter)
Replaces all internal trace painters by the new one.void
setVisible(boolean visible)
Set the visibility.void
setXRange(Range range)
Set the valid range for x values.void
setYRange(Range range)
Set the valid range for y values.void
setZIndex(java.lang.Integer zIndex)
Sets the internal z-index property.boolean
showsErrorBars()
Tests whether error bars are painted by this trace.boolean
showsNegativeXErrorBars()
Tests whether error bars in negative x direction are painted by this trace.boolean
showsNegativeYErrorBars()
Tests whether error bars in negative y direction are painted by this trace.boolean
showsPositiveXErrorBars()
Tests whether error bars in positive x direction are painted by this trace.boolean
showsPositiveYErrorBars()
Tests whether error bars in positive y direction are painted by this trace.java.lang.String
toString()
-
-
-
Constructor Detail
-
Trace2DDebugger
public Trace2DDebugger(ITrace2D debug)
Creates an instance to debug the given trace for valid points added.- Parameters:
debug
- the trace to debug.
-
-
Method Detail
-
addComputingTrace
public void addComputingTrace(ITrace2D trace)
Description copied from interface:ITrace2D
Adds a trace that "should" compute values from the points added viaITrace2D.addPoint(ITracePoint2D)
The given trace will be informed in case an add operation on this trace succeeds via
.ITrace2D.addPoint(ITracePoint2D)
- Specified by:
addComputingTrace
in interfaceITrace2D
- Parameters:
trace
- the trace that will calculate it's points from the added points of this trace.- See Also:
ITrace2D.addComputingTrace(info.monitorenter.gui.chart.ITrace2D)
-
addErrorBarPolicy
public boolean addErrorBarPolicy(IErrorBarPolicy<?> errorBarPolicy)
Description copied from interface:ITrace2D
Adds the given error bar policy to the internal set of error bar policies.It will be the last error bar policy to render (most forward on screen).
- Specified by:
addErrorBarPolicy
in interfaceITrace2D
- Parameters:
errorBarPolicy
- the error bar policy to add for rendering this trace's error bars.- Returns:
- true if the painter was added (same instance was not contained before).
- See Also:
ITrace2D.addErrorBarPolicy(info.monitorenter.gui.chart.IErrorBarPolicy)
-
addPoint
public boolean addPoint(double x, double y)
Description copied from interface:ITrace2D
Adds a trace point to the internal data.Warning:
Do not call this method before this trace has been added to a chart or you will not succeed as the chart is needed to get the properChart2D.getTracePointProvider()
- Specified by:
addPoint
in interfaceITrace2D
- Parameters:
x
- the x-value of the point to add.y
- the y-value of the point to add.- Returns:
- true if the operation was successful, false else.
- See Also:
ITrace2D.addPoint(double, double)
-
addPoint
public boolean addPoint(ITracePoint2D p)
Description copied from interface:ITrace2D
Adds the givenTracePoint2D
to the internal data.Try to pass instances of
TracePoint2D
to this instance instead of invoking
to increase performance. Else the given point has to be copied into such an instance from the other method and delegated to this method.ITrace2D.addPoint(double, double)
Implementations decide whether the point will be accepted or not. So they have to update the internal properties
minX
,maxX
,maxY
andminY
and also care about firing property change events for those properties by method
.PropertyChangeSupport.firePropertyChange(java.beans.PropertyChangeEvent)
- Specified by:
addPoint
in interfaceITrace2D
- Parameters:
p
- the point to add.- Returns:
- true if the operation was successful, false else.
- See Also:
ITrace2D.addPoint(ITracePoint2D)
-
addPointHighlighter
public boolean addPointHighlighter(IPointPainter<?> highlighter)
Description copied from interface:ITrace2D
Adds the given point painter to the internal set of point highlighters.It will be the last point painter to paint highlighting if highlighting is active.
- Specified by:
addPointHighlighter
in interfaceITrace2D
- Parameters:
highlighter
- the highlighter to add for highlighting this trace.- Returns:
- true if the highlighter was added (class of instance not contained before).
-
addPropertyChangeListener
public void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
Description copied from interface:ITrace2D
Registers a property change listener that will be informed about changes of the property identified by the givenpropertyName
.- Specified by:
addPropertyChangeListener
in interfaceITrace2D
- Parameters:
propertyName
- the name of the property the listener is interested inlistener
- a listener that will only be informed if the property identified by the argumentpropertyName
changes- See Also:
ITrace2D.addPropertyChangeListener(String, PropertyChangeListener)
-
addTracePainter
public boolean addTracePainter(ITracePainter<?> painter)
Description copied from interface:ITrace2D
Adds the given trace painter to the internal set of trace painters.It will be the last painter to paint (most forward).
- Specified by:
addTracePainter
in interfaceITrace2D
- Parameters:
painter
- the painter to add for rendering this trace.- Returns:
- true if the painter was added (class of instance not contained before).
- See Also:
ITrace2D.addTracePainter(info.monitorenter.gui.chart.ITracePainter)
-
compareTo
public int compareTo(ITrace2D o)
- Specified by:
compareTo
in interfacejava.lang.Comparable<ITrace2D>
- Parameters:
o
- the trace to compare to.- Returns:
- see interface.
- See Also:
Comparable.compareTo(java.lang.Object)
-
containsTracePainter
public boolean containsTracePainter(ITracePainter<?> painter)
Description copied from interface:ITrace2D
Returns true if the given painter is contained in this compound painter.- Specified by:
containsTracePainter
in interfaceITrace2D
- Parameters:
painter
- the painter to check whether it is contained.- Returns:
- true if the given painter is contained in this compound painter.
- See Also:
ITrace2D.containsTracePainter(info.monitorenter.gui.chart.ITracePainter)
-
firePointChanged
public void firePointChanged(ITracePoint2D changed, int state)
Description copied from interface:ITrace2D
Method to trigger by
,TracePoint2D.setLocation(double, double)
orITrace2D.addPoint(ITracePoint2D)
ITrace2D.removePoint(ITracePoint2D)
Bound checks are performed and property change events for the properties
,ITrace2D.PROPERTY_MAX_X
,ITrace2D.PROPERTY_MIN_X
andITrace2D.PROPERTY_MAX_Y
are fired if the add bounds have changed due to the modification of the point.ITrace2D.PROPERTY_MIN_Y
- Specified by:
firePointChanged
in interfaceITrace2D
- Parameters:
changed
- the point that has been changed which may be a newly added point (from
, a removed one or a modified one.ITrace2D.addPoint(ITracePoint2D)
state
- one of {
to inform about the type of change.ITracePoint2D.STATE_ADDED
,ITracePoint2D.STATE_CHANGED
,ITracePoint2D.STATE_REMOVED
- See Also:
ITrace2D.firePointChanged(info.monitorenter.gui.chart.ITracePoint2D, int)
-
getColor
public java.awt.Color getColor()
Description copied from interface:ITrace2D
Because the color is data common to a trace of aChart2D
it is stored here.On the other hand only the corresponding
Chart2D
may detect the same color chosen for differentIChart2D
instances to be displayed. Therefore it is allowed to return null. This is a message to theChart2D
to leave it the choice of the color. Then theChart2D
will chose a color not owned by anotherITrace2D
instance managed and assign it to the null- returning instance.The
Chart2D
will often call this method. So try to cache the value in implementation and only check on modifications ofTracePoint
instances or onadd
- invocations for changes.- Specified by:
getColor
in interfaceITrace2D
- Returns:
- The chosen java.awt.Color or null if the decision for the color
should be made by the corresponding
Chart2D
. - See Also:
ITrace2D.getColor()
-
getErrorBarPolicies
public java.util.Set<IErrorBarPolicy<?>> getErrorBarPolicies()
Description copied from interface:ITrace2D
Returns theSet<
that will be used to render error bars for this trace.IErrorBarPolicy
>- Specified by:
getErrorBarPolicies
in interfaceITrace2D
- Returns:
- the
Set<
that will be used to render error bars for this trace.IErrorBarPolicy
> - See Also:
ITrace2D.getErrorBarPolicies()
-
getHasErrorBars
public boolean getHasErrorBars()
Description copied from interface:ITrace2D
Returns true if this trace has error bars configured.If this returns false, no error bars will be painted for this trace.
- Specified by:
getHasErrorBars
in interfaceITrace2D
- Returns:
- true if this trace has error bars configured.
- See Also:
ITrace2D.getHasErrorBars()
-
getLabel
public java.lang.String getLabel()
Description copied from interface:ITrace2D
Callback method for theChart2D
that returns aString
describing the label of theITrace2D
that will be displayed below the drawing area of theChart2D
.This method should be implemented and finalized ASAP in the inheritance tree and rely on the property
name
andphysicalUnits
.- Specified by:
getLabel
in interfaceITrace2D
- Returns:
- a String describing the Axis being accessed.
- See Also:
ITrace2D.getLabel()
-
getMaxSize
public int getMaxSize()
Description copied from interface:ITrace2D
Returns the maximum amount of
TracePoint2D
instances that may be added. For implementations that limit the maximum amount this is a reasonable amount. Non-limiting implementations should returnInteger.MAX_VALUE
. This allows to detect the unlimitedness. Of course no implementation could store that amount of points.- Specified by:
getMaxSize
in interfaceITrace2D
- Returns:
- The maximum amount of
TracePoint2D
instances that may be added. - See Also:
ITrace2D.getMaxSize()
-
getMaxX
public double getMaxX()
Description copied from interface:ITrace2D
Returns the maximum value to be displayed on the x- axis of theChart2D
. Implementations should be synchronized for multithreaded use. No exception is thrown. In case of empty data (no tracepoints) 0 should be returned, to let the Chart2D know.The
Chart2D
will often call this method. So try to cache the value in implementation and only check on modifications ofTracePoint
instances or onadd
- invocations for changes.- Specified by:
getMaxX
in interfaceITrace2D
- Returns:
- the maximum value of the internal data for the x- dimension.
- See Also:
ITrace2D.getMaxX()
-
getMaxY
public double getMaxY()
Description copied from interface:ITrace2D
Returns the maximum value to be displayed on the y- axis of the Chart2D. Implementations should be synchronized for multithreaded use. No exception is thrown. In case of empty data (no tracepoints) 0 should be returned. (watch division with zero).- Specified by:
getMaxY
in interfaceITrace2D
- Returns:
- the maximum value of the internal data for the y- dimension.
- See Also:
ITrace2D.getMaxY()
-
getMinX
public double getMinX()
Description copied from interface:ITrace2D
Returns the minimum value to be displayed on the x- axis of the Chart2D.Implementations should be synchronized for multithreaded use. No exception is thrown. In case of empty data (no tracepoints) 0 should be returned. (watch division with zero).
The
Chart2D
will often call this method. So try to cache the value in implementation and only check on modifications ofTracePoint
instances or onadd
- invocations for changes.- Specified by:
getMinX
in interfaceITrace2D
- Returns:
- the minimum value of the internal data for the x- dimension.
- See Also:
ITrace2D.getMinX()
-
getMinY
public double getMinY()
Description copied from interface:ITrace2D
Returns the minimum value to be displayed on the y- axis of the Chart2D.Implementations should be synchronized for multithreaded use. No exception is thrown. In case of empty data (no tracepoints) 0 should be returned. (watch division with zero).
The
Chart2D
will often call this method. So try to cache the value in implementation and only check on modifications ofTracePoint
instances or onadd
- invocations for changes.- Specified by:
getMinY
in interfaceITrace2D
- Returns:
- the minimum value of the internal data for the y- dimension.
- See Also:
ITrace2D.getMinY()
-
getName
public java.lang.String getName()
Description copied from interface:ITrace2D
Returns the name of this trace.- Specified by:
getName
in interfaceITrace2D
- Returns:
- the name of this trace.
- See Also:
ITrace2D.getName()
-
getNearestPointEuclid
public ITrace2D.DistancePoint getNearestPointEuclid(double x, double y)
Description copied from interface:ITrace2D
Returns the nearest point to the given normalized value coordinates of this trace in Euclid distance.Please note that the arguments must be normalized value coordinates like provided by a
or the division of a pixel coordinate by the total pixel range of the chart.TracePoint2D.getScaledX()
Using the Manhattan distance is much faster than Euclid distance as it only includes basic addition an absolute value for computation per point (vs. square root, addition and quadrature for Euclid distance). However the euclid distance spans a circle for the nearest points which is visually more normal for end users than the Manhattan distance which forms a rhombus and reaches far distances in only one dimension.
- Specified by:
getNearestPointEuclid
in interfaceITrace2D
- Parameters:
x
- the x value as a normalized value between 0 and 1.0.y
- the x value as a normalized value between 0 and 1.0.- Returns:
- the nearest point to the given normalized value coordinates of this trace in Euclid distance.
- See Also:
ITrace2D.getNearestPointEuclid(double, double)
-
getNearestPointManhattan
public ITrace2D.DistancePoint getNearestPointManhattan(double x, double y)
Description copied from interface:ITrace2D
Returns the nearest point to the given normalized value coordinates of this trace in Manhattan distance.Please note that the arguments must be normalized value coordinates like provided by a
or the division of a pixel coordinate by the total pixel range of the chart.TracePoint2D.getScaledX()
Using the Manhattan distance is much faster than Euclid distance as it only includes basic addition an absolute value for computation per point (vs. square root, addition and quadrature for Euclid distance).
- Specified by:
getNearestPointManhattan
in interfaceITrace2D
- Parameters:
x
- the x value as a normalized value between 0 and 1.0.y
- the x value as a normalized value between 0 and 1.0.- Returns:
- the nearest point to the given normalized value coordinates of this trace in Manhattan distance.
- See Also:
ITrace2D.getNearestPointManhattan(double, double)
-
getPhysicalUnits
public java.lang.String getPhysicalUnits()
Description copied from interface:ITrace2D
Returns the concatenation[x: "
.ITrace2D.getPhysicalUnitsX()
", y: "ITrace2D.getPhysicalUnitsY()
"]- Specified by:
getPhysicalUnits
in interfaceITrace2D
- Returns:
- the concatenation
[x: "
.ITrace2D.getPhysicalUnitsX()
", y: "ITrace2D.getPhysicalUnitsY()
"] - See Also:
ITrace2D.getPhysicalUnits()
-
getPhysicalUnitsX
public java.lang.String getPhysicalUnitsX()
Description copied from interface:ITrace2D
Returns the physical unit string value for the x dimension.- Specified by:
getPhysicalUnitsX
in interfaceITrace2D
- Returns:
- the physical unit string value for the x dimension.
- See Also:
ITrace2D.getPhysicalUnitsX()
-
getPhysicalUnitsY
public java.lang.String getPhysicalUnitsY()
Description copied from interface:ITrace2D
Returns the physical unit string value for the y dimension.- Specified by:
getPhysicalUnitsY
in interfaceITrace2D
- Returns:
- the physical unit string value for the y dimension.
- See Also:
ITrace2D.getPhysicalUnitsY()
-
getPointHighlighters
public java.util.Set<IPointPainter<?>> getPointHighlighters()
Description copied from interface:ITrace2D
Returns theSet<
that may be used to highlight points of this trace.IPointPainter
>This is used by the point highlighting feature:
Chart2D.enablePointHighlighting(boolean)
- Specified by:
getPointHighlighters
in interfaceITrace2D
- Returns:
- the
Set<
that may be used to highlight points.IPointPainter
>
-
getPropertyChangeListeners
public java.beans.PropertyChangeListener[] getPropertyChangeListeners(java.lang.String property)
Description copied from interface:ITrace2D
Returns all property change listeners for the given property.- Specified by:
getPropertyChangeListeners
in interfaceITrace2D
- Parameters:
property
- one of the constants with thePROPERTY_
prefix defined in this class or subclasses.- Returns:
- the property change listeners for the given property.
- See Also:
ITrace2D.getPropertyChangeListeners(java.lang.String)
-
getRenderer
public Chart2D getRenderer()
- Specified by:
getRenderer
in interfaceITrace2D
- Returns:
- Returns the renderer.
- See Also:
ITrace2D.getRenderer()
-
getSize
public int getSize()
Description copied from interface:ITrace2D
Returns the amount ofTracePoint2D
instances currently contained.- Specified by:
getSize
in interfaceITrace2D
- Returns:
- The amount of
instances currently contained.TracePoint2D
- See Also:
ITrace2D.getSize()
-
getStroke
public java.awt.Stroke getStroke()
Description copied from interface:ITrace2D
Returns the Stroke that is used to render this instance.- Specified by:
getStroke
in interfaceITrace2D
- Returns:
- the Stroke that is used to render this instance.
- See Also:
ITrace2D.getStroke()
-
getTracePainters
public final java.util.Set<ITracePainter<?>> getTracePainters()
Description copied from interface:ITrace2D
Returns theSet<
that will be used to paint this trace.ITracePainter
>The original set should be returned by contract to allow adding painters "silently" (vs. using
).ITrace2D.addTracePainter(ITracePainter)
- Specified by:
getTracePainters
in interfaceITrace2D
- Returns:
- the
Set<
that will be used to paint this trace.ITracePainter
> - See Also:
ITrace2D.getTracePainters()
-
getXRange
public Range getXRange()
Returns the range of valid points of the x axis.- Returns:
- the range of valid points of the x axis.
-
getYRange
public Range getYRange()
Returns the range of valid points of the y axis.- Returns:
- the range of valid points of the y axis.
-
getZIndex
public java.lang.Integer getZIndex()
Description copied from interface:ITrace2D
The z-index defines the order in which this instance will be painted.A higher value will bring it more "to the front".
- Specified by:
getZIndex
in interfaceITrace2D
- Returns:
- the z-index that will define the order in which this instance will be painted.
- See Also:
ITrace2D.getZIndex()
-
isEmpty
public boolean isEmpty()
Description copied from interface:ITrace2D
Returns false if internal
instances are contained or true if not.TracePoint2D
- Specified by:
isEmpty
in interfaceITrace2D
- Returns:
- false if internal
instances are contained or true if not.TracePoint2D
- See Also:
ITrace2D.isEmpty()
-
isVisible
public boolean isVisible()
Description copied from interface:ITrace2D
Returns true if this instance should be rendered.- Specified by:
isVisible
in interfaceITrace2D
- Returns:
- true if this instance should be rendered.
- See Also:
ITrace2D.isVisible()
-
iterator
public java.util.Iterator<ITracePoint2D> iterator()
Description copied from interface:ITrace2D
Returns anIterator
over the internalTracePoint2D
Implementations should be synchronized. This method is meant to allow modifications of the intenal
TracePoint2D
instances, so the original points should be returned.There is no guarantee that changes made to the contained tracepoints will be reflected in the display immediately. The order the iterator returns the
TracePoint2D
instances decides how theChart2D
will paint the trace.- Specified by:
iterator
in interfaceITrace2D
- Returns:
- an
Iterator
over the internalTracePoint2D
- See Also:
ITrace2D.iterator()
-
propertyChange
public void propertyChange(java.beans.PropertyChangeEvent evt)
- Specified by:
propertyChange
in interfacejava.beans.PropertyChangeListener
- See Also:
PropertyChangeListener.propertyChange(java.beans.PropertyChangeEvent)
-
removeAllPointHighlighters
public java.util.Set<IPointPainter<?>> removeAllPointHighlighters()
Description copied from interface:ITrace2D
Clears all internal point highlighters used.Returns the
Set<
that was used to highlight points.IPointPainter
>This is used by the point highlighting feature:
Chart2D.enablePointHighlighting(boolean)
- Specified by:
removeAllPointHighlighters
in interfaceITrace2D
- Returns:
- the
Set<
that was be used to highlight points.IPointPainter
> - See Also:
ITrace2D.removeAllPointHighlighters()
-
removeAllPoints
public void removeAllPoints()
Description copied from interface:ITrace2D
Removes all internalTracePoint2D
.ITrace2D.isEmpty()
will return true afterwards.- Specified by:
removeAllPoints
in interfaceITrace2D
- See Also:
ITrace2D.removeAllPoints()
-
removeComputingTrace
public boolean removeComputingTrace(ITrace2D trace)
Description copied from interface:ITrace2D
Remove a trace that "should" compute values from the points added via
.ITrace2D.addPoint(ITracePoint2D)
- Specified by:
removeComputingTrace
in interfaceITrace2D
- Parameters:
trace
- the trace that will calculate it's points from the added points of this trace.- Returns:
- true if the given trace was removed (recognized by the means of
).Object.equals(Object)
- See Also:
ITrace2D.removeComputingTrace(info.monitorenter.gui.chart.ITrace2D)
-
removeErrorBarPolicy
public boolean removeErrorBarPolicy(IErrorBarPolicy<?> errorBarPolicy)
Description copied from interface:ITrace2D
Removes the given error bar policy from the internal set of error bar policies.- Specified by:
removeErrorBarPolicy
in interfaceITrace2D
- Parameters:
errorBarPolicy
- the error bar policy to remove.- Returns:
- true if the painter was removed (same instance contained before).
- See Also:
ITrace2D.removeErrorBarPolicy(info.monitorenter.gui.chart.IErrorBarPolicy)
-
removePoint
public boolean removePoint(ITracePoint2D point)
Description copied from interface:ITrace2D
Removes the given point from this trace.- Specified by:
removePoint
in interfaceITrace2D
- Parameters:
point
- the point to remove.- Returns:
- true if the remove opertation was successful, false else.
- See Also:
ITrace2D.removePoint(info.monitorenter.gui.chart.ITracePoint2D)
-
removePointHighlighter
public boolean removePointHighlighter(IPointPainter<?> highlighter)
Description copied from interface:ITrace2D
Removes the given point highlighter, if it's class is contained.- Specified by:
removePointHighlighter
in interfaceITrace2D
- Parameters:
highlighter
- the highlighter to remove.- Returns:
- true if a point highlighter of the class of the given argument was removed.
-
removePropertyChangeListener
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Description copied from interface:ITrace2D
Unregisters a property change listener that has been registered for listening on all properties.- Specified by:
removePropertyChangeListener
in interfaceITrace2D
- Parameters:
listener
- a listener that will only be informed if the property identified by the argumentpropertyName
changes- See Also:
ITrace2D.removePropertyChangeListener(java.beans.PropertyChangeListener)
-
removePropertyChangeListener
public void removePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener)
Description copied from interface:ITrace2D
Removes a property change listener for listening on the given property.- Specified by:
removePropertyChangeListener
in interfaceITrace2D
- Parameters:
property
- one of the constants with thePROPERTY_
prefix defined in this class or subclasses.listener
- the listener for this property change.- See Also:
ITrace2D.removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
-
removeTracePainter
public boolean removeTracePainter(ITracePainter<?> painter)
Description copied from interface:ITrace2D
Removes the given trace painter, if it's class is contained and if more painters are remaining.- Specified by:
removeTracePainter
in interfaceITrace2D
- Parameters:
painter
- the trace painter to remove.- Returns:
- true if a trace painter of the class of the given argument was removed.
- See Also:
ITrace2D.removeTracePainter(info.monitorenter.gui.chart.ITracePainter)
-
setColor
public void setColor(java.awt.Color color)
Description copied from interface:ITrace2D
Set ajava.awt.Color
for this trace.- Specified by:
setColor
in interfaceITrace2D
- Parameters:
color
- the Color to set.- See Also:
ITrace2D.setColor(java.awt.Color)
-
setErrorBarPolicy
public java.util.Set<IErrorBarPolicy<?>> setErrorBarPolicy(IErrorBarPolicy<?> errorBarPolicy)
Description copied from interface:ITrace2D
Replaces all internal error bar policies by the new one.- Specified by:
setErrorBarPolicy
in interfaceITrace2D
- Parameters:
errorBarPolicy
- the new sole painter to use.- Returns:
- the
Set<
that was used before.IErrorBarPolicy
> - See Also:
ITrace2D.setErrorBarPolicy(info.monitorenter.gui.chart.IErrorBarPolicy)
-
setName
public void setName(java.lang.String name)
Description copied from interface:ITrace2D
Assingns a specific name to theITrace2D
which will be displayed by theChart2D
.- Specified by:
setName
in interfaceITrace2D
- Parameters:
name
- the name for this trace.- See Also:
ITrace2D.setName(java.lang.String)
-
setPhysicalUnits
public void setPhysicalUnits(java.lang.String xunit, java.lang.String yunit)
Description copied from interface:ITrace2D
Assigns a specific String representing the physical unit to theITrace2D
(e.g. Volt, Ohm, lux, ...) which will be displayed by theChart2D
- Specified by:
setPhysicalUnits
in interfaceITrace2D
- Parameters:
xunit
- the physical unit for the x axis.yunit
- the physical unit for the y axis.- See Also:
ITrace2D.setPhysicalUnits(java.lang.String, java.lang.String)
-
setPointHighlighter
public java.util.Set<IPointPainter<?>> setPointHighlighter(IPointPainter<?> highlighter)
Description copied from interface:ITrace2D
Replaces all internal point highlighters by the new one.- Specified by:
setPointHighlighter
in interfaceITrace2D
- Parameters:
highlighter
- the new sole highlighter to use.- Returns:
- the
Set<
that was used before or null if nothing changed.IPointPainter
>
-
setRenderer
public void setRenderer(Chart2D renderer)
Description copied from interface:ITrace2D
This is a callback fromChart2D.addTrace(ITrace2D)
and must not be invoked from elsewhere (needed for synchronization).Not the best design to put this to an interface, but Char2D should handle this interface only.
- Specified by:
setRenderer
in interfaceITrace2D
- Parameters:
renderer
- The renderer to set.- See Also:
ITrace2D.setRenderer(info.monitorenter.gui.chart.Chart2D)
-
setStroke
public void setStroke(java.awt.Stroke stroke)
Description copied from interface:ITrace2D
Allows to specify the rendering of the ITrace2D. This Stroke will be assigned to theGraphics2D
by the renderingChart2D
when painting this instance.- Specified by:
setStroke
in interfaceITrace2D
- Parameters:
stroke
- the stroke to use for painting this trace.- See Also:
ITrace2D.setStroke(java.awt.Stroke)
-
setTracePainter
public final java.util.Set<ITracePainter<?>> setTracePainter(ITracePainter<?> painter)
Description copied from interface:ITrace2D
Replaces all internal trace painters by the new one.- Specified by:
setTracePainter
in interfaceITrace2D
- Parameters:
painter
- the new sole painter to use.- Returns:
- the
Set<
that was used before.ITracePainter
> - See Also:
ITrace2D.setTracePainter(info.monitorenter.gui.chart.ITracePainter)
-
setVisible
public void setVisible(boolean visible)
Description copied from interface:ITrace2D
Set the visibility. If argument is false, this instance will not be rendered by a Chart2D.- Specified by:
setVisible
in interfaceITrace2D
- Parameters:
visible
- true if this trace should be painted, false else.- See Also:
ITrace2D.setVisible(boolean)
-
setXRange
public void setXRange(Range range)
Set the valid range for x values. If a point breaks these bounds anIllegalArgumentException
will be thrown.- Parameters:
range
- The xRange to set.
-
setYRange
public void setYRange(Range range)
Set the valid range for y values. If a point breaks these bounds anIllegalArgumentException
will be thrown.- Parameters:
range
- The yRange to set.
-
setZIndex
public void setZIndex(java.lang.Integer zIndex)
Description copied from interface:ITrace2D
Sets the internal z-index property. This decides the order in which different traces within the same
are painted.Chart2D
The higher the given value is the more this trace will be brought to front.
The value must not be lower than
ITrace2D.Z_INDEX_MIN
(0) and higher thanITrace2D.ZINDEX_MAX
(100).This might not be tested for increased performance but ignoring these bounds may result in wrong ordering of display.
- Specified by:
setZIndex
in interfaceITrace2D
- Parameters:
zIndex
- the z index of this trace - the lower the value the more in front the trace will appear amongst other traces in the same chart.- See Also:
ITrace2D.setZIndex(java.lang.Integer)
-
showsErrorBars
public boolean showsErrorBars()
Description copied from interface:ITrace2D
Tests whether error bars are painted by this trace.Returns true if
- this trace contains
IErrorBarPolicy
instances. - and at least one of these instances contains at least one
IErrorBarPainter
instance.
- Specified by:
showsErrorBars
in interfaceITrace2D
- Returns:
- true if this trace renders error bars.
- See Also:
ITrace2D.showsErrorBars()
- this trace contains
-
showsNegativeXErrorBars
public boolean showsNegativeXErrorBars()
Description copied from interface:ITrace2D
Tests whether error bars in negative x direction are painted by this trace.Returns true if
- this trace contains at leaste one
IErrorBarPolicy
instance thatIErrorBarPolicy.isShowNegativeXErrors()
. - and at least one of these instances contains at least one
IErrorBarPainter
instance.
- Specified by:
showsNegativeXErrorBars
in interfaceITrace2D
- Returns:
- true if this trace renders error bars in negative x direction.
- See Also:
ITrace2D.showsNegativeXErrorBars()
- this trace contains at leaste one
-
showsNegativeYErrorBars
public boolean showsNegativeYErrorBars()
Description copied from interface:ITrace2D
Tests whether error bars in negative y direction are painted by this trace.Returns true if
- this trace contains at leaste one
IErrorBarPolicy
instance thatIErrorBarPolicy.isShowNegativeYErrors()
. - and at least one of these instances contains at least one
IErrorBarPainter
instance.
- Specified by:
showsNegativeYErrorBars
in interfaceITrace2D
- Returns:
- true if this trace renders error bars in negative y direction.
- See Also:
ITrace2D.showsNegativeYErrorBars()
- this trace contains at leaste one
-
showsPositiveXErrorBars
public boolean showsPositiveXErrorBars()
Description copied from interface:ITrace2D
Tests whether error bars in positive x direction are painted by this trace.Returns true if
- this trace contains at leaste one
IErrorBarPolicy
instance thatIErrorBarPolicy.isShowPositiveXErrors()
. - and at least one of these instances contains at least one
IErrorBarPainter
instance.
- Specified by:
showsPositiveXErrorBars
in interfaceITrace2D
- Returns:
- true if this trace renders error bars in positive x direction.
- See Also:
ITrace2D.showsPositiveXErrorBars()
- this trace contains at leaste one
-
showsPositiveYErrorBars
public boolean showsPositiveYErrorBars()
Description copied from interface:ITrace2D
Tests whether error bars in positive y direction are painted by this trace.Returns true if
- this trace contains at leaste one
IErrorBarPolicy
instance thatIErrorBarPolicy.isShowPositiveYErrors()
. - and at least one of these instances contains at least one
IErrorBarPainter
instance.
- Specified by:
showsPositiveYErrorBars
in interfaceITrace2D
- Returns:
- true if this trace renders error bars in positive y direction.
- See Also:
ITrace2D.showsPositiveYErrorBars()
- this trace contains at leaste one
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- See Also:
Object.toString()
-
-