## Uses of Interface
org.apache.xml.dtm.DTMIterator

- Packages that use DTMIterator
  Package | Description
  --- | ---
  org.apache.xalan.templates | Implements the `Templates` interface, and defines a set of classes that represent an XSLT stylesheet.
  org.apache.xalan.transformer | In charge of run-time transformations and the production of result trees.
  org.apache.xml.dtm |
  org.apache.xml.dtm.ref |
  org.apache.xpath | Implementation of XPath; for the most part, only classes meant for public use are found at this root level of the XPath packages.
  org.apache.xpath.axes | Implementation of XPath LocationPath support -- primary classes are LocPathIterator and UnionPathIterator.
  org.apache.xpath.objects | Implementation of XPath polymorphic type objects -- this package will grow as XPath objects are expanded to support XML Schema data types.

- - ### Uses of DTMIterator in org.apache.xalan.templates

    Methods in org.apache.xalan.templates that return DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `DTMIterator` | ElemForEach.`sortNodes(XPathContext xctxt, java.util.Vector keys, DTMIterator sourceNodes)` Sort given nodes

    Methods in org.apache.xalan.templates with parameters of type DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `DTMIterator` | ElemForEach.`sortNodes(XPathContext xctxt, java.util.Vector keys, DTMIterator sourceNodes)` Sort given nodes

  - ### Uses of DTMIterator in org.apache.xalan.transformer

    Classes in org.apache.xalan.transformer that implement DTMIterator
    Modifier and Type | Class and Description
    --- | ---
    `class` | `KeyIterator` This class implements an optimized iterator for "key()" patterns, matching each node to the match attribute in one or more xsl:key declarations.
    `class` | `KeyRefIterator` This class filters nodes from a key iterator, according to whether or not the use value matches the ref value.

    Methods in org.apache.xalan.transformer that return DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `DTMIterator` | TransformerImpl.`getContextNodeList()` Get the current context node list.

    Methods in org.apache.xalan.transformer with parameters of type DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `void` | NodeSorter.`sort(DTMIterator v, java.util.Vector keys, XPathContext support)` Given a vector of nodes, sort each node according to the criteria in the keys.

    Constructors in org.apache.xalan.transformer with parameters of type DTMIterator
    Constructor and Description
    `KeyRefIterator(QName name, XMLString ref, java.util.Vector keyDecls, DTMIterator ki)` Constructor KeyRefIterator

  - ### Uses of DTMIterator in org.apache.xml.dtm

    Methods in org.apache.xml.dtm that return DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `DTMIterator` | DTMIterator.`cloneWithReset()` Get a cloned Iterator that is reset to the start of the iteration.
    `abstract DTMIterator` | DTMManager.`createDTMIterator(int node)` Create a new `DTMIterator` that holds exactly one node.
    `abstract DTMIterator` | DTMManager.`createDTMIterator(int whatToShow, DTMFilter filter, boolean entityReferenceExpansion)` Create a new `DTMIterator` based only on a whatToShow and a DTMFilter.
    `abstract DTMIterator` | DTMManager.`createDTMIterator(java.lang.Object xpathCompiler, int pos)` Create a new `DTMIterator` based on an XPath UnionExpr.
    `abstract DTMIterator` | DTMManager.`createDTMIterator(java.lang.String xpathString, PrefixResolver presolver)` Create a new `DTMIterator` based on an XPath UnionExpr.

  - ### Uses of DTMIterator in org.apache.xml.dtm.ref

    Methods in org.apache.xml.dtm.ref that return DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `DTMIterator` | DTMManagerDefault.`createDTMIterator(int node)` NEEDSDOC Method createDTMIterator NEEDSDOC @param node NEEDSDOC (createDTMIterator) @return
    `DTMIterator` | DTMManagerDefault.`createDTMIterator(int whatToShow, DTMFilter filter, boolean entityReferenceExpansion)` NEEDSDOC Method createDTMIterator NEEDSDOC @param whatToShow NEEDSDOC @param filter NEEDSDOC @param entityReferenceExpansion NEEDSDOC (createDTMIterator) @return
    `DTMIterator` | DTMManagerDefault.`createDTMIterator(java.lang.Object xpathCompiler, int pos)` NEEDSDOC Method createDTMIterator NEEDSDOC @param xpathCompiler NEEDSDOC @param pos NEEDSDOC (createDTMIterator) @return
    `DTMIterator` | DTMManagerDefault.`createDTMIterator(java.lang.String xpathString, PrefixResolver presolver)` NEEDSDOC Method createDTMIterator NEEDSDOC @param xpathString NEEDSDOC @param presolver NEEDSDOC (createDTMIterator) @return
    `DTMIterator` | DTMNodeList.`getDTMIterator()` Access the wrapped DTMIterator.
    `DTMIterator` | DTMNodeIterator.`getDTMIterator()` Access the wrapped DTMIterator.

    Constructors in org.apache.xml.dtm.ref with parameters of type DTMIterator
    Constructor and Description
    `DTMNodeIterator(DTMIterator dtmIterator)` Public constructor: Wrap a DTMNodeIterator around an existing and preconfigured DTMIterator
    `DTMNodeList(DTMIterator dtmIterator)` Public constructor: Wrap a DTMNodeList around an existing and preconfigured DTMIterator WARNING: THIS HAS THE SIDE EFFECT OF ISSUING setShouldCacheNodes(true) AGAINST THE DTMIterator.

  - ### Uses of DTMIterator in org.apache.xpath

    Classes in org.apache.xpath that implement DTMIterator
    Modifier and Type | Class and Description
    --- | ---
    `class` | `NodeSetDTM` The NodeSetDTM class can act as either a NodeVector, NodeList, or NodeIterator.

    Methods in org.apache.xpath that return DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `DTMIterator` | Expression.`asIterator(XPathContext xctxt, int contextNode)` Given an select expression and a context, evaluate the XPath and return the resulting iterator.
    `DTMIterator` | Expression.`asIteratorRaw(XPathContext xctxt, int contextNode)` Given an select expression and a context, evaluate the XPath and return the resulting iterator, but do not clone.
    `DTMIterator` | NodeSetDTM.`cloneWithReset()` Get a cloned Iterator, and reset its state to the beginning of the iteration.
    `DTMIterator` | XPathContext.`createDTMIterator(int node)` Create a new `DTMIterator` that holds exactly one node.
    `DTMIterator` | XPathContext.`createDTMIterator(int whatToShow, DTMFilter filter, boolean entityReferenceExpansion)` Create a new `DTMIterator` based only on a whatToShow and a DTMFilter.
    `DTMIterator` | XPathContext.`createDTMIterator(java.lang.Object xpathCompiler, int pos)` Create a new `DTMIterator` based on an XPath UnionExpr.
    `DTMIterator` | XPathContext.`createDTMIterator(java.lang.String xpathString, PrefixResolver presolver)` Create a new `DTMIterator` based on an XPath UnionExpr.
    `DTMIterator` | XPathContext.`getContextNodeList()` Get the current context node list.
    `DTMIterator` | XPathContext.`getContextNodes()` Get the current context node list.

    Methods in org.apache.xpath with parameters of type DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `void` | NodeSetDTM.`addNodes(DTMIterator iterator)` Copy NodeList members into this nodelist, adding in document order.
    `void` | NodeSetDTM.`addNodesInDocOrder(DTMIterator iterator, XPathContext support)` Copy NodeList members into this nodelist, adding in document order.
    `void` | XPathContext.`pushContextNodeList(DTMIterator nl)` Set the current context node list.

    Constructors in org.apache.xpath with parameters of type DTMIterator
    Constructor and Description
    `NodeSetDTM(DTMIterator ni)` Create a NodeSetDTM, and copy the members of the given DTMIterator into it.

  - ### Uses of DTMIterator in org.apache.xpath.axes

    Classes in org.apache.xpath.axes that implement DTMIterator
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AttributeIterator` This class implements an optimized iterator for attribute axes patterns.
    `class` | `BasicTestIterator` Base for iterators that handle predicates.
    `class` | `ChildIterator` This class implements an optimized iterator for "node()" patterns, that is, any children of the context node.
    `class` | `ChildTestIterator` This class implements an optimized iterator for children patterns that have a node test, and possibly a predicate.
    `class` | `DescendantIterator` This class implements an optimized iterator for descendant, descendant-or-self, or "//foo" patterns.
    `class` | `FilterExprIterator`
    `class` | `FilterExprIteratorSimple` Class to use for one-step iteration that doesn't have a predicate, and doesn't need to set the context.
    `class` | `LocPathIterator` This class extends NodeSetDTM, which implements NodeIterator, and fetches nodes one at a time in document order based on a XPath | `class` | `MatchPatternIterator` This class treats a LocationPath as a filtered iteration over the tree, evaluating each node in a super axis traversal against the LocationPath interpreted as a match pattern.
    `class` | `NodeSequence` This class is the dynamic wrapper for a Xalan DTMIterator instance, and provides random access capabilities.
    `class` | `OneStepIterator` This class implements a general iterator for those LocationSteps with only one step, and perhaps a predicate.
    `class` | `OneStepIteratorForward` This class implements a general iterator for those LocationSteps with only one step, and perhaps a predicate, that only go forward (i.e. it can not be used with ancestors, preceding, etc.)
    `class` | `RTFIterator`
    `class` | `SelfIteratorNoPredicate` This class implements an optimized iterator for "." patterns, that is, the self axes without any predicates.
    `class` | `UnionChildIterator` This class defines a simplified type of union iterator that only tests along the child axes.
    `class` | `UnionPathIterator` This class extends NodeSetDTM, which implements DTMIterator, and fetches nodes one at a time in document order based on a XPath UnionExpr.
    `class` | `WalkingIterator` Location path iterator that uses Walkers.
    `class` | `WalkingIteratorSorted` This class iterates over set of nodes that needs to be sorted.

    Methods in org.apache.xpath.axes that return DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `DTMIterator` | LocPathIterator.`asIterator(XPathContext xctxt, int contextNode)` Given an select expression and a context, evaluate the XPath and return the resulting iterator.
    `DTMIterator` | OneStepIterator.`cloneWithReset()` Get a cloned Iterator that is reset to the beginning of the query.
    `DTMIterator` | NodeSequence.`cloneWithReset()` Note: Not a deep clone.
    `DTMIterator` | LocPathIterator.`cloneWithReset()` Get a cloned Iterator that is reset to the beginning of the query.
    `DTMIterator` | DescendantIterator.`cloneWithReset()` Get a cloned Iterator that is reset to the beginning of the query.
    `DTMIterator` | ChildTestIterator.`cloneWithReset()` Get a cloned Iterator that is reset to the beginning of the query.
    `DTMIterator` | BasicTestIterator.`cloneWithReset()` Get a cloned Iterator that is reset to the beginning of the query.
    `DTMIterator` | NodeSequence.`getContainedIter()` Get the functional iterator that fetches nodes.
    `DTMIterator` | IteratorPool.`getInstance()` Get an instance of the given object in this pool
    `DTMIterator` | IteratorPool.`getInstanceOrThrow()` Get an instance of the given object in this pool
    `static DTMIterator` | WalkerFactory.`newDTMIterator(Compiler compiler, int opPos, boolean isTopLevel)` Create a new LocPathIterator iterator.

    Methods in org.apache.xpath.axes with parameters of type DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `void` | UnionPathIterator.`addIterator(DTMIterator expr)` Add an iterator to the union list.
    `void` | IteratorPool.`freeInstance(DTMIterator obj)` Add an instance of the given object to the pool
    `void` | NodeSequence.`setIter(DTMIterator iter)` Set the functional iterator that fetches nodes.

    Constructors in org.apache.xpath.axes with parameters of type DTMIterator
    Constructor and Description
    `IteratorPool(DTMIterator original)` Constructor IteratorPool

  - ### Uses of DTMIterator in org.apache.xpath.objects

    Classes in org.apache.xpath.objects that implement DTMIterator
    Modifier and Type | Class and Description
    --- | ---
    `class` | `XNodeSet` This class represents an XPath nodeset object, and is capable of converting the nodeset to other types, such as a string.
    `class` | `XNodeSetForDOM` This class overrides the XNodeSet#object() method to provide the original Node object, NodeList object, or NodeIterator.
    `class` | `XNull` This class represents an XPath null object, and is capable of converting the null to other types, such as a string.

    Methods in org.apache.xpath.objects that return DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `DTMIterator` | XRTreeFragSelectWrapper.`asNodeIterator()` Cast result object to a DTMIterator.
    `DTMIterator` | XRTreeFrag.`asNodeIterator()` Cast result object to a DTMIterator.
    `DTMIterator` | XObject.`iter()` Cast result object to a nodelist.
    `DTMIterator` | XNodeSet.`iter()` Cast result object to a nodelist.
    `DTMIterator` | XNodeSet.`iterRaw()` Return the iterator without cloning, etc.

    Methods in org.apache.xpath.objects with parameters of type DTMIterator
    Modifier and Type | Method and Description
    --- | ---
    `void` | XNodeSet.`release(DTMIterator iter)`

    Constructors in org.apache.xpath.objects with parameters of type DTMIterator
    Constructor and Description
    `XNodeSet(DTMIterator val)` Construct a XNodeSet object.

Copyright © 2023 Apache XML Project. All Rights Reserved.