IlvDataSet (Rogue Wave JViews 9.2 API)

All Known Implementing Classes:

IlvAbstractDataSet, IlvCombinedDataSet, IlvCyclicDataSet, IlvDefaultDataSet, IlvFilterDataSet, IlvFunctionDataSet, IlvLODDataSet, IlvMovingAvgDataSet, IlvResourceDataSet, IlvXSortedDataSet
```
public interface IlvDataSet
```
The core interface for data sets. This interface specifies the methods needed to fetch and modify data that are accessed as an indexed list of data points (a data point is defined by its x- and y-values and optionally carries a label). The IlvDataSet interface also enables data queries based on data interval (getDataInside(ilog.views.chart.IlvDataWindow, int, boolean) method).
Notes about the indices:
- Usually, a data set containing n points will use the indices 0, 1, ..., n-1 for these points; the method getDataCount() will then return n.
- The indices do not need to be in the same order as the x values, but if they are, the isXValuesSorted() method should be implemented to return true; this will allow some charts operations to run more efficiently.
- All indices must lie in the interval 0 <= idx < getDataCount().
- The indices do not need to cover the entire interval from 0 to getDataCount()-1. An arbitrary sub-interval of this interval is also OK. For example, the IlvCyclicDataSet in LINEAR_MODE uses a set of indices that is only a sub-interval of [0,getDataCount()-1].
- However, indices should be consecutive. This means, the difference between neighbour indices should not be greater than 1. For example, the polyline renderer draws lines between points at indices i and i+1; it does not draw lines between points whose indices are farther apart.
- A point with y value equal to Double.NaN or equal to getUndefValue().doubleValue() is an "undefined point". The polyline renderer represents it through a hole.
Since:

JViews 5.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addData(double x, double y)` Adds a data point at the end of this data set.
`void`	`addDataSetListener(DataSetListener listener)` Adds the specified listener to receive events concerning changes on this data set.
`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.
`String`	`getName()` Returns the name of this data set.
`Object`	`getProperty(Object key)` Returns the value of the property associated with the specified key.
`Double`	`getUndefValue()` Returns a value that is used to mark a data point as undefined.
`double`	`getXData(int idx)` Returns the x-value of the data point at the specified index.
`IlvDataInterval`	`getXRange(IlvDataInterval range)` Returns the limits of the x-values handled by this data set.
`double`	`getYData(int idx)` Returns the y-value of the data point at the specified index.
`IlvDataInterval`	`getYRange(IlvDataInterval range)` Returns the limits of the y-values handled by this data set.
`boolean`	`isEditable()` Indicates whether the data set is editable.
`boolean`	`isXValuesSorted()` Indicates whether the X values of the data points managed by this data set are sorted into ascending order.
`void`	`putProperty(Object key, Object value, boolean notify)` Adds a property to this data set.
`void`	`removeDataSetListener(DataSetListener listener)` Removes the specified listener from this data set.
`void`	`setData(int idx, double x, double y)` Modifies the data point at the specified index.

- Method Detail
  - getName
```
String getName()
```
    Returns the name of this data set.
  - getDataCount
```
int getDataCount()
```
    Returns the number of data points held by this data set.
  - getXData
```
double getXData(int idx)
```
    Returns the x-value of the data point at the specified index.
    
    Parameters:
    
    idx - a data point index, >= 0, < getDataCount()
  - getYData
```
double getYData(int idx)
```
    Returns the y-value of the data point at the specified index.
    
    Parameters:
    
    idx - a data point index, >= 0, < getDataCount()
  - setData
```
void setData(int idx,
             double x,
             double y)
```
    Modifies the data point at the specified index.
    
    Parameters:
    
    idx - a data point index, >= 0, < getDataCount()
    
    x - the new x coordinate of the point (if this data set supports setting arbitrary x values)
    
    y - the new y coordinate of the point
  - addData
```
void addData(double x,
             double y)
```
    Adds a data point at the end of this data set.
    
    Parameters:
    
    x - the x coordinate of the new point
    
    y - the y coordinate of the new point
  - getDataLabel
```
String getDataLabel(int idx)
```
    Returns the label associated with the data point at the specified index.
    These labels are used in the following situations:
    - as labels on the x axis, if the x axis is in "category" mode,
    - as data labels in the plot area, if the renderer's labeling mode is set to IlvChartRenderer.DATA_LABEL,
    - as legend text for the slices of pie charts,
    - in CSS rules for the selector point, as value of the label property.
    Parameters:
    
    idx - a data point index, >= 0, < getDataCount()
  - isEditable
```
boolean isEditable()
```
    Indicates whether the data set is editable.
    If this method returns true, the methods addData(double, double) and setData(int, double, double) can be called to modify the data set contents. Otherwise, these editing methods may have empty implementations.
  - getUndefValue
```
Double getUndefValue()
```
    Returns a value that is used to mark a data point as undefined. When the y-value of a data point equals this value, a chart renderer should not display the corresponding measurement. The method can return null, in which case it is assumed that all undefined data in the data set is represented by NaN values.
  - getXRange
```
IlvDataInterval getXRange(IlvDataInterval range)
```
    Returns the limits of the x-values handled by this data set. This method stores the result into range and returns range. If range is null, a new IlvDataInterval is allocated.
  - getYRange
```
IlvDataInterval getYRange(IlvDataInterval range)
```
    Returns the limits of the y-values handled by this data set. This method stores the result into range and returns range. If range is null, a new IlvDataInterval is allocated.
  - isXValuesSorted
```
boolean isXValuesSorted()
```
    Indicates whether the X values of the data points managed by this data set are sorted into ascending order. More precisely, if isXValuesSorted() is true, the particular IlvDataSet implementation class guarantees that for any two indices i and j such that i < j, getXData(i) <= getXData(j).
  - getData
```
IlvDataPoints getData()
```
    Returns all the data points held by this data set.
    Note: The returned array of data points may have less than getDataCount() points; this is the case, for example, for an IlvCyclicDataSet in LINEAR_MODE or for an IlvLODDataSet.
    For optimal performance, you should dispose() the resulting object when done with it.
    
    Returns:
    
    An IlvDataPoints representing all points. May return null if there are no such points.
  - getDataBetween
```
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.
    
    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
```
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.
    
    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.
  - getProperty
```
Object getProperty(Object key)
```
    Returns the value of the property associated with the specified key.
    
    Parameters:
    
    key - The key of the property to retrieve.
    
    Returns:
    
    The property value.
    
    See Also:
    
    putProperty(java.lang.Object, java.lang.Object, boolean), IlvDataSetProperty
  - putProperty
```
void putProperty(Object key,
                 Object value,
                 boolean notify)
```
    Adds a property to this data set. A property is a value associated with a unique key.
    
    Parameters:
    
    key - The key of this property. A key cannot be null, and must be designed to be used as a key of an associative map.
    
    value - The value of this property. A null value means that the property corresponding to the specified key must be removed.
    
    notify - If true, changes to properties are reported with DataSetPropertyEvent events. In that case, the name of the property in the event is key.toString().
    
    See Also:
    
    getProperty(java.lang.Object), IlvDataSetProperty
  - addDataSetListener
```
void addDataSetListener(DataSetListener listener)
```
    Adds the specified listener to receive events concerning changes on this data set.
  - removeDataSetListener
```
void removeDataSetListener(DataSetListener listener)
```
    Removes the specified listener from this data set.

Interface IlvDataSet

Method Summary

Method Detail

getName

getDataCount

getXData

getYData

setData

addData

getDataLabel

isEditable

getUndefValue

getXRange

getYRange

isXValuesSorted

getData

getDataBetween

getDataInside

getProperty

putProperty

addDataSetListener

removeDataSetListener