WebLogic Server 6.1 API Reference: Class KeyWalker

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.xalan.transformer
Class KeyWalker

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.DescendantWalker
                                |
                                +--weblogic.apache.xpath.axes.DescendantOrSelfWalker
                                      |
                                      +--weblogic.apache.xalan.transformer.KeyWalker

public class KeyWalker
extends DescendantOrSelfWalker

Walker for a Key() function.

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:: Serialized Form

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
`KeyWalker(LocPathIterator locPathIterator)` Construct a KeyWalker using a LocPathIterator.

Method Summary
`short`	`acceptNode(org.w3c.dom.Node testNode)` Test whether a specified node is visible in the logical view of a TreeWalker or NodeIterator.
`protected org.w3c.dom.Node`	`getNextNode()` Get the next node in document order on the axes.
`org.w3c.dom.Node`	`nextNode()` Moves the `TreeWalker` to the next visible node in document order relative to the current node, and returns the new node.
`void`	`setRoot(org.w3c.dom.Node root)` Set the root node of the TreeWalker.

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

firstChild

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

getLevelMax, 
nextSibling, 
parentNode

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

canTraverseOutsideSubtree, 
checkOKToTraverse, 
clone, 
getArgLen, 
getCurrentNode, 
getExpandEntityReferences, 
getFilter, 
getLastPos, 
getNextLevelAmount, 
getNextWalker, 
getPrevWalker, 
getRoot, 
getStepType, 
init, 
isFastWalker, 
lastChild, 
previousNode, 
previousSibling, 
setCurrentIfNotNull, 
setCurrentNode, 
setNextWalker, 
setPrevWalker, 
toString

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

countProximityPosition, 
getLocPathIterator, 
getPredicateCount, 
getPredicateIndex, 
getProximityPosition, 
getProximityPosition, 
getProximityPosition, 
initPredicateInfo, 
initProximityPosition, 
isReverseAxes, 
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

Constructor Detail

KeyWalker

public KeyWalker(LocPathIterator locPathIterator)

Construct a KeyWalker using a LocPathIterator.

Parameters:: locPathIterator: - this is usually a KeyIterator

Method Detail

setRoot

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

Set the root node of the TreeWalker.

Parameters:: root - Document root node
Overrides:: setRoot in class DescendantOrSelfWalker

getNextNode

protected org.w3c.dom.Node getNextNode()

Get the next node in document order on the axes.

Returns:: The next node found or null.
Overrides:: getNextNode in class AxesWalker

acceptNode

public short acceptNode(org.w3c.dom.Node testNode)

Test whether a specified node is visible in the logical view of a TreeWalker or NodeIterator. This function will be called by the implementation of TreeWalker and NodeIterator; it is not intended to be called directly from user code.

Parameters:: testnode - The node to check to see if it passes the filter or not.
Returns:: a constant to determine whether the node is accepted, rejected, or skipped, as defined above .
Overrides:: acceptNode in class PredicatedNodeTest

nextNode

public org.w3c.dom.Node nextNode()

Moves the TreeWalker to the next visible node in document order relative to the current node, and returns the new node. If the current node has no next node, or if the search for nextNode attempts to step upward from the TreeWalker's root node, returns null , and retains the current node.

Returns:: The new node, or null if the current node has no next node in the TreeWalker's logical view.
Overrides:: nextNode in class AxesWalker