gnu.lists

Class TreePosition

public class TreePosition extends SeqPosition implements Cloneable

A position that can also go down and up in a tree. A TreePosition is a stack of positions. The "current" position (i.e. the one you get if you tree the TreePosition as a SeqPosition) is that in the innermost containing sequence. Normally, the "current" element is (the one following) a position in a sequence. As a special (initial case), we may want to treat the entire sequence is the "current element". This is represented by depth==-1 and xpos set to the root element (which need not actually be a sequence).

Constructor Summary
	TreePosition()
	TreePosition(Object root) Not a position in a sequence, but the current element is the entire sequence.
	TreePosition(AbstractSequence seq, int index)
	TreePosition(TreePosition pos)

Method Summary
Object	clone()
void	dump() Copy this position into pos.
Object	getAncestor(int up) Get the value of an ancestor node.
int	getDepth() Number of ancestor sequences, including current sequence.
Object	getPosNext()
AbstractSequence	getRoot() Get the "root document".
boolean	gotoAttributesStart() Set position before first attribute (of the element following position).
boolean	gotoChildrenStart() Set position before first child (of the element following position).
boolean	gotoParent()
void	pop()
void	popNoRelease()
void	push(AbstractSequence child, int iposChild)
void	release()
void	set(TreePosition position)

Constructor Detail

TreePosition

public TreePosition()

TreePosition

public TreePosition(Object root)

Not a position *in* a sequence, but the current element is the entire sequence.

TreePosition

public TreePosition(AbstractSequence seq, int index)

TreePosition

public TreePosition(TreePosition pos)

Method Detail

clone

public Object clone()

dump

public void dump()

Copy this position into pos.

getAncestor

public Object getAncestor(int up)

Get the value of an ancestor node.

Parameters: up the number parents to go up.

Returns: if up is 0, same getNext. Otherwise get parent applied as specified.

Returns: true if there is a child sequence (which might be empty); false if current position is end of sequence or following element is atomic (cannot have children).