MutableTree (OWLAPI :: Distribution 5.1.17 API)

java.lang.Object
- uk.ac.manchester.cs.owl.explanation.ordering.MutableTree<N>

Type Parameters:

N - type of elements

All Implemented Interfaces:

Tree<N>

Direct Known Subclasses:

ExplanationTree
```
public class MutableTree<N>
extends Object
implements Tree<N>
```
Since:

2.2.0

Author:

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

Constructor Summary

Constructors
Constructor and Description

MutableTree(N userObject)

Constructors
Constructor and Description
`MutableTree(N userObject)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(MutableTree<N> child)`
`void`	`addChild(MutableTree<N> child, Object edge)`
`void`	`clearChildren()` remove all children.
`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)`
`int`	`getMaxDepth()`
`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.
`int`	`getSize()`
`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`	`removeChild(MutableTree<N> child)`
`void`	`replace(MutableTree<N> tree)`
`void`	`setNodeRenderer(NodeRenderer<N> renderer)` Sets the node renderer.
`void`	`setParent(MutableTree<N> parent)`
`void`	`sortChildren(Comparator<Tree<N>> comparator)` Sorts the children using the specified comparator.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MutableTree
```
public MutableTree(N userObject)
```
    Parameters:
    
    userObject - the user object
- Method Detail
  - getUserObject
```
@Nullable
public N getUserObject()
```
    Description copied from interface: Tree
    
    Gets the "content" of this tree node.
    
    Specified by:
    
    getUserObject in interface Tree<N>
    
    Returns:
    
    The user content of this node.
  - addChild
```
public void addChild(MutableTree<N> child)
```
    Parameters:
    
    child - child to add
  - addChild
```
public void addChild(MutableTree<N> child,
                     Object edge)
```
    Parameters:
    
    child - child to add
    
    edge - the edge
  - removeChild
```
public void removeChild(MutableTree<N> child)
```
    Parameters:
    
    child - child to remove
  - getEdge
```
@Nullable
public Object getEdge(Tree<N> child)
```
    Specified by:
    
    getEdge in interface Tree<N>
    
    Parameters:
    
    child - the child to use
    
    Returns:
    
    the object stored as edge
  - sortChildren
```
public void sortChildren(Comparator<Tree<N>> comparator)
```
    Description copied from interface: Tree
    
    Sorts the children using the specified comparator.
    
    Specified by:
    
    sortChildren in interface Tree<N>
    
    Parameters:
    
    comparator - The comparator to be used for the sorting.
  - clearChildren
```
public void clearChildren()
```
    remove all children.
  - getParent
```
@Nullable
public Tree<N> getParent()
```
    Description copied from interface: Tree
    
    Gets the parent of this tree node.
    
    Specified by:
    
    getParent in interface Tree<N>
    
    Returns:
    
    The parent tree node, or null if this node doesn't have a parent.
  - setParent
```
public void setParent(MutableTree<N> parent)
```
    Parameters:
    
    parent - the new parent
  - getChildren
```
public List<Tree<N>> getChildren()
```
    Description copied from interface: Tree
    
    Gets the children of this tree node.
    
    Specified by:
    
    getChildren in interface Tree<N>
    
    Returns:
    
    A list of children. If this tree node doesn't have any children then the list will be empty.
  - getChildCount
```
public int getChildCount()
```
    Description copied from interface: Tree
    
    A convenience method that gets the number of child nodes that this node has.
    
    Specified by:
    
    getChildCount in interface Tree<N>
    
    Returns:
    
    The count of the number of children of this node.
  - isRoot
```
public boolean isRoot()
```
    Description copied from interface: Tree
    
    A convenience method that determines if this is a root node (because it has no parent node).
    
    Specified by:
    
    isRoot in interface Tree<N>
    
    Returns:
    
    true if this is a root node, otherwise false.
  - isLeaf
```
public boolean isLeaf()
```
    Description copied from interface: Tree
    
    A convenience method that determines if this node is a leaf node (because it has no children).
    
    Specified by:
    
    isLeaf in interface Tree<N>
    
    Returns:
    
    true if this node is a leaf node otherwise false.
  - getRoot
```
public Tree<N> getRoot()
```
    Description copied from interface: Tree
    
    A convenience method that gets the root of this tree.
    
    Specified by:
    
    getRoot in interface Tree<N>
    
    Returns:
    
    The root node, which could be this node.
  - getPathToRoot
```
public List<Tree<N>> getPathToRoot()
```
    Description copied from interface: Tree
    
    Gets the path to root.
    
    Specified by:
    
    getPathToRoot in interface Tree<N>
    
    Returns:
    
    the path to the root
  - getUserObjectPathToRoot
```
public List<N> getUserObjectPathToRoot()
```
    Description copied from interface: Tree
    
    Gets the user object path to root.
    
    Specified by:
    
    getUserObjectPathToRoot in interface Tree<N>
    
    Returns:
    
    the elements in the path to root
  - getUserObjectClosure
```
public Set<N> getUserObjectClosure()
```
    Description copied from interface: Tree
    
    Gets the user object closure.
    
    Specified by:
    
    getUserObjectClosure in interface Tree<N>
    
    Returns:
    
    the set of user objects
  - dump
```
public void dump(PrintWriter writer)
```
    Description copied from interface: Tree
    
    Dump.
    
    Specified by:
    
    dump in interface Tree<N>
    
    Parameters:
    
    writer - the writer to print to
  - dump
```
public void dump(PrintWriter writer,
                 int indent)
```
    Description copied from interface: Tree
    
    Dump.
    
    Specified by:
    
    dump in interface Tree<N>
    
    Parameters:
    
    writer - the writer to print to
    
    indent - how much to indent
  - setNodeRenderer
```
public void setNodeRenderer(NodeRenderer<N> renderer)
```
    Description copied from interface: Tree
    
    Sets the node renderer.
    
    Specified by:
    
    setNodeRenderer in interface Tree<N>
    
    Parameters:
    
    renderer - the renderer to use
  - fillDepthFirst
```
public List<N> fillDepthFirst()
```
    Description copied from interface: Tree
    
    Fill depth first.
    
    Specified by:
    
    fillDepthFirst in interface Tree<N>
    
    Returns:
    
    the list of elements
  - replace
```
public void replace(MutableTree<N> tree)
```
    Parameters:
    
    tree - the node to put in place of this one
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getSize
```
public int getSize()
```
    Returns:
    
    the size
  - getMaxDepth
```
public int getMaxDepth()
```
    Returns:
    
    the max depth

Class MutableTree<N>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MutableTree

Method Detail

getUserObject

addChild

addChild

removeChild

getEdge

sortChildren

clearChildren

getParent

setParent

getChildren

getChildCount

isRoot

isLeaf

getRoot

getPathToRoot

getUserObjectPathToRoot

getUserObjectClosure

dump

dump

setNodeRenderer

fillDepthFirst

replace

toString

getSize

getMaxDepth