org.xwiki.tree

Interface TreeNode

All Known Subinterfaces:

Tree

All Known Implementing Classes:

AbstractCompositeTree, AbstractTree, AbstractTreeNode

@Role
public interface TreeNode

The interface used to represent a node in a tree structure.

Since:

8.3M2, 7.4.5

Version:

$Id: 4dc5d49e274fd26e614e438846215fff9d8728aa $

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_EXCLUSIONS The property that specifies the nodes to exclude.
static String	PROPERTY_FILTERS The property that specifies the filters to apply on the tree.
static String	PROPERTY_ORDER_BY The property that specifies how the child nodes are sorted.

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.
Map<String,Object>	getProperties() Retrieve the properties that can be used to configure the tree node.

Field Detail

PROPERTY_ORDER_BY

static final String PROPERTY_ORDER_BY

The property that specifies how the child nodes are sorted.

See Also:

Constant Field Values

PROPERTY_EXCLUSIONS

static final String PROPERTY_EXCLUSIONS

The property that specifies the nodes to exclude.

See Also:

Constant Field Values

PROPERTY_FILTERS

static final String PROPERTY_FILTERS

The property that specifies the filters to apply on the tree.

See Also:

Constant Field Values

Method Detail

getChildren

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

Retrieve the children of the specified node.

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

int getChildCount(String nodeId)

Retrieve the number of children of the specified node.

Parameters:

nodeId - the node id

Returns:

the number of child nodes

getParent

String getParent(String nodeId)

Retrieve the parent of the specified node.

Parameters:

nodeId - the node id

Returns:

the parent node id

getProperties

Map<String,Object> getProperties()

Retrieve the properties that can be used to configure the tree node. For instance you may want to sort or filter the child nodes.

Returns:

the map of tree node properties