org.apache.xalan.xsltc.dom

Class UnionIterator

java.lang.Object

org.apache.xml.dtm.ref.DTMAxisIteratorBase

org.apache.xalan.xsltc.dom.UnionIterator

All Implemented Interfaces:

java.lang.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

Author:

Jacek Ambroziak, Santiago Pericas-Geertsen

Field Summary

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

END

Constructor Summary

Constructors

Constructor and Description
UnionIterator(DOM dom)

Method Summary

Methods

Modifier and Type	Method and Description
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() Resets the iterator to the last start node.
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

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnionIterator

public UnionIterator(DOM dom)

Method Detail

cloneIterator

public DTMAxisIterator cloneIterator()

Description copied from class: DTMAxisIteratorBase

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 class DTMAxisIteratorBase

Returns:

a deep copy of this iterator.

addIterator

public UnionIterator addIterator(DTMAxisIterator iterator)

next

public int next()

Description copied from interface: DTMAxisIterator

Get the next node in the iteration.

Returns:

The next node handle in the iteration, or END.

setStartNode

public DTMAxisIterator setStartNode(int node)

Description copied from interface: DTMAxisIterator

Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Parameters:

node - Sets the root of the iteration.

Returns:

A DTMAxisIterator set to the start of the iteration.

setMark

public void setMark()

Description copied from interface: DTMAxisIterator

Remembers the current node for the next call to gotoMark().

gotoMark

public void gotoMark()

Description copied from interface: DTMAxisIterator

Restores the current node remembered by setMark().

reset

public DTMAxisIterator reset()

Description copied from interface: DTMAxisIterator

Resets the iterator to the last start node.

Specified by:

reset in interface DTMAxisIterator

Overrides:

reset in class DTMAxisIteratorBase

Returns:

A DTMAxisIterator which has been reset to the start node, which may or may not be the same as this iterator.