|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.saxon.tree.TreeEnumeration
abstract class TreeEnumeration
Field Summary | |
---|---|
protected NodeImpl |
current
|
protected NodeImpl |
next
|
protected NodeTest |
nodeTest
|
protected int |
position
|
protected NodeImpl |
start
|
Fields inherited from interface net.sf.saxon.om.SequenceIterator |
---|
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD |
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. |
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface net.sf.saxon.om.UnfailingIterator |
---|
getAnother |
Field Detail |
---|
protected NodeImpl start
protected NodeImpl next
protected NodeTest nodeTest
protected NodeImpl current
protected int position
Constructor Detail |
---|
public TreeEnumeration(NodeImpl origin, NodeTest nodeTest)
origin
- the node from which the axis originatesnodeTest
- test to be satisfied by the returned nodes, or null if all nodes
are to be returned.Method Detail |
---|
protected boolean conforms(NodeImpl node)
protected final void advance()
protected abstract void step()
public boolean hasNext()
hasNext
in interface LookaheadIterator
public boolean moveNext()
moveNext
in interface AxisIterator
public final Item next()
next
in interface SequenceIterator
next
in interface UnfailingIterator
public final Item current()
current
in interface SequenceIterator
current
in interface UnfailingIterator
public final int position()
position
in interface SequenceIterator
position
in interface UnfailingIterator
public AxisIterator iterateAxis(byte axis, NodeTest test)
iterateAxis
in interface AxisIterator
axis
- the axis to iterate over, using a constant such as
Axis.CHILD
test
- a predicate to apply to the nodes before returning them.
NullPointerException
- if there is no current nodepublic Value atomize() throws XPathException
atomize
in interface AxisIterator
NullPointerException
- if there is no current node
XPathException
public CharSequence getStringValue()
getStringValue
in interface AxisIterator
NullPointerException
- if there is no current nodepublic int getProperties()
getProperties
in interface SequenceIterator
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |