ilog.views.chart.datax.adapter

Class IlvSubTreeSetModel

java.lang.Object

ilog.views.chart.datax.tree.set.IlvAbstractTreeSetModel

ilog.views.chart.datax.tree.set.IlvFilterTreeSetModel

ilog.views.chart.datax.adapter.IlvSubTreeSetModel

All Implemented Interfaces:

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

public class IlvSubTreeSetModel
extends IlvFilterTreeSetModel

This class represents a subtree of a given IlvTreeSetModel. 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.set.IlvTreeSetModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK, DURING_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvSubTreeSetModel(IlvTreeSetModel model, Object focus) Creates a subtree model.
IlvSubTreeSetModel(IlvTreeSetModel 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_CHANGED event from the underlying model.
void	noteBeforeObjectsRemoved(Object parent, TreePath parentPath, Object[] objects) 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) Reacts on a DURING_OBJECTS_REMOVED event from the underlying model.
void	noteObjectsAdded(Object parent, TreePath parentPath, Object[] objects) Reacts on an OBJECTS_ADDED event from the underlying model.
void	noteObjectsRemoved(Object parent, TreePath parentPath, Object[] objects) Reacts on an OBJECTS_REMOVED event from the underlying model.

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

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

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

addTreeSetModelListener, convertToDouble, endBatch, fireModelEvent, postOrderIterator, preOrderIterator, removeTreeSetModelListener, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSubTreeSetModel

public IlvSubTreeSetModel(IlvTreeSetModel model,
                          Object focus)

Creates a subtree model.

Parameters:

model - The original model.

focus - The root of the subtree.

IlvSubTreeSetModel

public IlvSubTreeSetModel(IlvTreeSetModel 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 IlvTreeSetModel

Overrides:

getRoot in class IlvFilterTreeSetModel

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 IlvFilterTreeSetModel

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 IlvTreeSetModel

Overrides:

getSupportedEventsMask in class IlvFilterTreeSetModel

See Also:

IlvTreeSetModel.BEFORE_DATA_CHANGE_MASK, IlvTreeSetModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeSetModel.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 IlvFilterTreeSetModel

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_CHANGED event from the underlying model.

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

Overrides:

noteBeforeDataChange in class IlvFilterTreeSetModel

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.

noteObjectsAdded

public void noteObjectsAdded(Object parent,
                             TreePath parentPath,
                             Object[] objects)

Reacts on an OBJECTS_ADDED event from the underlying model.

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

Overrides:

noteObjectsAdded in class IlvFilterTreeSetModel

Parameters:

parent - The parent object of the set of objects that were added, 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 was added (together with their entire subtrees).

noteObjectsRemoved

public void noteObjectsRemoved(Object parent,
                               TreePath parentPath,
                               Object[] objects)

Reacts on an OBJECTS_REMOVED event from the underlying model.

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

Overrides:

noteObjectsRemoved in class IlvFilterTreeSetModel

Parameters:

parent - The parent object of the set of objects that were 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 was removed (together with their entire subtrees).

noteBeforeObjectsRemoved

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

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 IlvFilterTreeSetModel

Parameters:

parent - The parent object of the set of objects that will be 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 will be removed (together with their entire subtrees).

noteDuringObjectsRemoved

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

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 IlvFilterTreeSetModel

Parameters:

parent - The parent object of the set of objects that will be 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 will be removed (together with their entire subtrees).

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 IlvFilterTreeSetModel

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 IlvFilterTreeSetModel

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 IlvFilterTreeSetModel

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvFilterTreeSetModel