APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.xpath.internal.axes

public Class ChildIterator

extends LocPathIterator
Class Inheritance
Imports
com.sun.org.apache.xml.internal.dtm.DTM, .DTMFilter, com.sun.org.apache.xpath.internal.XPathContext, com.sun.org.apache.xpath.internal.compiler.Compiler

This class implements an optimized iterator for "node()" patterns, that is, any children of the context node.
See Also
com.sun.org.apache.xpath.internal.axes.LocPathIterator

Field Summary

Modifier and TypeField and Description
pack-priv static final long
Inherited from com.sun.org.apache.xpath.internal.axes.LocPathIterator:
m_allowDetachm_cdtmm_clonesm_contextm_currentContextNodem_execContextm_lastFetchedm_lengthm_posm_stackFrame

Constructor Summary

AccessConstructor and Description
pack-priv
ChildIterator(Compiler
A reference to the Compiler that contains the op map.
compiler
,
int
The position within the op map, which contains the location path expression for this itterator.
opPos
,
int
Analysis bits of the entire pattern.
analysis
)

Create a ChildIterator object.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the first node out of the nodeset, or DTM.NULL.
asNode
(XPathContext
The XPath runtime context.
xctxt
)

Overrides com.sun.org.apache.xpath.internal.axes.LocPathIterator.asNode.

Return the first node out of the nodeset, if this expression is a nodeset expression.

public int

Returns:

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

Overrides com.sun.org.apache.xpath.internal.axes.LocPathIterator.getAxis.

Implements com.sun.org.apache.xml.internal.dtm.DTMIterator.getAxis.

Returns the axis being iterated, if it is known.

public int

Returns:

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

Implements abstract com.sun.org.apache.xpath.internal.axes.LocPathIterator.nextNode.

Implements com.sun.org.apache.xml.internal.dtm.DTMIterator.nextNode.

Returns the next node in the set and advances the position of the iterator in the set.

Inherited from com.sun.org.apache.xpath.internal.axes.LocPathIterator:
allowDetachToReleaseasIteratorboolcallVisitorscloneWithResetdetachexecuteexecuteCharsToContentHandlergetAnalysisBitsgetContextgetCurrentContextNodegetCurrentNodegetCurrentPosgetDTMgetDTMManagergetExpandEntityReferencesgetFiltergetFoundLastgetIsTopLevelgetLastPosgetLengthgetPrefixResolvergetRootgetWhatToShowgetXPathContextincrementCurrentPosisDocOrderedisFreshisMutableisNodesetExpritempreviousNoderesetreturnNextNoderunTosetCurrentContextNodesetCurrentPossetEnvironmentsetIsTopLevelsetItemsetNextPositionsetRootsetShouldCacheNodessize

Field Detail

serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Hides com.sun.org.apache.xpath.internal.axes.LocPathIterator.serialVersionUID.

Constructor Detail

ChildIteratorback to summary
pack-priv ChildIterator(Compiler compiler, int opPos, int analysis) throws TransformerException

Create a ChildIterator object.

Parameters
compiler:Compiler

A reference to the Compiler that contains the op map.

opPos:int

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

analysis:int

Analysis bits of the entire pattern.

Method Detail

asNodeback to summary
public int asNode(XPathContext xctxt) throws TransformerException

Overrides com.sun.org.apache.xpath.internal.axes.LocPathIterator.asNode.

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!

Parameters
xctxt:XPathContext

The XPath runtime context.

Returns:int

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

getAxisback to summary
public int getAxis()

Overrides com.sun.org.apache.xpath.internal.axes.LocPathIterator.getAxis.

Implements com.sun.org.apache.xml.internal.dtm.DTMIterator.getAxis.

Returns the axis being iterated, if it is known.

Returns:int

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

nextNodeback to summary
public int nextNode()

Implements abstract com.sun.org.apache.xpath.internal.axes.LocPathIterator.nextNode.

Implements com.sun.org.apache.xml.internal.dtm.DTMIterator.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:int

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