ilog.views.chart

Class IlvAxisTransformer

java.lang.Object

ilog.views.chart.IlvAxisTransformer

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvAffineAxisTransformer, IlvLocalZoomAxisTransformer, IlvLogarithmicAxisTransformer

public abstract class IlvAxisTransformer
extends Object
implements Serializable

Defines a transformation that can be applied to the coordinates along a given axis. The IlvAxis.setTransformer(ilog.views.chart.IlvAxisTransformer) method lets you associate a transformer with an axis.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvAxisTransformer() Creates a new IlvAxisTransformer object.

Method Summary

Modifier and Type	Method and Description
abstract double	apply(double value) Applies the transformation to the specified value.
double[]	apply(double[] values, int count) Applies the transformation to the specified values.
IlvDataInterval	apply(IlvDataInterval itv) Applies the transformation to a data interval.
IlvAxis	getAxis() Returns the axis to which this transformer is associated.
abstract double	inverse(double value) Applies the inverse transformation to the specified value.
double[]	inverse(double[] values, int count) Applies the inverse transformation to the specified values.
IlvDataInterval	inverse(IlvDataInterval itv) Applies the inverse transformation to a data interval.
protected void	transformerChanged() Notifies the axis that the transformer has changed.
boolean	validateInterval(IlvDataInterval itv) Modifies the specified interval so that it is consistent with the definition domain of the transformation.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvAxisTransformer

protected IlvAxisTransformer()

Creates a new IlvAxisTransformer object.

Method Detail

getAxis

public IlvAxis getAxis()

Returns the axis to which this transformer is associated.

See Also:

IlvAxis.setTransformer(ilog.views.chart.IlvAxisTransformer)

apply

public abstract double apply(double value)
                      throws IlvAxisTransformerException

Applies the transformation to the specified value.

Parameters:

value - The considered value.

Returns:

The transformed value.

Throws:

IlvAxisTransformerException - If the transformation of the specified value could not be properly computed.

See Also:

inverse(double)

apply

public double[] apply(double[] values,
                      int count)
               throws IlvAxisTransformerException

Applies the transformation to the specified values. The default implementation calls apply(double) for each value. It can be overridden to provide a more efficient implementation.

Parameters:

values - The considered values. The method modifies the contents of this array and returns it.

count - The number of values that must be transformed.

Returns:

The transformed values. This is the same array as the argument values.

Throws:

IlvAxisTransformerException

inverse

public abstract double inverse(double value)
                        throws IlvAxisTransformerException

Applies the inverse transformation to the specified value.

Parameters:

value - The considered value.

Returns:

The inverse transformed value. * @throws IlvAxisTransformerException If the inverse transformation of the specified value could not be properly computed.

Throws:

IlvAxisTransformerException

inverse

public double[] inverse(double[] values,
                        int count)
                 throws IlvAxisTransformerException

Applies the inverse transformation to the specified values. The default implementation calls inverse(double) for each value. It can be overridden to provide a more efficient implementation.

Parameters:

values - The considered values. The method modifies the content of this array and returns it.

count - The number of values that must be transformed.

Returns:

The transformed values. This is the same array as the argument values.

Throws:

IlvAxisTransformerException

apply

public IlvDataInterval apply(IlvDataInterval itv)
                      throws IlvAxisTransformerException

Applies the transformation to a data interval. The returned interval contains the transformation of all the values inside the original interval. The default implementation returns the smallest interval containing the transformed minimum and maximum values of the specified interval.

Parameters:

itv - The considered interval. The method modifies this interval and returns it.

Throws:

IlvAxisTransformerException

See Also:

apply(double)

inverse

public IlvDataInterval inverse(IlvDataInterval itv)
                        throws IlvAxisTransformerException

Applies the inverse transformation to a data interval. The returned interval contains the inverse transformation of all the values inside the original interval. The default implementation returns the smallest interval containing the inversely transformed minimum and maximum values of the specified interval.

Parameters:

itv - The considered interval. The method modifies this interval and returns it.

Throws:

IlvAxisTransformerException

See Also:

inverse(double)

validateInterval

public boolean validateInterval(IlvDataInterval itv)

Modifies the specified interval so that it is consistent with the definition domain of the transformation.

Parameters:

itv - The interval to validate. This interval is modified by the method accordingly.

Returns:

A boolean value indicating whether the interval was modified.

transformerChanged

protected void transformerChanged()

Notifies the axis that the transformer has changed. You must call this method in your subclasses for all the changes that affect the transformer behavior.

See Also:

AxisChangeEvent.TRANSFORMER_CHANGE