org.vishia.util

Interface SortedTree<Type extends SortedTree<Type>>

Type Parameters:

Type - The type of elements. The elements are instance of SortedTree too. Therewith the SortedTree consists of nodes of type SortedTree.

All Known Subinterfaces:

XmlNode, ZbnfParseResultItem

All Known Implementing Classes:

SortedTreeNode, TreeNodeBase, TreeNodeBase.MetaNode, TreeNodeBase.TreeNode, XmlNodeSimple, ZbnfParserStore.ParseResultItemImplement

public interface SortedTree<Type extends SortedTree<Type>>

Interface to access data which are organized in a sorted tree. The sorting key is of type String. The interface should be implemented from a class which presents a node in a tree.

Method Summary

Modifier and Type	Method and Description
Type	getChild(java.lang.String sKey) Searches the first child with given key from the given node this.
Type	getParent()
java.util.Iterator<Type>	iterChildren() Returns an iterator through the list of all children of the node.
java.util.Iterator<Type>	iterChildren(java.lang.String sKey) Returns an iterator through the list of all children with the given key.
java.util.List<Type>	listChildren() Returns a List of all children of the node.
java.util.List<Type>	listChildren(java.lang.String sKey) Returns a List of all children with the given key.

Method Detail

getParent

Type getParent()

getChild

Type getChild(java.lang.String sKey)

Searches the first child with given key from the given node this.

Parameters:

sKey - 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

java.util.Iterator<Type> iterChildren()

Returns an iterator through the list of all children of the node.

Returns:

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

iterChildren

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

Returns an iterator through the list of all children with the given key.

Parameters:

sKey - 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

java.util.List<Type> listChildren()

Returns a List of all children of the node.

Returns:

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

listChildren

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

Returns a List of all children with the given key.

Parameters:

sKey - 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.