org.apache.xpath.axes

Class ChildIterator

public class ChildIterator extends LocPathIterator

This class implements an optimized iterator for "node()" patterns, that is, any children of the context node.

UNKNOWN: advanced

Method Summary
int	asNode(XPathContext xctxt) Return the first node out of the nodeset, if this expression is a nodeset expression.
int	getAxis() Returns the axis being iterated, if it is known.
int	nextNode() Returns the next node in the set and advances the position of the iterator in the set.

Method Detail

asNode

public int asNode(XPathContext xctxt)

Return the first node out of the nodeset, if this expression is a nodeset expression. This is the default implementation for nodesets.

WARNING: Do not mutate this class from this function!

Parameters: xctxt The XPath runtime context.

Returns: the first node out of the nodeset, or DTM.NULL.

getAxis

public int getAxis()

Returns the axis being iterated, if it is known.

Returns: Axis.CHILD, etc., or -1 if the axis is not known or is of multiple types.

nextNode

public int nextNode()

Returns the next node in the set and advances the position of the iterator in the set. After a NodeIterator is created, the first call to nextNode() returns the first node in the set.

Returns: The next Node in the set being iterated over, or null if there are no more members in that set.