org.auxis.commons.tree

Class TreeIndex

java.lang.Object

org.auxis.commons.tree.TreeIndex

All Implemented Interfaces:

Tree

public class TreeIndex
extends Object
implements Tree

Index implementation that augments a given tree with some extra index accessors like find by selector and tag.

Author:

Toni Menzel

Constructor Summary

Constructors

Constructor and Description
TreeIndex(Tree tree)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeIndex

public TreeIndex(Tree tree)

Method Detail

select

public TreeIndex select(Selector selector)

select

public TreeIndex select(Selector... selectors)

selectable

public boolean selectable()

fingerprint

public String fingerprint()

Description copied from interface: Tree

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

Specified by:

fingerprint in interface Tree

Returns:

the hash value of this tree.

selector

public Selector selector()

Description copied from interface: Tree

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

Specified by:

selector in interface Tree

Returns:

string version of the selector.

branches

public TreeIndex[] branches()

Description copied from interface: Tree

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

Specified by:

branches in interface Tree

Returns:

List of sub trees.

toString

public String toString()

Overrides:

toString in class Object

tags

public Tag tags()

Specified by:

tags in interface Tree

Returns:

Tags for this tree.