ilog.views.chart.data

Class IlvDataPoints

java.lang.Object

ilog.views.chart.IlvDoublePoints

ilog.views.chart.data.IlvDataPoints

All Implemented Interfaces:

Serializable

public class IlvDataPoints
extends IlvDoublePoints

Holds the values of several data points. This class is used to store the result of data queries.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvDataPoints(IlvDataSet dataSet, int count) Creates a new object associated with the given data set and allocates storage for count value pairs.
IlvDataPoints(IlvDataSet dataSet, int count, double[] xValues, double[] yValues, int[] indices) Creates a new object and initializes it with the given values and indices.
IlvDataPoints(int count) Creates a new object and allocates storage for count value pairs.

Method Summary

Modifier and Type	Method and Description
void	add(double[] x, double[] y, int count) Appends the specified values to this object.
void	add(double[] x, double[] y, int[] indices, int count) Appends the specified values to this object.
void	add(double x, double y) Appends the specified values to this object.
void	add(double x, double y, int index) Appends the specified values to this object.
void	add(IlvDataPoints pts) Appends the contents of the specified object.
void	add(int insertIdx, double[] x, double[] y, int count) Inserts the specified values at the specified index.
void	add(int insertIdx, double[] x, double[] y, int[] indices, int count) Inserts the specified values at the specified index.
void	dispose() Releases the memory used by this object.
int	getDataIndex(int i) Deprecated. Please use the method getIndex(int) instead.
IlvDataSet	getDataSet() Returns the data set to which these data points belong.
int	getIndex(int index) Returns the index of the specified data point.
int[]	getIndices() Returns the array holding all the indices.
void	remove(int start, int count) Removes the specified points.
void	setIndices(int[] indices, int count) Sets the indices of the stored data points.
String	toString() Returns a string representation of this object.

Methods inherited from class ilog.views.chart.IlvDoublePoints

add, getX, getXFloor, getXValues, getXValuesClone, getY, getYFloor, getYValues, getYValuesClone, reset, set, setSize, setX, setY, size, swapXYValues

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDataPoints

public IlvDataPoints(IlvDataSet dataSet,
                     int count,
                     double[] xValues,
                     double[] yValues,
                     int[] indices)

Creates a new object and initializes it with the given values and indices.

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

IlvDataPoints

public IlvDataPoints(int count)

Creates a new object and allocates storage for count value pairs.

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

IlvDataPoints

public IlvDataPoints(IlvDataSet dataSet,
                     int count)

Creates a new object associated with the given data set and allocates storage for count value pairs.

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

Method Detail

add

public void add(double x,
                double y)

Appends the specified values to this object. The new point will have an index equal to -1.

Overrides:

add in class IlvDoublePoints

Parameters:

x - The new X value.

y - The new Y value.

add

public void add(double x,
                double y,
                int index)

Appends the specified values to this object.

Parameters:

x - The new x-value.

y - The new y-value.

index - The index of the data point.

add

public void add(double[] x,
                double[] y,
                int count)

Appends the specified values to this object. The new points will have an index equal to -1.

Overrides:

add in class IlvDoublePoints

Parameters:

x - The X values to add.

y - The Y values to add.

count - The number of values to add.

add

public void add(double[] x,
                double[] y,
                int[] indices,
                int count)

Appends the specified values to this object.

Parameters:

x - The X values to add.

y - The Y values to add.

indices - The indices of the values.

count - The number of values to add.

add

public void add(int insertIdx,
                double[] x,
                double[] y,
                int count)

Inserts the specified values at the specified index.

Overrides:

add in class IlvDoublePoints

Parameters:

insertIdx - The insertion index. This index must be less than or equal to the number of values stored in this object.

x - The X values to insert.

y - The Y values to insert.

count - The number of values to insert.

add

public void add(int insertIdx,
                double[] x,
                double[] y,
                int[] indices,
                int count)

Inserts the specified values at the specified index.

Parameters:

insertIdx - The insertion index. This index must be less than or equal to the number of values stored in this object.

x - The X values to insert.

y - The Y values to insert.

indices - The indices of the values.

count - The number of values to insert.

Since:

JViews 8.1

add

public void add(IlvDataPoints pts)

Appends the contents of the specified object.

remove

public void remove(int start,
                   int count)

Removes the specified points.

Overrides:

remove in class IlvDoublePoints

Parameters:

start - The index of the first point to remove.

count - The number of points to remove.

getDataSet

public IlvDataSet getDataSet()

Returns the data set to which these data points belong.

getDataIndex

@Deprecated
public final int getDataIndex(int i)

Deprecated. Please use the method getIndex(int) instead.

Returns the index of the data at the specified position.

Deprecated Since:

JViews 8.1

setIndices

public void setIndices(int[] indices,
                       int count)

Sets the indices of the stored data points.

Parameters:

indices - The new indices.

count - The number of provided indices. If this number is inferior than the actual number of data points, an index equal to -1 will be assigned to these data points .

getIndices

public final int[] getIndices()

Returns the array holding all the indices. The returned array is a direct reference to the internal array used by this object, which gives an efficient access to the stored values.

getIndex

public final int getIndex(int index)

Returns the index of the specified data point.

Parameters:

index - The index of the considered data point within this object.

Returns:

The index of the data point in the data set.

dispose

public void dispose()

Releases the memory used by this object. Although garbage collection also reclaims this memory, calling this method explicitly allows the application to recycle immediately the storage space, and to make it available for future array allocation.

Overrides:

dispose in class IlvDoublePoints

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class IlvDoublePoints