ilog.views.chart.data

Class IlvCombinedDataSet

java.lang.Object

ilog.views.chart.data.IlvAbstractDataSet

ilog.views.chart.data.IlvCombinedDataSet

All Implemented Interfaces:

IlvDataSet, IlvDataSetList, IlvBatchable, Serializable

Direct Known Subclasses:

IlvMovingAvgDataSet

public abstract class IlvCombinedDataSet
extends IlvAbstractDataSet
implements IlvDataSetList

Represents a data set expressed as a combination of other data sets. A combined data set provides values that are computed from one or several values accessible from one or several data sets.

For a data set that depends on just another data set, you can also use the class IlvFilterDataSet.

Since:

JViews 5.0

See Also:

IlvFilterDataSet, Serialized Form

Field Summary

Fields inherited from class ilog.views.chart.data.IlvAbstractDataSet

DEFAULT_UNDEF_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvCombinedDataSet() Creates a new IlvCombinedDataSet object.

Method Summary

Modifier and Type	Method and Description
void	addDataSet(IlvDataSet dataSet) Appends a data set to the end of the list.
void	addDataSet(int index, IlvDataSet dataSet) Inserts a data set at the specified index.
protected int	computeDataCount() Computes the data count of this data set.
protected void	dataSetContentsChanged(DataSetContentsEvent event) Called when one of the data sets referenced by this object has been modified.
protected void	dataSetPropertyChanged(DataSetPropertyEvent event) Called when a property of one of the data sets referenced by this object has been modified.
protected void	dataSetsChanged() Invoked when the referenced data sets change.
void	dispose() Cleans up this data set and drops references to objects to help garbage collection.
void	fireDataSetContentsEvent(DataSetContentsEvent event) Overridden to update the data count.
int	getDataCount() Returns the number of data points held by this data set.
IlvDataSet	getDataSet(int index) Returns the data set at the specified index.
int	getDataSetCount() Returns the number of managed data sets.
int	getDataSetIndex(IlvDataSet dataSet) Returns the index of a data set in the list.
IlvDataSet[]	getDataSets() Returns an array containing all the managed data sets.
int	getMaxDataSetCount() Returns the maximum number of data set that this combined data set can hold.
boolean	isXValuesSorted() Indicates whether the X values of the data points managed by this data set are sorted by increasing order.
boolean	removeDataSet(IlvDataSet dataSet) Removes the specified data set.
void	removeDataSet(int index) Removes the data set at the specified index.
boolean	replaceDataSet(IlvDataSet oldDataSet, IlvDataSet newDataSet) Replaces a data set by another data set.
void	setDataSet(int index, IlvDataSet dataSet) Replaces the data set at the specified position.
void	setDataSets(IlvDataSet[] dataSets) Initializes the list contents with the specified array.
void	setMaxDataSetCount(int max) Specifies that this combined data set should not hold more than a given number of data sets.
protected void	updateDataCount() Invoked when the data count needs to be updated.

Methods inherited from class ilog.views.chart.data.IlvAbstractDataSet

addData, addDataSetListener, computeLimits, computeMinimumXDifference, dataAdded, dataChanged, endBatch, fireDataAddedEvent, fireDataChangedEvent, fireDataSetPropertyEvent, getData, getDataBetween, getDataInside, getDataInside, getDataLabel, getMinimumXDifference, getName, getProperty, getUndefValue, getXData, getXRange, getXRange, getYData, getYRange, getYRange, invalidateLimits, invalidateLimits, invalidateLimits, isBatched, isEditable, isXRangeIncludingUndefinedPoints, putProperty, removeDataSetListener, setData, setLimitsValid, setName, setUndefValue, setXRangeIncludingUndefinedPoints, startBatch, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvCombinedDataSet

protected IlvCombinedDataSet()

Creates a new IlvCombinedDataSet object.

Method Detail

getDataSetCount

public int getDataSetCount()

Returns the number of managed data sets.

Specified by:

getDataSetCount in interface IlvDataSetList

getDataSet

public IlvDataSet getDataSet(int index)

Returns the data set at the specified index.

Specified by:

getDataSet in interface IlvDataSetList

getDataSets

public IlvDataSet[] getDataSets()

Returns an array containing all the managed data sets.

Specified by:

getDataSets in interface IlvDataSetList

getDataSetIndex

public int getDataSetIndex(IlvDataSet dataSet)

Returns the index of a data set in the list.

Specified by:

getDataSetIndex in interface IlvDataSetList

setDataSet

public void setDataSet(int index,
                       IlvDataSet dataSet)

Replaces the data set at the specified position.

Specified by:

setDataSet in interface IlvDataSetList

setDataSets

public void setDataSets(IlvDataSet[] dataSets)

Initializes the list contents with the specified array.

Specified by:

setDataSets in interface IlvDataSetList

replaceDataSet

public boolean replaceDataSet(IlvDataSet oldDataSet,
                              IlvDataSet newDataSet)

Replaces a data set by another data set.

Specified by:

replaceDataSet in interface IlvDataSetList

addDataSet

public void addDataSet(IlvDataSet dataSet)

Appends a data set to the end of the list.

Specified by:

addDataSet in interface IlvDataSetList

addDataSet

public void addDataSet(int index,
                       IlvDataSet dataSet)

Inserts a data set at the specified index.

Specified by:

addDataSet in interface IlvDataSetList

removeDataSet

public void removeDataSet(int index)

Removes the data set at the specified index.

Specified by:

removeDataSet in interface IlvDataSetList

removeDataSet

public boolean removeDataSet(IlvDataSet dataSet)

Removes the specified data set.

Specified by:

removeDataSet in interface IlvDataSetList

getMaxDataSetCount

public int getMaxDataSetCount()

Returns the maximum number of data set that this combined data set can hold.

Specified by:

getMaxDataSetCount in interface IlvDataSetList

See Also:

setMaxDataSetCount(int)

setMaxDataSetCount

public void setMaxDataSetCount(int max)

Specifies that this combined data set should not hold more than a given number of data sets.

Specified by:

setMaxDataSetCount in interface IlvDataSetList

isXValuesSorted

public boolean isXValuesSorted()

Indicates whether the X values of the data points managed by this data set are sorted by increasing order. The default implementation returns false.

Specified by:

isXValuesSorted in interface IlvDataSet

Overrides:

isXValuesSorted in class IlvAbstractDataSet

See Also:

IlvAbstractDataSet.isXValuesSorted()

getDataCount

public int getDataCount()

Returns the number of data points held by this data set.

Specified by:

getDataCount in interface IlvDataSet

Specified by:

getDataCount in class IlvAbstractDataSet

computeDataCount

protected int computeDataCount()

Computes the data count of this data set.

The default implementation returns the smallest data count among the referenced data sets.

updateDataCount

protected void updateDataCount()

Invoked when the data count needs to be updated. This method calls the computeDataCount() method.

See Also:

dataSetsChanged()

fireDataSetContentsEvent

public void fireDataSetContentsEvent(DataSetContentsEvent event)

Overridden to update the data count.

Overrides:

fireDataSetContentsEvent in class IlvAbstractDataSet

See Also:

IlvAbstractDataSet.addDataSetListener(ilog.views.chart.event.DataSetListener), DataSetContentsEvent

dataSetsChanged

protected void dataSetsChanged()

Invoked when the referenced data sets change.

This method is called when data sets are added or removed from the combined data set. The default implementation performs the following operations:

• It updates the data count.
• It invalidates the data limits.

See Also:

updateDataCount(), IlvAbstractDataSet.setLimitsValid(boolean)

dataSetContentsChanged

protected void dataSetContentsChanged(DataSetContentsEvent event)

Called when one of the data sets referenced by this object has been modified.

The default implementation deals only with batch begin/end. Subclasses must override this method in order to

1. propagate changes to the subscribed listeners of the combined data set,
2. invoke updateDataCount(), to recompute the current data count (unless the method getDataCount() is overridden),
3. invoke invalidateLimits(), to invalidate the x-range and y-range caches (unless the methods getXRange and getYRange are overridden).

Calls to fireDataSetContentsEvent will also invalidate the current data count (unless the method getDataCount() is overridden) and invalidate the x-range and y-range caches (unless the methods getXRange and getYRange are overridden).

dataSetPropertyChanged

protected void dataSetPropertyChanged(DataSetPropertyEvent event)

Called when a property of one of the data sets referenced by this object has been modified.

The default implementation does nothing.

dispose

public void dispose()

Cleans up this data set and drops references to objects to help garbage collection.

Note: After calling this function, this data set is no longer functional. You should have disconnected this data set from all other objects (data sources, renderers, charts) before calling this function.

Since:

JViews 8.5