IlvDefaultTreeSetModel (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.chart.datax.tree.set.IlvAbstractTreeSetModel
- - ilog.views.chart.datax.tree.set.IlvBasicTreeSetModel
  - - ilog.views.chart.datax.tree.set.IlvDefaultTreeSetModel

All Implemented Interfaces:

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

Direct Known Subclasses:

IlvBufferTreeSetModel, IlvPropertyBasedTreeSetModel
```
public class IlvDefaultTreeSetModel
extends IlvBasicTreeSetModel
implements Cloneable
```
This class is the default implementation of the IlvTreeSetModel 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.set.IlvTreeSetModel
  BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK, DURING_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors
Constructor and Description
`IlvDefaultTreeSetModel()` Creates an empty model with no objects and zero columns.
`IlvDefaultTreeSetModel(IlvDataColumnInfo[] columns)` Creates an empty model with no objects and the given columns.
`IlvDefaultTreeSetModel(int numColumns)` Creates an empty model with no objects and the given number of columns.
`IlvDefaultTreeSetModel(Object root, Collection objects, IlvDataColumnInfo[] columns)` Creates a model with the given root, the given first-level objects and the given columns.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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.
`Collection`	`getChildren(Object parent)` Returns the set of 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.
`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`	`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`	`setChildren(Object parent, Collection 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 the equivalent of a `setDoubleAt()`.
`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.set.IlvBasicTreeSetModel
addColumn, addColumn, disconnect, fireModelEvent, getColumn, getColumnCount, getColumns, insertColumn, insertColumn, removeColumn, setColumn, setColumnCount, 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
  - IlvDefaultTreeSetModel
```
public IlvDefaultTreeSetModel()
```
    Creates an empty model with no objects and zero columns.
  - IlvDefaultTreeSetModel
```
public IlvDefaultTreeSetModel(int numColumns)
```
    Creates an empty model with no objects and the given number of columns.
  - IlvDefaultTreeSetModel
```
public IlvDefaultTreeSetModel(IlvDataColumnInfo[] columns)
```
    Creates an empty model with no objects and the given columns.
  - IlvDefaultTreeSetModel
```
public IlvDefaultTreeSetModel(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 IlvTreeSetModel
  - getChildren
```
public Collection getChildren(Object parent)
```
    Returns the set of children objects of a given object in this model.
    
    Specified by:
    
    getChildren in interface IlvTreeSetModel
    
    Returns:
    
    A collection that cannot be modified.
  - getPath
```
public TreePath getPath(Object object)
```
    Returns the path from the root to the given object.
    
    Specified by:
    
    getPath in interface IlvTreeSetModel
    
    Overrides:
    
    getPath in class IlvAbstractTreeSetModel
    
    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 IlvTreeSetModel
    
    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 IlvTreeSetModel
    
    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, specifying whether the given value is different from the previous one.
  - 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.
  - 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 IlvTreeSetModel
    
    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 IlvTreeSetModel
    
    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 | BEFORE_COLUMN_REMOVED_MASK. It may need to be overridden in subclasses.
    
    Specified by:
    
    getSupportedEventsMask in interface IlvTreeSetModel
    
    Overrides:
    
    getSupportedEventsMask in class IlvBasicTreeSetModel
    
    See Also:
    
    IlvTreeSetModel.BEFORE_DATA_CHANGE_MASK, IlvTreeSetModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeSetModel.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.
  - 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.
    
    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.
  - addChild
```
public void addChild(Object object,
                     Object parent)
```
    Adds an object to the list of children of a parent object in the model.
  - 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.
  - 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)
```
    Removes some children of a common parent object, and their subtrees, from the model.
    
    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.
  - clear
```
public void clear()
```
    Removes all objects from the model.
  - 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 IlvBasicTreeSetModel
  - clone
```
public Object clone()
```
    Returns a copy of this object.
    
    Overrides:
    
    clone in class IlvBasicTreeSetModel

Class IlvDefaultTreeSetModel

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

IlvDefaultTreeSetModel

IlvDefaultTreeSetModel

IlvDefaultTreeSetModel

IlvDefaultTreeSetModel

Method Detail

getRoot

getChildren

getPath

getValueAt

getDoubleAt

setValueAtInternal

setDoubleAtInternal

setValueAt

setDoubleAt

getSupportedEventsMask

getParent

setRoot

setChildren

addChild

addChildren

removeChild

removeChildren

removeAllChildren

clear

dispose

clone