ilog.views.chart.datax.tree.list

Class IlvPropertyBasedTreeListModel

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.IlvPropertyBasedTreeListModel

All Implemented Interfaces:

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

public class IlvPropertyBasedTreeListModel
extends IlvDefaultTreeListModel

This class is an implementation of the IlvTreeListModel interface which stores the objects and the column info objects locally in this instance. The values are assumed to be properties of the objects.

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
IlvPropertyBasedTreeListModel(IlvPropertyConnector propaccess) Creates an empty model, with zero columns.
IlvPropertyBasedTreeListModel(IlvPropertyConnector propaccess, IlvDataColumnInfo[] columns) Creates an empty model, with the given columns.

Method Summary

Modifier and Type	Method and Description
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.
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.
double	getDoubleAt(Object object, int columnIndex) Returns the value for the attribute number columnIndex in the given object.
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.
protected void	removeColumnStorage(int columnIndex, int removedColumnCount) Removes storage for columns that have been dropped.
protected boolean	setDoubleAtInternal(double value, Object object, int columnIndex, boolean forReal) Does the equivalent of a setDoubleAt().
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

addChild, clear, getChildAt, getChildren, getIndexOf, getParent, getPath, getRoot, insertChild, insertChildren, removeAllChildren, removeChild, removeChildren, setChildren, setDoubleAt, setRoot, setValueAt

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

addColumn, addColumn, 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

IlvPropertyBasedTreeListModel

public IlvPropertyBasedTreeListModel(IlvPropertyConnector propaccess)

Creates an empty model, with zero columns.

IlvPropertyBasedTreeListModel

public IlvPropertyBasedTreeListModel(IlvPropertyConnector propaccess,
                                     IlvDataColumnInfo[] columns)

Creates an empty model, with the given columns.

Method Detail

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

Overrides:

getValueAt in class IlvDefaultTreeListModel

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

Overrides:

getDoubleAt in class IlvDefaultTreeListModel

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.

If you override this method, you also have to override the methods addChild(Object, Object[], Object) and insertChild(Object, Object[], Object, int).

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

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

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[] 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

addColumnStorage

protected void addColumnStorage(int columnIndex,
                                int insertedColumnCount)

Adds storage for new columns.

Overrides:

addColumnStorage in class IlvDefaultTreeListModel

removeColumnStorage

protected void removeColumnStorage(int columnIndex,
                                   int removedColumnCount)

Removes storage for columns that have been dropped.

Overrides:

removeColumnStorage in class IlvDefaultTreeListModel

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 columns or in the contained objects, 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