ilog.views.chart.datax.tree.set

Class IlvBufferTreeSetModel

java.lang.Object

ilog.views.chart.datax.tree.set.IlvAbstractTreeSetModel

ilog.views.chart.datax.tree.set.IlvBasicTreeSetModel

ilog.views.chart.datax.tree.set.IlvDefaultTreeSetModel

ilog.views.chart.datax.tree.set.IlvBufferTreeSetModel

All Implemented Interfaces:

IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvTreeModelWithColumns, IlvTreeSetModel, IlvBatchable, Cloneable

public class IlvBufferTreeSetModel
extends IlvDefaultTreeSetModel

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

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

Note: This model supports adding and removing objects if and only if the underlying IlvTreeSetModel is an instance of IlvDefaultTreeSetModel. It supports adding and removing columns if and only if the underlying IlvTreeSetModel is an instance of IlvBasicTreeSetModel.

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.chart.datax.tree.set.IlvTreeSetModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK, DURING_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addChild(Object object, Object parent) Adds an object to the list of children of a parent object in the model.
void	addChildren(Object[] objects, Object parent) Adds some objects to the list of children of a parent object in the model at a given index.
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, Map 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	removeAllChildren(Object parent) Removes all children objects of a parent object in the model.
void	removeChild(Object object, Object parent) Removes an object from the list of children of a parent object in the model.
void	removeChildren(Object[] objects, Object parent) Removes some children of a common parent object, and their subtrees, from the model.
void	removeColumn(int columnIndex) Removes a column from the model.
void	setChildren(Object parent, Collection newChildren) Replaces the set of children of a given object in 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	setRoot(Object object) Changes the root object of 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.tree.set.IlvDefaultTreeSetModel

clear, getChildren, getDoubleAt, getParent, getPath, getRoot, getValueAt, setDoubleAt, setValueAt

Methods inherited from class ilog.views.chart.datax.tree.set.IlvBasicTreeSetModel

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

Methods inherited from class ilog.views.chart.datax.tree.set.IlvAbstractTreeSetModel

addTreeSetModelListener, convertToDouble, endBatch, postOrderIterator, preOrderIterator, removeTreeSetModelListener, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBufferTreeSetModel

public IlvBufferTreeSetModel(IlvTreeSetModel model)

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

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, indicating whether the given value is different from the previous one.

Overrides:

setValueAtInternal in class IlvDefaultTreeSetModel

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, indicating whether the given value is different from the previous one.

Overrides:

setDoubleAtInternal in class IlvDefaultTreeSetModel

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 IlvTreeSetModel

Overrides:

getSupportedEventsMask in class IlvDefaultTreeSetModel

See Also:

IlvTreeSetModel.BEFORE_DATA_CHANGE_MASK, IlvTreeSetModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeSetModel.BEFORE_COLUMN_REMOVED_MASK

setRoot

public void setRoot(Object object)

Changes the root object of the model. Note: The root children, grand-children and so on must be added afterwards, using the setChildren() method. Note: All attribute values are lost.

Overrides:

setRoot in class IlvDefaultTreeSetModel

Parameters:

object - The new root, or null.

setChildren

public void setChildren(Object parent,
                        Collection newChildren)

Replaces the set of children of a given object in the model. Note: The grand-children and so on must be added afterwards, using the setChildren() method. Note: All attribute values of children, grand-children and so on are lost.

Overrides:

setChildren in class IlvDefaultTreeSetModel

addChild

public void addChild(Object object,
                     Object parent)

Adds an object to the list of children of a parent object in the model.

Overrides:

addChild in class IlvDefaultTreeSetModel

addChildren

public void addChildren(Object[] objects,
                        Object parent)

Adds some objects to the list of children of a parent object in the model at a given index.

Overrides:

addChildren in class IlvDefaultTreeSetModel

removeChild

public void removeChild(Object object,
                        Object parent)

Removes an object from the list of children of a parent object in the model.

Overrides:

removeChild in class IlvDefaultTreeSetModel

removeChildren

public void removeChildren(Object[] objects,
                           Object parent)

Removes some children of a common parent object, and their subtrees, from the model.

Overrides:

removeChildren in class IlvDefaultTreeSetModel

Parameters:

objects - Some objects that were in getChildren(parent).

removeAllChildren

public void removeAllChildren(Object parent)

Removes all children objects of a parent object in the model.

Overrides:

removeAllChildren in class IlvDefaultTreeSetModel

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 IlvBasicTreeSetModel

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 IlvBasicTreeSetModel

Parameters:

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

column - The meta information of this column.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column,
                         Map data)

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

Overrides:

insertColumn in class IlvBasicTreeSetModel

Parameters:

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

column - The meta information of this column.

data - The initial data of this column. This should be a map that assigns a value to every object in this model.

removeColumn

public void removeColumn(int columnIndex)

Removes a column from the model.

Overrides:

removeColumn in class IlvBasicTreeSetModel

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: The call of setNotifying(true) after the notification was turned off 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 IlvDefaultTreeSetModel

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 IlvBasicTreeSetModel

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvDefaultTreeSetModel