org.xwiki.tree

Class AbstractCompositeTree

java.lang.Object

org.xwiki.tree.AbstractTreeNode

org.xwiki.tree.AbstractTree

org.xwiki.tree.AbstractCompositeTree

All Implemented Interfaces:

Tree, TreeNode

public abstract class AbstractCompositeTree
extends AbstractTree

Base class for representing a composite tree, where each type of node is handled by a separate component. The node identifiers are prefixed with the node type.

Since:

8.3M2, 7.4.5

Version:

$Id: 2c4af87bcc4040ebcbc7559b88d1eba832f80788 $

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,TreeNode>	treeNodeByNodeType

Fields inherited from class org.xwiki.tree.AbstractTreeNode

contextComponentManagerProvider, logger

Fields inherited from interface org.xwiki.tree.Tree

PROPERTY_ROOT

Fields inherited from interface org.xwiki.tree.TreeNode

PROPERTY_EXCLUSIONS, PROPERTY_FILTERS, PROPERTY_ORDER_BY

Constructor Summary

Constructors

Constructor and Description
AbstractCompositeTree()

Method Summary

Modifier and Type	Method and Description
int	getChildCount(String nodeId) Retrieve the number of children of the specified node.
List<String>	getChildren(String nodeId, int offset, int limit) Retrieve the children of the specified node.
String	getParent(String nodeId) Retrieve the parent of the specified node.
protected TreeNode	getTreeNode(String nodeId)

Methods inherited from class org.xwiki.tree.AbstractTree

getPath

Methods inherited from class org.xwiki.tree.AbstractTreeNode

getExclusions, getExclusions, getOrderBy, getProperties, subList

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.tree.TreeNode

getProperties

Field Detail

treeNodeByNodeType

protected final Map<String,TreeNode> treeNodeByNodeType

Constructor Detail

AbstractCompositeTree

public AbstractCompositeTree()

Method Detail

getChildren

public List<String> getChildren(String nodeId,
                                int offset,
                                int limit)

Description copied from interface: TreeNode

Retrieve the children of the specified node.

Specified by:

getChildren in interface TreeNode

Overrides:

getChildren in class AbstractTreeNode

Parameters:

nodeId - the node id

offset - the offset within the list of child nodes

limit - the number of child nodes to return

Returns:

a part of the child nodes of the specified node

getChildCount

public int getChildCount(String nodeId)

Description copied from interface: TreeNode

Retrieve the number of children of the specified node.

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractTreeNode

Parameters:

nodeId - the node id

Returns:

the number of child nodes

getParent

public String getParent(String nodeId)

Description copied from interface: TreeNode

Retrieve the parent of the specified node.

Specified by:

getParent in interface TreeNode

Overrides:

getParent in class AbstractTreeNode

Parameters:

nodeId - the node id

Returns:

the parent node id

getTreeNode

protected TreeNode getTreeNode(String nodeId)

Parameters:

nodeId - the node identifier

Returns:

the TreeNode component that handles the specified node type