OrderedTree

java.lang.Object
- java.util.AbstractCollection<E>
- - net.junaraki.libtree.AbstractTree<E>
  - - net.junaraki.libtree.OrderedTree<E>

Type Parameters:

E - the type of elements in this tree

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, Tree<E>

Direct Known Subclasses:

BinaryTree
```
public class OrderedTree<E>
extends AbstractTree<E>
```
This class implements an ordered tree. An ordered tree is a tree in which an ordering is specified for children of each node.

Author:

Jun Araki

Field Summary
- Fields inherited from class net.junaraki.libtree.AbstractTree
  PAREN_END, PAREN_START

Constructor Summary

Constructors
Constructor and Description

OrderedTree()
Public constructor.

OrderedTree(E element)
Public constructor.

Constructors
Constructor and Description
`OrderedTree()` Public constructor.
`OrderedTree(E element)` Public constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(OrderedTree<E> child)` Adds the given child to this node.
`void`	`addChild(E element)` Adds a child with the given element to this node.
`void`	`addChild(OrderedTree<E> child)` Adds the given child to this node.
`BinaryTree<E>`	`binarize()` Converts this ordered tree to a binary tree.
`boolean`	`equals(java.lang.Object obj)` Returns `true` if this tree is equal to the given object.
`OrderedTree<E>`	`find(E element)` Finds a node of the first occurrence of the given element in this tree.
`OrderedTree<E>`	`findChild(E element)` Finds a child of the first occurrence of the given element in this node.
`java.util.List<E>`	`getAncestorElements()` Returns a list of elements of ancestors of this node, ordered from the root to the parent of this node.
`java.util.List<OrderedTree<E>>`	`getAncestors()` Returns a list of ancestors of this node, ordered from the root to the parent of this node.
`OrderedTree<E>`	`getChildAt(int index)` Returns the child of this node at the given index.
`java.util.List<OrderedTree<E>>`	`getChildren()` Returns a list of children of this node.
`java.util.List<E>`	`getElements()` Returns a list of all elements in this tree.
`OrderedTree<E>`	`getFirstChild()` Returns the first child of this node.
`OrderedTree<E>`	`getLastChild()` Returns the last child of this node.
`java.util.List<OrderedTree<E>>`	`getLeaves()` Returns a list of leaves in this tree in a natural order.
`java.util.List<Tree<E>>`	`getNodes()` Returns a list of all nodes of the type `Tree<E>` in this tree.
`java.util.List<OrderedTree<E>>`	`getOrderedTreeNodes()` Returns a list of all nodes of the type `OrderedTree<E>` in this tree.
`OrderedTree<E>`	`getParent()` Returns the parent of this node.
`OrderedTree<E>`	`getRoot()` Returns the root of this tree.
`java.util.List<E>`	`getSiblingElements()` Returns a list of elements of siblings of this node.
`java.util.List<OrderedTree<E>>`	`getSiblings()` Returns a list of siblings of this node.
`java.util.List<OrderedTree<E>>`	`getSubtrees()` Returns a list of subtrees of this tree.
`boolean`	`hasChild(E element)` Returns `true` if this node has a child with the given element.
`boolean`	`hasChild(OrderedTree<E> child)` Returns `true` if this node has the given child.
`int`	`hashCode()` Returns the hash code value for this tree.
`boolean`	`isFirstChild(OrderedTree<E> node)` Returns `true` if the first child of this node is the given node.
`boolean`	`isLastChild(OrderedTree<E> node)` Returns `true` if the last child of this node is the given node.
`int`	`numChildren()` Returns the number of children of this node.
`int`	`numSiblings()` Returns the number of siblings of this node.
`void`	`remove()` Removes this node.
`void`	`removeChild(E element)` Removes a child with the given element from this node.
`void`	`removeChild(OrderedTree<E> child)` Removes the given child from this node.
`void`	`removeChildAt(int index)` Removes a child at the given index from this node.
`void`	`removeChildren()` Removes all children from this node.
`void`	`setChildAt(int index, OrderedTree<E> child)` Sets the given child to this node at the given index.
`void`	`setParent(OrderedTree<E> parent)` Sets the given parent to this node.
`boolean`	`subsumes(OrderedTree<E> tree)` Returns `true` if the given tree matches this tree or a subtree of the tree.
`java.lang.String`	`toNewick()` Returns a string representation of this tree in the Newick standard format.
`java.lang.String`	`toNewick(java.lang.String startMark, java.lang.String endMark)` Returns a string representation of this tree in the Newick standard format with the given starting and ending mark.
`java.lang.String`	`toString()` Returns a string representation of this tree in the format of the UNIX 'tree' command.
`java.util.List<E>`	`traverse()` Traverses this tree, and returns a list of found elements in this tree.
`java.util.List<E>`	`traverseLevelOrder()` Traverses this tree in the level-order manner, which is breadth-first search (BFS), and returns a list of found elements.
`java.util.List<OrderedTree<E>>`	`traverseNodes()` Traverses this tree, and returns a list of found nodes in this tree.
`java.util.List<OrderedTree<E>>`	`traverseNodesLevelOrder()` Traverses this tree in the level-order manner, which is breadth-first search (BFS), and returns a list of found nodes.
`java.util.List<OrderedTree<E>>`	`traverseNodesPostOrder()` Traverses this tree in the post-order manner, which is one way of depth-first search (DFS), and returns a list of found nodes.
`java.util.List<OrderedTree<E>>`	`traverseNodesPreOrder()` Traverses this tree in the pre-order manner, which is one way of depth-first search (DFS), and returns a list of found nodes.
`java.util.List<E>`	`traversePostOrder()` Traverses this tree in the post-order manner, which is one way of depth-first search (DFS), and returns a list of found elements.
`java.util.List<E>`	`traversePreOrder()` Traverses this tree in the pre-order manner, which is one way of depth-first search (DFS), and returns a list of found elements.

Methods inherited from class net.junaraki.libtree.AbstractTree
add, degree, degree, depth, depth, getElement, getLeafElements, hasAncestor, hasAncestor, hasChild, hasDescendant, hasDescendant, hasElement, hasElement, hasParent, hasParent, hasParent, isBalanced, isLabeled, isLabeledTree, isLeaf, isRoot, iterator, numLeaves, removeChildren, setElement, size, yield

Methods inherited from class java.util.AbstractCollection
addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

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

Methods inherited from interface java.util.Collection
addAll, clear, contains, containsAll, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - OrderedTree
```
public OrderedTree()
```
    Public constructor.
  - OrderedTree
```
public OrderedTree(E element)
```
    Public constructor.
    
    Parameters:
    
    element - an element of this node
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns true if this tree is equal to the given object. Two ordered trees are equal if they have the same elements in the same tree structure.
    
    Specified by:
    
    equals in interface java.util.Collection<E>
    
    Specified by:
    
    equals in interface Tree<E>
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - an object to be compared with this tree
    
    Returns:
    
    true if this tree is equal to the given object; false otherwise
  - hashCode
```
public int hashCode()
```
    Returns the hash code value for this tree. Two trees must have the same hash code if they are equal; we hash elements of all nodes to generate the hash code.
    
    Specified by:
    
    hashCode in interface java.util.Collection<E>
    
    Specified by:
    
    hashCode in interface Tree<E>
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code value for this tree
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this tree in the format of the UNIX 'tree' command.
    
    Overrides:
    
    toString in class java.util.AbstractCollection<E>
    
    Returns:
    
    a string representation of this tree in the format of the UNIX 'tree' command
  - toNewick
```
public java.lang.String toNewick()
```
    Returns a string representation of this tree in the Newick standard format.
    
    Returns:
    
    a string representation of this tree in the Newick standard format
  - toNewick
```
public java.lang.String toNewick(java.lang.String startMark,
                                 java.lang.String endMark)
```
    Returns a string representation of this tree in the Newick standard format with the given starting and ending mark.
    
    Parameters:
    
    startMark - a string to start with a string presentation of a node
    
    endMark - a string to end with a string presentation of a node
    
    Returns:
    
    a string representation of this tree in the Newick standard format
  - find
```
public OrderedTree<E> find(E element)
```
    Finds a node of the first occurrence of the given element in this tree.
    
    Parameters:
    
    element - an element to be found in this tree, if present
    
    Returns:
    
    a node of the first occurrence of the given element in this tree
  - findChild
```
public OrderedTree<E> findChild(E element)
```
    Finds a child of the first occurrence of the given element in this node.
    
    Parameters:
    
    element - an element to be found in the children of this node, if present
    
    Returns:
    
    a child of the first occurrence of the given element in this node
  - getParent
```
public OrderedTree<E> getParent()
```
    Returns the parent of this node.
    
    Returns:
    
    the parent of this node
  - setParent
```
public void setParent(OrderedTree<E> parent)
```
    Sets the given parent to this node.
    
    Parameters:
    
    parent - a parent that will be set to this node
  - getChildAt
```
public OrderedTree<E> getChildAt(int index)
```
    Returns the child of this node at the given index.
    
    Parameters:
    
    index - an index of the element to return
    
    Returns:
    
    the child of this node at the given index
  - getChildren
```
public java.util.List<OrderedTree<E>> getChildren()
```
    Returns a list of children of this node.
    
    Returns:
    
    a list of children of this node
  - numChildren
```
public int numChildren()
```
    Returns the number of children of this node.
    
    Returns:
    
    the number of children of this node
  - hasChild
```
public boolean hasChild(E element)
```
    Returns true if this node has a child with the given element.
    
    Parameters:
    
    element - an element whose presence in the children of this node will be tested
    
    Returns:
    
    true if this node has a child with the given element; false otherwise
  - hasChild
```
public boolean hasChild(OrderedTree<E> child)
```
    Returns true if this node has the given child.
    
    Parameters:
    
    child - a node whose presence in the children of this node will be tested
    
    Returns:
    
    true if this node has the given child; false otherwise
  - getFirstChild
```
public OrderedTree<E> getFirstChild()
```
    Returns the first child of this node.
    
    Returns:
    
    the first child of this node
  - isFirstChild
```
public boolean isFirstChild(OrderedTree<E> node)
```
    Returns true if the first child of this node is the given node.
    
    Parameters:
    
    node - a node whose presence as the first child will be tested
    
    Returns:
    
    true if the first child of this node is the given node; false otherwise
  - getLastChild
```
public OrderedTree<E> getLastChild()
```
    Returns the last child of this node.
    
    Returns:
    
    the last child of this node
  - isLastChild
```
public boolean isLastChild(OrderedTree<E> node)
```
    Returns true if the last child of this node is the given node.
    
    Parameters:
    
    node - a node whose presence as the last child will be tested
    
    Returns:
    
    true if the last child of this node is the given node; false otherwise
  - setChildAt
```
public void setChildAt(int index,
                       OrderedTree<E> child)
```
    Sets the given child to this node at the given index.
    
    Parameters:
    
    index - an index of the element to set
    
    child - a child that will be set to this node
  - add
```
public void add(OrderedTree<E> child)
```
    Adds the given child to this node.
    
    Parameters:
    
    child - a child that will be added to this node
  - addChild
```
public void addChild(OrderedTree<E> child)
```
    Adds the given child to this node.
    
    Parameters:
    
    child - a child that will be added to this node
  - addChild
```
public void addChild(E element)
```
    Adds a child with the given element to this node.
    
    Parameters:
    
    element - an element that will be added to the children of this node
  - getSiblings
```
public java.util.List<OrderedTree<E>> getSiblings()
```
    Returns a list of siblings of this node.
    
    Returns:
    
    a list of siblings of this node
  - getSiblingElements
```
public java.util.List<E> getSiblingElements()
```
    Returns a list of elements of siblings of this node.
    
    Returns:
    
    a list of elements of siblings of this node
  - numSiblings
```
public int numSiblings()
```
    Returns the number of siblings of this node.
    
    Returns:
    
    the number of siblings of this node
  - getRoot
```
public OrderedTree<E> getRoot()
```
    Returns the root of this tree.
    
    Returns:
    
    the root of this tree.
  - getAncestors
```
public java.util.List<OrderedTree<E>> getAncestors()
```
    Returns a list of ancestors of this node, ordered from the root to the parent of this node.
    
    Returns:
    
    a list of ancestors of this node, ordered from the root to the parent of this node
  - getAncestorElements
```
public java.util.List<E> getAncestorElements()
```
    Returns a list of elements of ancestors of this node, ordered from the root to the parent of this node.
    
    Returns:
    
    a list of elements of ancestors of this node, ordered from the root to the parent of this node
  - getOrderedTreeNodes
```
public java.util.List<OrderedTree<E>> getOrderedTreeNodes()
```
    Returns a list of all nodes of the type OrderedTree<E> in this tree.
    
    Returns:
    
    a list of all nodes of the type OrderedTree<E> in this tree
  - getNodes
```
public java.util.List<Tree<E>> getNodes()
```
    Returns a list of all nodes of the type Tree<E> in this tree.
    
    Returns:
    
    a list of all nodes of the type Tree<E> in this tree
  - getElements
```
public java.util.List<E> getElements()
```
    Returns a list of all elements in this tree.
    
    Returns:
    
    a list of all elements in this tree
  - traverse
```
public java.util.List<E> traverse()
```
    Traverses this tree, and returns a list of found elements in this tree.
    
    Returns:
    
    a list of elements of nodes traversed with breadth-first search (BFS)
  - traverseNodes
```
public java.util.List<OrderedTree<E>> traverseNodes()
```
    Traverses this tree, and returns a list of found nodes in this tree.
    
    Returns:
    
    a list of nodes traversed with breadth-first search (BFS)
  - traversePreOrder
```
public java.util.List<E> traversePreOrder()
```
    Traverses this tree in the pre-order manner, which is one way of depth-first search (DFS), and returns a list of found elements.
    
    Returns:
    
    a list of elements of nodes traversed in the pre-order manner
  - traverseNodesPreOrder
```
public java.util.List<OrderedTree<E>> traverseNodesPreOrder()
```
    Traverses this tree in the pre-order manner, which is one way of depth-first search (DFS), and returns a list of found nodes.
    
    Returns:
    
    a list of nodes traversed in the pre-order manner
  - traversePostOrder
```
public java.util.List<E> traversePostOrder()
```
    Traverses this tree in the post-order manner, which is one way of depth-first search (DFS), and returns a list of found elements.
    
    Returns:
    
    a list of elements of nodes traversed in the post-order manner
  - traverseNodesPostOrder
```
public java.util.List<OrderedTree<E>> traverseNodesPostOrder()
```
    Traverses this tree in the post-order manner, which is one way of depth-first search (DFS), and returns a list of found nodes.
    
    Returns:
    
    a list of nodes traversed in the post-order manner
  - traverseLevelOrder
```
public java.util.List<E> traverseLevelOrder()
```
    Traverses this tree in the level-order manner, which is breadth-first search (BFS), and returns a list of found elements.
    
    Returns:
    
    a list of elements of nodes traversed in the level-order manner
  - traverseNodesLevelOrder
```
public java.util.List<OrderedTree<E>> traverseNodesLevelOrder()
```
    Traverses this tree in the level-order manner, which is breadth-first search (BFS), and returns a list of found nodes.
    
    Returns:
    
    a list of nodes traversed in the level-order manner
  - remove
```
public void remove()
```
    Removes this node.
  - removeChild
```
public void removeChild(OrderedTree<E> child)
```
    Removes the given child from this node. This operation removes all nodes under the child.
    
    Parameters:
    
    child - a node to be removed from the children of this node
  - removeChild
```
public void removeChild(E element)
```
    Removes a child with the given element from this node. This operation removes the child and its all descendants.
    
    Parameters:
    
    element - an element to be removed from the children of this node
  - removeChildAt
```
public void removeChildAt(int index)
```
    Removes a child at the given index from this node. This operation removes the child and its all descendants.
    
    Parameters:
    
    index - an index where a child will be removed from this node
  - removeChildren
```
public void removeChildren()
```
    Description copied from interface: Tree
    
    Removes all children from this node.
  - getSubtrees
```
public java.util.List<OrderedTree<E>> getSubtrees()
```
    Returns a list of subtrees of this tree.
    
    Returns:
    
    a list of subtrees of this tree
  - getLeaves
```
public java.util.List<OrderedTree<E>> getLeaves()
```
    Returns a list of leaves in this tree in a natural order.
    
    Returns:
    
    a list of leaves in this tree
  - subsumes
```
public boolean subsumes(OrderedTree<E> tree)
```
    Returns true if the given tree matches this tree or a subtree of the tree.
    
    Parameters:
    
    tree - a tree to compared with this tree
    
    Returns:
    
    true if the given tree matches this tree or a subtree of the tree; false otherwise
  - binarize
```
public BinaryTree<E> binarize()
```
    Converts this ordered tree to a binary tree. This method constructs a left-child, right-sibling (LC-RS) binary tree for this ordered tree, guaranteeing a one-to-one mapping between an ordered tree and a binary tree.
    
    Returns:
    
    a binary tree converted from this tree

Class OrderedTree<E>

Field Summary

Fields inherited from class net.junaraki.libtree.AbstractTree

Constructor Summary

Method Summary

Methods inherited from class net.junaraki.libtree.AbstractTree

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

OrderedTree

OrderedTree

Method Detail

equals

hashCode

toString

toNewick

toNewick

find

findChild

getParent

setParent

getChildAt

getChildren

numChildren

hasChild

hasChild

getFirstChild

isFirstChild

getLastChild

isLastChild

setChildAt

add

addChild

addChild

getSiblings

getSiblingElements

numSiblings

getRoot

getAncestors

getAncestorElements

getOrderedTreeNodes

getNodes

getElements

traverse

traverseNodes

traversePreOrder

traverseNodesPreOrder

traversePostOrder

traverseNodesPostOrder

traverseLevelOrder

traverseNodesLevelOrder

remove

removeChild

removeChild

removeChildAt

removeChildren

getSubtrees

getLeaves

subsumes

binarize