org.apache.xpath.axes
Class ChildIterator

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

All Implemented Interfaces:

Cloneable, DTMIterator, ExpressionNode, PathComponent, Serializable, javax.xml.transform.SourceLocator, SubContextList, XPathVisitable

public class ChildIterator

extends LocPathIterator

This class implements an optimized iterator for "node()" patterns, that is, any children of the context node.

See Also:

org.apache.xpath.axes.WalkerFactory#newLocPathIterator, Serialized Form

Nested Class Summary

Nested classes inherited from class org.apache.xpath.axes.PredicatedNodeTest

PredicatedNodeTest.PredOwner

Field Summary

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

m_allowDetach, m_cdtm, m_clones, m_context, m_currentContextNode, m_execContext, m_lastFetched, m_length, m_pos, m_stackFrame

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

DEBUG_PREDICATECOUNTING, m_foundLast, m_lpi, m_predCount, m_predicateIndex, m_proximityPositions

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

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

Fields inherited from class org.apache.xpath.Expression

Fields inherited from interface org.apache.xml.dtm.DTMIterator

FILTER_ACCEPT, FILTER_REJECT, FILTER_SKIP

Constructor Summary

(package private)

ChildIterator(Compiler compiler, int opPos, int analysis) Create a ChildIterator object.

Method Summary

int	asNode(XPathContext xctxt) Return the first node out of the nodeset, if this expression is a nodeset expression.
int	getAxis() Returns the axis being iterated, if it is known.
int	nextNode() Returns the next node in the set and advances the position of the iterator in the set.

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

allowDetachToRelease, asIterator, bool, callVisitors, cloneWithReset, detach, execute, executeCharsToContentHandler, getAnalysisBits, getContext, getCurrentContextNode, getCurrentNode, getCurrentPos, getDTM, getDTMManager, getExpandEntityReferences, getFilter, getFoundLast, getIsTopLevel, getLastPos, getLength, getPrefixResolver, getRoot, getWhatToShow, getXPathContext, incrementCurrentPos, isDocOrdered, isFresh, isMutable, isNodesetExpr, item, previousNode, reset, returnNextNode, runTo, setCurrentContextNode, setCurrentPos, setEnvironment, setIsTopLevel, setItem, setNextPosition, setRoot, setShouldCacheNodes, size

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

acceptNode, callPredicateVisitors, canTraverseOutsideSubtree, clone, countProximityPosition, deepEquals, executePredicates, fixupVariables, getLocPathIterator, getPredicate, getPredicateCount, getPredicateIndex, getProximityPosition, getProximityPosition, getProximityPosition, initPredicateInfo, initProximityPosition, isReverseAxes, nodeToString, resetProximityPositions, setLocPathIterator, setPredicateCount

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

calcScore, debugWhatToShow, execute, execute, getDefaultScore, getLocalName, getNamespace, getNodeTypeTest, getStaticScore, initNodeTest, initNodeTest, setLocalName, setNamespace, setStaticScore, setWhatToShow

Methods inherited from class org.apache.xpath.Expression

asIteratorRaw, assertion, error, execute, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isSameClass, isStableNumber, num, warn, xstr

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.xml.dtm.DTMIterator

clone

Constructor Detail

ChildIterator

ChildIterator(Compiler compiler,
              int opPos,
              int analysis)
        throws javax.xml.transform.TransformerException

Create a ChildIterator object.

Parameters:

compiler - A reference to the Compiler that contains the op map.

opPos - The position within the op map, which contains the location path expression for this itterator.

analysis - Analysis bits of the entire pattern.

Throws:

javax.xml.transform.TransformerException

Method Detail

asNode

public int asNode(XPathContext xctxt)
           throws javax.xml.transform.TransformerException

Return the first node out of the nodeset, if this expression is a nodeset expression. This is the default implementation for nodesets.

WARNING: Do not mutate this class from this function!

Overrides:

asNode in class LocPathIterator

Parameters:

xctxt - The XPath runtime context.

Returns:

the first node out of the nodeset, or DTM.NULL.

Throws:

javax.xml.transform.TransformerException

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.

Specified by:

nextNode in interface DTMIterator

Specified by:

nextNode in class LocPathIterator

Returns:

The next Node in the set being iterated over, or null if there are no more members in that set.

getAxis

public int getAxis()

Returns the axis being iterated, if it is known.

Specified by:

getAxis in interface DTMIterator

Overrides:

getAxis in class LocPathIterator

Returns:

Axis.CHILD, etc., or -1 if the axis is not known or is of multiple types.