ilog.views.chart.datax.adapter

Class IlvTreeSetToTreeListModel

java.lang.Object

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

ilog.views.chart.datax.adapter.IlvTreeSetToTreeListModel

All Implemented Interfaces:

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

public class IlvTreeSetToTreeListModel
extends IlvAbstractTreeListModel

This class implements an IlvTreeListModel, based on an IlvTreeSetModel and a Comparator that is used to order the children objects of any node in the tree.

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
IlvTreeSetToTreeListModel(IlvTreeSetModel model, Comparator sortCriterion) Creates an IlvTreeListModel from an IlvTreeSetModel and a Comparator.
IlvTreeSetToTreeListModel(IlvTreeSetModel model, Comparator sortCriterion, int eventsMaskHint) Creates an IlvTreeListModel from an IlvTreeSetModel and a Comparator.

Method Summary

Modifier and Type	Method and Description
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) This method is implemented through a call to the underlying model, followed by sorting.
IlvDataColumnInfo	getColumn(int columnIndex) This method is implemented through a call to the underlying model.
int	getColumnCount() This method is implemented through a call to the underlying model.
double	getDoubleAt(Object object, int columnIndex) This method is implemented through a call to the underlying model.
TreePath	getPath(Object object) This method is implemented through a call to the underlying model.
Object	getRoot() This method is implemented through a call to the underlying model.
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) This method is implemented through a call to the underlying model.
void	setDoubleAt(double value, Object object, int columnIndex) This method is implemented through a call to the underlying model.
void	setValueAt(Object value, Object object, int columnIndex) This method is implemented through a call to the underlying model.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvTreeSetToTreeListModel

public IlvTreeSetToTreeListModel(IlvTreeSetModel model,
                                 Comparator sortCriterion)

Creates an IlvTreeListModel from an IlvTreeSetModel and a Comparator.

Parameters:

model - The underlying model.

sortCriterion - Sorting criterion: null means the natural sorting order for objects implementing the Comparable interface.

See Also:

IlvColumnValueComparator

IlvTreeSetToTreeListModel

public IlvTreeSetToTreeListModel(IlvTreeSetModel model,
                                 Comparator sortCriterion,
                                 int eventsMaskHint)

Creates an IlvTreeListModel from an IlvTreeSetModel and a Comparator.

Parameters:

model - The underlying model.

sortCriterion - Sorting criterion: null means the natural sorting order for objects implementing the Comparable interface.

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

See Also:

IlvColumnValueComparator

Method Detail

getRoot

public Object getRoot()

This method is implemented through a call to the underlying model.

getChildren

public List getChildren(Object parent)

This method is implemented through a call to the underlying model, followed by sorting.

Returns:

An unmodifiable list.

getPath

public TreePath getPath(Object object)

This method is implemented through a call to the underlying model.

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.

getColumnCount

public int getColumnCount()

This method is implemented through a call to the underlying model.

getValueAt

public Object getValueAt(Object object,
                         int columnIndex)

This method is implemented through a call to the underlying model.

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.

setValueAt

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

This method is implemented through a call to the underlying model.

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.

getDoubleAt

public double getDoubleAt(Object object,
                          int columnIndex)

This method is implemented through a call to the underlying model.

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.

setDoubleAt

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

This method is implemented through a call to the underlying model.

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.

getColumn

public IlvDataColumnInfo getColumn(int columnIndex)

This method is implemented through a call to the underlying model.

Parameters:

columnIndex - The column.

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 the event mask of the underlying model, intersected with the eventsMaskHint constructor argument and with 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 IlvAbstractTreeListModel

See Also:

IlvTreeListModel.BEFORE_DATA_CHANGE_MASK, IlvTreeListModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeListModel.BEFORE_COLUMN_REMOVED_MASK

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.

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.

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvAbstractTreeListModel