WebLogic Server 6.1 API Reference: Class KeyRefIterator

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 KeyRefIterator

java.lang.Object
  |
  +--weblogic.apache.xpath.Expression
        |
        +--weblogic.apache.xpath.patterns.NodeTest
              |
              +--weblogic.apache.xpath.axes.PredicatedNodeTest
                    |
                    +--weblogic.apache.xpath.axes.LocPathIterator
                          |
                          +--weblogic.apache.xalan.transformer.KeyRefIterator

public class KeyRefIterator
extends LocPathIterator

This class implements an optimized iterator for "key()" patterns. It uses a KeyIterator to walk the source tree and incrementally build a list of nodes that match a given key name, match pattern and value.

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.LocPathIterator

m_analysis,  
m_context,  
m_currentContextNode,  
m_dhelper,  
m_execContext,  
m_firstWalker,  
m_foundLast,  
m_lastFetched,  
m_lastUsedWalker,  
m_next,  
m_prefixResolver

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
`KeyRefIterator(java.lang.String ref, KeyIterator ki)` Constructor KeyRefIterator

Method Summary
`void`	`addNode(org.w3c.dom.Node node)` Add a node matching this ref to the cached nodes for this iterator
`java.lang.Object`	`clone()` Get a cloned LocPathIterator that holds the same position as this iterator.
`QName`	`getName()` Get key name
`org.w3c.dom.Node`	`nextNode()` Returns the next node in the set and advances the position of the iterator in the set.
`void`	`reset()` Reset the iterator.

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

addToWaitList, 
canTraverseOutsideSubtree, 
cloneWithReset, 
detach, 
execute, 
getCachedNodes, 
getContext, 
getCurrentContextNode, 
getCurrentNode, 
getCurrentPos, 
getDOMHelper, 
getExpandEntityReferences, 
getFilter, 
getFirstWalker, 
getFoundLast, 
getIsTopLevel, 
getLast, 
getLastPos, 
getLastUsedWalker, 
getLength, 
getPrefixResolver, 
getRoot, 
getWhatToShow, 
getXPathContext, 
initContext, 
isFresh, 
item, 
previousNode, 
removeFromWaitList, 
returnNextNode, 
runTo, 
setCurrentContextNode, 
setCurrentPos, 
setIsTopLevel, 
setLast, 
setLastUsedWalker, 
setNextPosition, 
setShouldCacheNodes, 
size

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

acceptNode, 
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, 
getDefaultScore, 
getLocalName, 
getNamespace, 
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, 
toString, 
wait, 
wait, 
wait

Constructor Detail

KeyRefIterator

public KeyRefIterator(java.lang.String ref,
                      KeyIterator ki)

Constructor KeyRefIterator

Parameters:: ref - Key value to match; ki - The main key iterator used to walk the source tree

Method Detail

getName

public QName getName()

Get key name

Returns:: Key name

nextNode

public org.w3c.dom.Node nextNode()
                          throws org.w3c.dom.DOMException

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.
Throws:: org.w3c.dom.DOMException - INVALID_STATE_ERR: Raised if this method is called after the detach method was invoked.
Overrides:: nextNode in class LocPathIterator

clone

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

Get a cloned LocPathIterator that holds the same position as this iterator.

Returns:: A clone of this iterator that holds the same node position.
Throws:: java.lang.CloneNotSupportedException -
Overrides:: clone in class LocPathIterator

reset

public void reset()

Reset the iterator.

Overrides:: reset in class LocPathIterator

addNode

public void addNode(org.w3c.dom.Node node)

Add a node matching this ref to the cached nodes for this iterator

Parameters:: node - Node to add to cached nodes