org.apache.xalan.xsltc.dom

Class MultiValuedNodeHeapIterator.HeapNode

Enclosing Class:
MultiValuedNodeHeapIterator
Implemented Interfaces:
Cloneable

public abstract class MultiValuedNodeHeapIterator.HeapNode
extends java.lang.Object
implements Cloneable

An abstract representation of a set of nodes that will be retrieved in document order.

Method Summary

MultiValuedNodeHeapIterator.HeapNode
cloneHeapNode()
Creates a deep copy of this MultiValuedNodeHeapIterator.HeapNode.
void
gotoMark()
Restores the current node remembered by setMark().
abstract boolean
isLessThan(MultiValuedNodeHeapIterator.HeapNode heapNode)
Performs a comparison of the two heap nodes
abstract MultiValuedNodeHeapIterator.HeapNode
reset()
Reset the heap node back to its beginning.
void
setMark()
Remembers the current node for the next call to gotoMark().
abstract MultiValuedNodeHeapIterator.HeapNode
setStartNode(int node)
Sets context with respect to which this heap node is evaluated.
abstract int
step()
Advance to the next node represented by this MultiValuedNodeHeapIterator.HeapNode

Method Details

cloneHeapNode

public MultiValuedNodeHeapIterator.HeapNode cloneHeapNode()
Creates a deep copy of this MultiValuedNodeHeapIterator.HeapNode. The clone is not reset from the current position of the original.
Returns:
the cloned heap node

gotoMark

public void gotoMark()

isLessThan

public abstract boolean isLessThan(MultiValuedNodeHeapIterator.HeapNode heapNode)
Performs a comparison of the two heap nodes
Parameters:
heapNode - the heap node against which to compare
Returns:
true if and only if the current node for this heap node is before the current node of the argument heap node in document order.

reset

public abstract MultiValuedNodeHeapIterator.HeapNode reset()
Reset the heap node back to its beginning.
Returns:
a MultiValuedNodeHeapIterator.HeapNode which may or may not be the same as this HeapNode.

setMark

public void setMark()

setStartNode

public abstract MultiValuedNodeHeapIterator.HeapNode setStartNode(int node)
Sets context with respect to which this heap node is evaluated.
Parameters:
node - The new context node
Returns:
a MultiValuedNodeHeapIterator.HeapNode which may or may not be the same as this HeapNode.

step

public abstract int step()
Returns:
the next DTM node.

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