Package gnu.lists
Class TreePosition
java.lang.Object
gnu.lists.SeqPosition
gnu.lists.TreePosition
- All Implemented Interfaces:
Cloneable
,Enumeration
,Iterator
,ListIterator
- Direct Known Subclasses:
Focus
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).
-
Field Summary
Fields inherited from class gnu.lists.SeqPosition
ipos, sequence
-
Constructor Summary
ConstructorsConstructorDescriptionTreePosition
(AbstractSequence seq, int index) TreePosition
(TreePosition pos) TreePosition
(Object root) Not a position *in* a sequence, but the current element is the entire sequence. -
Method Summary
Modifier and TypeMethodDescriptionclone()
void
dump()
Copy this position into pos.getAncestor
(int up) Get the value of an ancestor node.int
getDepth()
Number of ancestor sequences, including current sequence.getRoot()
Get the "root document".boolean
Set position before first attribute (of the element following position).boolean
Set position before first child (of the element following position).final boolean
void
pop()
void
void
push
(AbstractSequence child, int iposChild) void
release()
void
set
(TreePosition position) Methods inherited from class gnu.lists.SeqPosition
add, copy, finalize, fromEndIndex, getContainingSequenceSize, getNext, getNextKind, getNextTypeName, getNextTypeObject, getPos, getPrevious, gotoEnd, gotoNext, gotoPrevious, gotoStart, hasMoreElements, hasNext, hasPrevious, isAfter, make, next, nextElement, nextIndex, previous, previousIndex, remove, set, set, set, setNext, setPos, setPos, setPrevious, toInfo, toString
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Enumeration
asIterator
Methods inherited from interface java.util.Iterator
forEachRemaining
-
Constructor Details
-
TreePosition
public TreePosition() -
TreePosition
Not a position *in* a sequence, but the current element is the entire sequence. -
TreePosition
-
TreePosition
-
-
Method Details
-
clone
-
set
-
getDepth
public int getDepth()Number of ancestor sequences, including current sequence. -
getRoot
Get the "root document". -
getPosNext
-
push
-
pop
public void pop() -
popNoRelease
public void popNoRelease() -
gotoParent
public final boolean gotoParent() -
gotoChildrenStart
public boolean gotoChildrenStart()Set position before first child (of the element following position).- Overrides:
gotoChildrenStart
in classSeqPosition
- 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).
-
gotoAttributesStart
public boolean gotoAttributesStart()Set position before first attribute (of the element following position). This is used to iterate through the sequence of attributes. -
getAncestor
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.
-
release
public void release()- Overrides:
release
in classSeqPosition
-
dump
public void dump()Copy this position into pos.
-