AsyncTreeModel

java.lang.Object
- javax.swing.tree.DefaultTreeModel
- - com.alee.laf.tree.WebTreeModel<E>
  - - com.alee.extended.tree.AsyncTreeModel<E>

Type Parameters:

E - custom node type

All Implemented Interfaces:

java.io.Serializable, javax.swing.tree.TreeModel
```
public class AsyncTreeModel<E extends AsyncUniqueNode>
extends WebTreeModel<E>
```
Special model for asynchronous tree that provides asynchronous data loading. This class also controls the loading animation in elements.

See Also:

WebAsyncTree, AsyncTreeDataProvider, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`asyncLoading` Whether to load children asynchronously or not.
`protected java.util.List<AsyncTreeModelListener>`	`asyncTreeModelListeners` Asynchronous tree listeners.
`protected java.lang.Object`	`busyLock` Lock object for busy state changes.
`protected java.lang.Object`	`cacheLock` Lock object for cache changes.
`protected AsyncTreeDataProvider<E>`	`dataProvider` Asynchronous tree data provider.
`protected java.lang.Object`	`modelListenersLock` Lock object for asynchronous tree listeners.
`protected com.alee.utils.collection.DoubleMap<java.lang.String,E>`	`nodeById` Direct nodes cache (node ID -> node).
`protected java.util.Map<java.lang.String,java.lang.Boolean>`	`nodeCached` Nodes cached states (parent ID -> children cached state).
`protected java.util.Map<java.lang.String,java.util.List<E>>`	`rawNodeChildrenCache` Cache for children nodes returned by data provider (parent ID -> list of raw child nodes).
`protected E`	`rootNode` Root node cache.
`protected WebAsyncTree<E>`	`tree` Asynchronous tree that uses this model.

Fields inherited from class javax.swing.tree.DefaultTreeModel
asksAllowsChildren, listenerList, root

Constructor Summary

Constructors
Constructor and Description
`AsyncTreeModel(WebAsyncTree<E> tree, AsyncTreeDataProvider<E> dataProvider)` Constructs default asynchronous tree model using custom data provider.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAsyncTreeModelListener(AsyncTreeModelListener listener)` Adds new asynchronous tree model listener.
`void`	`addChildNodes(E parent, java.util.List<E> children)` Adds child nodes for the specified node.
`boolean`	`areChildrenLoaded(E node)` Returns whether children for the specified node are already loaded or not.
`protected void`	`cacheNodeById(E node)` Caches node by its IDs.
`protected void`	`cacheNodesById(java.util.List<E> nodes)` Caches nodes by their IDs.
`protected void`	`clearNodeChildrenCache(E[] nodes, boolean clearNodes)` Clears nodes children cached states.
`protected void`	`clearNodeChildrenCache(E node, boolean clearNode)` Clears node and all of its child nodes children cached states.
`protected void`	`clearNodeChildrenCache(java.util.List<E> nodes, boolean clearNodes)` Clears nodes children cached states.
`protected java.util.List<E>`	`filterAndSort(E parentNode, java.util.List<E> children)` Returns list of filtered and sorted raw children.
`E`	`findNode(java.lang.String nodeId)` Looks for the node with the specified ID in the tree model and returns it or null if it was not found.
`protected void`	`fireChildrenLoadCompleted(E parent, java.util.List<E> children)` Fires children load complete event.
`protected void`	`fireChildrenLoadFailed(E parent, java.lang.Throwable cause)` Fires children load failed event.
`protected void`	`fireChildrenLoadStarted(E parent)` Fires children load start event.
`java.util.List<AsyncTreeModelListener>`	`getAsyncTreeModelListeners()` Returns list of all available asynchronous tree model listeners.
`E`	`getChild(java.lang.Object parent, int index)` Returns child node for parent node at the specified index.
`int`	`getChildCount(java.lang.Object parent)` Returns children count for specified node.
`AsyncTreeDataProvider<E>`	`getDataProvider()` Returns asynchronous tree data provider.
`com.alee.utils.collection.DoubleMap<java.lang.String,E>`	`getNodesCache()` Returns nodes cache map copy.
`E`	`getRoot()` Returns tree root node.
`void`	`insertNodeInto(javax.swing.tree.MutableTreeNode newChild, javax.swing.tree.MutableTreeNode parent, int index)` Inserts new child node into parent node at the specified index.
`protected void`	`insertNodeIntoImpl(E child, E parent, int index)` Inserts a child node into parent node.
`void`	`insertNodesInto(E[] children, E parent, int index)` Inserts an array of child nodes into parent node.
`void`	`insertNodesInto(java.util.List<E> children, E parent, int index)` Inserts a list of child nodes into parent node.
`protected void`	`insertNodesIntoImpl(E[] children, E parent, int index)` Inserts an array of child nodes into parent node.
`protected void`	`insertNodesIntoImpl(java.util.List<E> children, E parent, int index)` Inserts a list of child nodes into parent node.
`boolean`	`isAsyncLoading()` Returns whether children are loaded asynchronously or not.
`boolean`	`isLeaf(java.lang.Object node)` Returns whether the specified node is leaf or not.
`protected int`	`loadChildren(E parent)` Loads (or reloads) node children and returns zero or children count if async mode is off.
`protected void`	`performSortingAndFiltering(E parentNode, boolean recursively, boolean performUpdates)` Updates node children using current comparator and filter.
`void`	`reload(javax.swing.tree.TreeNode node)` Reloads node children.
`void`	`removeAsyncTreeModelListener(AsyncTreeModelListener listener)` Removes asynchronous tree model listener.
`void`	`removeNodeFromParent(javax.swing.tree.MutableTreeNode node)` Removes specified node from parent node.
`void`	`setAsyncLoading(boolean asyncLoading)` Sets whether to load children asynchronously or not.
`void`	`setChildNodes(E parent, java.util.List<E> children)` Sets child nodes for the specified node.
`void`	`updateSortingAndFiltering()` Updates nodes sorting and filtering for all loaded nodes.
`void`	`updateSortingAndFiltering(E parentNode)` Updates sorting and filtering for the specified node children.
`void`	`updateSortingAndFiltering(E parentNode, boolean recursively)` Updates sorting and filtering for the specified node children.
`protected void`	`updateSortingAndFilteringImpl(E parentNode, boolean recursively, boolean performUpdates)` Updates sorting and filtering for the specified node children.

Methods inherited from class com.alee.laf.tree.WebTreeModel
getRootNode, removeNodesFromParent, removeNodesFromParent, removeNodesFromParent, updateNode, updateNodeStructure, updateTree, valueForPathChanged

Methods inherited from class javax.swing.tree.DefaultTreeModel
addTreeModelListener, asksAllowsChildren, fireTreeNodesChanged, fireTreeNodesInserted, fireTreeNodesRemoved, fireTreeStructureChanged, getIndexOfChild, getListeners, getPathToRoot, getPathToRoot, getTreeModelListeners, nodeChanged, nodesChanged, nodeStructureChanged, nodesWereInserted, nodesWereRemoved, reload, removeTreeModelListener, setAsksAllowsChildren, setRoot

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - modelListenersLock
```
protected final java.lang.Object modelListenersLock
```
    Lock object for asynchronous tree listeners.
  - asyncTreeModelListeners
```
protected final java.util.List<AsyncTreeModelListener> asyncTreeModelListeners
```
    Asynchronous tree listeners.
  - tree
```
protected final WebAsyncTree<E extends AsyncUniqueNode> tree
```
    Asynchronous tree that uses this model.
  - dataProvider
```
protected final AsyncTreeDataProvider<E extends AsyncUniqueNode> dataProvider
```
    Asynchronous tree data provider.
  - asyncLoading
```
protected boolean asyncLoading
```
    Whether to load children asynchronously or not.
  - rootNode
```
protected E extends AsyncUniqueNode rootNode
```
    Root node cache. Cached when root is requested for the first time.
  - cacheLock
```
protected final java.lang.Object cacheLock
```
    Lock object for cache changes.
  - nodeCached
```
protected final java.util.Map<java.lang.String,java.lang.Boolean> nodeCached
```
    Nodes cached states (parent ID -> children cached state). If child nodes for some parent node are cached then this map contains "true" value under that parent node ID as a key.
  - rawNodeChildrenCache
```
protected final java.util.Map<java.lang.String,java.util.List<E extends AsyncUniqueNode>> rawNodeChildrenCache
```
    Cache for children nodes returned by data provider (parent ID -> list of raw child nodes). This map contains raw children which weren't affected by sorting and filtering operations. If children needs to be re-sorted or re-filtered they are simply taken from the cache and re-organized once again.
  - nodeById
```
protected final com.alee.utils.collection.DoubleMap<java.lang.String,E extends AsyncUniqueNode> nodeById
```
    Direct nodes cache (node ID -> node). Used for quick node search within the tree.
  - busyLock
```
protected final java.lang.Object busyLock
```
    Lock object for busy state changes.
- Constructor Detail
  - AsyncTreeModel
```
public AsyncTreeModel(WebAsyncTree<E> tree,
                      AsyncTreeDataProvider<E> dataProvider)
```
    Constructs default asynchronous tree model using custom data provider.
    
    Parameters:
    
    tree - asynchronous tree
    
    dataProvider - data provider
- Method Detail
  - isAsyncLoading
```
public boolean isAsyncLoading()
```
    Returns whether children are loaded asynchronously or not.
    
    Returns:
    
    true if children are loaded asynchronously, false otherwise
  - setAsyncLoading
```
public void setAsyncLoading(boolean asyncLoading)
```
    Sets whether to load children asynchronously or not.
    
    Parameters:
    
    asyncLoading - whether to load children asynchronously or not
  - getDataProvider
```
public AsyncTreeDataProvider<E> getDataProvider()
```
    Returns asynchronous tree data provider.
    
    Returns:
    
    data provider
  - getRoot
```
public E getRoot()
```
    Returns tree root node.
    
    Specified by:
    
    getRoot in interface javax.swing.tree.TreeModel
    
    Overrides:
    
    getRoot in class javax.swing.tree.DefaultTreeModel
    
    Returns:
    
    root node
  - isLeaf
```
public boolean isLeaf(java.lang.Object node)
```
    Returns whether the specified node is leaf or not.
    
    Specified by:
    
    isLeaf in interface javax.swing.tree.TreeModel
    
    Overrides:
    
    isLeaf in class javax.swing.tree.DefaultTreeModel
    
    Parameters:
    
    node - node
    
    Returns:
    
    true if node is leaf, false otherwise
  - getChildCount
```
public int getChildCount(java.lang.Object parent)
```
    Returns children count for specified node.
    
    Specified by:
    
    getChildCount in interface javax.swing.tree.TreeModel
    
    Overrides:
    
    getChildCount in class javax.swing.tree.DefaultTreeModel
    
    Parameters:
    
    parent - parent node
    
    Returns:
    
    children count
  - getChild
```
public E getChild(java.lang.Object parent,
                  int index)
```
    Returns child node for parent node at the specified index.
    
    Specified by:
    
    getChild in interface javax.swing.tree.TreeModel
    
    Overrides:
    
    getChild in class javax.swing.tree.DefaultTreeModel
    
    Parameters:
    
    parent - parent node
    
    index - child node index
    
    Returns:
    
    child node
  - areChildrenLoaded
```
public boolean areChildrenLoaded(E node)
```
    Returns whether children for the specified node are already loaded or not.
    
    Parameters:
    
    node - node to process
    
    Returns:
    
    true if children for the specified node are already loaded, false otherwise
  - reload
```
public void reload(javax.swing.tree.TreeNode node)
```
    Reloads node children.
    
    Overrides:
    
    reload in class javax.swing.tree.DefaultTreeModel
    
    Parameters:
    
    node - node
  - clearNodeChildrenCache
```
protected void clearNodeChildrenCache(E node,
                                      boolean clearNode)
```
    Clears node and all of its child nodes children cached states.
    
    Parameters:
    
    node - node to clear cache for
    
    clearNode - whether should clear node cache or not
  - clearNodeChildrenCache
```
protected void clearNodeChildrenCache(java.util.List<E> nodes,
                                      boolean clearNodes)
```
    Clears nodes children cached states.
    
    Parameters:
    
    nodes - nodes to clear cache for
    
    clearNodes - whether should clear nodes cache or not
  - clearNodeChildrenCache
```
protected void clearNodeChildrenCache(E[] nodes,
                                      boolean clearNodes)
```
    Clears nodes children cached states.
    
    Parameters:
    
    nodes - nodes to clear cache for
    
    clearNodes - whether should clear nodes cache or not
  - cacheNodeById
```
protected void cacheNodeById(E node)
```
    Caches node by its IDs.
    
    Parameters:
    
    node - node to cache
  - cacheNodesById
```
protected void cacheNodesById(java.util.List<E> nodes)
```
    Caches nodes by their IDs.
    
    Parameters:
    
    nodes - list of nodes to cache
  - loadChildren
```
protected int loadChildren(E parent)
```
    Loads (or reloads) node children and returns zero or children count if async mode is off. This is base method that uses installed AsyncTreeDataProvider to retrieve tree node children.
    
    Parameters:
    
    parent - node to load children for
    
    Returns:
    
    zero or children count if async mode is off
    
    See Also:
    
    AsyncTreeDataProvider.loadChildren(AsyncUniqueNode, ChildrenListener)
  - setChildNodes
```
public void setChildNodes(E parent,
                          java.util.List<E> children)
```
    Sets child nodes for the specified node. This method might be used to manually change tree node children without causing any structure corruptions.
    
    Parameters:
    
    parent - node to process
    
    children - new node children
  - addChildNodes
```
public void addChildNodes(E parent,
                          java.util.List<E> children)
```
    Adds child nodes for the specified node. This method might be used to manually change tree node children without causing any structure corruptions.
    
    Parameters:
    
    parent - node to process
    
    children - new node children
  - removeNodeFromParent
```
public void removeNodeFromParent(javax.swing.tree.MutableTreeNode node)
```
    Removes specified node from parent node.
    
    Overrides:
    
    removeNodeFromParent in class javax.swing.tree.DefaultTreeModel
    
    Parameters:
    
    node - node to remove
  - insertNodeInto
```
public void insertNodeInto(javax.swing.tree.MutableTreeNode newChild,
                           javax.swing.tree.MutableTreeNode parent,
                           int index)
```
    Inserts new child node into parent node at the specified index.
    
    Overrides:
    
    insertNodeInto in class javax.swing.tree.DefaultTreeModel
    
    Parameters:
    
    newChild - new child node
    
    parent - parent node
    
    index - insert index
  - insertNodesInto
```
public void insertNodesInto(java.util.List<E> children,
                            E parent,
                            int index)
```
    Inserts a list of child nodes into parent node.
    
    Overrides:
    
    insertNodesInto in class WebTreeModel<E extends AsyncUniqueNode>
    
    Parameters:
    
    children - list of new child nodes
    
    parent - parent node
    
    index - insert index
  - insertNodesInto
```
public void insertNodesInto(E[] children,
                            E parent,
                            int index)
```
    Inserts an array of child nodes into parent node.
    
    Overrides:
    
    insertNodesInto in class WebTreeModel<E extends AsyncUniqueNode>
    
    Parameters:
    
    children - array of new child nodes
    
    parent - parent node
    
    index - insert index
  - insertNodeIntoImpl
```
protected void insertNodeIntoImpl(E child,
                                  E parent,
                                  int index)
```
    Inserts a child node into parent node.
    
    Parameters:
    
    child - new child node
    
    parent - parent node
    
    index - insert index
  - insertNodesIntoImpl
```
protected void insertNodesIntoImpl(java.util.List<E> children,
                                   E parent,
                                   int index)
```
    Inserts a list of child nodes into parent node.
    
    Parameters:
    
    children - list of new child nodes
    
    parent - parent node
    
    index - insert index
  - insertNodesIntoImpl
```
protected void insertNodesIntoImpl(E[] children,
                                   E parent,
                                   int index)
```
    Inserts an array of child nodes into parent node.
    
    Parameters:
    
    children - array of new child nodes
    
    parent - parent node
    
    index - insert index
  - updateSortingAndFiltering
```
public void updateSortingAndFiltering()
```
    Updates nodes sorting and filtering for all loaded nodes.
  - updateSortingAndFiltering
```
public void updateSortingAndFiltering(E parentNode)
```
    Updates sorting and filtering for the specified node children.
    
    Parameters:
    
    parentNode - node which children sorting and filtering should be updated
  - updateSortingAndFiltering
```
public void updateSortingAndFiltering(E parentNode,
                                      boolean recursively)
```
    Updates sorting and filtering for the specified node children.
    
    Parameters:
    
    parentNode - node which children sorting and filtering should be updated
    
    recursively - whether should update the whole children structure recursively or not
  - updateSortingAndFilteringImpl
```
protected void updateSortingAndFilteringImpl(E parentNode,
                                             boolean recursively,
                                             boolean performUpdates)
```
    Updates sorting and filtering for the specified node children.
    
    Parameters:
    
    parentNode - node which children sorting and filtering should be updated
    
    recursively - whether should update the whole children structure recursively or not
    
    performUpdates - whether tree updates should be triggered within this method
  - performSortingAndFiltering
```
protected void performSortingAndFiltering(E parentNode,
                                          boolean recursively,
                                          boolean performUpdates)
```
    Updates node children using current comparator and filter. Updates the whole node children structure if recursive update requested.
    
    Parameters:
    
    parentNode - node which children sorting and filtering should be updated
    
    recursively - whether should update the whole children structure recursively or not
    
    performUpdates - whether tree updates should be triggered within this method
  - filterAndSort
```
protected java.util.List<E> filterAndSort(E parentNode,
                                          java.util.List<E> children)
```
    Returns list of filtered and sorted raw children.
    
    Parameters:
    
    parentNode - parent node
    
    children - children to filter and sort
    
    Returns:
    
    list of filtered and sorted children
  - findNode
```
public E findNode(java.lang.String nodeId)
```
    Looks for the node with the specified ID in the tree model and returns it or null if it was not found.
    
    Parameters:
    
    nodeId - node ID
    
    Returns:
    
    node with the specified ID or null if it was not found
  - getNodesCache
```
public com.alee.utils.collection.DoubleMap<java.lang.String,E> getNodesCache()
```
    Returns nodes cache map copy.
    
    Returns:
    
    nodes cache map copy
  - getAsyncTreeModelListeners
```
public java.util.List<AsyncTreeModelListener> getAsyncTreeModelListeners()
```
    Returns list of all available asynchronous tree model listeners.
    
    Returns:
    
    asynchronous tree model listeners list
  - addAsyncTreeModelListener
```
public void addAsyncTreeModelListener(AsyncTreeModelListener listener)
```
    Adds new asynchronous tree model listener.
    
    Parameters:
    
    listener - asynchronous tree model listener to add
  - removeAsyncTreeModelListener
```
public void removeAsyncTreeModelListener(AsyncTreeModelListener listener)
```
    Removes asynchronous tree model listener.
    
    Parameters:
    
    listener - asynchronous tree model listener to remove
  - fireChildrenLoadStarted
```
protected void fireChildrenLoadStarted(E parent)
```
    Fires children load start event.
    
    Parameters:
    
    parent - node which children are being loaded
  - fireChildrenLoadCompleted
```
protected void fireChildrenLoadCompleted(E parent,
                                         java.util.List<E> children)
```
    Fires children load complete event.
    
    Parameters:
    
    parent - node which children were loaded
    
    children - loaded child nodes
  - fireChildrenLoadFailed
```
protected void fireChildrenLoadFailed(E parent,
                                      java.lang.Throwable cause)
```
    Fires children load failed event.
    
    Parameters:
    
    parent - node which children were loaded
    
    cause - children load failure cause

Class AsyncTreeModel<E extends AsyncUniqueNode>

Field Summary

Fields inherited from class javax.swing.tree.DefaultTreeModel

Constructor Summary

Method Summary

Methods inherited from class com.alee.laf.tree.WebTreeModel

Methods inherited from class javax.swing.tree.DefaultTreeModel

Methods inherited from class java.lang.Object

Field Detail

modelListenersLock

asyncTreeModelListeners

tree

dataProvider

asyncLoading

rootNode

cacheLock

nodeCached

rawNodeChildrenCache

nodeById

busyLock

Constructor Detail

AsyncTreeModel

Method Detail

isAsyncLoading

setAsyncLoading

getDataProvider

getRoot

isLeaf

getChildCount

getChild

areChildrenLoaded

reload

clearNodeChildrenCache

clearNodeChildrenCache

clearNodeChildrenCache

cacheNodeById

cacheNodesById

loadChildren

setChildNodes

addChildNodes

removeNodeFromParent

insertNodeInto

insertNodesInto

insertNodesInto

insertNodeIntoImpl

insertNodesIntoImpl

insertNodesIntoImpl

updateSortingAndFiltering

updateSortingAndFiltering

updateSortingAndFiltering

updateSortingAndFilteringImpl

performSortingAndFiltering

filterAndSort

findNode

getNodesCache

getAsyncTreeModelListeners

addAsyncTreeModelListener

removeAsyncTreeModelListener

fireChildrenLoadStarted

fireChildrenLoadCompleted

fireChildrenLoadFailed