org.vishia.util

Class SortedTreeNode<Type extends SortedTree<Type>>

java.lang.Object

org.vishia.util.SortedTreeNode<Type>

Type Parameters:

Type - Type of the children.

All Implemented Interfaces:

SortedTree<Type>

public class SortedTreeNode<Type extends SortedTree<Type>>
extends java.lang.Object
implements SortedTree<Type>

Commonly implementation of a Node in a sorted tree. The node is implemented with a TreeMap with the key and a LinkedList as Object in the TreeMap node, containing all Object with the same key. This construction enables the fast searching of more as one child nodes with same key. The found children with the same key may be sorted in its originally order on input by building the tree. UML-Diagram, presentation style see Docu_UML_simpleNotation:

 
 SortedTreeNode
     -key
       |-------obj------>Type (data)
       |
       |-------------key*>-------------*>|
       |                                Type (children)
       |-------------------------------*>|
                                         |--------------> SortedTreeNode
 

The node refers to some Instances from Type. The instances can be selected by a key, whereby more as one instance with the same key is possible.

If the Type contains a reference to a SortedTree in turn, then a tree of nodes is built.

See TreeNodeUniqueKey, it is another implementation of a node for a tree. This class is designated as deprecated. The problem of this class is: children are referenced directly with there data. Instead the child nodes should be referenced. For example the org.vishia.xmlSimle.XmlNodeSimple has contained extra references to its children if this class was used as subclass. Now this associations are contained in the used subclass TreeNodeBase.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Type	obj
(package private) java.lang.String	sKey
(package private) java.util.TreeMap<java.lang.String,java.util.LinkedList<Type>>	sortedChildren
(package private) java.util.List<Type>	unsortedChildren

Constructor Summary

Constructors

Constructor and Description
SortedTreeNode()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String itsKey, Type newElement) adds a child.
Type	getChild(java.lang.String key) implements the interface method from SortedTree.
Type	getParent()
java.util.Iterator<Type>	iterChildren() implements the interface method from SortedTree.
java.util.Iterator<Type>	iterChildren(java.lang.String key) implements the interface method from SortedTree.
java.util.List<Type>	listChildren() implements the interface method from SortedTree.
java.util.List<Type>	listChildren(java.lang.String key) implements the interface method from SortedTree.

Methods inherited from class java.lang.Object

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

Field Detail

sKey

java.lang.String sKey

obj

Type extends SortedTree<Type> obj

sortedChildren

java.util.TreeMap<java.lang.String,java.util.LinkedList<Type extends SortedTree<Type>>> sortedChildren

unsortedChildren

java.util.List<Type extends SortedTree<Type>> unsortedChildren

Constructor Detail

SortedTreeNode

public SortedTreeNode()

Method Detail

add

public void add(java.lang.String itsKey,
                Type newElement)

adds a child.

Parameters:

itsKey - The key may be free defined outside, independent of the content of the child. This key is used to find out children.

newElement - The child to add.

getParent

public Type getParent()

Specified by:

getParent in interface SortedTree<Type extends SortedTree<Type>>

getChild

public Type getChild(java.lang.String key)

implements the interface method from SortedTree.

Specified by:

getChild in interface SortedTree<Type extends SortedTree<Type>>

Parameters:

key - The key of the demanded child. The implementation may have extra possibilities in addressing children with strings. The sKey can be representing more as a simple string as a attribute in children. It may be comparable with the ability of XPATH in XML. But it will be a feature of Implementation and is not defined as a basic feature of this interface.
sKey==null or sKey="" should be accepted. Than the first child independed on its key is returned. This is useable if only one child exists, but with unknown key.

Returns:

The first child with the given key or null if there is no such child.

iterChildren

public java.util.Iterator<Type> iterChildren()

implements the interface method from SortedTree.

Specified by:

iterChildren in interface SortedTree<Type extends SortedTree<Type>>

Returns:

The iterator or null if there isn't any children.

iterChildren

public java.util.Iterator<Type> iterChildren(java.lang.String key)

implements the interface method from SortedTree.

Specified by:

iterChildren in interface SortedTree<Type extends SortedTree<Type>>

Parameters:

key - The key of the demanded child. The implementation may have extra possibilities, see getChild(String).

Returns:

A iterator through the list of all children with the given key or null if there is no such child.

listChildren

public java.util.List<Type> listChildren()

implements the interface method from SortedTree.

Specified by:

listChildren in interface SortedTree<Type extends SortedTree<Type>>

Returns:

The List or null if there isn't any children.

listChildren

public java.util.List<Type> listChildren(java.lang.String key)

implements the interface method from SortedTree.

Specified by:

listChildren in interface SortedTree<Type extends SortedTree<Type>>

Parameters:

key - The key of the demanded child. The implementation may have extra possibilities, see getChild(String).

Returns:

A List of all children with the given key or null if there is no such child.