org.netbeans.spi.viewmodel

Class CachedChildrenTreeModel

java.lang.Object

org.netbeans.spi.viewmodel.CachedChildrenTreeModel

All Implemented Interfaces:

AsynchronousModelFilter, Model, TreeModel

public abstract class CachedChildrenTreeModel
extends Object
implements TreeModel, AsynchronousModelFilter

A TreeModel, which caches children objects and allow seamless update of children objects.

Since:

1.49

Nested Class Summary

Nested classes/interfaces inherited from interface org.netbeans.spi.viewmodel.AsynchronousModelFilter

AsynchronousModelFilter.CALL

Field Summary

Fields inherited from interface org.netbeans.spi.viewmodel.TreeModel

ROOT

Fields inherited from interface org.netbeans.spi.viewmodel.AsynchronousModelFilter

CURRENT_THREAD, DEFAULT

Constructor Summary

Constructors

Constructor and Description
CachedChildrenTreeModel()

Method Summary

Modifier and Type	Method and Description
Executor	asynchronous(Executor original, AsynchronousModelFilter.CALL asynchCall, Object node) Change the threading information for view models method calls.
protected boolean	cacheChildrenOf(Object node) Can be overridden to decide which nodes to cache and which not.
protected void	clearCache() Clear the entire cache.
protected abstract Object[]	computeChildren(Object node) Compute the children nodes.
Object[]	getChildren(Object o, int from, int to) Returns children for given parent on given indexes.
protected void	recomputeChildren() Force to recompute all cached children.
protected void	recomputeChildren(Object node) Force to recompute children cached for the given node.
protected void	refreshCache(Object node) Force a refresh of the cache.
protected Object[]	reorder(Object[] nodes) Allows to reorder the children.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.netbeans.spi.viewmodel.TreeModel

addModelListener, getChildrenCount, getRoot, isLeaf, removeModelListener

Constructor Detail

CachedChildrenTreeModel

public CachedChildrenTreeModel()

Method Detail

asynchronous

public Executor asynchronous(Executor original,
                             AsynchronousModelFilter.CALL asynchCall,
                             Object node)
                      throws UnknownTypeException

Description copied from interface: AsynchronousModelFilter

Change the threading information for view models method calls. The returned Executor is used to call methods identified by AsynchronousModelFilter.CALL enum.

Specified by:

asynchronous in interface AsynchronousModelFilter

Parameters:

original - The original Executor

asynchCall - Identification of the method call

node - Object node

Returns:

an instance of Executor

Throws:

UnknownTypeException

getChildren

public final Object[] getChildren(Object o,
                                  int from,
                                  int to)
                           throws UnknownTypeException

Description copied from interface: TreeModel

Returns children for given parent on given indexes.

This method works in pair with TreeModel.getChildrenCount(java.lang.Object), the to parameter is up to the value that is returned from TreeModel.getChildrenCount(java.lang.Object). If the list of children varies over time, the implementation code needs to pay attention to bounds and check the from and to parameters, especially if TreeModel.getChildrenCount(java.lang.Object) returns Integer.MAX_VALUE. Caching of the children between TreeModel.getChildrenCount(java.lang.Object) and TreeModel.getChildren(java.lang.Object, int, int) can be used as well, if necessary.

Specified by:

getChildren in interface TreeModel

Parameters:

o - a parent of returned nodes

from - a start index

to - a end index

Returns:

children for given parent on given indexes

Throws:

UnknownTypeException - if this TreeModel implementation is not able to resolve children for given node type

See Also:

TreeModel.getChildrenCount(java.lang.Object)

computeChildren

protected abstract Object[] computeChildren(Object node)
                                     throws UnknownTypeException

Compute the children nodes. This is called when there are no children cached for this node only.

Parameters:

node - The node to compute the children for

Returns:

The list of children

Throws:

UnknownTypeException - When this implementation is not able to resolve children for given node type

cacheChildrenOf

protected boolean cacheChildrenOf(Object node)

Can be overridden to decide which nodes to cache and which not.

Parameters:

node - The node

Returns:

true when the children of this node should be cached, false otherwise. The default implementation returns true always.

refreshCache

protected final void refreshCache(Object node)

Force a refresh of the cache.

Parameters:

node - The node to refresh the cache for.

clearCache

protected final void clearCache()

Clear the entire cache.

reorder

protected Object[] reorder(Object[] nodes)

Allows to reorder the children. This is called each time the children are requested, even when they're cached.

Parameters:

nodes - The original nodes returned by CachedChildrenTreeModel.computeChildren(java.lang.Object) or by the cache.

Returns:

The reordered nodes. The default implementation returns the original nodes.

recomputeChildren

protected final void recomputeChildren()
                                throws UnknownTypeException

Force to recompute all cached children.

Throws:

UnknownTypeException - When this implementation is not able to resolve children for some node type

recomputeChildren

protected final void recomputeChildren(Object node)
                                throws UnknownTypeException

Force to recompute children cached for the given node.

Parameters:

node - The node to recompute the children for

Throws:

UnknownTypeException - When this implementation is not able to resolve children for the given node type