org.apache.xalan.xsltc.dom

Class UnionIterator

Implemented Interfaces:
Cloneable, DTMAxisIterator

public final class UnionIterator
extends DTMAxisIteratorBase

UnionIterator takes a set of NodeIterators and produces a merged NodeSet in document order with duplicates removed The individual iterators are supposed to generate nodes in document order
Authors:
Jacek Ambroziak
Santiago Pericas-Geertsen

Fields inherited from interface org.apache.xml.dtm.DTMAxisIterator

END

Constructor Summary

UnionIterator(DOM dom)

Method Summary

UnionIterator
addIterator(DTMAxisIterator iterator)
DTMAxisIterator
cloneIterator()
Returns a deep copy of this iterator.
void
gotoMark()
Restores the current node remembered by setMark().
int
next()
Get the next node in the iteration.
DTMAxisIterator
reset()
void
setMark()
Remembers the current node for the next call to gotoMark().
DTMAxisIterator
setStartNode(int node)
Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Methods inherited from class org.apache.xml.dtm.ref.DTMAxisIteratorBase

cloneIterator, getAxis, getLast, getNodeByPosition, getPosition, getStartNode, includeSelf, isDocOrdered, isReverse, reset, setRestartable

Constructor Details

UnionIterator

public UnionIterator(DOM dom)

Method Details

addIterator

public UnionIterator addIterator(DTMAxisIterator iterator)

cloneIterator

public DTMAxisIterator cloneIterator()
Returns a deep copy of this iterator. Cloned iterators may not be restartable. The iterator being cloned may or may not become non-restartable as a side effect of this operation.
Specified by:
cloneIterator in interface DTMAxisIterator
Overrides:
cloneIterator in interface DTMAxisIteratorBase
Returns:
a deep copy of this iterator.

gotoMark

public void gotoMark()
Restores the current node remembered by setMark().
Specified by:
gotoMark in interface DTMAxisIterator

next

public int next()
Get the next node in the iteration.
Specified by:
next in interface DTMAxisIterator
Returns:
The next node handle in the iteration, or END.

reset

public DTMAxisIterator reset()
Specified by:
reset in interface DTMAxisIterator
Overrides:
reset in interface DTMAxisIteratorBase
Returns:
A DTMAxisIterator which has been reset to the start node, which may or may not be the same as this iterator.

setMark

public void setMark()
Remembers the current node for the next call to gotoMark().
Specified by:
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.
Specified by:
setStartNode in interface DTMAxisIterator
Parameters:
node - Sets the root of the iteration.
Returns:
A DTMAxisIterator set to the start of the iteration.

Copyright B) 2005 Apache XML Project. All Rights Reserved.