sdd

Class VtreePath

java.lang.Object

sdd.VtreePath

public class VtreePath
extends java.lang.Object

A VtreePath, i.e., a Vtree path, is a sequence of vtrees such that each vtree is a child of the previous vtree. It is possible to navigate between vtrees from the ''root'' (the ancestor of the vtrees) down to the leaf of the path, and from the leaf up to the root.

Constructor Summary

Constructors

Constructor and Description
VtreePath(Vtree r, Vtree l) Creates a vtree path whose root is the first specified vtree and whose leaf is the second specified vtree.

Method Summary

Methods

Modifier and Type	Method and Description
void	down() Changes the current position one step towards the leaf.
Vtree	get() Returns the current position of this path.
void	gotoLeaf() Changes the current position to the leaf of this path.
void	gotoRoot() Changes the current position to the root of this path.
boolean	isAtLeaf() Indicates whether the current position is the leaf.
boolean	isAtRoot() Indicates whether the current position is the root.
boolean	isDownLeft() Indicates whether the next step is on the left or on the right.
java.lang.String	toString()
void	up() Changes the current position one step towards the root.

Methods inherited from class java.lang.Object

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

Constructor Detail

VtreePath

public VtreePath(Vtree r,
         Vtree l)

Creates a vtree path whose root is the first specified vtree and whose leaf is the second specified vtree.

Parameters:

r - the root of the tree.

l - the leaf of the tree.

Method Detail

gotoRoot

public void gotoRoot()

Changes the current position to the root of this path.

gotoLeaf

public void gotoLeaf()

Changes the current position to the leaf of this path.

up

public void up()

Changes the current position one step towards the root.

down

public void down()

Changes the current position one step towards the leaf.

isAtRoot

public boolean isAtRoot()

Indicates whether the current position is the root.

Returns:

true if this vtree path is currently positioned on the root.

isAtLeaf

public boolean isAtLeaf()

Indicates whether the current position is the leaf.

Returns:

true if this vtree path is currently positioned on the leaf.

get

public Vtree get()

Returns the current position of this path.

Returns:

the vtree that this path is currently on.

isDownLeft

public boolean isDownLeft()

Indicates whether the next step is on the left or on the right. This method should not be called when in the leaf.

Returns:

true if the tree obtained by doing down() following by get() is a left child of the tree obtained by get() (but does not move in the process).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object