Package com.appiancorp.suiteapi.common

Class TreePivot

java.lang.Object

com.appiancorp.suiteapi.common.TreePivot

All Implemented Interfaces:

Serializable

public class TreePivot
extends Object
implements Serializable

Represents a view of a tree from the position of a node in the tree.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TreePivot()

Method Summary

Modifier and Type	Method	Description
TreeNode[]	getBreadcrumbs()	Get the route from the root of the tree to the node.
Tree	getSubtree()	Get the tree starting a this node.
void	populateBreadcrumbs(Object[] data_)	Convenience method to populate node data in breadcrumb nodes.
void	setBreadcrumbs(TreeNode[] breadcrumbs)	Set the route from the root of the tree to the node.
void	setSubtree(Tree node_)	Set the tree starting a this node.

Methods inherited from class java.lang.Object

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

Constructor Details

TreePivot

public TreePivot()

Method Details

getBreadcrumbs

public TreeNode[] getBreadcrumbs()

Get the route from the root of the tree to the node. Breadcrumbs are the ancestors of this node, up to and including the root of the tree.

Returns:

the ancestors of this node.

See Also:

• setBreadcrumbs(TreeNode[])

setBreadcrumbs

public void setBreadcrumbs(TreeNode[] breadcrumbs)

Set the route from the root of the tree to the node.

See Also:

• getBreadcrumbs()

getSubtree

public Tree getSubtree()

Get the tree starting a this node. This is a subtree of the overall tree.

Returns:

the subtree

See Also:

• setSubtree(Tree)

setSubtree

public void setSubtree(Tree node_)

Set the tree starting a this node. This is a subtree of the overall tree.

Parameters:

node_ - a tree to install as the subtree

See Also:

• getSubtree()

populateBreadcrumbs

public void populateBreadcrumbs(Object[] data_)

Convenience method to populate node data in breadcrumb nodes. Data array should parallel breadcrumb array.

Parameters:

data_ - the data to put in the breadcrumbs