ilog.views.chart

Class IlvDefaultDataRangePolicy

java.lang.Object

ilog.views.chart.IlvDefaultDataRangePolicy

All Implemented Interfaces:

IlvDataRangePolicy, Serializable

public class IlvDefaultDataRangePolicy
extends Object
implements IlvDataRangePolicy, Serializable

Implements a default strategy for calculating the data range of chart axis.

The IlvDefaultDataRangePolicy class computes the data range according to the data actually displayed by the chart.

Since:

JViews 5.0

See Also:

IlvChartRenderer.getXRange(ilog.views.chart.IlvDataInterval), IlvChartRenderer.getYRange(ilog.views.chart.IlvDataInterval), IlvChart.setDataRangePolicy(ilog.views.chart.IlvDataRangePolicy), IlvAxis.getDataRange(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvDefaultDataRangePolicy() Initializes a new IlvDefaultDataRangePolicy.

Method Summary

Modifier and Type	Method and Description
protected void	adjustRange(IlvChart chart, IlvAxis axis, IlvDataInterval range) Adjusts the data range of the specified axis.
IlvDataInterval	computeDataRange(IlvChart chart, IlvAxis axis, IlvDataInterval retRange) Computes the data range of the specified chart axis.
protected boolean	shouldAdjust(IlvChart chart, IlvAxis axis) Indicates whether the calculation policy should adjust the data range of the specified axis.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultDataRangePolicy

public IlvDefaultDataRangePolicy()

Initializes a new IlvDefaultDataRangePolicy.

Method Detail

computeDataRange

public IlvDataInterval computeDataRange(IlvChart chart,
                                        IlvAxis axis,
                                        IlvDataInterval retRange)

Computes the data range of the specified chart axis.

Specified by:

computeDataRange in interface IlvDataRangePolicy

Parameters:

chart - The considered chart.

axis - The considered axis.

retRange - An interval used to store the result. If this parameter is null, a new IlvDataInterval must be allocated.

Returns:

The computed range. This range can be empty (for example if no data is projected along the specified axis). Before it is returned, the range is adjusted with the adjustRange(ilog.views.chart.IlvChart, ilog.views.chart.IlvAxis, ilog.views.chart.IlvDataInterval) method if shouldAdjust(ilog.views.chart.IlvChart, ilog.views.chart.IlvAxis) returns true.

See Also:

IlvAbstractDataSet.isXRangeIncludingUndefinedPoints()

shouldAdjust

protected boolean shouldAdjust(IlvChart chart,
                               IlvAxis axis)

Indicates whether the calculation policy should adjust the data range of the specified axis.

The default implementation returns true for y-axes.

Parameters:

chart - The considered chart.

axis - The considered axis.

Returns:

true if the data range of the axis must be adjusted.

See Also:

adjustRange(ilog.views.chart.IlvChart, ilog.views.chart.IlvAxis, ilog.views.chart.IlvDataInterval)

adjustRange

protected void adjustRange(IlvChart chart,
                           IlvAxis axis,
                           IlvDataInterval range)

Adjusts the data range of the specified axis. This method modifies the specified range so that its limits are snapped to unit values. The considered unit is computed by the same algorithm used by the IlvDefaultStepsDefinition class when it is using the IlvDefaultStepsDefinition.SIMPLE_MODE mode.

Parameters:

chart - The considered chart.

axis - The considered axis.

range - The range that must be adjusted.

See Also:

IlvDefaultStepsDefinition.adjustRange(IlvDataInterval)