com.icl.saxon.jdom
Class NodeWrapper.AncestorEnumeration

java.lang.Object
  extended bycom.icl.saxon.jdom.NodeWrapper.BaseEnumeration
      extended bycom.icl.saxon.jdom.NodeWrapper.AncestorEnumeration
All Implemented Interfaces:
AxisEnumeration, LastPositionFinder, NodeEnumeration
Enclosing class:
NodeWrapper

final class NodeWrapper.AncestorEnumeration
extends com.icl.saxon.jdom.NodeWrapper.BaseEnumeration


Field Summary
protected  NodeWrapper next
           
 
Constructor Summary
NodeWrapper.AncestorEnumeration(NodeWrapper start, boolean includeSelf)
           
 
Method Summary
 void advance()
           
 com.icl.saxon.jdom.NodeWrapper.BaseEnumeration copy()
           
 int getLastPosition()
          Get the last position
 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

next

protected NodeWrapper next
Constructor Detail

NodeWrapper.AncestorEnumeration

public NodeWrapper.AncestorEnumeration(NodeWrapper start,
                                       boolean includeSelf)
Method Detail

advance

public void advance()

isSorted

public boolean isSorted()
Description copied from interface: NodeEnumeration
Determine whether the nodes returned by this enumeration are known 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.


copy

public com.icl.saxon.jdom.NodeWrapper.BaseEnumeration copy()

hasMoreElements

public final 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
Returns:
true if there are more nodes

nextElement

public final 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
Returns:
the next NodeInfo

getLastPosition

public final int getLastPosition()
Description copied from interface: AxisEnumeration
Get the last position

Specified by:
getLastPosition in interface AxisEnumeration

isReverseSorted

public final 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.