org.apache.xalan.transformer
Class KeyIterator

java.lang.Object
  |
  +--org.apache.xpath.Expression
        |
        +--org.apache.xpath.patterns.NodeTest
              |
              +--org.apache.xpath.axes.PredicatedNodeTest
                    |
                    +--org.apache.xpath.axes.LocPathIterator
                          |
                          +--org.apache.xpath.axes.WalkingIterator
                                |
                                +--org.apache.xalan.transformer.KeyIterator

public class KeyIterator

extends WalkingIterator

**For internal use only** This class implements an optimized iterator for "key()" patterns. This iterator incrementally walks the source tree and finds all the nodes that match a given key name and match pattern.

See Also:

Serialized Form

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

m_lastFetched

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

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

Constructor Summary

KeyIterator(int doc, PrefixResolver nscontext, QName name, java.util.Vector keyDeclarations, XPathContext xctxt)
Constructor KeyIterator

Method Summary

java.util.Vector	getKeyDeclarations() Get the key declarations from the stylesheet
QName	getName() Get the key name from a key declaration this iterator will process
int	nextNode() Returns the next node in the set and advances the position of the iterator in the set.
void	setLookupKey(XMLString lookupKey) Set the value of the key that this iterator will look for

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

clone, detach, fixupVariables, getFirstWalker, getLastUsedWalker, reset, setLastUsedWalker

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

allowDetachToRelease, asIterator, asNode, bool, cloneWithReset, execute, findLastPos, getAxis, getCachedNodes, getContext, getCurrentContextNode, getCurrentNode, getCurrentPos, getDTM, getDTMManager, getExpandEntityReferences, getFilter, getFoundLast, getIsTopLevel, getLast, getLastPos, getLength, getPrefixResolver, getRoot, getWhatToShow, getXPathContext, isDocOrdered, isFresh, isMutable, isNodesetExpr, item, previousNode, runTo, setCurrentContextNode, setCurrentPos, setEnvironment, setIsTopLevel, setItem, setLast, setRoot, setShouldCacheNodes, size

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

acceptNode, canTraverseOutsideSubtree, 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, getNodeTypeTest, getStaticScore, initNodeTest, initNodeTest, setLocalName, setNamespace, setStaticScore, setWhatToShow

Methods inherited from class org.apache.xpath.Expression

assertion, error, executeCharsToContentHandler, isStableNumber, num, setSourceLocator, warn, xstr

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyIterator

public KeyIterator(int doc,
                   PrefixResolver nscontext,
                   QName name,
                   java.util.Vector keyDeclarations,
                   XPathContext xctxt)

Constructor KeyIterator

Parameters:

doc - The document node

nscontext - The prefix resolver for the execution context.

name - The key name

keyDeclarations - The key declarations from the stylesheet

xctxt - The XPath runtime state

Method Detail

getName

public QName getName()

Get the key name from a key declaration this iterator will process

Returns:

Key name

getKeyDeclarations

public java.util.Vector getKeyDeclarations()

Get the key declarations from the stylesheet

Returns:

Vector containing the key declarations from the stylesheet

nextNode

public int nextNode()

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.

Overrides:

nextNode in class WalkingIterator

setLookupKey

public void setLookupKey(XMLString lookupKey)

Set the value of the key that this iterator will look for

Parameters:

lookupKey - value of the key to look for