net.junaraki.libtree

Class UnorderedTree<E>

java.lang.Object

java.util.AbstractCollection<E>

net.junaraki.libtree.AbstractTree<E>

net.junaraki.libtree.UnorderedTree<E>

Type Parameters:

E - the type of elements in this tree

All Implemented Interfaces:

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

public class UnorderedTree<E>
extends AbstractTree<E>

This class implements an unordered tree. An unordered tree is a tree in which there is no ordering 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
UnorderedTree() Public constructor.
UnorderedTree(E element) Public constructor.

Method Summary

Modifier and Type	Method and Description
void	add(UnorderedTree<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(UnorderedTree<E> child) Adds the given child to this node.
UnorderedTree<E>	find(E element) Finds a node of the first occurrence of the given element in this tree.
UnorderedTree<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<UnorderedTree<E>>	getAncestors() Returns a list of ancestors of this node, ordered from the root to the parent of this node.
com.google.common.collect.Multiset<UnorderedTree<E>>	getChildren() Returns a set of children of this node.
java.util.List<E>	getElements() Returns a list of all elements in this tree.
java.util.List<UnorderedTree<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.
UnorderedTree<E>	getParent() Returns the parent of this node.
UnorderedTree<E>	getRoot() Returns the root of this tree.
com.google.common.collect.Multiset<E>	getSiblingElements() Returns a list of elements of siblings of this node.
com.google.common.collect.Multiset<UnorderedTree<E>>	getSiblings() Returns a list of siblings of this node.
java.util.List<UnorderedTree<E>>	getSubtrees() Returns a list of subtrees of this tree.
java.util.List<UnorderedTree<E>>	getUnorderedTreeNodes() Returns a list of all nodes of the type UnorderedTree<E> in this tree.
boolean	hasChild(E element) Returns true if this node has a child with the given element.
boolean	hasChild(UnorderedTree<E> child) Returns true if this node has the given child.
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(UnorderedTree<E> child) Removes the given child.
void	removeChildren() Removes all children from this node.
void	setParent(UnorderedTree<E> parent) Sets the given parent to this node.
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.

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.junaraki.libtree.Tree

equals, hashCode

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

UnorderedTree

public UnorderedTree()

Public constructor.

UnorderedTree

public UnorderedTree(E element)

Public constructor.

Parameters:

element - an element of this node

Method Detail

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 UnorderedTree<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 UnorderedTree<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 UnorderedTree<E> getParent()

Returns the parent of this node.

Returns:

the parent of this node

setParent

public void setParent(UnorderedTree<E> parent)

Sets the given parent to this node.

Parameters:

parent - a parent that will be set to this node

getChildren

public com.google.common.collect.Multiset<UnorderedTree<E>> getChildren()

Returns a set of children of this node.

Returns:

a set 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(UnorderedTree<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

add

public void add(UnorderedTree<E> child)

Adds the given child to this node.

Parameters:

child - a child that will be added to this node

addChild

public void addChild(UnorderedTree<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

getUnorderedTreeNodes

public java.util.List<UnorderedTree<E>> getUnorderedTreeNodes()

Returns a list of all nodes of the type UnorderedTree<E> in this tree.

Returns:

a list of all nodes of the type UnorderedTree<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

remove

public void remove()

Removes this node.

removeChild

public void removeChild(UnorderedTree<E> child)

Removes the given 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.

Parameters:

element - a node to be removed from the children of this node

removeChildren

public void removeChildren()

Description copied from interface: Tree

Removes all children from this node.

getSiblings

public com.google.common.collect.Multiset<UnorderedTree<E>> getSiblings()

Returns a list of siblings of this node.

Returns:

a list of siblings of this node

getSiblingElements

public com.google.common.collect.Multiset<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 UnorderedTree<E> getRoot()

Returns the root of this tree.

Returns:

the root of this tree.

getAncestors

public java.util.List<UnorderedTree<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

getSubtrees

public java.util.List<UnorderedTree<E>> getSubtrees()

Returns a list of subtrees of this tree.

Returns:

a list of subtrees of this tree

getLeaves

public java.util.List<UnorderedTree<E>> getLeaves()

Returns a list of leaves in this tree in a natural order.

Returns:

a list of leaves in this tree