net.sf.saxon.tree
abstract class TreeEnumeration extends Object implements AxisIterator, LookaheadIterator
Field Summary | |
---|---|
protected NodeImpl | current |
protected NodeImpl | next |
protected NodeTest | nodeTest |
protected int | position |
protected NodeImpl | start |
Constructor Summary | |
---|---|
TreeEnumeration(NodeImpl origin, NodeTest nodeTest)
Create an axis enumeration for a given type and name of node, from a given
origin node |
Method Summary | |
---|---|
protected void | advance()
Advance along the axis until a node is found that matches the required criteria |
Value | atomize()
Return the atomized value of the current node.
|
void | close() |
protected boolean | conforms(NodeImpl node)
Test whether a node conforms to the node type and name constraints.
|
Item | current()
Return the current Item |
int | getProperties()
Get properties of this iterator, as a bit-significant integer.
|
CharSequence | getStringValue()
Return the string value of the current node.
|
boolean | hasNext()
Determine whether there are more items to come. |
AxisIterator | iterateAxis(byte axis, NodeTest test)
Return an iterator over an axis, starting at the current node.
|
boolean | moveNext()
Move to the next node, without returning it. |
Item | next()
Return the next node in the enumeration |
int | position()
Return the current position |
protected abstract void | step()
Advance one step along the axis: the resulting node might not meet the required
criteria for inclusion |
Parameters: origin the node from which the axis originates nodeTest test to be satisfied by the returned nodes, or null if all nodes are to be returned.
Returns: the atomized value.
Throws: NullPointerException if there is no current node
Returns: the properties of this iterator. This will be some combination of properties such as GROUNDED, LAST_POSITION_FINDER, and 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.
Returns: the string value, as an instance of CharSequence.
Throws: NullPointerException if there is no current node
Returns: true if there are more items in the sequence
Parameters: axis the axis to iterate over, using a constant such as CHILD test a predicate to apply to the nodes before returning them.
Throws: NullPointerException if there is no current node