Package net.sf.saxon.tinytree
Class SiblingEnumeration
java.lang.Object
net.sf.saxon.om.AxisIteratorImpl
net.sf.saxon.tinytree.SiblingEnumeration
- All Implemented Interfaces:
AtomizableIterator
,AxisIterator
,LookaheadIterator
,SequenceIterator
This class supports both the child:: and following-sibling:: axes, which are
identical except for the route to the first candidate node.
It enumerates either the children or the following siblings of the specified node.
In the case of children, the specified node must always
be a node that has children: to ensure this, construct the enumeration
using NodeInfo#getEnumeration()
-
Field Summary
Fields inherited from class net.sf.saxon.om.AxisIteratorImpl
current, position
Fields inherited from interface net.sf.saxon.om.SequenceIterator
ATOMIZABLE, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
-
Constructor Summary
ConstructorsConstructorDescriptionSiblingEnumeration
(TinyTree tree, TinyNodeImpl node, NodeTest nodeTest, boolean getChildren) Return an enumeration over children or siblings of the context node -
Method Summary
Methods inherited from class net.sf.saxon.om.AxisIteratorImpl
current, isAtomizing, position, setIsAtomizing
-
Constructor Details
-
SiblingEnumeration
SiblingEnumeration(TinyTree tree, TinyNodeImpl node, NodeTest nodeTest, boolean getChildren) Return an enumeration over children or siblings of the context node- Parameters:
tree
- The TinyTree containing the context nodenode
- The context node, the start point for the iterationnodeTest
- Test that the selected nodes must satisfy, or null indicating that all nodes are selectedgetChildren
- True if children of the context node are to be returned, false if following siblings are required
-
-
Method Details
-
next
Description copied from interface:SequenceIterator
Get the next item in the sequence. This method changes the state of the iterator, in particular it affects the result of subsequent calls of position() and current().- Specified by:
next
in interfaceAxisIterator
- Specified by:
next
in interfaceSequenceIterator
- Returns:
- the next item, or null if there are no more items. Once a call on next() has returned null, no further calls should be made. The preferred action for an iterator if subsequent calls on next() are made is to return null again, and all implementations within Saxon follow this rule.
-
hasNext
public boolean hasNext()Test whether there are any more nodes to come. This method is used only when testing whether the current item is the last in the sequence. It's not especially efficient, but is more efficient than the alternative strategy which involves counting how many nodes there are in the sequence.- Specified by:
hasNext
in interfaceLookaheadIterator
- Returns:
- true if there are more items in the sequence
-
getAnother
Get another enumeration of the same nodes- Specified by:
getAnother
in interfaceAxisIterator
- Specified by:
getAnother
in interfaceSequenceIterator
- Returns:
- a SequenceIterator that iterates over the same items, positioned before the first item
-
getProperties
public int getProperties()Description copied from class:AxisIteratorImpl
Get properties of this iterator, as a bit-significant integer.- Specified by:
getProperties
in interfaceSequenceIterator
- Overrides:
getProperties
in classAxisIteratorImpl
- Returns:
- the properties of this iterator. This will be some combination of
properties such as
SequenceIterator.GROUNDED
,SequenceIterator.LAST_POSITION_FINDER
, andSequenceIterator.LOOKAHEAD
. It is always acceptable to return the value zero, indicating that there are no known special properties. It is acceptable for the properties of the iterator to change depending on its state.
-