ilog.views.chart.datax.flat.set

Class IlvBufferFlatSetModel

java.lang.Object

ilog.views.chart.datax.flat.set.IlvAbstractFlatSetModel

ilog.views.chart.datax.flat.set.IlvBasicFlatSetModel

ilog.views.chart.datax.flat.set.IlvDefaultFlatSetModel

ilog.views.chart.datax.flat.set.IlvBufferFlatSetModel

All Implemented Interfaces:

IlvFlatSetModel, IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvBatchable, Cloneable

public class IlvBufferFlatSetModel
extends IlvDefaultFlatSetModel

This class implements an IlvFlatSetModel that buffers (caches) the data of a given IlvFlatSetModel. It is meant to be used when the access to the original IlvFlatSetModel 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 IlvFlatSetModel is an instance of IlvDefaultFlatSetModel. It supports adding and removing columns if the underlying IlvFlatSetModel is an instance of IlvBasicFlatSetModel.

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.chart.datax.flat.set.IlvFlatSetModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addObject(Object object) Adds an object to the model.
void	addObject(Object object, Object[] data) Adds an object to the model.
void	addObjects(Object[] objects) Adds some objects to the model.
void	clear() Removes all 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.
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) Removes some 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.set.IlvDefaultFlatSetModel

getDoubleAt, getObjects, getValueAt, setDoubleAt, setValueAt

Methods inherited from class ilog.views.chart.datax.flat.set.IlvBasicFlatSetModel

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

Methods inherited from class ilog.views.chart.datax.flat.set.IlvAbstractFlatSetModel

addFlatSetModelListener, convertToDouble, endBatch, removeFlatSetModelListener, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBufferFlatSetModel

public IlvBufferFlatSetModel(IlvFlatSetModel model)

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

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 IlvDefaultFlatSetModel

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 IlvDefaultFlatSetModel

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 IlvFlatSetModel

Overrides:

getSupportedEventsMask in class IlvDefaultFlatSetModel

See Also:

IlvFlatSetModel.BEFORE_DATA_CHANGE_MASK, IlvFlatSetModel.BEFORE_OBJECTS_REMOVED_MASK, IlvFlatSetModel.BEFORE_COLUMN_REMOVED_MASK

setObjects

public void setObjects(Collection objects)

Replaces the set of objects in the model.

Overrides:

setObjects in class IlvDefaultFlatSetModel

addObject

public void addObject(Object object)

Adds an object to the model.

Overrides:

addObject in class IlvDefaultFlatSetModel

addObjects

public void addObjects(Object[] objects)

Adds some objects to the model.

Overrides:

addObjects in class IlvDefaultFlatSetModel

addObject

public void addObject(Object object,
                      Object[] data)

Adds an object to the model.

Overrides:

addObject in class IlvDefaultFlatSetModel

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

removeObject

public void removeObject(Object object)

Removes an object from the model.

Overrides:

removeObject in class IlvDefaultFlatSetModel

removeObjects

public void removeObjects(Object[] objects)

Removes some objects from the model.

Overrides:

removeObjects in class IlvDefaultFlatSetModel

clear

public void clear()

Removes all objects from the model.

Overrides:

clear in class IlvDefaultFlatSetModel

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 IlvBasicFlatSetModel

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 IlvBasicFlatSetModel

Parameters:

columnIndex - The new column desired index. It 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 IlvBasicFlatSetModel

Parameters:

columnIndex - The new column desired index. It 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 IlvBasicFlatSetModel

Parameters:

columnIndex - The new column desired index. It 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 IlvBasicFlatSetModel

Parameters:

columnIndex - The column index. It 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 IlvDefaultFlatSetModel

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 IlvBasicFlatSetModel

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvDefaultFlatSetModel