ilog.views.chart.datax.flat.list

Class IlvBufferFlatListModel

java.lang.Object

ilog.views.chart.datax.flat.list.IlvAbstractFlatListModel

ilog.views.chart.datax.flat.list.IlvBasicFlatListModel

ilog.views.chart.datax.flat.list.IlvDefaultFlatListModel

ilog.views.chart.datax.flat.list.IlvBufferFlatListModel

All Implemented Interfaces:

IlvFlatListModel, IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvBatchable, Cloneable

public class IlvBufferFlatListModel
extends IlvDefaultFlatListModel

This class implements an IlvFlatListModel that buffers (caches) the data of a given IlvFlatListModel. It is meant to be used when the access to the original IlvFlatListModel is slow.

Changes in the underlying model are propagated to this model if the isNotifying method returns true.

Note: this model supports adding and removing objects if the underlying IlvFlatListModel is an instance of IlvDefaultFlatListModel. It supports adding and removing columns if the underlying IlvFlatListModel is an instance of IlvBasicFlatListModel.

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.chart.datax.flat.list.IlvFlatListModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvBufferFlatListModel(IlvFlatListModel model) Creates a model that is fed by and caches the data of a given IlvFlatListModel.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all the objects from the model.
Object	clone() Returns a copy of this object.
void	disconnect() Drops references to objects to help garbage collection.
void	dispose() Cleans up this model and drops references to objects to help garbage collection.
int	getSupportedEventsMask() Returns a bit mask denoting the optional kinds of events that are guaranteed to be sent by this model to the registered listeners.
void	insertColumn(int columnIndex, IlvDataColumnInfo column) Adds a column to the model at a given index.
void	insertColumn(int columnIndex, IlvDataColumnInfo column, double[] data) Adds a column with given data to the model at a given index.
void	insertColumn(int columnIndex, IlvDataColumnInfo column, Object[] data) Adds a column with given data to the model at a given index.
void	insertObject(Object object, int index) Adds an object to the model at a given index.
void	insertObject(Object object, Object[] data, int index) Adds an object to the model at a given index.
void	insertObjects(Object[] objects, int index) Adds some objects to the model at a given index.
protected boolean	isColumnComputed(int columnIndex) Returns true if setValueAtInternal and setDoubleAtInternal on a given column have no effect.
boolean	isNotifying() Returns true when this model is a dynamically updated cache of the underlying model.
void	removeColumn(int columnIndex) Removes a column from the model.
void	removeObject(Object object) Removes an object from the model.
void	removeObjects(Object[] objects, int firstIndex) Removes some consecutive objects from the model.
void	setColumnCount(int columnCount) Sets the number of columns in the model.
protected boolean	setDoubleAtInternal(double value, Object object, int columnIndex, boolean forReal) Does the equivalent of a setDoubleAt().
void	setNotifying(boolean dynamic) Determines whether this model is a dynamically updated cache of the underlying event (and therefore also sends events when the underlying model changes).
void	setObjects(Collection objects) Replaces the set of objects in the model.
protected boolean	setValueAtInternal(Object value, Object object, int columnIndex, boolean forReal) Does the equivalent of a setValueAt().

Methods inherited from class ilog.views.chart.datax.flat.list.IlvDefaultFlatListModel

addObject, addObject, createColumnStorage, getDoubleAt, getIndexOf, getObjectAt, getObjects, getValueAt, internalObjectsAdd, internalObjectsRemove, internalObjectsSet, setDoubleAt, setValueAt

Methods inherited from class ilog.views.chart.datax.flat.list.IlvBasicFlatListModel

addColumn, addColumn, addColumn, fireModelEvent, getColumn, getColumnCount, getColumns, setColumn, setColumns

Methods inherited from class ilog.views.chart.datax.flat.list.IlvAbstractFlatListModel

addFlatListModelListener, convertToDouble, endBatch, removeFlatListModelListener, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBufferFlatListModel

public IlvBufferFlatListModel(IlvFlatListModel model)

Creates a model that is fed by and caches the data of a given IlvFlatListModel.

Method Detail

setValueAtInternal

protected boolean setValueAtInternal(Object value,
                                     Object object,
                                     int columnIndex,
                                     boolean forReal)

Does the equivalent of a setValueAt(). Instead of notifying, it simply returns a boolean indicating whether notification should be done.

If forReal is false, the value is not actually set, but the method still returns the same Boolean, specifying whether the given value is different from the previous one.

Overrides:

setValueAtInternal in class IlvDefaultFlatListModel

setDoubleAtInternal

protected boolean setDoubleAtInternal(double value,
                                      Object object,
                                      int columnIndex,
                                      boolean forReal)

Does the equivalent of a setDoubleAt(). Instead of notifying, it simply returns a boolean indicating whether notification should be done.

If forReal is false, the value is not actually set, but the method still returns the same Boolean, specifying whether the given value is different from the previous one.

Overrides:

setDoubleAtInternal in class IlvDefaultFlatListModel

isColumnComputed

protected boolean isColumnComputed(int columnIndex)

Returns true if setValueAtInternal and setDoubleAtInternal on a given column have no effect.

Overrides:

isColumnComputed in class IlvDefaultFlatListModel

getSupportedEventsMask

public int getSupportedEventsMask()

Returns a bit mask denoting the optional kinds of events that are guaranteed to be sent by this model to the registered listeners.

This implementation returns BEFORE_DATA_CHANGE_MASK | BEFORE_OBJECTS_REMOVED_MASK | BEFORE_COLUMN_REMOVED_MASK. It may need to be overridden in subclasses.

Specified by:

getSupportedEventsMask in interface IlvFlatListModel

Overrides:

getSupportedEventsMask in class IlvDefaultFlatListModel

See Also:

IlvFlatListModel.BEFORE_DATA_CHANGE_MASK, IlvFlatListModel.BEFORE_OBJECTS_REMOVED_MASK, IlvFlatListModel.BEFORE_COLUMN_REMOVED_MASK

setObjects

public void setObjects(Collection objects)

Replaces the set of objects in the model.

Overrides:

setObjects in class IlvDefaultFlatListModel

insertObject

public void insertObject(Object object,
                         int index)

Adds an object to the model at a given index.

Overrides:

insertObject in class IlvDefaultFlatListModel

index - The object desired index. It must be >= 0 and <= getObjects().size().

insertObjects

public void insertObjects(Object[] objects,
                          int index)

Adds some objects to the model at a given index.

Overrides:

insertObjects in class IlvDefaultFlatListModel

index - The first index of the new object. It must be >= 0 and <= getObjects().size().

insertObject

public void insertObject(Object object,
                         Object[] data,
                         int index)

Adds an object to the model at a given index.

Overrides:

insertObject in class IlvDefaultFlatListModel

data - The initial data of this object. It must be an array of getColumnCount() elements.

index - The index of the new object. It must be >= 0 and <= getObjects().size().

removeObject

public void removeObject(Object object)

Removes an object from the model.

Overrides:

removeObject in class IlvDefaultFlatListModel

removeObjects

public void removeObjects(Object[] objects,
                          int firstIndex)

Removes some consecutive objects from the model.

Overrides:

removeObjects in class IlvDefaultFlatListModel

Parameters:

objects - The objects that were at indices firstIndex, ..., firstIndex+objects.length-1 of getObjects().iterator().

clear

public void clear()

Removes all the objects from the model.

Overrides:

clear in class IlvDefaultFlatListModel

setColumnCount

public void setColumnCount(int columnCount)

Sets the number of columns in the model. If the new size is greater than the current size, new columns are added to the end of the model. If the new size is less than the current size, all columns at index columnCount and greater are discarded.

Overrides:

setColumnCount in class IlvBasicFlatListModel

Parameters:

columnCount - The new number of columns.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column)

Adds a column to the model at a given index.

Overrides:

insertColumn in class IlvBasicFlatListModel

Parameters:

columnIndex - The new column desired index, must be >= 0 and <= getColumnCount()

column - The metainformation of this column.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column,
                         Object[] data)

Adds a column with given data to the model at a given index.

Overrides:

insertColumn in class IlvBasicFlatListModel

Parameters:

columnIndex - The new column desired index, must be >= 0 and <= getColumnCount().

column - The metainformation of this column.

data - The initial data of this column. This should be an array of at least getObjects().size() elements. Not used if the column is a computed column.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column,
                         double[] data)

Adds a column with given data to the model at a given index.

Overrides:

insertColumn in class IlvBasicFlatListModel

Parameters:

columnIndex - the new column desired index, must be >= 0 and <= getColumnCount().

column - The metainformation of this column.

data - The initial data of this column. This should be an array of at least getObjects().size() elements. Not used if the column is a computed column.

removeColumn

public void removeColumn(int columnIndex)

Removes a column from the model.

Overrides:

removeColumn in class IlvBasicFlatListModel

Parameters:

columnIndex - The column index, must be >= 0 and < getColumnCount().

isNotifying

public boolean isNotifying()

Returns true when this model is a dynamically updated cache of the underlying model. Returns false when this model is a snapshot buffer of the underlying model.

See Also:

setNotifying(boolean)

setNotifying

public void setNotifying(boolean dynamic)

Determines whether this model is a dynamically updated cache of the underlying event (and therefore also sends events when the underlying model changes).

Note: If setNotifying(true) is called, after the notification was turned off, it has the effect of bringing the entire cache up to date; this can be an expensive operation.

See Also:

isNotifying()

dispose

public void dispose()

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

Note: After calling this function, this model is no longer functional.

Overrides:

dispose in class IlvDefaultFlatListModel

disconnect

public void disconnect()

Drops references to objects to help garbage collection.

Note: After calling this function, and after some changes occurred in the underlying model or columns, this model is no longer functional.

Overrides:

disconnect in class IlvBasicFlatListModel

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvDefaultFlatListModel