org.apache.xpath.axes
Class RootWalker

java.lang.Object
  |
  +--org.apache.xpath.Expression
        |
        +--org.apache.xpath.patterns.NodeTest
              |
              +--org.apache.xpath.axes.PredicatedNodeTest
                    |
                    +--org.apache.xpath.axes.AxesWalker
                          |
                          +--org.apache.xpath.axes.RootWalker

public class RootWalker

extends AxesWalker

Walker for the FROM_ROOT axes.

See Also:

XPath location-paths descriptions, XPath AbsoluteLocationPath descriptions, XPath AbbreviatedAbsoluteLocationPath descriptions, Serialized Form

Fields inherited from class org.apache.xpath.axes.AxesWalker

FEATURE_NODETESTFILTER

Fields inherited from class org.apache.xpath.patterns.NodeTest

SCORE_NODETEST, SCORE_NONE, SCORE_NSWILD, SCORE_OTHER, SCORE_QNAME, SHOW_BYFUNCTION, SHOW_NAMESPACE, SUPPORTS_PRE_STRIPPING, WILD

Constructor Summary

RootWalker(LocPathIterator locPathIterator)
Construct a RootWalker using a LocPathIterator.

Method Summary

Node	firstChild() Moves the TreeWalker to the first visible child of the current node, and returns the new node.
void	setRoot(Node root) Set the root node of the TreeWalker.

Methods inherited from class org.apache.xpath.axes.AxesWalker

canTraverseOutsideSubtree, clone, getCurrentNode, getExpandEntityReferences, getFilter, getLastPos, getNextWalker, getPrevWalker, getRoot, init, lastChild, nextNode, nextSibling, parentNode, previousNode, previousSibling, setCurrentNode, setNextWalker, setPrevWalker, toString

Methods inherited from class org.apache.xpath.axes.PredicatedNodeTest

acceptNode, getLocPathIterator, getPredicateCount, getPredicateIndex, getProximityPosition, getProximityPosition, initProximityPosition, isReverseAxes, resetProximityPositions, setLocPathIterator, setPredicateCount

Methods inherited from class org.apache.xpath.patterns.NodeTest

debugWhatToShow, execute, execute, getDefaultScore, getLocalName, getNamespace, getWhatToShow, initNodeTest, initNodeTest

Methods inherited from class org.apache.xpath.Expression

assertion, error, setSourceLocator, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RootWalker

public RootWalker(LocPathIterator locPathIterator)

Construct a RootWalker using a LocPathIterator.

Parameters:

locPathIterator - The location path iterator that 'owns' this walker.

Method Detail

setRoot

public void setRoot(Node root)

Set the root node of the TreeWalker.

Parameters:

root - The context node of this step.

Overrides:

setRoot in class AxesWalker

firstChild

public Node firstChild()

Moves the TreeWalker to the first visible child of the current node, and returns the new node. If the current node has no visible children, returns null , and retains the current node.

Returns:

The new node, or null if the current node has no visible children in the TreeWalker's logical view.

Overrides:

firstChild in class AxesWalker