org.apache.xalan.xsltc.dom
Class MatchingIterator
- Cloneable, DTMAxisIterator
public final class MatchingIterator
This is a special kind of iterator that takes a source iterator and a
node N. If initialized with a node M (the parent of N) it computes the
position of N amongst the children of M. This position can be obtained
by calling getPosition().
It is an iterator even though next() will never be called. It is used to
match patterns with a single predicate like:
BOOK[position() = last()]
In this example, the source iterator will return elements of type BOOK,
a call to position() will return the position of N. Notice that because
of the way the pattern matching is implemented, N will always be a node
in the source since (i) it is a BOOK or the test sequence would not be
considered and (ii) the source iterator is initialized with M which is
the parent of N. Also, and still in this example, a call to last() will
return the number of elements in the source (i.e. the number of BOOKs).
- Jacek Ambroziak
- Santiago Pericas-Geertsen
cloneIterator , getAxis , getLast , getNodeByPosition , getPosition , getStartNode , includeSelf , isDocOrdered , isReverse , reset , setRestartable |
getLast
public int getLast()
Returns the position of the last node within the iteration, as
defined by XPath. In a forward iterator, I believe this equals the number of nodes which this
iterator will yield. In a reverse iterator, I believe it should return
1 (since the "last" is the first produced.)
This may be an expensive operation when called the first time, since
it may have to iterate through a large part of the document to produce
its answer.
- getLast in interface DTMAxisIterator
- getLast in interface DTMAxisIteratorBase
- The number of nodes in this iterator (forward) or 1 (reverse).
gotoMark
public void gotoMark()
Restores the current node remembered by setMark().
- gotoMark in interface DTMAxisIterator
next
public int next()
Get the next node in the iteration.
- next in interface DTMAxisIterator
- The next node handle in the iteration, or END.
setMark
public void setMark()
Remembers the current node for the next call to gotoMark().
- setMark in interface DTMAxisIterator
setStartNode
public DTMAxisIterator setStartNode(int node)
Set start to END should 'close' the iterator,
i.e. subsequent call to next() should return END.
- setStartNode in interface DTMAxisIterator
node
- Sets the root of the iteration.
- A DTMAxisIterator set to the start of the iteration.
Copyright © 2006 Apache XML Project. All Rights Reserved.