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

- Packages that use DTM
  Package | Description
  --- | ---
  org.apache.xalan.lib.sql | Provides extension functions for connecting to a JDBC data source, executing a query, and working incrementally through a "streamable" result set.
  org.apache.xalan.serialize |
  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.xalan.xsltc.dom |
  org.apache.xml.dtm |
  org.apache.xml.dtm.ref |
  org.apache.xml.dtm.ref.dom2dtm |
  org.apache.xml.dtm.ref.sax2dtm |
  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.patterns | Implementation of XPath nodeTest support, and XSLT pattern matching support.

- - ### Uses of DTM in org.apache.xalan.lib.sql

    Classes in org.apache.xalan.lib.sql that implement DTM
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DTMDocument` The SQL Document is the main controlling class the executesa SQL Query
    `class` | `SQLDocument` The SQL Document is the main controlling class the executesa SQL Query
    `class` | `SQLErrorDocument` The SQL Document is the main controlling class the executesa SQL Query

    Methods in org.apache.xalan.lib.sql that return DTM
    Modifier and Type | Method and Description
    --- | ---
    `DTM` | XConnection.`getError()` Provide access to the last error that occued.
    `DTM` | XConnection.`pquery(ExpressionContext exprContext, java.lang.String queryString)` Execute a parameterized query statement by instantiating an
    `DTM` | XConnection.`pquery(ExpressionContext exprContext, java.lang.String queryString, java.lang.String typeInfo)` Execute a parameterized query statement by instantiating an
    `DTM` | XConnection.`query(ExpressionContext exprContext, java.lang.String queryString)` Execute a query statement by instantiating an

  - ### Uses of DTM in org.apache.xalan.serialize

    Methods in org.apache.xalan.serialize with parameters of type DTM
    Modifier and Type | Method and Description
    --- | ---
    `static void` | SerializerUtils.`ensureNamespaceDeclDeclared(SerializationHandler handler, DTM dtm, int namespace)` This function checks to make sure a given prefix is really declared.
    `static boolean` | SerializerUtils.`isDefinedNSDecl(SerializationHandler serializer, int attr, DTM dtm)` Returns whether a namespace is defined
    `static void` | SerializerUtils.`processNSDecls(SerializationHandler handler, int src, int type, DTM dtm)` Copy `xmlns:` attributes in if not already in scope.

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

    Methods in org.apache.xalan.templates with parameters of type DTM
    Modifier and Type | Method and Description
    --- | ---
    `org.apache.xalan.templates.TemplateSubPatternAssociation` | TemplateList.`getHead(XPathContext xctxt, int targetNode, DTM dtm)` Get the head of the most likely list of associations to check, based on the name and type of the targetNode argument.
    `ElemTemplate` | TemplateList.`getTemplate(XPathContext xctxt, int targetNode, QName mode, boolean quietConflictWarnings, DTM dtm)` Given a target element, find the template that best matches in the given XSL document, according to the rules specified in the xsl draft.
    `ElemTemplate` | TemplateList.`getTemplate(XPathContext xctxt, int targetNode, QName mode, int maxImportLevel, int endImportLevel, boolean quietConflictWarnings, DTM dtm)` Given a target element, find the template that best matches in the given XSL document, according to the rules specified in the xsl draft.
    `ElemTemplate` | StylesheetRoot.`getTemplateComposed(XPathContext xctxt, int targetNode, QName mode, boolean quietConflictWarnings, DTM dtm)` Get an "xsl:template" property by node match.
    `ElemTemplate` | StylesheetRoot.`getTemplateComposed(XPathContext xctxt, int targetNode, QName mode, int maxImportLevel, int endImportLevel, boolean quietConflictWarnings, DTM dtm)` Get an "xsl:template" property by node match.
    `ElemTemplate` | TemplateList.`getTemplateFast(XPathContext xctxt, int targetNode, int expTypeID, QName mode, int maxImportLevel, boolean quietConflictWarnings, DTM dtm)` Given a target element, find the template that best matches in the given XSL document, according to the rules specified in the xsl draft.
    `WhiteSpaceInfo` | StylesheetRoot.`getWhiteSpaceInfo(XPathContext support, int targetElement, DTM dtm)` Get information about whether or not an element should strip whitespace.

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

    Methods in org.apache.xalan.transformer with parameters of type DTM
    Modifier and Type | Method and Description
    --- | ---
    `static void` | ClonerToResultTree.`cloneToResultTree(int node, int nodeType, DTM dtm, SerializationHandler rth, boolean shouldCloneAttributes)` Clone an element with or without children.
    `short` | TransformerImpl.`getShouldStripSpace(int elementHandle, DTM dtm)` Test whether whitespace-only text nodes are visible in the logical view of `DTM`.

  - ### Uses of DTM in org.apache.xalan.xsltc.dom

    Classes in org.apache.xalan.xsltc.dom that implement DTM
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AdaptiveResultTreeImpl` AdaptiveResultTreeImpl is a adaptive DOM model for result tree fragments (RTF).
    `class` | `SAXImpl` SAXImpl is the core model for SAX input source.
    `class` | `SimpleResultTreeImpl` This class represents a light-weight DOM model for simple result tree fragment(RTF).

    Methods in org.apache.xalan.xsltc.dom that return DTM
    Modifier and Type | Method and Description
    --- | ---
    `DTM` | XSLTCDTMManager.`getDTM(javax.xml.transform.Source source, boolean unique, DTMWSFilter whiteSpaceFilter, boolean incremental, boolean doIndexing)` Get an instance of a DTM, loaded with the content from the specified source.
    `DTM` | XSLTCDTMManager.`getDTM(javax.xml.transform.Source source, boolean unique, DTMWSFilter whiteSpaceFilter, boolean incremental, boolean doIndexing, boolean buildIdIndex)` Get an instance of a DTM, loaded with the content from the specified source.
    `DTM` | XSLTCDTMManager.`getDTM(javax.xml.transform.Source source, boolean unique, DTMWSFilter whiteSpaceFilter, boolean incremental, boolean doIndexing, boolean buildIdIndex, boolean newNameTable)` Get an instance of a DTM, loaded with the content from the specified source.
    `DTM` | XSLTCDTMManager.`getDTM(javax.xml.transform.Source source, boolean unique, DTMWSFilter whiteSpaceFilter, boolean incremental, boolean doIndexing, boolean hasUserReader, int size, boolean buildIdIndex)` Get an instance of a DTM, loaded with the content from the specified source.
    `DTM` | XSLTCDTMManager.`getDTM(javax.xml.transform.Source source, boolean unique, DTMWSFilter whiteSpaceFilter, boolean incremental, boolean doIndexing, boolean hasUserReader, int size, boolean buildIdIndex, boolean newNameTable)` Get an instance of a DTM, loaded with the content from the specified source.

    Methods in org.apache.xalan.xsltc.dom with parameters of type DTM
    Modifier and Type | Method and Description
    --- | ---
    `short` | DOMWSFilter.`getShouldStripSpace(int node, DTM dtm)` Test whether whitespace-only text nodes are visible in the logical view of `DTM`.

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

    Methods in org.apache.xml.dtm that return DTM
    Modifier and Type | Method and Description
    --- | ---
    `abstract DTM` | DTMManager.`createDocumentFragment()` Creates a DTM representing an empty `DocumentFragment` object.
    `abstract DTM` | DTMManager.`getDTM(int nodeHandle)` Get the instance of DTM that "owns" a node handle.
    `DTM` | DTMIterator.`getDTM(int nodeHandle)` Get an instance of a DTM that "owns" a node handle.
    `abstract DTM` | DTMManager.`getDTM(javax.xml.transform.Source source, boolean unique, DTMWSFilter whiteSpaceFilter, boolean incremental, boolean doIndexing)` Get an instance of a DTM, loaded with the content from the specified source.

    Methods in org.apache.xml.dtm with parameters of type DTM
    Modifier and Type | Method and Description
    --- | ---
    `abstract int` | DTMManager.`getDTMIdentity(DTM dtm)` %TBD% Doc NEEDSDOC @param dtm NEEDSDOC ($objectName$) @return
    `short` | DTMWSFilter.`getShouldStripSpace(int elementHandle, DTM dtm)` Test whether whitespace-only text nodes are visible in the logical view of `DTM`.
    `abstract boolean` | DTMManager.`release(DTM dtm, boolean shouldHardDelete)` Release a DTM either to a lru pool, or completely remove reference.

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

    Classes in org.apache.xml.dtm.ref that implement DTM
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DTMDefaultBase` The `DTMDefaultBase` class serves as a helper base for DTMs.
    `class` | `DTMDefaultBaseIterators` This class implements the traversers for DTMDefaultBase.
    `class` | `DTMDefaultBaseTraversers` This class implements the traversers for DTMDefaultBase.
    `class` | `DTMDocumentImpl` This is the implementation of the DTM document interface.

    Fields in org.apache.xml.dtm.ref declared as DTM
    Modifier and Type | Field and Description
    --- | ---
    `DTM` | DTMNodeProxy.`dtm` The DTM for this node.

    Methods in org.apache.xml.dtm.ref that return DTM
    Modifier and Type | Method and Description
    --- | ---
    `DTM` | DTMManagerDefault.`createDocumentFragment()` Method createDocumentFragment NEEDSDOC (createDocumentFragment) @return
    `DTM` | DTMNodeProxy.`getDTM()` NON-DOM: Return the DTM model
    `DTM` | DTMManagerDefault.`getDTM(int nodeHandle)` Return the DTM object containing a representation of this node.
    `DTM` | DTMManagerDefault.`getDTM(javax.xml.transform.Source source, boolean unique, DTMWSFilter whiteSpaceFilter, boolean incremental, boolean doIndexing)` Get an instance of a DTM, loaded with the content from the specified source.

    Methods in org.apache.xml.dtm.ref with parameters of type DTM
    Modifier and Type | Method and Description
    --- | ---
    `void` | DTMManagerDefault.`addDTM(DTM dtm, int id)` Add a DTM to the DTM table.
    `void` | DTMManagerDefault.`addDTM(DTM dtm, int id, int offset)` Add a DTM to the DTM table.
    `int` | DTMManagerDefault.`getDTMIdentity(DTM dtm)` Given a DTM, find the ID number in the DTM tables which addresses the start of the document.
    `ExpandedNameTable` | DTMManagerDefault.`getExpandedNameTable(DTM dtm)` return the expanded name table.
    `boolean` | DTMManagerDefault.`release(DTM dtm, boolean shouldHardDelete)` Release the DTMManager's reference(s) to a DTM, making it unmanaged.
    `void` | DTMTreeWalker.`setDTM(DTM dtm)` Set the DTM to be traversed.

    Constructors in org.apache.xml.dtm.ref with parameters of type DTM
    Constructor and Description
    `DTMAxisIterNodeList(DTM dtm, DTMAxisIterator dtmAxisIterator)` Public constructor: Wrap a DTMNodeList around an existing and preconfigured DTMAxisIterator
    `DTMChildIterNodeList(DTM parentDTM, int parentHandle)` Public constructor: Create a NodeList to support DTMNodeProxy.getChildren().
    `DTMNamedNodeMap(DTM dtm, int element)` Create a getAttributes NamedNodeMap for a given DTM element node
    `DTMNodeProxy(DTM dtm, int node)` Create a DTMNodeProxy Node representing a specific Node in a DTM
    `DTMTreeWalker(org.xml.sax.ContentHandler contentHandler, DTM dtm)` Constructor.

  - ### Uses of DTM in org.apache.xml.dtm.ref.dom2dtm

    Classes in org.apache.xml.dtm.ref.dom2dtm that implement DTM
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DOM2DTM` The `DOM2DTM` class serves up a DOM's contents via the DTM API.

  - ### Uses of DTM in org.apache.xml.dtm.ref.sax2dtm

    Classes in org.apache.xml.dtm.ref.sax2dtm that implement DTM
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SAX2DTM` This class implements a DTM that tends to be optimized more for speed than for compactness, that is constructed via SAX2 ContentHandler events.
    `class` | `SAX2DTM2` SAX2DTM2 is an optimized version of SAX2DTM which is used in non-incremental situation.
    `class` | `SAX2RTFDTM` This is a subclass of SAX2DTM which has been modified to meet the needs of Result Tree Frameworks (RTFs).

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

    Methods in org.apache.xpath that return DTM
    Modifier and Type | Method and Description
    --- | ---
    `DTM` | XPathContext.`createDocumentFragment()` Creates an empty `DocumentFragment` object.
    `DTM` | XPathContext.`getDTM(int nodeHandle)` Get an instance of a DTM that "owns" a node handle.
    `DTM` | NodeSetDTM.`getDTM(int nodeHandle)` Get an instance of a DTM that "owns" a node handle.
    `DTM` | XPathContext.`getDTM(javax.xml.transform.Source source, boolean unique, DTMWSFilter wsfilter, boolean incremental, boolean doIndexing)` Get an instance of a DTM, loaded with the content from the specified source.
    `DTM` | XPathContext.`getGlobalRTFDTM()` Get a DTM to be used as a container for a global Result Tree Fragment.
    `DTM` | XPathContext.`getRTFDTM()` Get a DTM to be used as a container for a dynamic Result Tree Fragment.

    Methods in org.apache.xpath with parameters of type DTM
    Modifier and Type | Method and Description
    --- | ---
    `XObject` | Expression.`execute(XPathContext xctxt, int currentNode, DTM dtm, int expType)` Execute an expression in the XPath runtime context, and return the result of the expression.
    `int` | XPathContext.`getDTMIdentity(DTM dtm)` %TBD% Doc
    `boolean` | XPathContext.`release(DTM dtm, boolean shouldHardDelete)` Release a DTM either to a lru pool, or completely remove reference.

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

    Methods in org.apache.xpath.axes that return DTM
    Modifier and Type | Method and Description
    --- | ---
    `DTM` | NodeSequence.`getDTM(int nodeHandle)`
    `DTM` | LocPathIterator.`getDTM(int nodeHandle)` Get an instance of a DTM that "owns" a node handle.
    `DTM` | AxesWalker.`getDTM(int node)` Get the DTM for this walker.

    Methods in org.apache.xpath.axes with parameters of type DTM
    Modifier and Type | Method and Description
    --- | ---
    `void` | AxesWalker.`setDefaultDTM(DTM dtm)` Set the DTM for this walker.

  - ### Uses of DTM in org.apache.xpath.patterns

    Methods in org.apache.xpath.patterns with parameters of type DTM
    Modifier and Type | Method and Description
    --- | ---
    `XObject` | StepPattern.`execute(XPathContext xctxt, int currentNode, DTM dtm, int expType)` Execute an expression in the XPath runtime context, and return the result of the expression.
    `XObject` | NodeTest.`execute(XPathContext xctxt, int context, DTM dtm, int expType)` Tell what the test score is for the given node.
    `XObject` | FunctionPattern.`execute(XPathContext xctxt, int context, DTM dtm, int expType)` Test a node to see if it matches the given node test.

Copyright © 2023 Apache XML Project. All Rights Reserved.