Docs For Class TreeNodeInterface

Description

This is the building piece of the Tree data structure used for the backbone of the hierarchy.

since: Created: 8/30/2003
version: $Id: TreeNode.interface.php,v 1.7 2007/09/04 20:25:42 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/hierarchy/tree/TreeNode.interface.php (line 15)

Direct descendents

Class	Description
TreeNode	This is the building piece of the Tree data structure used for the backbone of the hierarchy.

Method Summary

void addChild (ref $child)

void detachChild (ref $child)

ref getChildren ()

integer getChildrenCount ()

string getId ()

ref getParents ()

integer getParentsCount ()

boolean hasChildren ()

boolean hasParents ()

boolean isChild (ref $node)

boolean isParent (ref $node)

Methods

addChild (line 24)

Adds a new child for this node.

access: public

void addChild (ref $child)

ref $child: object child The child node to add.

Redefined in descendants as:

TreeNode::addChild() : Adds a new child for this node.

detachChild (line 35)

Detaches the child from this node. The child remains in the hierarchy.

access: public

void detachChild (ref $child)

ref $child: object child The child node to detach.

Redefined in descendants as:

TreeNode::detachChild() : Detaches the child from this node. The child remains in the hierarchy.

getChildren (line 76)

Returns the children of this node in the order they were added.

return: array An array of the children nodes of this node.
access: public

ref getChildren ()

Redefined in descendants as:

TreeNode::getChildren() : Returns the children of this node in the order they were added.

getChildrenCount (line 86)

Returns the number of children for this node.

return: The number of children for this node.
access: public

integer getChildrenCount ()

Redefined in descendants as:

TreeNode::getChildrenCount() : Returns the number of children for this node.

getId (line 127)

Returns the id of this node.

return: The id of this node.
access: public

string getId ()

Redefined in descendants as:

TreeNode::getId() : Returns the id of this node.

getParents (line 45)

Returns the parent node of this node.

return: array The parent nodes of this node.
access: public

ref getParents ()

Redefined in descendants as:

TreeNode::getParents() : Returns the parent node of this node.

getParentsCount (line 55)

Returns the number of parents for this node.

return: The number of parents for this node.
access: public

integer getParentsCount ()

Redefined in descendants as:

TreeNode::getParentsCount() : Returns the number of parents for this node.

hasChildren (line 97)

Determines if this node has any children.

return:
```
true
```
if this node has at least one child;
```
false
```
, otherwise.
access: public

boolean hasChildren ()

Redefined in descendants as:

TreeNode::hasChildren() : Determines if this node has any children.

hasParents (line 66)

Determines if this node has any parents.

return:
```
true
```
if this node has at least one parent;
```
false
```
, otherwise.
access: public

boolean hasParents ()

Redefined in descendants as:

TreeNode::hasParents() : Determines if this node has any parents.

isChild (line 108)

Checks if the given node is a child of this node.

return:
```
true
```
if
```
$node
```
is a child of this node.
access: public

boolean isChild (ref $node)

ref $node: object node The child node to check.

Redefined in descendants as:

TreeNode::isChild() : Checks if the given node is a child of this node.

isParent (line 118)

Checks if the given node is a parent of this node.

return:
```
true
```
if
```
$node
```
is a parent of this node.
access: public

boolean isParent (ref $node)

ref $node: object node The child node to check.

Redefined in descendants as:

TreeNode::isParent() : Checks if the given node is a parent of this node.