org.auxis.commons.tree

Interface Tree

All Known Implementing Classes:

InMemoryTreeImpl, TreeIndex

public interface Tree

The central element for this library. Actually you will get many instances of Tree. They are all unmodifiable. Trees are made of a selector which identifies it. Note: selector does not have to be globally unique but unique for its parent. A tree then has a fingerprint (also call it "hash" which stands for the data of all its sub branches. Subbranches are accessable from here to. They may get initialized lazily.

Author:

Toni Menzel

Method Summary

Modifier and Type	Method and Description
Tree[]	branches() Sub branches of this tree.
String	fingerprint() Hash value of all its sub branches.
Selector	selector() Identification of this tree for the parent.
Tag	tags()

Method Detail

fingerprint

String fingerprint()

Hash value of all its sub branches. Can also be called a hash. Default implementations may use a SHA-1.

Returns:

the hash value of this tree.

selector

Selector selector()

Identification of this tree for the parent. Selectors are not global. Actually used to create indexes.

Returns:

string version of the selector.

branches

Tree[] branches()

Sub branches of this tree. May be empty or a list of sub trees. All sub branches are supposed to have unique selectors.

Returns:

List of sub trees.

tags

Tag tags()

Returns:

Tags for this tree.