ilog.views.chart.datax.adapter

Class IlvSubTreeListModel

java.lang.Object

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

ilog.views.chart.datax.tree.list.IlvFilterTreeListModel

ilog.views.chart.datax.adapter.IlvSubTreeListModel

All Implemented Interfaces:

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

public class IlvSubTreeListModel
extends IlvFilterTreeListModel

This class represents a subtree of a given IlvTreeListModel. It is specified through a node of the given model called the "focus"; this node becomes the root of this model. If the focus node is not contained in the original model, this model is empty.

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
IlvSubTreeListModel(IlvTreeListModel model, Object focus) Creates a subtree model.
IlvSubTreeListModel(IlvTreeListModel model, Object focus, int eventsMaskHint) Creates a subtree model.

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.
Object	getFocus() Returns the focus.
TreePath	getPath(Object object) Returns the path from the root to the given object.
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.
void	noteBeforeColumnRemoved(int column, IlvDataColumnInfo columnInfo) Reacts on a BEFORE_COLUMN_REMOVED event from the underlying model.
void	noteBeforeDataChange(Object object, TreePath objectPath, boolean recursive, int column) Reacts on a BEFORE_DATA_CHANGE event from the underlying model.
void	noteBeforeObjectsRemoved(Object parent, TreePath parentPath, Object[] objects, int firstIndex) Reacts on a BEFORE_OBJECTS_REMOVED event from the underlying model.
void	noteDataChanged(Object object, TreePath objectPath, boolean recursive, int column) Reacts on a DATA_CHANGED event from the underlying model.
void	noteDuringObjectsRemoved(Object parent, TreePath parentPath, Object[] objects, int firstIndex) Reacts on a DURING_OBJECTS_REMOVED event from the underlying model.
void	noteObjectsChanged(Object parent, TreePath parentPath, Object[] oldObjects, Object[] newObjects, int firstIndex) Reacts on a OBJECTS_CHANGED event from the underlying model.

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

fireBeforeColumnRemoved, fireBeforeDataChange, fireBeforeObjectsRemoved, fireColumnAdded, fireColumnPropertyChanged, fireColumnRemoved, fireDataChanged, fireDuringObjectsRemoved, fireObjectsChanged, getChildren, getColumn, getColumnCount, getDoubleAt, getFilteredModel, getValueAt, noteColumnAdded, noteColumnPropertyChanged, noteColumnRemoved, setDoubleAt, setFilteredModel, setValueAt

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

IlvSubTreeListModel

public IlvSubTreeListModel(IlvTreeListModel model,
                           Object focus)

Creates a subtree model.

Parameters:

model - The original model.

focus - The root of the subtree.

IlvSubTreeListModel

public IlvSubTreeListModel(IlvTreeListModel model,
                           Object focus,
                           int eventsMaskHint)

Creates a subtree model.

Parameters:

model - The original model.

focus - The root of the subtree.

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()

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

Specified by:

getRoot in interface IlvTreeListModel

Overrides:

getRoot in class IlvFilterTreeListModel

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 IlvFilterTreeListModel

Parameters:

object - An object in the model.

Returns:

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

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 IlvFilterTreeListModel

See Also:

IlvTreeListModel.BEFORE_DATA_CHANGE_MASK, IlvTreeListModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeListModel.BEFORE_COLUMN_REMOVED_MASK

noteDataChanged

public void noteDataChanged(Object object,
                            TreePath objectPath,
                            boolean recursive,
                            int column)

Reacts on a DATA_CHANGED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireDataChanged.

Overrides:

noteDataChanged in class IlvFilterTreeListModel

Parameters:

object - The object whose attributes have changed.

objectPath - The path from the root to the object.

recursive - true if the attributes of the entire subtree have changed, false for a change affecting only the single object.

column - Column that changed, or -1 for all columns.

noteBeforeDataChange

public void noteBeforeDataChange(Object object,
                                 TreePath objectPath,
                                 boolean recursive,
                                 int column)

Reacts on a BEFORE_DATA_CHANGE event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireBeforeDataChange.

Overrides:

noteBeforeDataChange in class IlvFilterTreeListModel

Parameters:

object - The object whose attributes will change.

objectPath - The path from the root to the object.

recursive - true if the attributes of the entire subtree will change, false for a change affecting only the single object.

column - Column that will change, or -1 for all columns.

noteObjectsChanged

public void noteObjectsChanged(Object parent,
                               TreePath parentPath,
                               Object[] oldObjects,
                               Object[] newObjects,
                               int firstIndex)

Reacts on a OBJECTS_CHANGED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireObjectsChanged.

Overrides:

noteObjectsChanged in class IlvFilterTreeListModel

Parameters:

parent - The parent object of the set of objects that were changed, added or removed, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

oldObjects - The set of objects that was in place before the change (together with their entire subtrees), in the same order as in source.getChildren(parent).

newObjects - The set of objects that is in place after the change (together with their entire subtrees), in the same order as in source.getChildren(parent).

firstIndex - The index of the first object (index after adding or before removing the objects) in source.getChildren(parent). The second object is/was at firstIndex+1, and so on.

noteBeforeObjectsRemoved

public void noteBeforeObjectsRemoved(Object parent,
                                     TreePath parentPath,
                                     Object[] objects,
                                     int firstIndex)

Reacts on a BEFORE_OBJECTS_REMOVED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireBeforeObjectsRemoved.

Overrides:

noteBeforeObjectsRemoved in class IlvFilterTreeListModel

Parameters:

parent - The parent object of the set of objects that will be changed or removed, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

objects - The set of objects that are in place before the change (together with their entire subtrees), in the same order as in source.getChildren(parent).

firstIndex - The index of the first object (index before removing the objects) in source.getChildren(parent). The second object is at firstIndex+1, and so on.

noteDuringObjectsRemoved

public void noteDuringObjectsRemoved(Object parent,
                                     TreePath parentPath,
                                     Object[] objects,
                                     int firstIndex)

Reacts on a DURING_OBJECTS_REMOVED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireDuringObjectsRemoved.

Overrides:

noteDuringObjectsRemoved in class IlvFilterTreeListModel

Parameters:

parent - The parent object of the set of objects that will be changed or removed, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

objects - The set of objects that are in place before the change (together with their entire subtrees), in the same order as in source.getChildren(parent).

firstIndex - The index of the first object (index before removing the objects) in source.getChildren(parent). The second object is at firstIndex+1, and so on.

noteBeforeColumnRemoved

public void noteBeforeColumnRemoved(int column,
                                    IlvDataColumnInfo columnInfo)

Reacts on a BEFORE_COLUMN_REMOVED event from the underlying model.

This method is meant to be overridden in subclasses. The default implementation here calls fireBeforeColumnRemoved.

Overrides:

noteBeforeColumnRemoved in class IlvFilterTreeListModel

Parameters:

column - The column that will be removed (index before removing).

columnInfo - The IlvDataColumnInfo of the column that will be removed.

getFocus

public Object getFocus()

Returns the focus. If contained in the underlying model, it is the root of this 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 IlvFilterTreeListModel

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 IlvFilterTreeListModel

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvFilterTreeListModel