IlvAbstractDataSet (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.data.IlvAbstractDataSet

All Implemented Interfaces:

IlvDataSet, IlvBatchable, Serializable

Direct Known Subclasses:

IlvCombinedDataSet, IlvDefaultDataSet, IlvFilterDataSet, IlvFunctionDataSet, IlvLODDataSet
```
public abstract class IlvAbstractDataSet
extends Object
implements IlvDataSet, IlvBatchable, Serializable
```
This abstract class provides default implementations for some of the methods in the IlvDataSet interface.
- It maintains the list of registered DataSetListener listeners and provides methods to generate and dispatch DataSetEvent events.
- It maintains internally the limits of the x- and y-values.
- It implements data queries.
- It handles properties.
To create a concrete IlvDataSet as a subclass of IlvAbstractDataSet, you must provide an implementation for the following methods:
```
      public abstract int getDataCount();
      public abstract double getXData(int idx);
      public abstract double getYData(int idx);
 
```
The resulting data set will be read-only, as IlvAbstractDataSet defines empty implementations for writing operations.
Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Double DEFAULT_UNDEF_VALUE
A default undefined value equal to Double.MIN_VALUE.

Fields
Modifier and Type	Field and Description
`static Double`	`DEFAULT_UNDEF_VALUE` A default undefined value equal to `Double.MIN_VALUE`.

Constructor Summary

Constructors
Modifier Constructor and Description

protected IlvAbstractDataSet()
Creates a new IlvAbstractDataSet.

Constructors
Modifier	Constructor and Description
`protected`	`IlvAbstractDataSet()` Creates a new `IlvAbstractDataSet`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated 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 lst)` Adds the specified listener to receive events concerning changes on this data set.
`protected void`	`computeLimits(IlvDataInterval xRange, IlvDataInterval yRange)` Computes the limits of the values stored in this data set.
`static double`	`computeMinimumXDifference(IlvDataSet ds)` Computes the minimum positive difference among adjacent X values in the sequence of X values, sorted into ascending order.
`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.
`void`	`endBatch()` Terminates a batch of modifications.
`void`	`fireDataAddedEvent(int firstIdx, int lastIdx)` Notifies the listeners that the data from `firstIdx` to `lastIdx` have been added to the data set.
`void`	`fireDataChangedEvent(int firstIdx, int lastIdx, int eventType)` Notifies the listeners that a change of the given type occurred on the data from `firstIdx` to `lastIdx`.
`void`	`fireDataSetContentsEvent(DataSetContentsEvent event)` Sends the specified content event to all the registered data set listeners.
`void`	`fireDataSetPropertyEvent(DataSetPropertyEvent event)` Sends the specified property event to all the registered data set listeners.
`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.
`abstract 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.
`protected IlvDataPoints`	`getDataInside(IlvDataWindow window, int iMin, int iMax, int adjCount, boolean continuous)` Returns the data points of the specified index range 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.
`String`	`getName()` Returns the name of this data set.
`Object`	`getProperty(Object key)` Returns the value of the given property.
`Double`	`getUndefValue()` Returns a value that is used to mark a data point as undefined.
`abstract double`	`getXData(int idx)` Returns the x-value of the data point at the specified index.
`IlvDataInterval`	`getXRange()` Returns the limits of the x-values handled by this data set.
`IlvDataInterval`	`getXRange(IlvDataInterval xRange)` Returns the limits of the x-values handled by this data set.
`abstract double`	`getYData(int idx)` Returns the y-value of the data point at the specified index.
`IlvDataInterval`	`getYRange()` Returns the limits of the y-values handled by this data set.
`IlvDataInterval`	`getYRange(IlvDataInterval yRange)` Returns the limits of the y-values handled by this data set.
`void`	`invalidateLimits()` Invalidates the entire x range and y range cache.
`void`	`invalidateLimits(int firstIdx, int lastIdx)` Invalidates the x range cache and y range cache from index `firstIdx` to index `lastIdx` (inclusive).
`void`	`invalidateLimits(int firstIdx, int lastIdx, boolean dataAdded)` Invalidates the x range cache and y range cache from index `firstIdx` to index `lastIdx` (inclusive).
`boolean`	`isBatched()` Indicates whether notification events are batched.
`boolean`	`isEditable()` Indicates whether the data set is editable.
`boolean`	`isXRangeIncludingUndefinedPoints()` Returns true if points with an undefined y value are included when computing the x range.
`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)` Sets the given property on this data set.
`void`	`removeDataSetListener(DataSetListener lst)` Removes the specified listener from this data set.
`void`	`setData(int idx, double x, double y)` Modifies the data point at the specified index.
`protected void`	`setLimitsValid(boolean valid)` Deprecated. Please use `invalidateLimits()` or `invalidateLimits(int, int)` instead of `setLimitsValid(false)`.
`void`	`setName(String name)` Sets the name of this data set.
`void`	`setUndefValue(Double undefValue)` Specifies the `undefined value` for this data set.
`void`	`setXRangeIncludingUndefinedPoints(boolean include)` Specifies whether points with an undefined y value are included when computing the x range.
`void`	`startBatch()` Starts a batch of modifications.
`String`	`toString()` Returns a string representation of this data set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_UNDEF_VALUE
```
public static final Double DEFAULT_UNDEF_VALUE
```
    A default undefined value equal to Double.MIN_VALUE.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setUndefValue(java.lang.Double)
- Constructor Detail
  - IlvAbstractDataSet
```
protected IlvAbstractDataSet()
```
    Creates a new IlvAbstractDataSet.
- Method Detail
  - isXRangeIncludingUndefinedPoints
```
public boolean isXRangeIncludingUndefinedPoints()
```
    Returns true if points with an undefined y value are included when computing the x range. Returns false if points with an undefined y value are ignored.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    setXRangeIncludingUndefinedPoints(boolean)
  - setXRangeIncludingUndefinedPoints
```
public void setXRangeIncludingUndefinedPoints(boolean include)
```
    Specifies whether points with an undefined y value are included when computing the x range.
    
    Parameters:
    
    include - true if such points are considered, false if they are ignored for the x range.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    isXRangeIncludingUndefinedPoints()
  - getXRange
```
public IlvDataInterval getXRange()
```
    Returns the limits of the x-values handled by this data set. This method is a shortcut to getXRange(null).
    
    See Also:
    
    getXRange(IlvDataInterval), isXRangeIncludingUndefinedPoints()
  - getYRange
```
public IlvDataInterval getYRange()
```
    Returns the limits of the y-values handled by this data set. This method is a shortcut to getYRange(null).
    
    See Also:
    
    getYRange(IlvDataInterval)
  - getXRange
```
public IlvDataInterval getXRange(IlvDataInterval xRange)
```
    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.
    
    Specified by:
    
    getXRange in interface IlvDataSet
    
    See Also:
    
    isXRangeIncludingUndefinedPoints()
  - getYRange
```
public IlvDataInterval getYRange(IlvDataInterval yRange)
```
    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.
    
    Specified by:
    
    getYRange in interface IlvDataSet
  - invalidateLimits
```
public final void invalidateLimits()
```
    Invalidates the entire x range and y range cache.
    
    Since:
    
    JViews 8.1
  - invalidateLimits
```
public final void invalidateLimits(int firstIdx,
                                   int lastIdx)
```
    Invalidates the x range cache and y range cache from index firstIdx to index lastIdx (inclusive).
    
    Since:
    
    JViews 8.1
  - invalidateLimits
```
public final void invalidateLimits(int firstIdx,
                                   int lastIdx,
                                   boolean dataAdded)
```
    Invalidates the x range cache and y range cache from index firstIdx to index lastIdx (inclusive).
    
    Parameters:
    
    firstIdx - index of first added or changed data point
    
    lastIdx - index of last added or changed data point
    
    dataAdded - true if data was added at the end, false otherwise.
    
    Since:
    
    JViews 8.7
  - setLimitsValid
```
@Deprecated
protected void setLimitsValid(boolean valid)
```
    Deprecated. Please use invalidateLimits() or invalidateLimits(int, int) instead of setLimitsValid(false).
    
    Invalidates the x- and y-values limits.
    
    Deprecated Since:
    
    JViews 8.1
  - computeLimits
```
protected void computeLimits(IlvDataInterval xRange,
                             IlvDataInterval yRange)
```
    Computes the limits of the values stored in this data set.
    
    Parameters:
    
    xRange - Returns the x-values range.
    
    yRange - Returns the y-values range.
    
    See Also:
    
    isXRangeIncludingUndefinedPoints()
  - isXValuesSorted
```
public 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).
    The default implementation returns false. Note that the spatial request implemented by the getDataInside(ilog.views.chart.IlvDataWindow, int, boolean) method is much more efficient if the values are sorted.
    
    Specified by:
    
    isXValuesSorted in interface IlvDataSet
  - computeMinimumXDifference
```
public static double computeMinimumXDifference(IlvDataSet ds)
```
    Computes the minimum positive difference among adjacent X values in the sequence of X values, sorted into ascending order. Returns -1 if this data set is not empty but all X values are the same. Returns -2 if this data set is empty.
    This function can be used to implement getMinimumXDifference() for your own data sets.
    
    Since:
    
    JViews 8.7
  - 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).
    
    Since:
    
    JViews 8.7
  - getDataCount
```
public abstract int getDataCount()
```
    Returns the number of data points held by this data set.
    
    Specified by:
    
    getDataCount in interface IlvDataSet
  - getXData
```
public abstract double getXData(int idx)
```
    Returns the x-value of the data point at the specified index.
    
    Specified by:
    
    getXData in interface IlvDataSet
    
    Parameters:
    
    idx - a data point index, >= 0, < getDataCount()
  - getYData
```
public abstract double getYData(int idx)
```
    Returns the y-value of the data point at the specified index.
    
    Specified by:
    
    getYData in interface IlvDataSet
    
    Parameters:
    
    idx - a data point index, >= 0, < getDataCount()
  - addData
```
public void addData(double x,
                    double y)
```
    Adds a data point at the end of this data set.
    
    Specified by:
    
    addData in interface IlvDataSet
    
    Parameters:
    
    x - the x coordinate of the new point
    
    y - the y coordinate of the new point
  - setData
```
public void setData(int idx,
                    double x,
                    double y)
```
    Modifies the data point at the specified index.
    
    Specified by:
    
    setData in interface IlvDataSet
    
    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
  - isEditable
```
public boolean isEditable()
```
    Indicates whether the data set is editable.
    
    Specified by:
    
    isEditable in interface IlvDataSet
    
    Returns:
    
    false, as IlvAbstractDataSet provides empty implementation for editing operations.
  - setUndefValue
```
public void setUndefValue(Double undefValue)
```
    Specifies the undefined value for this data set.
    
    See Also:
    
    getUndefValue()
  - getUndefValue
```
public 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.
    
    Specified by:
    
    getUndefValue in interface IlvDataSet
  - startBatch
```
public void startBatch()
```
    Starts a batch of modifications. After this method is called, event listeners are aware of a batch of events until the corresponding endBatch() call.
    The listeners are responsible for accumulating the events instead of handling them immediately, if they wish to do so. The class IlvBatchingDataSetListener is a utility class that helps doing so.
    
    Specified by:
    
    startBatch in interface IlvBatchable
    
    See Also:
    
    endBatch(), DataSetContentsEvent.BATCH_BEGIN, IlvBatchingDataSetListener
  - endBatch
```
public void endBatch()
```
    Terminates a batch of modifications. Event listeners are made aware that a batch of events terminated.
    In the case of nested batches the listeners are notified only after the most enclosing batch is terminated.
    The listeners are responsible for accumulating the events instead of handling them immediately, if they wish to do so. The class IlvBatchingDataSetListener is a utility class that helps doing so.
    
    Specified by:
    
    endBatch in interface IlvBatchable
    
    See Also:
    
    startBatch(), DataSetContentsEvent.BATCH_END, IlvBatchingDataSetListener
  - isBatched
```
public final boolean isBatched()
```
    Indicates whether notification events are batched.
    
    See Also:
    
    startBatch(), endBatch()
  - fireDataSetContentsEvent
```
public void fireDataSetContentsEvent(DataSetContentsEvent event)
```
    Sends the specified content event to all the registered data set listeners.
    
    See Also:
    
    addDataSetListener(ilog.views.chart.event.DataSetListener), DataSetContentsEvent
  - fireDataSetPropertyEvent
```
public void fireDataSetPropertyEvent(DataSetPropertyEvent event)
```
    Sends the specified property event to all the registered data set listeners.
    
    See Also:
    
    addDataSetListener(ilog.views.chart.event.DataSetListener), DataSetPropertyEvent
  - fireDataAddedEvent
```
public void fireDataAddedEvent(int firstIdx,
                               int lastIdx)
```
    Notifies the listeners that the data from firstIdx to lastIdx have been added to the data set.
    
    See Also:
    
    DataSetContentsEvent
  - fireDataChangedEvent
```
public void fireDataChangedEvent(int firstIdx,
                                 int lastIdx,
                                 int eventType)
```
    Notifies the listeners that a change of the given type occurred on the data from firstIdx to lastIdx.
    
    See Also:
    
    DataSetContentsEvent
  - addDataSetListener
```
public void addDataSetListener(DataSetListener lst)
```
    Adds the specified listener to receive events concerning changes on this data set.
    
    Specified by:
    
    addDataSetListener in interface IlvDataSet
  - removeDataSetListener
```
public void removeDataSetListener(DataSetListener lst)
```
    Removes the specified listener from this data set.
    
    Specified by:
    
    removeDataSetListener in interface IlvDataSet
  - dataChanged
```
protected void dataChanged(int firstIdx,
                           int lastIdx,
                           int eventType)
```
    Called when data points have been modified. The default implementation invalidates the limits of the x-values and y-values and calls fireDataChangedEvent.
    
    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. The default implementation updates the ranges of the x-values and y-values and calls fireDataAddedEvent.
  - 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
    
    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
    
    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
    
    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.
  - getDataInside
```
protected IlvDataPoints getDataInside(IlvDataWindow window,
                                      int iMin,
                                      int iMax,
                                      int adjCount,
                                      boolean continuous)
```
    Returns the data points of the specified index range inside the specified data window.
    For optimal performance, you should dispose() the resulting object when done with it.
    
    Parameters:
    
    window - The considered data window.
    
    iMin - Minimum data index to consider.
    
    iMax - Maximum data index to consider.
    
    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.
    
    Since:
    
    JViews 8.0
  - putProperty
```
public void putProperty(Object key,
                        Object value,
                        boolean notify)
```
    Sets the given property on this data set.
    
    Specified by:
    
    putProperty in interface IlvDataSet
    
    Parameters:
    
    key - The key of this property.
    
    value - The value of the property. Passing null removes the property.
    
    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:
    
    IlvDataSet.getProperty(java.lang.Object), IlvDataSetProperty
  - getProperty
```
public Object getProperty(Object key)
```
    Returns the value of the given property. May return null if the property has not been set on this data set.
    
    Specified by:
    
    getProperty in interface IlvDataSet
    
    Parameters:
    
    key - The key of the property to retrieve.
    
    Returns:
    
    The property value.
    
    See Also:
    
    IlvDataSet.putProperty(java.lang.Object, java.lang.Object, boolean), IlvDataSetProperty
  - toString
```
public String toString()
```
    Returns a string representation of this data set.
    
    Overrides:
    
    toString in class Object
  - getName
```
public String getName()
```
    Returns the name of this data set.
    
    Specified by:
    
    getName in interface IlvDataSet
  - setName
```
public void setName(String name)
```
    Sets the name of this data set. The name is set as a property of the data set trough the putProperty(java.lang.Object, java.lang.Object, boolean) method.
  - getDataLabel
```
public String getDataLabel(int idx)
```
    Returns the label associated with the data point at the specified index. This default implementation returns an empty string.
    
    Specified by:
    
    getDataLabel in interface IlvDataSet
    
    Parameters:
    
    idx - a data point index, >= 0, < getDataCount()

Class IlvAbstractDataSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_UNDEF_VALUE

Constructor Detail

IlvAbstractDataSet

Method Detail

isXRangeIncludingUndefinedPoints

setXRangeIncludingUndefinedPoints

getXRange

getYRange

getXRange

getYRange

invalidateLimits

invalidateLimits

invalidateLimits

setLimitsValid

computeLimits

isXValuesSorted

computeMinimumXDifference

getMinimumXDifference

getDataCount

getXData

getYData

addData

setData

isEditable

setUndefValue

getUndefValue

startBatch

endBatch

isBatched

fireDataSetContentsEvent

fireDataSetPropertyEvent

fireDataAddedEvent

fireDataChangedEvent

addDataSetListener

removeDataSetListener

dataChanged

dataAdded

getData

getDataBetween

getDataInside

getDataInside

putProperty

getProperty

toString

getName

setName

getDataLabel