WebLogic Server 6.1 API Reference: Class AncestorWalker

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

BEA Systems, Inc.

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

WebLogic Server 6.1 API Reference

weblogic.apache.xpath.axes
Class AncestorWalker

java.lang.Object
  |
  +--weblogic.apache.xpath.Expression
        |
        +--weblogic.apache.xpath.patterns.NodeTest
              |
              +--weblogic.apache.xpath.axes.PredicatedNodeTest
                    |
                    +--weblogic.apache.xpath.axes.AxesWalker
                          |
                          +--weblogic.apache.xpath.axes.ReverseAxesWalker
                                |
                                +--weblogic.apache.xpath.axes.AncestorWalker

Direct Known Subclasses:: AncestorOrSelfWalker

public class AncestorWalker
extends ReverseAxesWalker

Walker for the 'ancestor' axes.

This class is based on an implementation from the Apache XML Project. In future releases the XML parser, XSLT processor, and associated classes will likely be updated to be based on a later version of the Apache implementations. Since Apache does not guarantee backwards compatibility between versions of their software, we cannot guarantee backwards compatibility of any of the classes contained in the weblogic.apache package or sub-packages.

See Also:: XPath axes descriptions, Serialized Form

Field Summary
`protected java.util.Stack`	`m_ancestors` Stack of ancestors.
`protected int`	`m_ancestorsPos` The position within the stack.

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

FEATURE_NODETESTFILTER,  
m_nextLevelAmount,  
m_nextWalker

Fields inherited from class weblogic.apache.xpath.axes.PredicatedNodeTest

m_lpi,  
m_proximityPositions

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

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

Fields inherited from class weblogic.apache.xpath.Expression

m_slocator

Constructor Summary
`AncestorWalker(LocPathIterator locPathIterator)` Construct an AncestorWalker using a LocPathWalker.

Method Summary
`java.lang.Object`	`clone()` Get a cloned AncestorWalker.
`org.w3c.dom.Node`	`firstChild()` Moves the `TreeWalker` to the first visible child of the current node, and returns the new node.
`protected int`	`getLevelMax()` Tell what's the maximum level this axes can descend to.
`protected void`	`pushAncestors(org.w3c.dom.Node n)` Push the ancestor nodes.
`void`	`setRoot(org.w3c.dom.Node root)` The root node of the TreeWalker.

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

countProximityPosition, 
getLastPos, 
getProximityPosition, 
isReverseAxes

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

canTraverseOutsideSubtree, 
checkOKToTraverse, 
getArgLen, 
getCurrentNode, 
getExpandEntityReferences, 
getFilter, 
getNextLevelAmount, 
getNextNode, 
getNextWalker, 
getPrevWalker, 
getRoot, 
getStepType, 
init, 
isFastWalker, 
lastChild, 
nextNode, 
nextSibling, 
parentNode, 
previousNode, 
previousSibling, 
setCurrentIfNotNull, 
setCurrentNode, 
setNextWalker, 
setPrevWalker, 
toString

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

acceptNode, 
getLocPathIterator, 
getPredicateCount, 
getPredicateIndex, 
getProximityPosition, 
getProximityPosition, 
initPredicateInfo, 
initProximityPosition, 
nodeToString, 
resetProximityPositions, 
setLocPathIterator, 
setPredicateCount

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

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

Methods inherited from class weblogic.apache.xpath.Expression

assert, 
error, 
setSourceLocator, 
warn

Methods inherited from class java.lang.Object

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

Field Detail

m_ancestors

protected transient java.util.Stack m_ancestors

Stack of ancestors. We have to do this instead of just using getParent on the fly, because we have to walk the ancestors in document order.

m_ancestorsPos

protected transient int m_ancestorsPos

The position within the stack.

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

pushAncestors

protected void pushAncestors(org.w3c.dom.Node n)

Push the ancestor nodes.

Parameters:: n -

setRoot

public void setRoot(org.w3c.dom.Node root)

The root node of the TreeWalker.

Parameters:: root - The context node of this step.
Overrides:: setRoot in class ReverseAxesWalker

firstChild

public org.w3c.dom.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

getLevelMax

protected int getLevelMax()

Tell what's the maximum level this axes can descend to.

Returns:: An estimation of the maximum level this axes can descend to.
Overrides:: getLevelMax in class AxesWalker