jhelp.util.list

Class Tree<INFORMATION>

java.lang.Object

jhelp.util.list.Tree<INFORMATION>

Type Parameters:

INFORMATION - Information carry type

public class Tree<INFORMATION>
extends java.lang.Object

A generic tree

Author:

JHelp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	Tree.ComparatorTree<INFO> Comparator used to compare 2 branches on using there carry information
static class	Tree.SearchMode Method of search inside the tree.
static interface	Tree.TestFoundListener<INFO> Listener called each tile we test an information to know if this information is the searched one.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ArrayList<Tree<INFORMATION>>	branches Tree branches
private Tree.ComparatorTree<INFORMATION>	comparatorTree Comparator used to compare 2 branches
(package private) INFORMATION	information Carried information
private Tree<INFORMATION>	trunk Trunk that contains this tree

Constructor Summary

Constructors

Modifier	Constructor and Description
	Tree(INFORMATION information) Create a new instance of Tree
private	Tree(Tree<INFORMATION> trunk, INFORMATION information) Create a new instance of Tree

Method Summary

Methods

Modifier and Type	Method and Description
Tree<INFORMATION>	addBranch(INFORMATION information) Add a branch to the tree
Tree<INFORMATION>	addBranchSorted(INFORMATION information, java.util.Comparator<INFORMATION> comparator) Add a branch to the tree if ordered way.
private void	collectLeafs(java.util.List<Tree<INFORMATION>> list) Collect all tree leafs and put them in a list
int	computeWeight() Compute the branch weight.
void	exchangeBranch(int index1, int index2) Exchange 2 branch
Tree<INFORMATION>	getBranch(int index) Obtain a branch
EnumerationIterator<Tree<INFORMATION>>	getBranches() List of branches
int	getIndexInTrunk() Compute the index of this tree in its trunk parent.
INFORMATION	getInformation() Carried information
Tree<INFORMATION>	getMainTrunk() Get tree main trunk.
Tree<INFORMATION>	getTrunk() Trunk parent
boolean	isLeaf() Indicates if the tree is a leaf.
java.util.List<Tree<INFORMATION>>	listOfLeafs() Collect all the tree leaf, no matter how depth they are
int	numberOfBranch() Number branch of the tree
Tree<INFORMATION>	removeBranch(int index) Remove a branch
Tree<INFORMATION>	searchBranch(Tree.TestFoundListener<INFORMATION> testFoundListener, Tree.SearchMode searchMode, boolean remove) Search a branch by its information
private Tree<INFORMATION>	searchLeftToRightDepth(Tree.TestFoundListener<INFORMATION> testFoundListener) Search a branch in left to right depth rule.
private Tree<INFORMATION>	searchLeftToRightHigh(Tree.TestFoundListener<INFORMATION> testFoundListener) Search a branch in left to right high rule.
private Tree<INFORMATION>	searchRightToLeftDepth(Tree.TestFoundListener<INFORMATION> testFoundListener) Search a branch in right to left depth rule.
private Tree<INFORMATION>	searchRightToLeftHigh(Tree.TestFoundListener<INFORMATION> testFoundListener) Search a branch in right to left high rule.
void	sortBranches(java.util.Comparator<INFORMATION> comparator) Sort branches of the tree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

branches

private final java.util.ArrayList<Tree<INFORMATION>> branches

Tree branches

comparatorTree

private final Tree.ComparatorTree<INFORMATION> comparatorTree

Comparator used to compare 2 branches

trunk

private final Tree<INFORMATION> trunk

Trunk that contains this tree

information

final INFORMATION information

Carried information

Constructor Detail

Tree

private Tree(Tree<INFORMATION> trunk,
    INFORMATION information)

Create a new instance of Tree

Parameters:

trunk - Trunk parent

information - Information carry

Tree

public Tree(INFORMATION information)

Create a new instance of Tree

Parameters:

information - Information carray (Musn't be null)

Method Detail

collectLeafs

private void collectLeafs(java.util.List<Tree<INFORMATION>> list)

Collect all tree leafs and put them in a list

Parameters:

list - List where put collected leafs

searchLeftToRightDepth

private Tree<INFORMATION> searchLeftToRightDepth(Tree.TestFoundListener<INFORMATION> testFoundListener)

Search a branch in left to right depth rule. See Tree.SearchMode, the order here is : Tree.SearchMode.LEFT_TO_RIGHT_DEPTH

Parameters:

testFoundListener - Tester of information search

Returns:

Founded branch or null if not found

searchLeftToRightHigh

private Tree<INFORMATION> searchLeftToRightHigh(Tree.TestFoundListener<INFORMATION> testFoundListener)

Search a branch in left to right high rule. See Tree.SearchMode, the order here is : Tree.SearchMode.LEFT_TO_RIGHT_HIGH

Parameters:

testFoundListener - Tester of information search

Returns:

Founded branch or null if not found

searchRightToLeftDepth

private Tree<INFORMATION> searchRightToLeftDepth(Tree.TestFoundListener<INFORMATION> testFoundListener)

Search a branch in right to left depth rule. See Tree.SearchMode, the order here is : Tree.SearchMode.RIGHT_TO_LEFT_DEPTH

Parameters:

testFoundListener - Tester of information search

Returns:

Founded branch or null if not found

searchRightToLeftHigh

private Tree<INFORMATION> searchRightToLeftHigh(Tree.TestFoundListener<INFORMATION> testFoundListener)

Search a branch in right to left high rule. See Tree.SearchMode, the order here is : Tree.SearchMode.RIGHT_TO_LEFT_HIGH

Parameters:

testFoundListener - Tester of information search

Returns:

Founded branch or null if not found

addBranch

public Tree<INFORMATION> addBranch(INFORMATION information)

Add a branch to the tree

Parameters:

information - Information to put on the branch

Returns:

Added branch

addBranchSorted

public Tree<INFORMATION> addBranchSorted(INFORMATION information,
                                java.util.Comparator<INFORMATION> comparator)

Add a branch to the tree if ordered way.
This method suppose that the tree is already ordered via the given comparator. See sortBranches(Comparator)

Parameters:

information - Information to put on the branch

comparator - Comparator to use for know the order

Returns:

Added branch

computeWeight

public int computeWeight()

Compute the branch weight.
More a tree have branch and its branch have branch ,and ... more the weight is high

Returns:

Tree weight

exchangeBranch

public void exchangeBranch(int index1,
                  int index2)

Exchange 2 branch

Parameters:

index1 - Index of branch 1

index2 - Index of branch 2

getBranch

public Tree<INFORMATION> getBranch(int index)

Obtain a branch

Parameters:

index - Branch index

Returns:

The branch

getBranches

public EnumerationIterator<Tree<INFORMATION>> getBranches()

List of branches

Returns:

List of branches

getIndexInTrunk

public int getIndexInTrunk()

Compute the index of this tree in its trunk parent.
If the tree is a main trunk (have no parent), -1 is return

Returns:

Index of the tree in its trunk or -1 if tree have no trunk (Because it's a main trunk)

getInformation

public INFORMATION getInformation()

Carried information

Returns:

Carried information

getMainTrunk

public Tree<INFORMATION> getMainTrunk()

Get tree main trunk.
The main trunk is the tree who carries all other trees, the tree without trunk parent

Returns:

Main trunk

getTrunk

public Tree<INFORMATION> getTrunk()

Trunk parent

Returns:

Trunk parent

isLeaf

public boolean isLeaf()

Indicates if the tree is a leaf.
In other words, that tree didn't have any branch

Returns:

true if the tree is a leaf

listOfLeafs

public java.util.List<Tree<INFORMATION>> listOfLeafs()

Collect all the tree leaf, no matter how depth they are

Returns:

List of leafs

numberOfBranch

public int numberOfBranch()

Number branch of the tree

Returns:

Number branch of the tree

removeBranch

public Tree<INFORMATION> removeBranch(int index)

Remove a branch

Parameters:

index - Branch index

Returns:

Removed branch

searchBranch

public Tree<INFORMATION> searchBranch(Tree.TestFoundListener<INFORMATION> testFoundListener,
                             Tree.SearchMode searchMode,
                             boolean remove)

Search a branch by its information

Parameters:

testFoundListener - Tester to know if an information is the searched one

searchMode - Way to search in the tree. See Tree.SearchMode

remove - Indicates if the searched branch have to be removed from its trunk

Returns:

The searched branch or null if not found

sortBranches

public void sortBranches(java.util.Comparator<INFORMATION> comparator)

Sort branches of the tree

Parameters:

comparator - Comparator to know the order