ilog.views.chart.datax.tree.list

Class IlvBufferTreeListModel

java.lang.Object

ilog.views.chart.datax.tree.list.IlvAbstractTreeListModel

ilog.views.chart.datax.tree.list.IlvBasicTreeListModel

ilog.views.chart.datax.tree.list.IlvDefaultTreeListModel

ilog.views.chart.datax.tree.list.IlvBufferTreeListModel

All Implemented Interfaces:

IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvTreeModelWithColumns, IlvTreeListModel, IlvBatchable, Cloneable

public class IlvBufferTreeListModel
extends IlvDefaultTreeListModel

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

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.chart.datax.tree.list.IlvTreeListModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK, DURING_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

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

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	addChild(Object object, Object[] data, Object parent) Adds an object to the list of children of a parent object in 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	insertChild(Object object, Object[] data, Object parent, int index) Adds an object to the list of children of a parent object in the model at a given index.
void	insertChild(Object object, Object parent, int index) Adds an object to the list of children of a parent object in the model at a given index.
void	insertChildren(Object[] objects, Object parent, int index) Adds some objects to the list of children of a parent object in the model at a given index.
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.
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	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, int firstIndex) Removes some consecutive 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, List 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.list.IlvDefaultTreeListModel

addColumnStorage, clear, getChildAt, getChildren, getDoubleAt, getIndexOf, getParent, getPath, getRoot, getValueAt, removeColumnStorage, setDoubleAt, setValueAt

Methods inherited from class ilog.views.chart.datax.tree.list.IlvBasicTreeListModel

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

Methods inherited from class ilog.views.chart.datax.tree.list.IlvAbstractTreeListModel

addTreeListModelListener, convertToDouble, endBatch, postOrderIterator, preOrderIterator, removeTreeListModelListener, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBufferTreeListModel

public IlvBufferTreeListModel(IlvTreeListModel model)

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

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 IlvDefaultTreeListModel

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 IlvDefaultTreeListModel

isColumnComputed

protected boolean isColumnComputed(int columnIndex)

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

Overrides:

isColumnComputed in class IlvBasicTreeListModel

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 | DURING_OBJECTS_REMOVED_MASK | BEFORE_COLUMN_REMOVED_MASK. It may need to be overridden in subclasses.

Specified by:

getSupportedEventsMask in interface IlvTreeListModel

Overrides:

getSupportedEventsMask in class IlvDefaultTreeListModel

See Also:

IlvTreeListModel.BEFORE_DATA_CHANGE_MASK, IlvTreeListModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeListModel.BEFORE_COLUMN_REMOVED_MASK

setRoot

public void setRoot(Object object)

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

Overrides:

setRoot in class IlvDefaultTreeListModel

Parameters:

object - the new root, or null

setChildren

public void setChildren(Object parent,
                        List newChildren)

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

Overrides:

setChildren in class IlvDefaultTreeListModel

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 IlvDefaultTreeListModel

Parameters:

object - the child object to add

parent - specify where to insert the object

addChild

public void addChild(Object object,
                     Object[] data,
                     Object parent)

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

Overrides:

addChild in class IlvDefaultTreeListModel

Parameters:

object - object the child object to add

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

parent - specify where to insert the object

Since:

JViews 8.0

insertChild

public void insertChild(Object object,
                        Object parent,
                        int index)

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

Overrides:

insertChild in class IlvDefaultTreeListModel

Parameters:

object - the child object to add

parent - specify where to insert the object

index - the new object's desired index, must be >= 0 and <= parent.getChildren().size()

insertChild

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

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

Overrides:

insertChild in class IlvDefaultTreeListModel

Parameters:

object - the child object to add

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

parent - specify where to insert the object

index - the new object's desired index, must be >= 0 and <= parent.getChildren().size()

Since:

JViews 8.0

insertChildren

public void insertChildren(Object[] objects,
                           Object parent,
                           int index)

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

Overrides:

insertChildren in class IlvDefaultTreeListModel

Parameters:

objects - the objects to add

parent - specify where to insert the object

index - the first new object's desired index, must be >= 0 and <= parent.getChildren().size()

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 IlvDefaultTreeListModel

removeChildren

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

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

Overrides:

removeChildren in class IlvDefaultTreeListModel

Parameters:

objects - the objects that were at indices firstIndex, ..., firstIndex+objects.length-1 of getChildren(parent).iterator()

parent - where to find the objects

firstIndex - object to remove must be after

removeAllChildren

public void removeAllChildren(Object parent)

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

Overrides:

removeAllChildren in class IlvDefaultTreeListModel

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 IlvBasicTreeListModel

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 IlvBasicTreeListModel

Parameters:

columnIndex - The new column 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 IlvBasicTreeListModel

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 IlvBasicTreeListModel

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 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 IlvDefaultTreeListModel

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 IlvBasicTreeListModel

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvDefaultTreeListModel