uk.ac.vamsas.objects.utils.trees
Class BinaryNode

java.lang.Object
  extended byuk.ac.vamsas.objects.utils.trees.BinaryNode
Direct Known Subclasses:
SequenceNode

public class BinaryNode
extends java.lang.Object


Field Summary
 int bootstrap
          bootstrap is non-negative integer
 
Constructor Summary
BinaryNode()
          Creates a new BinaryNode object.
BinaryNode(Vobject val, BinaryNode parent, java.lang.String name)
          Creates a new BinaryNode object.
 
Method Summary
 BinaryNode ascendLeft()
          Traverses up through the tree until a node with a free leftchild is discovered.
 BinaryNode ascendRight()
          Traverses up through the tree until a node with a free rightchild is discovered.
 BinaryNode detach()
          Detaches the node from the binary tree, along with all its child nodes.
 Vobject element()
          DOCUMENT ME!
 int getBootstrap()
          DOCUMENT ME!
 java.lang.String getName()
          DOCUMENT ME!
 boolean isLeaf()
          DOCUMENT ME!
 BinaryNode left()
          DOCUMENT ME!
 BinaryNode parent()
          DOCUMENT ME!
 BinaryNode right()
          DOCUMENT ME!
 void setBootstrap(int boot)
          DOCUMENT ME!
 void SetChildren(BinaryNode leftchild, BinaryNode rightchild)
          attaches FIRST and SECOND node arguments as the LEFT and RIGHT children of this node (removing any old references) a null parameter DOES NOT mean that the pointer to the corresponding child node is set to NULL - you should use setChild(null), or detach() for this.
 Vobject setElement(Vobject v)
          DOCUMENT ME!
 BinaryNode setLeft(BinaryNode n)
          DOCUMENT ME!
 void setName(java.lang.String name)
          DOCUMENT ME!
 BinaryNode setParent(BinaryNode n)
          DOCUMENT ME!
 BinaryNode setRight(BinaryNode n)
          DOCUMENT ME!
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

bootstrap

public int bootstrap
bootstrap is non-negative integer

Constructor Detail

BinaryNode

public BinaryNode()
Creates a new BinaryNode object.


BinaryNode

public BinaryNode(Vobject val,
                  BinaryNode parent,
                  java.lang.String name)
Creates a new BinaryNode object.

Parameters:
val - DOCUMENT ME!
parent - DOCUMENT ME!
name - DOCUMENT ME!
Method Detail

element

public Vobject element()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setElement

public Vobject setElement(Vobject v)
DOCUMENT ME!

Parameters:
v - DOCUMENT ME!
Returns:
DOCUMENT ME!

left

public BinaryNode left()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setLeft

public BinaryNode setLeft(BinaryNode n)
DOCUMENT ME!

Parameters:
n - DOCUMENT ME!
Returns:
DOCUMENT ME!

right

public BinaryNode right()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setRight

public BinaryNode setRight(BinaryNode n)
DOCUMENT ME!

Parameters:
n - DOCUMENT ME!
Returns:
DOCUMENT ME!

parent

public BinaryNode parent()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setParent

public BinaryNode setParent(BinaryNode n)
DOCUMENT ME!

Parameters:
n - DOCUMENT ME!
Returns:
DOCUMENT ME!

isLeaf

public boolean isLeaf()
DOCUMENT ME!

Returns:
DOCUMENT ME!

SetChildren

public void SetChildren(BinaryNode leftchild,
                        BinaryNode rightchild)
attaches FIRST and SECOND node arguments as the LEFT and RIGHT children of this node (removing any old references) a null parameter DOES NOT mean that the pointer to the corresponding child node is set to NULL - you should use setChild(null), or detach() for this.


detach

public BinaryNode detach()
Detaches the node from the binary tree, along with all its child nodes.

Returns:
BinaryNode The detached node.

ascendLeft

public BinaryNode ascendLeft()
Traverses up through the tree until a node with a free leftchild is discovered.

Returns:
BinaryNode

ascendRight

public BinaryNode ascendRight()
Traverses up through the tree until a node with a free rightchild is discovered. Jalview builds trees by descent on the left, so this may be unused.

Returns:
BinaryNode

setName

public void setName(java.lang.String name)
DOCUMENT ME!

Parameters:
name - DOCUMENT ME!

getName

public java.lang.String getName()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setBootstrap

public void setBootstrap(int boot)
DOCUMENT ME!

Parameters:
boot - DOCUMENT ME!

getBootstrap

public int getBootstrap()
DOCUMENT ME!

Returns:
DOCUMENT ME!