ilog.views.chart.datax.tree.list

Class IlvDefaultTreeListModel

java.lang.Object

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

IlvBufferTreeListModel, IlvPropertyBasedTreeListModel, IlvTreeTableToTreeListModel, IlvTreeToTreeListModel

public class IlvDefaultTreeListModel
extends IlvBasicTreeListModel
implements Cloneable

This class is the default implementation of the IlvTreeListModel interface.

It stores the objects, the data values and the column info objects locally in this instance.

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
IlvDefaultTreeListModel() Creates an empty model with no objects and zero columns.
IlvDefaultTreeListModel(IlvDataColumnInfo[] columns) Creates an empty model with no objects and the given columns.
IlvDefaultTreeListModel(int numColumns) Creates an empty model with no objects and the given number of columns.
IlvDefaultTreeListModel(Object root, Collection objects, IlvDataColumnInfo[] columns) Creates a model with the given root, the given first-level objects and the given columns.

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.
protected void	addColumnStorage(int columnIndex, int insertedColumnCount) Adds storage for new columns.
void	clear() Removes all objects from the model.
Object	clone() Returns a copy of this object.
void	dispose() Cleans up this model and drops references to objects to help garbage collection.
Object	getChildAt(Object parent, int index) Returns the object at a given index in getChildren(parent).
List	getChildren(Object parent) Returns the children objects of a given object in this model.
double	getDoubleAt(Object object, int columnIndex) Returns the value for the attribute number columnIndex in the given object.
int	getIndexOf(Object parent, Object object) Returns the index of a model object in its parent's children list.
Object	getParent(Object object) Returns the parent object of a given object, or null if it is the root.
TreePath	getPath(Object object) Returns the path from the root to the given object.
Object	getRoot() Returns the root object in this model, or null if the model is empty.
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.
Object	getValueAt(Object object, int columnIndex) Returns the value for the attribute number columnIndex in the given object.
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	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.
protected void	removeColumnStorage(int columnIndex, int removedColumnCount) Removes storage for columns that have been dropped.
void	setChildren(Object parent, List newChildren) Replaces the set of children of a given object in the model.
void	setDoubleAt(double value, Object object, int columnIndex) Sets the value for the attribute number columnIndex in the given object to the given value.
protected boolean	setDoubleAtInternal(double value, Object object, int columnIndex, boolean forReal) Does a setDoubleAt(), except instead of notifying it simply returns a boolean indicating whether notification should be done.
void	setRoot(Object object) Changes the root object of the model.
void	setValueAt(Object value, Object object, int columnIndex) Sets the value for the attribute number columnIndex in the given object to the given value.
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.IlvBasicTreeListModel

addColumn, addColumn, disconnect, fireModelEvent, getColumn, getColumnCount, getColumns, insertColumn, insertColumn, isColumnComputed, removeColumn, setColumn, setColumnCount, 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

IlvDefaultTreeListModel

public IlvDefaultTreeListModel()

Creates an empty model with no objects and zero columns.

IlvDefaultTreeListModel

public IlvDefaultTreeListModel(int numColumns)

Creates an empty model with no objects and the given number of columns.

IlvDefaultTreeListModel

public IlvDefaultTreeListModel(IlvDataColumnInfo[] columns)

Creates an empty model with no objects and the given columns.

IlvDefaultTreeListModel

public IlvDefaultTreeListModel(Object root,
                               Collection objects,
                               IlvDataColumnInfo[] columns)

Creates a model with the given root, the given first-level objects and the given columns.

Method Detail

getRoot

public Object getRoot()

Returns the root object in this model, or null if the model is empty.

Specified by:

getRoot in interface IlvTreeListModel

getChildren

public List getChildren(Object parent)

Returns the children objects of a given object in this model.

Specified by:

getChildren in interface IlvTreeListModel

Returns:

An unmodifiable list.

getPath

public TreePath getPath(Object object)

Returns the path from the root to the given object.

Specified by:

getPath in interface IlvTreeListModel

Overrides:

getPath in class IlvAbstractTreeListModel

Parameters:

object - An object in the model.

Returns:

A TreePath whose first component is getRoot() and whose last component is the given object.

getValueAt

public Object getValueAt(Object object,
                         int columnIndex)

Returns the value for the attribute number columnIndex in the given object.

Specified by:

getValueAt in interface IlvObjectModelWithColumns

Specified by:

getValueAt in interface IlvTreeListModel

Parameters:

object - The object (row) in which the value is to be looked up.

columnIndex - The column denoting the attribute whose value is to be looked up.

getDoubleAt

public double getDoubleAt(Object object,
                          int columnIndex)

Returns the value for the attribute number columnIndex in the given object.

This method should only be used for columns whose type is Double. For other types of columns, this method will do a conversion from the object returned by getValueAt, which may be inefficient or inaccurate or raise exceptions.

Specified by:

getDoubleAt in interface IlvObjectModelWithColumns

Specified by:

getDoubleAt in interface IlvTreeListModel

Parameters:

object - The object (row) in which the value is to be looked up.

columnIndex - The column denoting the attribute whose value is to be looked up.

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.

setDoubleAtInternal

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

Does a setDoubleAt(), except 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, telling whether the given value is different from the previous one.

setValueAt

public void setValueAt(Object value,
                       Object object,
                       int columnIndex)

Sets the value for the attribute number columnIndex in the given object to the given value.

Specified by:

setValueAt in interface IlvObjectModelWithColumns

Specified by:

setValueAt in interface IlvTreeListModel

Parameters:

value - The new value.

object - The object (row) in which the value is to be changed.

columnIndex - The column denoting the attribute whose value is to be changed.

setDoubleAt

public void setDoubleAt(double value,
                        Object object,
                        int columnIndex)

Sets the value for the attribute number columnIndex in the given object to the given value.

This method should only be used for columns whose type is Double. For other types of columns, this method will do a conversion to the column type, which may be inefficient or inaccurate or raise exceptions.

Specified by:

setDoubleAt in interface IlvObjectModelWithColumns

Specified by:

setDoubleAt in interface IlvTreeListModel

Parameters:

value - The new value.

object - The object (row) in which the value is to be changed.

columnIndex - The column denoting the attribute whose value is to be changed.

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 IlvBasicTreeListModel

See Also:

IlvTreeListModel.BEFORE_DATA_CHANGE_MASK, IlvTreeListModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeListModel.BEFORE_COLUMN_REMOVED_MASK

getParent

public Object getParent(Object object)

Returns the parent object of a given object, or null if it is the root.

getChildAt

public Object getChildAt(Object parent,
                         int index)

Returns the object at a given index in getChildren(parent).

Parameters:

parent - the parent object

index - the index of the requested model object

Throws:

IllegalArgumentException - if the index is out of range

getIndexOf

public int getIndexOf(Object parent,
                      Object object)

Returns the index of a model object in its parent's children list.

Parameters:

parent - the parent object

object - the model object for which the index is requested

Throws:

IllegalArgumentException - if the object is not contained in the model

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.

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.

addChild

public void addChild(Object object,
                     Object parent)

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

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.

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.

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.

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.

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.

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.

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.

clear

public void clear()

Removes all objects from the model.

addColumnStorage

protected void addColumnStorage(int columnIndex,
                                int insertedColumnCount)

Adds storage for new columns.

Overrides:

addColumnStorage in class IlvBasicTreeListModel

removeColumnStorage

protected void removeColumnStorage(int columnIndex,
                                   int removedColumnCount)

Removes storage for columns that have been dropped.

Overrides:

removeColumnStorage in class IlvBasicTreeListModel

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 IlvBasicTreeListModel

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvBasicTreeListModel