org.apache.xpath.axes
Class AncestorWalker

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.ReverseAxesWalker
                                |
                                +--org.apache.xpath.axes.AncestorWalker

Direct Known Subclasses:

AncestorOrSelfWalker

public class AncestorWalker

extends ReverseAxesWalker

Walker for the 'ancestor' axes.

See Also:

XPath axes 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

AncestorWalker(LocPathIterator locPathIterator)
Construct an AncestorWalker using a LocPathWalker.

Method Summary

java.lang.Object	clone() Get a cloned AncestorWalker.
Node	firstChild() Moves the TreeWalker to the first visible child of the current node, and returns the new node.
void	setRoot(Node root) The root node of the TreeWalker.

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

getLastPos, isReverseAxes

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

canTraverseOutsideSubtree, getCurrentNode, getExpandEntityReferences, getFilter, 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, 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

assert, error, setSourceLocator, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

AncestorWalker

public AncestorWalker(LocPathIterator locPathIterator)

Construct an AncestorWalker using a LocPathWalker.

Parameters:

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

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Get a cloned AncestorWalker.

Returns:

A new AncestorWalker that can be used without mutating this one.

Throws:

java.lang.CloneNotSupportedException -

Overrides:

clone in class AxesWalker

setRoot

public void setRoot(Node root)

The root node of the TreeWalker.

Parameters:

root - The context node of this step.

Overrides:

setRoot in class ReverseAxesWalker

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