org.richfaces.component
Interface TreeNode

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
TreeNodeImpl

public interface TreeNode
extends java.io.Serializable

Author:
Nick Belaevski - nbelaevski@exadel.com created 16.11.2006 Interface representing tree ADT nodes

Method Summary
 void addChild(java.lang.Object identifier, TreeNode child)
          adds child to children collection
 TreeNode getChild(java.lang.Object id)
          find child by id
 java.util.Iterator getChildren()
          getter for children
 java.lang.Object getData()
          getter for node attached data
 TreeNode getParent()
          getter for parent TreeNode
 boolean isLeaf()
          Returns whether this node is leaf
 void removeChild(java.lang.Object id)
          removes child from children collection by child id
 void setData(java.lang.Object data)
          setter for node attached data
 void setParent(TreeNode parent)
          setter for parent TreeNode
 

Method Detail

getData

java.lang.Object getData()
getter for node attached data

Returns:
node attached data

setData

void setData(java.lang.Object data)
setter for node attached data

Parameters:
data - data to set as attached node data

isLeaf

boolean isLeaf()
Returns whether this node is leaf

Returns:
true if this node is leaf else returns false

getChildren

java.util.Iterator getChildren()
getter for children

Returns:
Iterator of Map.Entry instances containing TreeNode as values and their identifiers as keys

getChild

TreeNode getChild(java.lang.Object id)
find child by id

Parameters:
id - identifier of the child to find
Returns:
designated TreeNode instance or null

addChild

void addChild(java.lang.Object identifier,
              TreeNode child)
adds child to children collection

Parameters:
identifier - child identifier
child - child

removeChild

void removeChild(java.lang.Object id)
removes child from children collection by child id

Parameters:
id - id of the child to remove

getParent

TreeNode getParent()
getter for parent TreeNode

Returns:
parent TreeNode instance or null if this node is root

setParent

void setParent(TreeNode parent)
setter for parent TreeNode

Parameters:
parent - TreeNode to set as parent


Copyright © 2007. All Rights Reserved.