ilog.views.chart.datax.adapter

Class IlvTreeToTreeListModel

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.adapter.IlvTreeToTreeListModel

All Implemented Interfaces:

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

public class IlvTreeToTreeListModel
extends IlvDefaultTreeListModel

This class implements an IlvTreeListModel, based on a Swing TreeModel.

Note: This model does not support adding and removing objects. You should use the underlying TreeModel for this purpose (assuming it is an instance of DefaultTreeModel and its nodes are instances of MutableTreeNode).

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
IlvTreeToTreeListModel(TreeModel model, IlvPropertyConnector propaccess) Creates a model backed by a given TreeModel, with zero columns.
IlvTreeToTreeListModel(TreeModel model, IlvPropertyConnector propaccess, IlvDataColumnInfo[] columns) Creates a model backed by a given TreeModel, with the given columns.
IlvTreeToTreeListModel(TreeModel model, IlvPropertyConnector propaccess, IlvDataColumnInfo[] columns, int eventsMaskHint) Creates a model backed by a given TreeModel, with the given columns.
IlvTreeToTreeListModel(TreeModel model, IlvPropertyConnector propaccess, int eventsMaskHint) Creates a model backed by a given TreeModel, with zero columns.

Method Summary

Modifier and Type	Method and Description
void	addChild(Object object, Object parent) This method throws an UnsupportedOperationException.
void	addChild(Object object, Object[] data, Object parent) This method throws an UnsupportedOperationException.
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.
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.
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) This method throws an UnsupportedOperationException.
void	insertChild(Object object, Object parent, int index) This method throws an UnsupportedOperationException.
void	insertChildren(Object[] objects, Object parent, int index) This method throws an UnsupportedOperationException.
protected boolean	isColumnComputed(int columnIndex) Returns true if setValueAtInternal and setDoubleAtInternal have no effect on a given column.
void	removeAllChildren(Object parent) This method throws an UnsupportedOperationException.
void	removeChild(Object object, Object parent) This method throws an UnsupportedOperationException.
void	removeChildren(Object[] objects, Object parent, int firstIndex) This method throws an UnsupportedOperationException.
protected void	removeColumnStorage(int columnIndex, int removedColumnCount) Removes storage for columns that have been dropped.
void	setChildren(Object parent, List newChildren) This method throws an UnsupportedOperationException.
protected boolean	setDoubleAtInternal(double value, Object object, int columnIndex, boolean forReal) Does the equivalent of a setDoubleAt().
void	setRoot(Object object) This method throws an UnsupportedOperationException.
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

clear, getChildAt, getIndexOf, setDoubleAt, setValueAt

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

addColumn, addColumn, fireModelEvent, getColumn, getColumnCount, getColumns, insertColumn, insertColumn, 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

IlvTreeToTreeListModel

public IlvTreeToTreeListModel(TreeModel model,
                              IlvPropertyConnector propaccess)

Creates a model backed by a given TreeModel, with zero columns.

Parameters:

model - A TreeModel.

propaccess - The way to access the properties of the model nodes.

IlvTreeToTreeListModel

public IlvTreeToTreeListModel(TreeModel model,
                              IlvPropertyConnector propaccess,
                              int eventsMaskHint)

Creates a model backed by a given TreeModel, with zero columns.

Parameters:

model - A TreeModel.

propaccess - The way to access the properties of the model nodes.

eventsMaskHint - Desired events mask. This is just a hint; there is no guarantee that the event types designated by the mask are supported by this model.

Since:

JViews 8.0

IlvTreeToTreeListModel

public IlvTreeToTreeListModel(TreeModel model,
                              IlvPropertyConnector propaccess,
                              IlvDataColumnInfo[] columns)

Creates a model backed by a given TreeModel, with the given columns.

Parameters:

model - A TreeModel.

propaccess - The way to access the properties of the model nodes.

columns - The initial list of columns.

IlvTreeToTreeListModel

public IlvTreeToTreeListModel(TreeModel model,
                              IlvPropertyConnector propaccess,
                              IlvDataColumnInfo[] columns,
                              int eventsMaskHint)

Creates a model backed by a given TreeModel, with the given columns.

Parameters:

model - A TreeModel.

propaccess - The way to access the properties of the model nodes.

columns - The initial list of columns.

eventsMaskHint - Desired events mask. This is just a hint; there is no guarantee that the event types designated by the mask are supported by this model.

Since:

JViews 8.0

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

Overrides:

getRoot in class IlvDefaultTreeListModel

getChildren

public List getChildren(Object parent)

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

Specified by:

getChildren in interface IlvTreeListModel

Overrides:

getChildren in class IlvDefaultTreeListModel

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 IlvDefaultTreeListModel

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

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.

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 have no effect on a given column.

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_OBJECTS_REMOVED_MASK | DURING_OBJECTS_REMOVED_MASK | BEFORE_COLUMN_REMOVED_MASK, intersected with the eventsMaskHint constructor argument. 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

getParent

public Object getParent(Object object)

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

Overrides:

getParent in class IlvDefaultTreeListModel

setRoot

public void setRoot(Object object)

This method throws an UnsupportedOperationException.

Overrides:

setRoot in class IlvDefaultTreeListModel

Parameters:

object - the new root, or null

setChildren

public void setChildren(Object parent,
                        List newChildren)

This method throws an UnsupportedOperationException.

Overrides:

setChildren in class IlvDefaultTreeListModel

addChild

public void addChild(Object object,
                     Object parent)

This method throws an UnsupportedOperationException.

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)

This method throws an UnsupportedOperationException.

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)

This method throws an UnsupportedOperationException.

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)

This method throws an UnsupportedOperationException.

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)

This method throws an UnsupportedOperationException.

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)

This method throws an UnsupportedOperationException.

Overrides:

removeChild in class IlvDefaultTreeListModel

removeChildren

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

This method throws an UnsupportedOperationException.

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)

This method throws an UnsupportedOperationException.

Overrides:

removeAllChildren in class IlvDefaultTreeListModel

addColumnStorage

protected void addColumnStorage(int columnIndex,
                                int insertedColumnCount)

Description copied from class: IlvDefaultTreeListModel

Adds storage for new columns.

Overrides:

addColumnStorage in class IlvDefaultTreeListModel

removeColumnStorage

protected void removeColumnStorage(int columnIndex,
                                   int removedColumnCount)

Description copied from class: IlvDefaultTreeListModel

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