org.molgenis.util

Interface Tree<T>

All Superinterfaces:

Serializable

All Known Implementing Classes:

DBSchema, Entity, Form, LinkableTree, Matrix, Menu, Method, MethodSchema, Plugin, Processor, PRSchema, SimpleTree, Tree, UISchema, View

public interface Tree<T>
extends Serializable

A tree with uniquely named nodes. Each node in the tree can have a value. Name and parent should be set in constructor.

Method Summary

Methods

Modifier and Type	Method and Description
T	get(String name) Retrieve a subtree by name.
List<T>	getAllChildren() Get the children, and their children, etc.
List<T>	getAllChildren(boolean includeSelf) Get all children, optional including self
T	getChild(String name) Get a subtree by name.
Vector<T>	getChildren() Get the children of this element.
String	getName() Retrieve the unique name of this tree element.
T	getParent() Retrieve the parent node of current element.
String	getPath(String separator) Translate the path of this subtree as a separated string.
T	getRoot() Get the root element of this tree.
Map<String,T>	getTreeElements() Retrieve all tree elements as map.
Object	getValue() Retrieve the value of this node/leaf
boolean	hasChildren() Retrieve wether this Tree has children
boolean	hasParent() Retrieve wether this Tree has a parent
void	setParent(T parent) Set the parent of current element (and move the children accordingly).
void	setValue(Object o) Set the value of this node/leaf
String	toString() Print the tree.
String	toString(boolean includeSubTree, int level) Pretty print the (sub)tree, but only a certain levels

Method Detail

getName

String getName()

Retrieve the unique name of this tree element.

get

T get(String name)

Retrieve a subtree by name.

Parameters:

name - of the subtree

Returns:

a subtree.

getParent

T getParent()

Retrieve the parent node of current element.

Returns:

parent

setParent

void setParent(T parent)

Set the parent of current element (and move the children accordingly).

Parameters:

parent - to replace current parent of this.

hasParent

boolean hasParent()

Retrieve wether this Tree has a parent

Returns:

true if hasParent, else false.

getRoot

T getRoot()

Get the root element of this tree.

Returns:

root Tree containing this.

getChildren

Vector<T> getChildren()

Get the children of this element.

Returns:

child subtrees

hasChildren

boolean hasChildren()

Retrieve wether this Tree has children

Returns:

true if hasChildren, else false.

getAllChildren

List<T> getAllChildren()

Get the children, and their children, etc. of this element.

getAllChildren

List<T> getAllChildren(boolean includeSelf)

Get all children, optional including self

getChild

T getChild(String name)

Get a subtree by name.

Parameters:

name - of the subtree

Returns:

subtree

toString

String toString()

Print the tree.

Overrides:

toString in class Object

Returns:

a string describing the tree.

toString

String toString(boolean includeSubTree,
              int level)

Pretty print the (sub)tree, but only a certain levels

Parameters:

includeSubTree - if true the subtree is also printed

level - will print in so many levels

getTreeElements

Map<String,T> getTreeElements()

Retrieve all tree elements as map.

Returns:

a map of subtrees

getValue

Object getValue()

Retrieve the value of this node/leaf

Returns:

the value.

setValue

void setValue(Object o)

Set the value of this node/leaf

getPath

String getPath(String separator)

Translate the path of this subtree as a separated string.

Parameters:

separator -

Returns:

string with the pat. FIXME: make this return a collection.