ilog.views.chart.data

Interface IlvDataSource

All Known Implementing Classes:

IlvAbstractDataSource, IlvAbstractTableDataSource, IlvDefaultDataSource, IlvInputDataSource, IlvJDBCDataSource, IlvSwingTableDataSource, IlvTreeTableDataSource, IlvXMLDataSource

public interface IlvDataSource

Represents a source of data sets. A data source provides an access to a collection of data sets. The write operations are optional and can have empty implementation. Data sources are used to connect data to chart renderers. When a renderer is bound to a data source, it is notified through DataSourceEvent events whenever the data source contents change.

Since:

JViews 5.0

Method Summary

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 lst) 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.
IlvDataSet	getDataSet(int idx) Returns the data set at the specified index.
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.
IlvDataSet[]	getDataSets() Returns the data sets provided by this data source.
void	removeDataSourceListener(DataSourceListener lst) 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.

Method Detail

getDataSetCount

int getDataSetCount()

Returns the number of data sets provided by this data source.

getDataSets

IlvDataSet[] getDataSets()

Returns the data sets provided by this data source.

getDataSetIterator

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 element removal (an UnsupportedOperationException is thrown when calling the remove method).

Returns:

an iterator over IlvDataSet elements

getDataSet

IlvDataSet getDataSet(int idx)

Returns the data set at the specified index.

getDataSetIndex

int getDataSetIndex(IlvDataSet dataSet)

Returns the index of the specified data set.

Parameters:

dataSet - The considered data set.

Returns:

The index of the considered data set, or -1 if the data source does not contain this data set.

setDataSet

void setDataSet(int idx,
                IlvDataSet dataSet)

Replaces the data set at the specified index.

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

void setDataSets(IlvDataSet[] dataSets)

Initializes this data source with the specified data sets.

Parameters:

dataSets - The new data sets. If this parameter is null, all the data sets provided by this data source are removed.

addDataSet

void addDataSet(int idx,
                IlvDataSet dataSet)

Inserts a new data set at the specified position.

addDataSet

void addDataSet(IlvDataSet dataSet)

Adds a new data set at the end of this data source.

containsDataSet

boolean containsDataSet(IlvDataSet dataSet)

Tells whether this data source contains the specified data set.

addDataSourceListener

void addDataSourceListener(DataSourceListener lst)

Adds the specified listener to receive events concerning changes in the contents of this data source.

removeDataSourceListener

void removeDataSourceListener(DataSourceListener lst)

Removes the specified listener.