IlvAbstractDataSource (Perforce JViews 10.0 API)

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

All Implemented Interfaces:

IlvDataSource, IlvBatchable, Serializable

Direct Known Subclasses:

IlvAbstractTableDataSource, IlvDefaultDataSource, IlvInputDataSource, IlvXMLDataSource
```
public abstract class IlvAbstractDataSource
extends Object
implements IlvDataSource, IlvBatchable, Serializable
```
This abstract class provides default implementations for some of the methods in the IlvDataSource interface.
- It stores the list of data sets accessible through this data source, and provides indexed access to this collection.
- It maintains the list of registered DataSourceListener listeners and provides methods to generate and dispatch DataSourceEvent events.
- It provides empty implementation for writing operations.
Subclasses can initialize the contents of this data source with the initDataSets(ilog.views.chart.data.IlvDataSet[]) method.
Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier Constructor and Description

protected IlvAbstractDataSource()
Creates a new IlvAbstractDataSource.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDataSet(IlvDataSet dataSet)` Adds a new data set at the end of this data source.
`void`	`addDataSet(int idx, IlvDataSet dataSet)` Inserts a new data set at the specified position.
`void`	`addDataSourceListener(DataSourceListener listener)` Adds the specified listener to receive events concerning changes in the contents of this data source.
`boolean`	`containsDataSet(IlvDataSet dataSet)` Tells whether this data source contains the specified data set.
`void`	`endBatch()` Signals the end of a series of changes to the data source.
`void`	`fireDataSourceEvent(DataSourceEvent event)` Fires a data source event to all subscribed listeners.
`IlvDataSet`	`getDataSet(int idx)` Returns the data set at the specified index.
`IlvDataSet`	`getDataSetByName(String dataSetName)` Returns the data set with the given name, of `null` if there is none.
`int`	`getDataSetCount()` Returns the number of data sets provided by this data source.
`int`	`getDataSetIndex(IlvDataSet dataSet)` Returns the index of the specified data set.
`Iterator<IlvDataSet>`	`getDataSetIterator()` Returns an iterator over the data sets provided by this data source.
`protected IlvDataSetList`	`getDataSetList()` Returns the internal list of data sets handled by the data source.
`IlvDataSet[]`	`getDataSets()` Returns the data sets provided by this data source.
`protected void`	`initDataSets(IlvDataSet[] dataSets)` Initializes the data source with the specified data sets.
`void`	`removeDataSourceListener(DataSourceListener listener)` Removes the specified listener.
`void`	`setDataSet(int idx, IlvDataSet dataSet)` Replaces the data set at the specified index.
`void`	`setDataSets(IlvDataSet[] dataSets)` Initializes this data source with the specified data sets.
`void`	`startBatch()` Signals the beginning of a series of changes to the data source.

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

- Constructor Detail
  - IlvAbstractDataSource
```
protected IlvAbstractDataSource()
```
    Creates a new IlvAbstractDataSource.
- Method Detail
  - getDataSetCount
```
public int getDataSetCount()
```
    Returns the number of data sets provided by this data source.
    
    Specified by:
    
    getDataSetCount in interface IlvDataSource
  - getDataSets
```
public IlvDataSet[] getDataSets()
```
    Returns the data sets provided by this data source.
    
    Specified by:
    
    getDataSets in interface IlvDataSource
  - getDataSetIterator
```
public Iterator<IlvDataSet> getDataSetIterator()
```
    Returns an iterator over the data sets provided by this data source. The type of the elements traversed by this iterator is IlvDataSet. The returned iterator does not allow the element removal (an UnsupportedOperationException is thrown when calling the remove method).
    
    Specified by:
    
    getDataSetIterator in interface IlvDataSource
    
    Returns:
    
    an iterator over IlvDataSet elements
  - getDataSet
```
public IlvDataSet getDataSet(int idx)
```
    Returns the data set at the specified index.
    
    Specified by:
    
    getDataSet in interface IlvDataSource
  - getDataSetIndex
```
public int getDataSetIndex(IlvDataSet dataSet)
```
    Returns the index of the specified data set.
    
    Specified by:
    
    getDataSetIndex in interface IlvDataSource
    
    Parameters:
    
    dataSet - The considered data set.
    
    Returns:
    
    The index of the considered data set, or -1 if the data set is not handled by the data source.
  - containsDataSet
```
public boolean containsDataSet(IlvDataSet dataSet)
```
    Tells whether this data source contains the specified data set.
    
    Specified by:
    
    containsDataSet in interface IlvDataSource
  - addDataSourceListener
```
public void addDataSourceListener(DataSourceListener listener)
```
    Adds the specified listener to receive events concerning changes in the contents of this data source.
    
    Specified by:
    
    addDataSourceListener in interface IlvDataSource
  - removeDataSourceListener
```
public void removeDataSourceListener(DataSourceListener listener)
```
    Removes the specified listener.
    
    Specified by:
    
    removeDataSourceListener in interface IlvDataSource
  - setDataSet
```
public void setDataSet(int idx,
                       IlvDataSet dataSet)
```
    Replaces the data set at the specified index. The default implementation does nothing.
    
    Specified by:
    
    setDataSet in interface IlvDataSource
    
    Parameters:
    
    idx - The index of the data set to replace.
    
    dataSet - The new data set. If this parameter is null, the data set at the index idx is removed.
  - setDataSets
```
public void setDataSets(IlvDataSet[] dataSets)
```
    Initializes this data source with the specified data sets. The default implementation does nothing.
    
    Specified by:
    
    setDataSets in interface IlvDataSource
    
    Parameters:
    
    dataSets - The new data sets. If this parameter is null, all the data sets provided by this data source should be removed.
  - addDataSet
```
public void addDataSet(int idx,
                       IlvDataSet dataSet)
```
    Inserts a new data set at the specified position. The default implementation does nothing.
    
    Specified by:
    
    addDataSet in interface IlvDataSource
  - addDataSet
```
public void addDataSet(IlvDataSet dataSet)
```
    Adds a new data set at the end of this data source. The default implementation does nothing.
    
    Specified by:
    
    addDataSet in interface IlvDataSource
  - fireDataSourceEvent
```
public void fireDataSourceEvent(DataSourceEvent event)
```
    Fires a data source event to all subscribed listeners.
  - startBatch
```
public void startBatch()
```
    Signals the beginning of a series of changes to the data source.
    
    Specified by:
    
    startBatch in interface IlvBatchable
    
    Since:
    
    JViews 8.5
  - endBatch
```
public void endBatch()
```
    Signals the end of a series of changes to the data source.
    
    Specified by:
    
    endBatch in interface IlvBatchable
    
    Since:
    
    JViews 8.5
  - initDataSets
```
protected void initDataSets(IlvDataSet[] dataSets)
```
    Initializes the data source with the specified data sets.
  - getDataSetList
```
protected IlvDataSetList getDataSetList()
```
    Returns the internal list of data sets handled by the data source.
  - getDataSetByName
```
public IlvDataSet getDataSetByName(String dataSetName)
```
    Returns the data set with the given name, of null if there is none.
    
    Since:
    
    JViews 7.5

Class IlvAbstractDataSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvAbstractDataSource

Method Detail

getDataSetCount

getDataSets

getDataSetIterator

getDataSet

getDataSetIndex

containsDataSet

addDataSourceListener

removeDataSourceListener

setDataSet

setDataSets

addDataSet

addDataSet

fireDataSourceEvent

startBatch

endBatch

initDataSets

getDataSetList

getDataSetByName