ilog.views.chart.data

Class IlvCyclicDataSet

java.lang.Object

ilog.views.chart.data.IlvAbstractDataSet

ilog.views.chart.data.IlvDefaultDataSet

ilog.views.chart.data.IlvCyclicDataSet

All Implemented Interfaces:

IlvDataSet, IlvBatchable, Serializable

public class IlvCyclicDataSet
extends IlvDefaultDataSet

Implements a data set where values are stored in a fixed-size buffer.

When new values are added, the oldest values are removed accordingly.

The data set can be managed in three modes:

• LINEAR_MODE: In this mode the data indices form a potentially infinite sequence 0, 1, 2, ... When a new data point is added, a new data index i becomes valid, and the value at data index i - bufferSize is dropped.
• ROTATE_MODE: In this mode the data indices stay between 0 and bufferSize - 1. When a new data point is added, the values are shifted, from data index 1 to data index 0, from data index 2 to data index 1, and so on. The new value is stored at data index bufferSize - 1.
• CYCLIC_MODE: In this mode the data indices stay between 0 and bufferSize - 1 as well. When a new data point is added, it overwrites a value at an index; this overwrite index cycles through the values 0 to bufferSize - 1.

LINEAR_MODE and ROTATE_MODE are similar in the sense that the resulting charts look the same in either mode. However, LINEAR_MODE has a better performance as it allows incremental repainting of real-time charts.

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CYCLIC_MODE In this mode the data indices stay between 0 and bufferSize - 1.
static int	LINEAR_MODE In this mode, the data indices form a potentially infinite sequence 0, 1, 2, ...
static int	ROTATE_MODE In this mode, the data indices stay between 0 and bufferSize - 1.

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

labels, xValues, yValues

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

DEFAULT_UNDEF_VALUE

Constructor Summary

Constructors

Constructor and Description
IlvCyclicDataSet(String name, int bufferSize, boolean useXValues) Deprecated. Please use the four-argument constructor instead, choosing an appropriate data management mode.
IlvCyclicDataSet(String name, int bufferSize, int mode, boolean useXValues) Creates a new cyclic data set.

Method Summary

Modifier and Type	Method and Description
void	addData(double x, double y, String label) Adds a data point at the end of this data set.
int	getBufferSize() Returns the number of data points that can be stored in this data set before a wrap-around occurs.
IlvDataPoints	getData() Returns all the data points held by this data set.
IlvDataPoints	getDataBetween(int iMin, int iMax) Returns the data points between the two specified indices.
int	getDataCount() Returns the number of data points held by this data set.
IlvDataPoints	getDataInside(IlvDataWindow window, int adjCount, boolean continuous) Returns the data points inside the specified data window.
String	getDataLabel(int idx) Returns the label associated with the data point at the specified index.
double	getMinimumXDifference() Returns the minimum positive difference among adjacent X values in the sequence of X values, sorted into ascending order.
int	getMode() Returns the data management mode of this data set.
double	getXData(int idx) Returns the x-value of the data point at the specified index.
double	getYData(int idx) Returns the y-value of the data point at the specified index.
boolean	isXValuesSorted() Indicates whether the X values held by this data set are sorted in ascending order.
void	setData(double[] xValues, double[] yValues, int count) Initializes the contents of this data set with a copy of the specified values.
void	setData(int idx, double x, double y) Modifies the data point at the specified index.
void	setDataLabel(int idx, String label) Sets a data point label.
void	setDataLabels(String[] labels) Specifies the data point labels.
void	useXValues(boolean b) Specifies whether x-values should be stored in the data set.

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

addData, create, dataAdded, dataChanged, getDataLabels, getXValues, getYValues, isEditable, isUsingXValues, setXData, setXValues, setYData, setYValues

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

addDataSetListener, computeLimits, computeMinimumXDifference, endBatch, fireDataAddedEvent, fireDataChangedEvent, fireDataSetContentsEvent, fireDataSetPropertyEvent, getDataInside, getName, getProperty, getUndefValue, getXRange, getXRange, getYRange, getYRange, invalidateLimits, invalidateLimits, invalidateLimits, isBatched, isXRangeIncludingUndefinedPoints, putProperty, removeDataSetListener, setLimitsValid, setName, setUndefValue, setXRangeIncludingUndefinedPoints, startBatch, toString

Methods inherited from class java.lang.Object

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

Field Detail

LINEAR_MODE

public static final int LINEAR_MODE

In this mode, the data indices form a potentially infinite sequence 0, 1, 2, ... When a new data point is added, a new data index i becomes valid, and the value at data index i - bufferSize is dropped.

Since:

JViews 8.0

See Also:

Constant Field Values

ROTATE_MODE

public static final int ROTATE_MODE

In this mode, the data indices stay between 0 and bufferSize - 1. When a new data point is added, the values are shifted, from data index 1 to data index 0, from data index 2 to data index 1, and so on. The new value is stored at data index bufferSize - 1.

Since:

JViews 8.0

See Also:

Constant Field Values

CYCLIC_MODE

public static final int CYCLIC_MODE

In this mode the data indices stay between 0 and bufferSize - 1. When a new data point is added, it overwrites a value at an index; this overwrite index cycles through the values 0 to bufferSize - 1.

Since:

JViews 8.0

See Also:

Constant Field Values

Constructor Detail

IlvCyclicDataSet

@Deprecated
public IlvCyclicDataSet(String name,
                                    int bufferSize,
                                    boolean useXValues)

Deprecated. Please use the four-argument constructor instead, choosing an appropriate data management mode.

Creates a new cyclic data set with mode ROTATE_MODE.

Parameters:

name - The name of this data set.

bufferSize - The size of the buffer.

useXValues - A boolean value indicating whether x-values should be stored in the data set, or generated according to the data point indices.

Deprecated Since:

JViews 8.1

IlvCyclicDataSet

public IlvCyclicDataSet(String name,
                        int bufferSize,
                        int mode,
                        boolean useXValues)

Creates a new cyclic data set.

Parameters:

name - The name of this data set.

bufferSize - The size of the buffer.

mode - The data management mode. One of LINEAR_MODE, ROTATE_MODE, CYCLIC_MODE.

useXValues - A boolean value indicating whether x-values should be stored in the data set, or generated according to the data point indices.

Since:

JViews 8.0

Method Detail

getDataCount

public int getDataCount()

Returns the number of data points held by this data set.

Specified by:

getDataCount in interface IlvDataSet

Overrides:

getDataCount in class IlvDefaultDataSet

getXData

public double getXData(int idx)

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

Note: if x-values are not stored, the returned value takes into account the number of cycles since the creation of the data set as well as the index of the data point.

Specified by:

getXData in interface IlvDataSet

Overrides:

getXData in class IlvDefaultDataSet

Parameters:

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

getYData

public double getYData(int idx)

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

Specified by:

getYData in interface IlvDataSet

Overrides:

getYData in class IlvDefaultDataSet

Parameters:

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

getDataLabel

public String getDataLabel(int idx)

Returns the label associated with the data point at the specified index.

Specified by:

getDataLabel in interface IlvDataSet

Overrides:

getDataLabel in class IlvDefaultDataSet

Parameters:

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

See Also:

IlvDefaultDataSet.setDataLabels(java.lang.String[])

setData

public void setData(int idx,
                    double x,
                    double y)

Modifies the data point at the specified index.

Specified by:

setData in interface IlvDataSet

Overrides:

setData in class IlvDefaultDataSet

Parameters:

idx - The index of the considered data point.

x - The new x-value of the data point. This value is not taken into account if the data set does not store x-values.

y - The new y-value of the data point.

See Also:

IlvDefaultDataSet.isUsingXValues()

addData

public void addData(double x,
                    double y,
                    String label)

Adds a data point at the end of this data set. This method cannot be called on a data set created with the IlvDefaultDataSet.create(double[][], int, java.lang.String[], java.lang.String[]) method.

Overrides:

addData in class IlvDefaultDataSet

Parameters:

x - The x-value of the new data point. This value is not taken into account if the data set does not store x-values.

y - The y-value of the new data point.

label - The label of the new data point.

See Also:

IlvDefaultDataSet.isUsingXValues(), IlvDefaultDataSet.setDataLabels(java.lang.String[])

isXValuesSorted

public boolean isXValuesSorted()

Indicates whether the X values held by this data set are sorted in ascending order.

Specified by:

isXValuesSorted in interface IlvDataSet

Overrides:

isXValuesSorted in class IlvDefaultDataSet

getMinimumXDifference

public double getMinimumXDifference()

Returns the minimum positive difference among adjacent X values in the sequence of X values, sorted into ascending order. May return -1 or a positive value if this data set is not empty but all X values are the same. May return -2 or a positive value if this data set is empty.

Note: This method may be slow, depending on the other characteristics of this data set. If you want to provide this information, instead of having it computed each time it is needed, you can do so by calling IlvDataSetProperty.setCategory(IlvDataSet, Double).

Overrides:

getMinimumXDifference in class IlvAbstractDataSet

getData

public IlvDataPoints getData()

Returns all the data points held by this data set.

For optimal performance, you should dispose() the resulting object when done with it.

Specified by:

getData in interface IlvDataSet

Overrides:

getData in class IlvAbstractDataSet

Returns:

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

getDataBetween

public IlvDataPoints getDataBetween(int iMin,
                                    int iMax)

Returns the data points between the two specified indices.

For optimal performance, you should dispose() the resulting object when done with it.

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.

getDataInside

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

Returns the data points inside the specified data window.

For optimal performance, you should dispose() the resulting object when done with it.

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.

useXValues

public void useXValues(boolean b)

Specifies whether x-values should be stored in the data set. If y-values are already stored, x-values will be generated according to the data indices.

Overrides:

useXValues in class IlvDefaultDataSet

See Also:

IlvDefaultDataSet.isUsingXValues()

setData

public void setData(double[] xValues,
                    double[] yValues,
                    int count)

Initializes the contents of this data set with a copy of the specified values. Calling this method triggers an DataSetContentsEvent.FULL_UPDATE event.

Overrides:

setData in class IlvDefaultDataSet

Parameters:

xValues - an array of at least count elements, or null

yValues - an array of at least count elements, or (only if count == 0) null

count - The number of relevant elements in the xValues and yValues arrays.

setDataLabel

public void setDataLabel(int idx,
                         String label)

Sets a data point label.

Overrides:

setDataLabel in class IlvDefaultDataSet

setDataLabels

public void setDataLabels(String[] labels)

Specifies the data point labels.

Overrides:

setDataLabels in class IlvDefaultDataSet

getBufferSize

public final int getBufferSize()

Returns the number of data points that can be stored in this data set before a wrap-around occurs.

Since:

JViews 8.0

getMode

public final int getMode()

Returns the data management mode of this data set.

Returns:

One of LINEAR_MODE, ROTATE_MODE, CYCLIC_MODE.

Since:

JViews 8.0