ilog.views.chart.datax.tree.list

Class IlvTreeListRowIndexCache

java.lang.Object

ilog.views.chart.datax.tree.list.IlvTreeListRowIndexCache

public class IlvTreeListRowIndexCache
extends Object

This class implements a row index cache for an IlvTreeListModel.

When a tree model is converted to a list or table, each object corresponds to a "row" in the list or table. The order of the rows is given by the preOrderIterator function. This class implements a fast conversion between the objects in the tree model and the indices of the rows. Additionally, it provides also a conversion between the objects and the TreePaths leading to these objects; that is, it remembers the position of each object in the tree.

This class acts as a cache. It updates itself when the underlying model changes.

Since:

JViews 7.5

See Also:

IlvTreeListUtilities.preOrderIterator(ilog.views.chart.datax.tree.list.IlvTreeListModel), IlvTreeListToFlatListModel, IlvTreeListToFlatTableModel

Constructor Summary

Constructors

Constructor and Description
IlvTreeListRowIndexCache(IlvTreeListModel model) Creates a row index cache for the given model.

Method Summary

Modifier and Type	Method and Description
void	disconnect() Drops references to objects to help garbage collection.
void	dispose() Cleans up this cache and drops references to the model and its objects to help garbage collection.
int	getBranchSize(Object node) Returns the number of node in the branch below the given node (including the given node itself).
int	getBranchSizeForPath(TreePath path) Returns the number of node in the branch below the given tree path (including the node at which the given tree path ends).
int	getRowCount() Returns the number of rows.
int	getRowIndex(Object node) Returns the row index of a given tree node.
int	getRowIndexForPath(TreePath path) Returns the row index of a given tree path.
int[]	getRowIntervalForPath(TreePath path) Returns a two-element array containing the first row index and the last row index corresponding to the branch below the given tree path (including the node at which the given tree path ends).
Object	getTreeNodeAt(int row) Returns the tree node at a given index.
TreePath	getTreePathAt(int row) Returns the tree path from the root to the node at a given index.
TreePath	getTreePathOf(Object node) Returns the tree path leading to a given node.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvTreeListRowIndexCache

public IlvTreeListRowIndexCache(IlvTreeListModel model)

Creates a row index cache for the given model.

Method Detail

getRowCount

public int getRowCount()

Returns the number of rows.

getTreeNodeAt

public Object getTreeNodeAt(int row)

Returns the tree node at a given index.

getTreePathAt

public TreePath getTreePathAt(int row)

Returns the tree path from the root to the node at a given index.

getTreePathOf

public TreePath getTreePathOf(Object node)

Returns the tree path leading to a given node.

Returns:

A tree path whose lastPathComponent is the given node.

getRowIndex

public int getRowIndex(Object node)

Returns the row index of a given tree node.

getRowIndexForPath

public int getRowIndexForPath(TreePath path)

Returns the row index of a given tree path.

getBranchSize

public int getBranchSize(Object node)

Returns the number of node in the branch below the given node (including the given node itself).

getBranchSizeForPath

public int getBranchSizeForPath(TreePath path)

Returns the number of node in the branch below the given tree path (including the node at which the given tree path ends).

getRowIntervalForPath

public int[] getRowIntervalForPath(TreePath path)

Returns a two-element array containing the first row index and the last row index corresponding to the branch below the given tree path (including the node at which the given tree path ends).

This is the same as [first, first + count - 1] where first = getRowIndexForPath(path) and count = getBranchSizeForPath(path).

dispose

public void dispose()

Cleans up this cache and drops references to the model and its objects to help garbage collection.

Note: After calling this function, this cache 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 cache is no longer functional.

Since:

JViews 8.0