com.icl.saxon.tinytree
Class DescendantEnumeration

java.lang.Object
  com.icl.saxon.tinytree.DescendantEnumeration

All Implemented Interfaces:

LastPositionFinder, AxisEnumeration, NodeEnumeration

final class DescendantEnumeration
extends java.lang.Object
implements AxisEnumeration

This class supports both the descendant:: and descendant-or-self:: axes, which are identical except for the route to the first candidate node. It enumerates descendants of the specified node. The calling code must ensure that the start node is not an attribute or namespace node.

Field Summary

(package private) TinyDocumentImpl	document
(package private) boolean	includeSelf
(package private) int	last
(package private) int	nextNodeNr
(package private) TinyNodeImpl	parentNode
(package private) int	startDepth
(package private) TinyNodeImpl	startNode
(package private) NodeTest	test

Constructor Summary

protected

DescendantEnumeration(TinyDocumentImpl doc, TinyNodeImpl node, NodeTest nodeTest, boolean includeSelf)

Method Summary

int	getLastPosition() Get the last position, that is the number of nodes in the enumeration
boolean	hasMoreElements() Determine whether there are more nodes to come.
boolean	isPeer() Determine whether the nodes returned by this enumeration are known to be peers, that is, no node is a descendant or ancestor of another node.
boolean	isReverseSorted() Determine whether the nodes returned by this enumeration are known to be in reverse document order.
boolean	isSorted() Determine whether the nodes returned by this enumeration are known to be in document order
NodeInfo	nextElement() Get the next node in sequence.

Methods inherited from class java.lang.Object

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

Field Detail

document

TinyDocumentImpl document

startNode

TinyNodeImpl startNode

includeSelf

boolean includeSelf

nextNodeNr

int nextNodeNr

startDepth

int startDepth

test

NodeTest test

last

int last

parentNode

TinyNodeImpl parentNode

Constructor Detail

DescendantEnumeration

protected DescendantEnumeration(TinyDocumentImpl doc,
                                TinyNodeImpl node,
                                NodeTest nodeTest,
                                boolean includeSelf)

Method Detail

hasMoreElements

public boolean hasMoreElements()

Description copied from interface: AxisEnumeration

Determine whether there are more nodes to come.
(Note the term "Element" is used here in the sense of the standard Java Enumeration class, it has nothing to do with XML elements).

Specified by:

hasMoreElements in interface AxisEnumeration

Specified by:

hasMoreElements in interface NodeEnumeration

Returns:

true if there are more nodes

nextElement

public NodeInfo nextElement()

Description copied from interface: AxisEnumeration

Get the next node in sequence.
(Note the term "Element" is used here in the sense of the standard Java Enumeration class, it has nothing to do with XML elements).

Specified by:

nextElement in interface AxisEnumeration

Specified by:

nextElement in interface NodeEnumeration

Returns:

the next NodeInfo

isSorted

public boolean isSorted()

Description copied from interface: NodeEnumeration

Determine whether the nodes returned by this enumeration are known to be in document order

Specified by:

isSorted in interface NodeEnumeration

Returns:

true if the nodes are guaranteed to be in document order.

isReverseSorted

public boolean isReverseSorted()

Description copied from interface: NodeEnumeration

Determine whether the nodes returned by this enumeration are known to be in reverse document order.

Specified by:

isReverseSorted in interface NodeEnumeration

Returns:

true if the nodes are guaranteed to be in document order.

isPeer

public boolean isPeer()

Description copied from interface: NodeEnumeration

Determine whether the nodes returned by this enumeration are known to be peers, that is, no node is a descendant or ancestor of another node. This significance of this property is that if a peer enumeration is applied to each node in a set derived from another peer enumeration, and if both enumerations are sorted, then the result is also sorted.

Specified by:

isPeer in interface NodeEnumeration

getLastPosition

public int getLastPosition()

Get the last position, that is the number of nodes in the enumeration

Specified by:

getLastPosition in interface LastPositionFinder

Specified by:

getLastPosition in interface AxisEnumeration