ilog.views.chart

Class IlvLogarithmicAxisTransformer

java.lang.Object

ilog.views.chart.IlvAxisTransformer

ilog.views.chart.IlvLogarithmicAxisTransformer

All Implemented Interfaces:

Serializable

public class IlvLogarithmicAxisTransformer
extends IlvAxisTransformer

Defines a logarithmic transformation.

Note: Setting a logarithmic transformation on an axis does not change the step labels displayed along the corresponding scale. If you want to change scale labels according to the logarithmic transformation, use the method IlvScale.setLogarithmic(double).

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvLogarithmicAxisTransformer() Creates a transformer with a logarithmic base of 10.
IlvLogarithmicAxisTransformer(double logBase) Creates a transformer with the specified logarithmic base.

Method Summary

Modifier and Type	Method and Description
double	apply(double value) Applies the transformation to the specified value.
double	getLogBase() Returns the logarithmic base of this transformer.
double	inverse(double value) Applies the inverse transformation to the specified value.
boolean	isRoundingToPowers() Returns true if this transformation attempts to produce intervals that start and end at powers of the logarithmic base.
void	setLogBase(double logBase) Modifies the logarithmic base of this transformer.
void	setRoundingToPowers(boolean round) Determines whether this transformation shall attempt to produce intervals that start and end at powers of the logarithmic base.
boolean	validateInterval(IlvDataInterval itv) Modifies the specified interval so that it is consistent with the definition domain of the transformation.

Methods inherited from class ilog.views.chart.IlvAxisTransformer

apply, apply, getAxis, inverse, inverse, transformerChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvLogarithmicAxisTransformer

public IlvLogarithmicAxisTransformer()

Creates a transformer with a logarithmic base of 10.

IlvLogarithmicAxisTransformer

public IlvLogarithmicAxisTransformer(double logBase)

Creates a transformer with the specified logarithmic base.

Method Detail

getLogBase

public final double getLogBase()

Returns the logarithmic base of this transformer.

setLogBase

public void setLogBase(double logBase)

Modifies the logarithmic base of this transformer.

isRoundingToPowers

public boolean isRoundingToPowers()

Returns true if this transformation attempts to produce intervals that start and end at powers of the logarithmic base.

Since:

JViews 7.5

See Also:

validateInterval(ilog.views.chart.IlvDataInterval)

setRoundingToPowers

public void setRoundingToPowers(boolean round)

Determines whether this transformation shall attempt to produce intervals that start and end at powers of the logarithmic base.

Since:

JViews 7.5

apply

public double apply(double value)
             throws IlvAxisTransformerException

Applies the transformation to the specified value.

Specified by:

apply in class IlvAxisTransformer

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)

inverse

public double inverse(double value)
               throws IlvAxisTransformerException

Applies the inverse transformation to the specified value.

Specified by:

inverse in class IlvAxisTransformer

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.

validateInterval

public boolean validateInterval(IlvDataInterval itv)

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

Overrides:

validateInterval in class IlvAxisTransformer

Parameters:

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

Returns:

A boolean value indicating whether the interval was modified.

See Also:

isRoundingToPowers()