uk.ac.manchester.cs.owl.explanation.ordering

Interface Tree<N>

Type Parameters:

N - the kind of elements in the tree

All Known Implementing Classes:

EntailedAxiomTree, ExplanationTree, MutableTree

public interface Tree<N>

Since:

2.2.0

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group

Method Summary

Modifier and Type	Method and Description
void	dump(PrintWriter writer) Dump.
void	dump(PrintWriter writer, int indent) Dump.
List<N>	fillDepthFirst() Fill depth first.
int	getChildCount() A convenience method that gets the number of child nodes that this node has.
List<Tree<N>>	getChildren() Gets the children of this tree node.
Object	getEdge(Tree<N> child)
Tree<N>	getParent() Gets the parent of this tree node.
List<Tree<N>>	getPathToRoot() Gets the path to root.
Tree<N>	getRoot() A convenience method that gets the root of this tree.
N	getUserObject() Gets the "content" of this tree node.
Set<N>	getUserObjectClosure() Gets the user object closure.
List<N>	getUserObjectPathToRoot() Gets the user object path to root.
boolean	isLeaf() A convenience method that determines if this node is a leaf node (because it has no children).
boolean	isRoot() A convenience method that determines if this is a root node (because it has no parent node).
void	setNodeRenderer(NodeRenderer<N> renderer) Sets the node renderer.
void	sortChildren(Comparator<Tree<N>> comparator) Sorts the children using the specified comparator.

Method Detail

getUserObject

@Nonnull
N getUserObject()

Gets the "content" of this tree node.

Returns:

The user content of this node.

getParent

@Nonnull
Tree<N> getParent()

Gets the parent of this tree node.

Returns:

The parent tree node, or null if this node doesn't have a parent.

getChildren

@Nonnull
List<Tree<N>> getChildren()

Gets the children of this tree node.

Returns:

A list of children. If this tree node doesn't have any children then the list will be empty.

getEdge

Object getEdge(Tree<N> child)

Parameters:

child - the child to use

Returns:

the object stored as edge

sortChildren

void sortChildren(@Nonnull
                  Comparator<Tree<N>> comparator)

Sorts the children using the specified comparator.

Parameters:

comparator - The comparator to be used for the sorting.

getChildCount

int getChildCount()

A convenience method that gets the number of child nodes that this node has.

Returns:

The count of the number of children of this node.

isRoot

boolean isRoot()

A convenience method that determines if this is a root node (because it has no parent node).

Returns:

true if this is a root node, otherwise false.

isLeaf

boolean isLeaf()

A convenience method that determines if this node is a leaf node (because it has no children).

Returns:

true if this node is a leaf node otherwise false.

getRoot

@Nonnull
Tree<N> getRoot()

A convenience method that gets the root of this tree.

Returns:

The root node, which could be this node.

getPathToRoot

@Nonnull
List<Tree<N>> getPathToRoot()

Gets the path to root.

Returns:

the path to the root

getUserObjectPathToRoot

@Nonnull
List<N> getUserObjectPathToRoot()

Gets the user object path to root.

Returns:

the elements in the path to root

dump

void dump(@Nonnull
          PrintWriter writer)

Dump.

Parameters:

writer - the writer to print to

dump

void dump(@Nonnull
          PrintWriter writer,
          int indent)

Dump.

Parameters:

writer - the writer to print to

indent - how much to indent

setNodeRenderer

void setNodeRenderer(@Nonnull
                     NodeRenderer<N> renderer)

Sets the node renderer.

Parameters:

renderer - the renderer to use

getUserObjectClosure

@Nonnull
Set<N> getUserObjectClosure()

Gets the user object closure.

Returns:

the set of user objects

fillDepthFirst

@Nonnull
List<N> fillDepthFirst()

Fill depth first.

Returns:

the list of elements