ilog.views.chart.data

Class IlvDefaultDataSet

java.lang.Object

ilog.views.chart.data.IlvAbstractDataSet

ilog.views.chart.data.IlvDefaultDataSet

All Implemented Interfaces:

IlvDataSet, IlvBatchable, Serializable

Direct Known Subclasses:

IlvCyclicDataSet, IlvResourceDataSet

public class IlvDefaultDataSet
extends IlvAbstractDataSet

Default data set that accesses data stored in memory.

Values are stored in an extensible array of double values. You can specify that only the Y values are stored, in which case the X value of a data point is equal to its index in the data set.

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<String>	labels The data labels.
protected IlvDoubleArray	xValues The x-values array.
protected IlvDoubleArray	yValues The y-values array.

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

DEFAULT_UNDEF_VALUE

Constructor Summary

Constructors

Constructor and Description
IlvDefaultDataSet(String name) Creates a new data set with the default initial capacity for data point storage.
IlvDefaultDataSet(String name, boolean useXValues) Creates a new data set with the default initial capacity for data point storage.
IlvDefaultDataSet(String name, double[] yValues) Initializes a new data set with a copy the specified y-values.
IlvDefaultDataSet(String name, double[] xValues, double[] yValues, boolean copy) Creates a new data set with the specified X and Y values.
IlvDefaultDataSet(String name, int initialSize, boolean useXValues) Initializes a new data set with the specified initial capacity for data point storage.

Method Summary

Modifier and Type	Method and Description
void	addData(double x, double y) Adds a data point at the end of this data set.
void	addData(double x, double y, String label) Adds a data point at the end of this data set.
static IlvDefaultDataSet[]	create(double[][] values, int xSeriesIdx, String[] names, String[] dataLabels) Creates data sets from the specified data.
protected void	dataAdded(int idx) Called when a data point has been added.
protected void	dataChanged(int firstIdx, int lastIdx, int eventType) Called when data points have been modified.
int	getDataCount() Returns the number of data points held by this data set.
String	getDataLabel(int idx) Returns the label associated with the data point at the specified index.
String[]	getDataLabels() Returns the data point labels.
double	getXData(int idx) Returns the x-value of the data point at the specified index.
double[]	getXValues() Returns the x values of all data points in a freshly allocated array.
double	getYData(int idx) Returns the y-value of the data point at the specified index.
double[]	getYValues() Returns the y values of all data points in a freshly allocated array.
boolean	isEditable() Indicates whether the data set is editable.
boolean	isUsingXValues() Tells whether X values are stored in the data set.
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	setXData(int idx, double x) Modifies the x value of the data point at the specified index.
void	setXValues(double[] xValues) Changes the x values of all data points.
void	setYData(int idx, double y) Modifies the y value of the data point at the specified index.
void	setYValues(double[] yValues) Changes the y values of all data points.
void	useXValues(boolean b) Specifies whether x-values should be stored in the data set.

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

addDataSetListener, computeLimits, computeMinimumXDifference, endBatch, fireDataAddedEvent, fireDataChangedEvent, fireDataSetContentsEvent, fireDataSetPropertyEvent, getData, getDataBetween, getDataInside, getDataInside, getMinimumXDifference, 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

xValues

protected IlvDoubleArray xValues

The x-values array. Either null or an array of the same size as yValues.

yValues

protected IlvDoubleArray yValues

The y-values array.

labels

protected ArrayList<String> labels

The data labels. Either null or a list of strings. It may be smaller than yValues; in this case extra labels are implicitly null. It may also be larger than yValues; in this case the extra labels are ignored.

Constructor Detail

IlvDefaultDataSet

public IlvDefaultDataSet(String name)

Creates a new data set with the default initial capacity for data point storage.

Parameters:

name - The name of the data set.

IlvDefaultDataSet

public IlvDefaultDataSet(String name,
                         boolean useXValues)

Creates a new data set with the default initial capacity for data point storage.

Parameters:

name - The name of the data set.

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

Since:

JViews 8.1

See Also:

isUsingXValues()

IlvDefaultDataSet

public IlvDefaultDataSet(String name,
                         int initialSize,
                         boolean useXValues)

Initializes a new data set with the specified initial capacity for data point storage.

Parameters:

name - The name of the data set.

initialSize - The initial size for the array holding the data points coordinates.

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

See Also:

isUsingXValues()

IlvDefaultDataSet

public IlvDefaultDataSet(String name,
                         double[] yValues)

Initializes a new data set with a copy the specified y-values.

The x-values of the data set will be computed according to the data points indices.

See Also:

isUsingXValues()

IlvDefaultDataSet

public IlvDefaultDataSet(String name,
                         double[] xValues,
                         double[] yValues,
                         boolean copy)

Creates a new data set with the specified X and Y values.

Parameters:

xValues - The x-values.

yValues - The y-values.

copy - If true, the given arrays are copied. Otherwise, the arrays are directly referenced by the data set. In the latter case, no modification should be done on the original arrays.

Method Detail

isUsingXValues

public final boolean isUsingXValues()

Tells whether X values are stored in the data set.

Returns:

true if x-values are stored in the data set, or false if they are computed according to the data points indices.

See Also:

useXValues(boolean)

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.

See Also:

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.

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.

getDataCount

public int getDataCount()

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

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.

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 y-value of the data point at the specified index.

Specified by:

getYData in interface IlvDataSet

Specified by:

getYData in class IlvAbstractDataSet

Parameters:

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

isEditable

public boolean isEditable()

Indicates whether the data set is editable.

Specified by:

isEditable in interface IlvDataSet

Overrides:

isEditable in class IlvAbstractDataSet

Returns:

true.

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 IlvAbstractDataSet

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:

isUsingXValues()

addData

public void addData(double x,
                    double y)

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

Specified by:

addData in interface IlvDataSet

Overrides:

addData in class IlvAbstractDataSet

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.

See Also:

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 create(double[][], int, java.lang.String[], java.lang.String[]) method.

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.

Since:

JViews 6.5

See Also:

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

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 IlvAbstractDataSet

Parameters:

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

See Also:

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 IlvAbstractDataSet

dataChanged

protected void dataChanged(int firstIdx,
                           int lastIdx,
                           int eventType)

Called when data points have been modified.

Overrides:

dataChanged in class IlvAbstractDataSet

Parameters:

firstIdx - The index of the first point impacted by the modification.

lastIdx - The index of the last point impacted by the modification.

eventType - The type of the notification event.

dataAdded

protected void dataAdded(int idx)

Called when a data point has been added.

Overrides:

dataAdded in class IlvAbstractDataSet

setXData

public void setXData(int idx,
                     double x)

Modifies the x value of the data point at the specified index.

This method has no effect if isUsingXValues() returns false.

Note: This method does not work in subclasses like IlvCyclicDataSet.

Since:

JViews 8.1

getXValues

public double[] getXValues()

Returns the x values of all data points in a freshly allocated array.

Returns:

An array with getDataCount() elements.

Since:

JViews 8.1

setXValues

public void setXValues(double[] xValues)

Changes the x values of all data points. If isUsingXValues() returns true, it also changes the number of data points held by this data set.

This method has no effect if isUsingXValues() returns false.

Note: This method does not work in subclasses like IlvCyclicDataSet.

Since:

JViews 8.1

setYData

public void setYData(int idx,
                     double y)

Modifies the y value of the data point at the specified index.

Note: This method does not work in subclasses like IlvCyclicDataSet.

Since:

JViews 8.1

getYValues

public double[] getYValues()

Returns the y values of all data points in a freshly allocated array.

Returns:

An array with getDataCount() elements.

Since:

JViews 8.1

setYValues

public void setYValues(double[] yValues)

Changes the y values of all data points. If isUsingXValues() returns false, it also changes the number of data points held by this data set.

Note: This method does not work in subclasses like IlvCyclicDataSet.

Since:

JViews 8.1

setDataLabel

public void setDataLabel(int idx,
                         String label)

Sets a data point label.

Since:

JViews 7.5

getDataLabels

public String[] getDataLabels()

Returns the data point labels.

Note: This method does not work in subclasses like IlvCyclicDataSet.

Returns:

An array of strings. Only the first up to getDataCount() elements are relevant.

Since:

JViews 8.1

setDataLabels

public void setDataLabels(String[] labels)

Specifies the data point labels.

create

public static IlvDefaultDataSet[] create(double[][] values,
                                         int xSeriesIdx,
                                         String[] names,
                                         String[] dataLabels)

Creates data sets from the specified data.

Parameters:

values - The values used to initialize the data source. This parameter is interpreted as an array of series.

xSeriesIdx - Specifies the index of the X series in the values parameter. If xSeriesIdx is equal to -1, values is assumed to hold only Y series. Otherwise, the corresponding X series is shared by all the data sets.

names - An optional array holding the names of the data sets.

dataLabels - An optional array of data point labels. These names will be used by all the data sets.