info.monitorenter.gui.chart.axis
Class AAxisTransformation<T extends AxisScalePolicyTransformation>

java.lang.Object
  info.monitorenter.gui.chart.axis.AAxis<T>
      info.monitorenter.gui.chart.axis.AAxisTransformation<T>

Type Parameters:

T - Used to enforce that this instance only accepts AxisScalePolicyTransformation and subtypes.

All Implemented Interfaces:

IAxis<T>, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener

Direct Known Subclasses:

AxisLog10, AxisLogE

public abstract class AAxisTransformation<T extends AxisScalePolicyTransformation>
extends AAxis<T>

Base class for Axis implementations that transform the scale for changed display.

Note that instances of this implementations will only accept subtypes of AxisScalePolicyTransformation for the method AAxis.setAxisScalePolicy(IAxisScalePolicy).

Version:

$Revision: 1.32 $

Author:

Achim Westermann

See Also:

Serialized Form

Nested Class Summary

protected class	AAxisTransformation.XDataAccessor An accessor for the x axis of a chart.
protected class	AAxisTransformation.YDataAccessor Accesses the y axis of the Chart2D.

Nested classes/interfaces inherited from class info.monitorenter.gui.chart.axis.AAxis

AAxis.AChart2DDataAccessor

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

IAxis.AxisTitle

Field Summary

protected long

m_outputErrorTstamp Internal timestamp of the last transformation error reporting.

Fields inherited from class info.monitorenter.gui.chart.axis.AAxis

DEBUG, m_accessor, m_formatter, m_majorTickSpacing, m_max, m_min, m_minorTickSpacing, m_needsFullRescale, m_rangePolicy

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

PROPERTY_ADD_REMOVE_TRACE, PROPERTY_AXIS_SCALE_POLICY_CHANGED, PROPERTY_LABELFORMATTER, PROPERTY_PAINTGRID, PROPERTY_PAINTSCALE, PROPERTY_RANGEPOLICY

Constructor Summary

AAxisTransformation()
Creates a default instance that will use a LabelFormatterAutoUnits for formatting labels.

AAxisTransformation(IAxisLabelFormatter formatter, T scalePolicy)
Creates an instance that will the given label formatter for formatting labels.

Method Summary

protected AAxis.AChart2DDataAccessor	createAccessor(Chart2D chart, int dimension, int position) Template method to create the proper AAxis.AChart2DDataAccessor implementation.
double	getMaxTransformed() Returns the transformed max with additional error treatment in case of empty traces.
double	getMinTransformed() Returns the transformed min with additional error treatment in case of empty traces.
double	getScaledValue(double absolute) Scales the given absolute value into a value between 0 and 1.0 (if it is in the range of the data).
void	scaleTrace(ITrace2D trace) Overridden to incorporate transformation.
abstract double	transform(double in) Template method for performing the axis transformation.
double	translateMousePosition(java.awt.event.MouseEvent mouseEvent) Returns the translation of the mouse event coordinates of the given mouse event to the value within the chart for the dimension (x,y) covered by this axis.
double	translatePxToValue(int pixel) Transforms the given pixel value (which has to be a awt value like MouseEvent.getY() into the chart value.
abstract double	untransform(double in) Template method for performing the reverse axis transformation.

Methods inherited from class info.monitorenter.gui.chart.axis.AAxis

addPropertyChangeListener, addTrace, ensureInitialized, equals, findMax, findMin, getAccessor, getAxisPosition, getAxisScalePolicy, getAxisTitle, getDimension, getDimensionString, getFormatter, getHeight, getMajorTickSpacing, getMax, getMaxValue, getMin, getMinorTickSpacing, getMinValue, getPixelXLeft, getPixelXRight, getPixelYBottom, getPixelYTop, getPropertyChangeListeners, getRange, getRangePolicy, getTitle, getTitlePainter, getTraces, getValueDistanceForPixel, getWidth, hashCode, hasTrace, initPaintIteration, isDirtyScaling, isPaintGrid, isPaintScale, isStartMajorTick, isVisible, paint, paintTitle, propertyChange, removeAllTraces, removeAxisTitle, removePropertyChangeListener, removeTrace, scale, scalePoint, setAccessor, setAxisPosition, setAxisScalePolicy, setAxisTitle, setChart, setFormatter, setMajorTickSpacing, setMinorTickSpacing, setPaintGrid, setPaintScale, setPixelXLeft, setPixelXRight, setPixelYBottom, setPixelYTop, setRange, setRangePolicy, setStartMajorTick, setTitle, setTitlePainter, setVisible, translateValueToPx

Methods inherited from class java.lang.Object

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

Field Detail

m_outputErrorTstamp

protected long m_outputErrorTstamp

Internal timestamp of the last transformation error reporting.

Constructor Detail

AAxisTransformation

public AAxisTransformation()

Creates a default instance that will use a LabelFormatterAutoUnits for formatting labels.

AAxisTransformation

public AAxisTransformation(IAxisLabelFormatter formatter,
                           T scalePolicy)

Creates an instance that will the given label formatter for formatting labels.

Parameters:

formatter - needed for formatting labels of this axis.

scalePolicy - controls the ticks/labels and their distance.

Method Detail

createAccessor

protected AAxis.AChart2DDataAccessor createAccessor(Chart2D chart,
                                                    int dimension,
                                                    int position)

Description copied from class: AAxis

Template method to create the proper AAxis.AChart2DDataAccessor implementation.

Specified by:

createAccessor in class AAxis<T extends AxisScalePolicyTransformation>

Parameters:

chart - the chart to access.

dimension - Chart2D.X or Chart2D.Y.

position - Chart2D.CHART_POSITION_BOTTOM, Chart2D.CHART_POSITION_LEFT, Chart2D.CHART_POSITION_RIGHT or Chart2D.CHART_POSITION_TOP.

Returns:

the proper AAxis.AChart2DDataAccessor implementation.

See Also:

AAxis.createAccessor(info.monitorenter.gui.chart.Chart2D, int, int)

getMaxTransformed

public double getMaxTransformed()

Returns the transformed max with additional error treatment in case of empty traces.

Returns:

the transformed max with additional error treatment in case of empty traces.

See Also:

AAxis.getMax()

getMinTransformed

public double getMinTransformed()

Returns the transformed min with additional error treatment in case of empty traces.

Returns:

the transformed min with additional error treatment in case of empty traces.

See Also:

AAxis.getMin()

getScaledValue

public final double getScaledValue(double absolute)

Description copied from interface: IAxis

Scales the given absolute value into a value between 0 and 1.0 (if it is in the range of the data).

If the given absolute value is not in the display- range of the Chart2D, negative values or values greater than 1.0 may result.

Parameters:

absolute - a value in the real value range of the corresponding chart.

Returns:

a value between 0.0 and 1.0 that is mapped to a position within the chart.

See Also:

IAxis.getScaledValue(double)

scaleTrace

public void scaleTrace(ITrace2D trace)

Overridden to incorporate transformation.

Specified by:

scaleTrace in interface IAxis<T extends AxisScalePolicyTransformation>

Overrides:

scaleTrace in class AAxis<T extends AxisScalePolicyTransformation>

Parameters:

trace - the trace to scale.

See Also:

IAxis.scaleTrace(info.monitorenter.gui.chart.ITrace2D)

transform

public abstract double transform(double in)
                          throws java.lang.IllegalArgumentException

Template method for performing the axis transformation.

The argument should not be negative, so only normalized values (no chart values but their scaled values or pixel values) should be given here.

Parameters:

in - the value to transform.

Returns:

the transformed value.

Throws:

java.lang.IllegalArgumentException - if scaling is impossible (due to some mathematical transformation in implementations like AxisLog10

translateMousePosition

public final double translateMousePosition(java.awt.event.MouseEvent mouseEvent)
                                    throws java.lang.IllegalArgumentException

Description copied from class: AAxis

Returns the translation of the mouse event coordinates of the given mouse event to the value within the chart for the dimension (x,y) covered by this axis.

Note that the mouse event has to be an event fired on the correspondinig chart component!

Overrides:

translateMousePosition in class AAxis<T extends AxisScalePolicyTransformation>

Parameters:

mouseEvent - a mouse event that has been fired on this component.

Returns:

the translation of the mouse event coordinates of the given mouse event to the value within the chart for the dimension covered by this axis (x or y) or null if no calculations could be performed as the chart was not painted before.

Throws:

java.lang.IllegalArgumentException - if the given mouse event is out of the current graphics context (not a mouse event of the chart component).

See Also:

AAxis.translateMousePosition(java.awt.event.MouseEvent)

translatePxToValue

public double translatePxToValue(int pixel)

Description copied from interface: IAxis

Transforms the given pixel value (which has to be a awt value like MouseEvent.getY() into the chart value.

Internal use only, the interface does not guarantee that the pixel corresponds to any valid awt pixel value within the chart component.

Specified by:

translatePxToValue in interface IAxis<T extends AxisScalePolicyTransformation>

Overrides:

translatePxToValue in class AAxis<T extends AxisScalePolicyTransformation>

Parameters:

pixel - a pixel value of the chart component as used by awt.

Returns:

the awt pixel value transformed to the chart value.

See Also:

AAxis.translatePxToValue(int)

untransform

public abstract double untransform(double in)

Template method for performing the reverse axis transformation.

This is the counterpart to transform(double).

Parameters:

in - the transformed value.

Returns:

the normal value;