ilog.views.chart.data.lod

Class IlvLODDataSet

java.lang.Object

ilog.views.chart.data.IlvAbstractDataSet

ilog.views.chart.data.lod.IlvLODDataSet

All Implemented Interfaces:

IlvDataSet, IlvBatchable, Serializable

public class IlvLODDataSet
extends IlvAbstractDataSet

A data set that loads its contents on demand.

The IlvLODDataSet is a data set implementation controlled by an IlvDataTileController. When an IlvLODDataSet is connected to a chart, the changes on the visible range of its x-axis trigger a loading request.

Note: Instances of this data set class cannot be serialized and deserialized, despite implementing the Serializable interface.

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.chart.data.IlvAbstractDataSet

DEFAULT_UNDEF_VALUE

Constructor Summary

Constructors

Constructor and Description
IlvLODDataSet(IlvDataTileController controller) Initializes a new load-on-demand data set with the specified controller.

Method Summary

Modifier and Type	Method and Description
protected void	axisRangeChanged(IlvAxis axis) Invoked when the visible range of a chart displaying this data set changes.
protected void	computeLimits(IlvDataInterval xRange, IlvDataInterval yRange) Computes the limits of the values stored in this data set.
IlvDataTileController	getController() Returns the controller that manages the data tiles.
IlvDataPoints	getDataBetween(int iMin, int iMax) Returns the data points between the two specified indices.
int	getDataCount() Returns an upper bound for the number of data points available at this moment.
IlvDataPoints	getDataInside(IlvDataWindow window, int adjCount, boolean continuous) Returns the data points inside the specified data window.
IlvStyle	getLoadingStyle() Returns the rendering style used to display the loading of data tiles.
String	getLoadingText() Returns the text displayed while loading data tiles.
double	getXData(int idx) Returns the x-value of the data point at the specified index.
double	getYData(int idx) Returns the x-value of the data point at the specified index.
boolean	isShowingLoading() Indicates whether the loading of data tiles is displayed.
void	setLoadingStyle(IlvStyle style) Sets the rendering style used to display the loading of data tiles.
void	setLoadingText(String text) Sets the text displayed while loading data tiles.
void	showLoading(boolean show) Specifies whether the loading of data tiles should be displayed.

Methods inherited from class ilog.views.chart.data.IlvAbstractDataSet

addData, addDataSetListener, computeMinimumXDifference, dataAdded, dataChanged, endBatch, fireDataAddedEvent, fireDataChangedEvent, fireDataSetContentsEvent, fireDataSetPropertyEvent, getData, getDataInside, getDataLabel, getMinimumXDifference, getName, getProperty, getUndefValue, getXRange, getXRange, getYRange, getYRange, invalidateLimits, invalidateLimits, invalidateLimits, isBatched, isEditable, isXRangeIncludingUndefinedPoints, isXValuesSorted, putProperty, removeDataSetListener, setData, setLimitsValid, setName, setUndefValue, setXRangeIncludingUndefinedPoints, startBatch, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvLODDataSet

public IlvLODDataSet(IlvDataTileController controller)

Initializes a new load-on-demand data set with the specified controller.

Throws:

IllegalArgumentException - If the controller is null or if it already controls another data set.

Method Detail

getDataCount

public int getDataCount()

Returns an upper bound for the number of data points available at this moment.

Specified by:

getDataCount in interface IlvDataSet

Specified by:

getDataCount in class IlvAbstractDataSet

getXData

public double getXData(int idx)

Returns the x-value of the data point at the specified index.

The tile capacity specified when creating the tile controller is used to compute an absolute indexing of data points.

Specified by:

getXData in interface IlvDataSet

Specified by:

getXData in class IlvAbstractDataSet

Parameters:

idx - a data point index, >= 0, < getDataCount()

getYData

public double getYData(int idx)

Returns the x-value of the data point at the specified index.

The tile capacity specified when creating the tile controller is used to compute an absolute indexing of data points.

Specified by:

getYData in interface IlvDataSet

Specified by:

getYData in class IlvAbstractDataSet

Parameters:

idx - a data point index, >= 0, < getDataCount()

getDataBetween

public IlvDataPoints getDataBetween(int iMin,
                                    int iMax)

Returns the data points between the two specified indices.

Note: The number of resulting points can be less than iMax-iMin+1.

Specified by:

getDataBetween in interface IlvDataSet

Overrides:

getDataBetween in class IlvAbstractDataSet

Parameters:

iMin - a data point index, >= 0, < getDataCount()

iMax - a data point index, >= iMin, < getDataCount()

Returns:

An IlvDataPoints representing the requested points. May return null if there are no such points. Returns null if iMin > iMax.

Since:

JViews 8.1

getDataInside

public IlvDataPoints getDataInside(IlvDataWindow window,
                                   int adjCount,
                                   boolean continuous)

Returns the data points inside the specified data window.

Warning: this method does not trigger a loading request. Instead it returns the contents of the loaded tiles that are within the specified window.

Specified by:

getDataInside in interface IlvDataSet

Overrides:

getDataInside in class IlvAbstractDataSet

Parameters:

window - The considered data window.

adjCount - The number of data points immediately outside the data window that must be returned by the request. If this parameter is equal to 0, only the points within the data window are returned. A value that is not equal to 0 is only relevant when requesting a continuous set of points (see the meaning of the continuous parameter).

continuous - Indicates whether the indices of the returned point set may have holes or not. If false, only data points inside the given data window are returned, and possibly adjCount data points on each side, even if the resulting set of indices has holes, like for example [1 2 4 7]. If true, a set of data points with continuous indices is returned, even if some of them lie outside the given data window, for example [1 2 3 4 5 6 7].

Returns:

An IlvDataPoints representing the requested points. May return null if there are no such points.

See Also:

IlvDataTileController.requestLoading(ilog.views.chart.IlvDataInterval, java.lang.Object)

computeLimits

protected void computeLimits(IlvDataInterval xRange,
                             IlvDataInterval yRange)

Computes the limits of the values stored in this data set.

Overrides:

computeLimits in class IlvAbstractDataSet

Parameters:

xRange - Returns the x-values range.

yRange - Returns the y-values range.

See Also:

IlvDataTileLoader.getXRange(), IlvDataTileLoader.getYRange()

getController

public final IlvDataTileController getController()

Returns the controller that manages the data tiles.

isShowingLoading

public final boolean isShowingLoading()

Indicates whether the loading of data tiles is displayed.

See Also:

showLoading(boolean)

showLoading

public void showLoading(boolean show)

Specifies whether the loading of data tiles should be displayed.

Parameters:

show - If true, the charts that represent the data set will display the loading of data tiles. In that case, the display is done with an instance of IlvDataIndicator. The default value of this property is false, which means that no graphical feedback is displayed while loading tiles.

See Also:

setLoadingStyle(ilog.views.chart.IlvStyle), setLoadingText(java.lang.String)

getLoadingStyle

public final IlvStyle getLoadingStyle()

Returns the rendering style used to display the loading of data tiles.

See Also:

setLoadingStyle(ilog.views.chart.IlvStyle)

setLoadingStyle

public void setLoadingStyle(IlvStyle style)

Sets the rendering style used to display the loading of data tiles.

See Also:

showLoading(boolean)

getLoadingText

public final String getLoadingText()

Returns the text displayed while loading data tiles.

See Also:

setLoadingText(java.lang.String)

setLoadingText

public void setLoadingText(String text)

Sets the text displayed while loading data tiles.

See Also:

showLoading(boolean)

axisRangeChanged

protected void axisRangeChanged(IlvAxis axis)

Invoked when the visible range of a chart displaying this data set changes.

The default implementation calls the IlvDataTileController.requestLoading(ilog.views.chart.IlvDataInterval, java.lang.Object) method, using the new visible range and the axis as parameters. You can override this implementation to load more data (for example, expand the visible range by a given factor).

Parameters:

axis - The considered x-axis.