de.alpharogroup.tree.ifaces

Interface ITreeNode<T>

Type Parameters:

T - the generic type

All Superinterfaces:

Serializable

All Known Implementing Classes:

TreeNode

public interface ITreeNode<T>
extends Serializable

The Interface ITreeNode.

Method Summary

Modifier and Type	Method and Description
void	addChild(ITreeNode<T> child) Adds the child.
void	addChildAt(int index, ITreeNode<T> child) Adds the child.
boolean	equals(ITreeNode<T> treeNode) Equals.
List<ITreeNode<T>>	getAllSiblings() Returns all siblings of this node in the parent's children list.
int	getChildCount() Gets the child count.
List<ITreeNode<T>>	getChildren() Gets the children.
int	getDepth() Returns the depth of the tree beginning at this node Returns 0 if this node has no children.
String	getDisplayValue() Gets the optional display value.
int	getLevel() Returns the distance from the root to this node.
ITreeNode<T>	getNextSibling() Returns the next sibling of this node in the parent's children list.
ITreeNode<T>	getParent() Gets the parent.
ITreeNode<T>	getPreviousSibling() Returns the previous sibling of this node in the parent's children list.
T	getValue() Gets the value.
boolean	hasChildren() Checks for children.
boolean	hasParent() Checks for parent.
boolean	isLeaf() Checks if is leaf.
boolean	isNode() Checks if is node.
boolean	isRoot() Checks if this treenode is root.
void	removeChild(ITreeNode<T> child) Removes the child.
void	removeChildAt(int index) Removes the child.
void	setChildren(List<ITreeNode<T>> children) Sets the children.
void	setDisplayValue(String displayValue) Sets the optional display value.
void	setParent(ITreeNode<T> parent) Sets the parent.
void	setValue(T value) Sets the value.
List<ITreeNode<T>>	toList() To list.
void	traverse(ITreeNode<T> node, List<ITreeNode<T>> list) Traverse.

Method Detail

addChild

void addChild(ITreeNode<T> child)

Adds the child.

Parameters:

child - the child

getDisplayValue

String getDisplayValue()

Gets the optional display value.

Returns:

the display value

setDisplayValue

void setDisplayValue(String displayValue)

Sets the optional display value.

Parameters:

displayValue - the new optional display value

addChildAt

void addChildAt(int index,
                ITreeNode<T> child)
         throws IndexOutOfBoundsException

Adds the child.

Parameters:

index - the index

child - the child

Throws:

IndexOutOfBoundsException - the index out of bounds exception

equals

boolean equals(ITreeNode<T> treeNode)

Equals.

Parameters:

treeNode - the tree node

Returns:

true, if successful

getChildCount

int getChildCount()

Gets the child count.

Returns:

the child count

getChildren

List<ITreeNode<T>> getChildren()

Gets the children.

Returns:

the children

getParent

ITreeNode<T> getParent()

Gets the parent.

Returns:

the parent

getValue

T getValue()

Gets the value.

Returns:

the value

hasChildren

boolean hasChildren()

Checks for children.

Returns:

true, if successful

hasParent

boolean hasParent()

Checks for parent.

Returns:

true, if successful

isLeaf

boolean isLeaf()

Checks if is leaf.

Returns:

true, if is leaf

isNode

boolean isNode()

Checks if is node.

Returns:

true, if is node

isRoot

boolean isRoot()

Checks if this treenode is root.

Returns:

true, if is root

removeChild

void removeChild(ITreeNode<T> child)

Removes the child.

Parameters:

child - the child

removeChildAt

void removeChildAt(int index)
            throws IndexOutOfBoundsException

Removes the child.

Parameters:

index - the index

Throws:

IndexOutOfBoundsException - the index out of bounds exception

setChildren

void setChildren(List<ITreeNode<T>> children)

Sets the children.

Parameters:

children - the new children

setParent

void setParent(ITreeNode<T> parent)

Sets the parent.

Parameters:

parent - the new parent

setValue

void setValue(T value)

Sets the value.

Parameters:

value - the new value

toList

List<ITreeNode<T>> toList()

To list.

Returns:

the list

traverse

void traverse(ITreeNode<T> node,
              List<ITreeNode<T>> list)

Traverse.

Parameters:

node - the node

list - the list

getNextSibling

ITreeNode<T> getNextSibling()

Returns the next sibling of this node in the parent's children list. Returns null if this node is the root or is the parent's last child.

Returns:

the next sibling of this node or null if this node is the root or is the parent's last child.

getPreviousSibling

ITreeNode<T> getPreviousSibling()

Returns the previous sibling of this node in the parent's children list. Returns null if this node is the root or is the parent's first child.

Returns:

the next sibling of this node or null if this node is the root or is the parent's last child.

getAllSiblings

List<ITreeNode<T>> getAllSiblings()

Returns all siblings of this node in the parent's children list. Returns null if this node is the root.

Returns:

Returns all siblings of this node or null if this node is the root.

getLevel

int getLevel()

Returns the distance from the root to this node. Returns 0 if this node is the root.

Returns:

the level from this node.

getDepth

int getDepth()

Returns the depth of the tree beginning at this node Returns 0 if this node has no children.

Returns:

the depth of the tree beginning at this node.