| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!--NewPage--> | |
| <HTML> | |
| <HEAD> | |
| <!-- Generated by javadoc (build 1.5.0_18) on Sun Apr 01 21:18:30 PDT 2012 --> | |
| <TITLE> | |
| DTM | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.xml.dtm.DTM interface"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="DTM"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <A NAME="navbar_top"><!-- --></A> | |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_top_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DTM.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../org/apache/xml/dtm/Axis.html" title="class in org.apache.xml.dtm"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xml/dtm/DTM.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="DTM.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_top"></A> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <HR> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <H2> | |
| <FONT SIZE="-1"> | |
| org.apache.xml.dtm</FONT> | |
| <BR> | |
| Interface DTM</H2> | |
| <DL> | |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xalan/xsltc/dom/AdaptiveResultTreeImpl.html" title="class in org.apache.xalan.xsltc.dom">AdaptiveResultTreeImpl</A>, <A HREF="../../../../org/apache/xml/dtm/ref/dom2dtm/DOM2DTM.html" title="class in org.apache.xml.dtm.ref.dom2dtm">DOM2DTM</A>, <A HREF="../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBase</A>, <A HREF="../../../../org/apache/xml/dtm/ref/DTMDefaultBaseIterators.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseIterators</A>, <A HREF="../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers</A>, <A HREF="../../../../org/apache/xalan/lib/sql/DTMDocument.html" title="class in org.apache.xalan.lib.sql">DTMDocument</A>, <A HREF="../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html" title="class in org.apache.xml.dtm.ref">DTMDocumentImpl</A>, <A HREF="../../../../org/apache/xml/dtm/ref/sax2dtm/SAX2DTM.html" title="class in org.apache.xml.dtm.ref.sax2dtm">SAX2DTM</A>, <A HREF="../../../../org/apache/xml/dtm/ref/sax2dtm/SAX2DTM2.html" title="class in org.apache.xml.dtm.ref.sax2dtm">SAX2DTM2</A>, <A HREF="../../../../org/apache/xml/dtm/ref/sax2dtm/SAX2RTFDTM.html" title="class in org.apache.xml.dtm.ref.sax2dtm">SAX2RTFDTM</A>, <A HREF="../../../../org/apache/xalan/xsltc/dom/SAXImpl.html" title="class in org.apache.xalan.xsltc.dom">SAXImpl</A>, <A HREF="../../../../org/apache/xalan/xsltc/dom/SimpleResultTreeImpl.html" title="class in org.apache.xalan.xsltc.dom">SimpleResultTreeImpl</A>, <A HREF="../../../../org/apache/xalan/lib/sql/SQLDocument.html" title="class in org.apache.xalan.lib.sql">SQLDocument</A>, <A HREF="../../../../org/apache/xalan/lib/sql/SQLErrorDocument.html" title="class in org.apache.xalan.lib.sql">SQLErrorDocument</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public interface <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.78"><B>DTM</B></A></DL> | |
| </PRE> | |
| <P> | |
| <code>DTM</code> is an XML document model expressed as a table | |
| rather than an object tree. It attempts to provide an interface to | |
| a parse tree that has very little object creation. (DTM | |
| implementations may also support incremental construction of the | |
| model, but that's hidden from the DTM API.) | |
| <p>Nodes in the DTM are identified by integer "handles". A handle must | |
| be unique within a process, and carries both node identification and | |
| document identification. It must be possible to compare two handles | |
| (and thus their nodes) for identity with "==".</p> | |
| <p>Namespace URLs, local-names, and expanded-names can all be | |
| represented by and tested as integer ID values. An expanded name | |
| represents (and may or may not directly contain) a combination of | |
| the URL ID, and the local-name ID. Note that the namespace URL id | |
| can be 0, which should have the meaning that the namespace is null. | |
| For consistancy, zero should not be used for a local-name index. </p> | |
| <p>Text content of a node is represented by an index and length, | |
| permitting efficient storage such as a shared FastStringBuffer.</p> | |
| <p>The model of the tree, as well as the general navigation model, | |
| is that of XPath 1.0, for the moment. The model will eventually be | |
| adapted to match the XPath 2.0 data model, XML Schema, and | |
| InfoSet.</p> | |
| <p>DTM does _not_ directly support the W3C's Document Object | |
| Model. However, it attempts to come close enough that an | |
| implementation of DTM can be created that wraps a DOM and vice | |
| versa.</p> | |
| <p><strong>Please Note:</strong> The DTM API is still | |
| <strong>Subject To Change.</strong> This wouldn't affect most | |
| users, but might require updating some extensions.</p> | |
| <p> The largest change being contemplated is a reconsideration of | |
| the Node Handle representation. We are still not entirely sure | |
| that an integer packed with two numeric subfields is really the | |
| best solution. It has been suggested that we move up to a Long, to | |
| permit more nodes per document without having to reduce the number | |
| of slots in the DTMManager. There's even been a proposal that we | |
| replace these integers with "cursor" objects containing the | |
| internal node id and a pointer to the actual DTM object; this might | |
| reduce the need to continuously consult the DTMManager to retrieve | |
| the latter, and might provide a useful "hook" back into normal Java | |
| heap management. But changing this datatype would have huge impact | |
| on Xalan's internals -- especially given Java's lack of C-style | |
| typedefs -- so we won't cut over unless we're convinced the new | |
| solution really would be an improvement!</p> | |
| <P> | |
| <P> | |
| <HR> | |
| <P> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <A NAME="field_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Field Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#ATTRIBUTE_NODE">ATTRIBUTE_NODE</A></B></CODE> | |
| <BR> | |
| The node is an <code>Attr</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#CDATA_SECTION_NODE">CDATA_SECTION_NODE</A></B></CODE> | |
| <BR> | |
| The node is a <code>CDATASection</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#COMMENT_NODE">COMMENT_NODE</A></B></CODE> | |
| <BR> | |
| The node is a <code>Comment</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#DOCUMENT_FRAGMENT_NODE">DOCUMENT_FRAGMENT_NODE</A></B></CODE> | |
| <BR> | |
| The node is a <code>DocumentFragment</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#DOCUMENT_NODE">DOCUMENT_NODE</A></B></CODE> | |
| <BR> | |
| The node is a <code>Document</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#DOCUMENT_TYPE_NODE">DOCUMENT_TYPE_NODE</A></B></CODE> | |
| <BR> | |
| The node is a <code>DocumentType</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#ELEMENT_NODE">ELEMENT_NODE</A></B></CODE> | |
| <BR> | |
| The node is an <code>Element</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#ENTITY_NODE">ENTITY_NODE</A></B></CODE> | |
| <BR> | |
| The node is an <code>Entity</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#ENTITY_REFERENCE_NODE">ENTITY_REFERENCE_NODE</A></B></CODE> | |
| <BR> | |
| The node is an <code>EntityReference</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#NAMESPACE_NODE">NAMESPACE_NODE</A></B></CODE> | |
| <BR> | |
| The node is a <code>namespace node</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#NOTATION_NODE">NOTATION_NODE</A></B></CODE> | |
| <BR> | |
| The node is a <code>Notation</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#NTYPES">NTYPES</A></B></CODE> | |
| <BR> | |
| The number of valid nodetypes.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#NULL">NULL</A></B></CODE> | |
| <BR> | |
| Null node handles are represented by this value.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#PROCESSING_INSTRUCTION_NODE">PROCESSING_INSTRUCTION_NODE</A></B></CODE> | |
| <BR> | |
| The node is a <code>ProcessingInstruction</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#ROOT_NODE">ROOT_NODE</A></B></CODE> | |
| <BR> | |
| The node is a <code>Root</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#TEXT_NODE">TEXT_NODE</A></B></CODE> | |
| <BR> | |
| The node is a <code>Text</code> node.</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <A NAME="method_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Method Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#appendChild(int, boolean, boolean)">appendChild</A></B>(int newChild, | |
| boolean clone, | |
| boolean cloneDepth)</CODE> | |
| <BR> | |
| Append a child to "the end of the document".</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#appendTextChild(java.lang.String)">appendTextChild</A></B>(java.lang.String str)</CODE> | |
| <BR> | |
| Append a text node child that will be constructed from a string, | |
| to the end of the document.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#dispatchCharactersEvents(int, org.xml.sax.ContentHandler, boolean)">dispatchCharactersEvents</A></B>(int nodeHandle, | |
| org.xml.sax.ContentHandler ch, | |
| boolean normalize)</CODE> | |
| <BR> | |
| Directly call the | |
| characters method on the passed ContentHandler for the | |
| string-value of the given node (see http://www.w3.org/TR/xpath#data-model | |
| for the definition of a node's string-value).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#dispatchToEvents(int, org.xml.sax.ContentHandler)">dispatchToEvents</A></B>(int nodeHandle, | |
| org.xml.sax.ContentHandler ch)</CODE> | |
| <BR> | |
| Directly create SAX parser events representing the XML content of | |
| a DTM subtree.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#documentRegistration()">documentRegistration</A></B>()</CODE> | |
| <BR> | |
| As the DTM is registered with the DTMManager, this method | |
| will be called.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#documentRelease()">documentRelease</A></B>()</CODE> | |
| <BR> | |
| As documents are released from the DTMManager, the DTM implementation | |
| will be notified of the event.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getAttributeNode(int, java.lang.String, java.lang.String)">getAttributeNode</A></B>(int elementHandle, | |
| java.lang.String namespaceURI, | |
| java.lang.String name)</CODE> | |
| <BR> | |
| Retrieves an attribute node by local name and namespace URI | |
| %TBD% Note that we currently have no way to support | |
| the DOM's old getAttribute() call, which accesses only the qname.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getAxisIterator(int)">getAxisIterator</A></B>(int axis)</CODE> | |
| <BR> | |
| This is a shortcut to the iterators that implement | |
| XPath axes.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTMAxisTraverser.html" title="class in org.apache.xml.dtm">DTMAxisTraverser</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getAxisTraverser(int)">getAxisTraverser</A></B>(int axis)</CODE> | |
| <BR> | |
| This returns a stateless "traverser", that can navigate over an | |
| XPath axis, though not in document order.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.xml.sax.ContentHandler</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getContentHandler()">getContentHandler</A></B>()</CODE> | |
| <BR> | |
| Return this DTM's content handler, if it has one.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.xml.sax.ext.DeclHandler</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDeclHandler()">getDeclHandler</A></B>()</CODE> | |
| <BR> | |
| Return this DTM's DeclHandler, if it has one.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDocument()">getDocument</A></B>()</CODE> | |
| <BR> | |
| Given a DTM which contains only a single document, | |
| find the Node Handle of the Document node.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDocumentAllDeclarationsProcessed()">getDocumentAllDeclarationsProcessed</A></B>()</CODE> | |
| <BR> | |
| Return an indication of | |
| whether the processor has read the complete DTD.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDocumentBaseURI()">getDocumentBaseURI</A></B>()</CODE> | |
| <BR> | |
| Return the base URI of the document entity.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDocumentEncoding(int)">getDocumentEncoding</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Return the name of the character encoding scheme | |
| in which the document entity is expressed.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDocumentRoot(int)">getDocumentRoot</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, find the owning document node.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDocumentStandalone(int)">getDocumentStandalone</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Return an indication of the standalone status of the document, | |
| either "yes" or "no".</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDocumentSystemIdentifier(int)">getDocumentSystemIdentifier</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Return the system identifier of the document entity.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDocumentTypeDeclarationPublicIdentifier()">getDocumentTypeDeclarationPublicIdentifier</A></B>()</CODE> | |
| <BR> | |
| Return the public identifier of the external subset, | |
| normalized as described in 4.2.2 External Entities [XML].</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDocumentTypeDeclarationSystemIdentifier()">getDocumentTypeDeclarationSystemIdentifier</A></B>()</CODE> | |
| <BR> | |
| A document type declaration information item has the following properties: | |
| 1.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDocumentVersion(int)">getDocumentVersion</A></B>(int documentHandle)</CODE> | |
| <BR> | |
| Return a string representing the XML version of the document.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.xml.sax.DTDHandler</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDTDHandler()">getDTDHandler</A></B>()</CODE> | |
| <BR> | |
| Return this DTM's DTDHandler, if it has one.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getElementById(java.lang.String)">getElementById</A></B>(java.lang.String elementId)</CODE> | |
| <BR> | |
| Returns the <code>Element</code> whose <code>ID</code> is given by | |
| <code>elementId</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.xml.sax.EntityResolver</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getEntityResolver()">getEntityResolver</A></B>()</CODE> | |
| <BR> | |
| Return this DTM's EntityResolver, if it has one.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.xml.sax.ErrorHandler</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getErrorHandler()">getErrorHandler</A></B>()</CODE> | |
| <BR> | |
| Return this DTM's ErrorHandler, if it has one.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getExpandedTypeID(int)">getExpandedTypeID</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, return an ID that represents the node's expanded name.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getExpandedTypeID(java.lang.String, java.lang.String, int)">getExpandedTypeID</A></B>(java.lang.String namespace, | |
| java.lang.String localName, | |
| int type)</CODE> | |
| <BR> | |
| Given an expanded name, return an ID.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getFirstAttribute(int)">getFirstAttribute</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, get the index of the node's first attribute.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getFirstChild(int)">getFirstChild</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, get the handle of the node's first child.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getFirstNamespaceNode(int, boolean)">getFirstNamespaceNode</A></B>(int nodeHandle, | |
| boolean inScope)</CODE> | |
| <BR> | |
| Given a node handle, get the index of the node's first namespace node.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getLastChild(int)">getLastChild</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, get the handle of the node's last child.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getLevel(int)">getLevel</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Get the depth level of this node in the tree (equals 1 for | |
| a parentless node).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.xml.sax.ext.LexicalHandler</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getLexicalHandler()">getLexicalHandler</A></B>()</CODE> | |
| <BR> | |
| Return this DTM's lexical handler, if it has one.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getLocalName(int)">getLocalName</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, return its DOM-style localname.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getLocalNameFromExpandedNameID(int)">getLocalNameFromExpandedNameID</A></B>(int ExpandedNameID)</CODE> | |
| <BR> | |
| Given an expanded-name ID, return the local name part.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getNamespaceFromExpandedNameID(int)">getNamespaceFromExpandedNameID</A></B>(int ExpandedNameID)</CODE> | |
| <BR> | |
| Given an expanded-name ID, return the namespace URI part.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getNamespaceURI(int)">getNamespaceURI</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, return its DOM-style namespace URI | |
| (As defined in Namespaces, this is the declared URI which this node's | |
| prefix -- or default in lieu thereof -- was mapped to.)</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getNextAttribute(int)">getNextAttribute</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, advance to the next attribute.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getNextNamespaceNode(int, int, boolean)">getNextNamespaceNode</A></B>(int baseHandle, | |
| int namespaceHandle, | |
| boolean inScope)</CODE> | |
| <BR> | |
| Given a namespace handle, advance to the next namespace in the same scope | |
| (local or local-plus-inherited, as selected by getFirstNamespaceNode)</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getNextSibling(int)">getNextSibling</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, advance to its next sibling.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.w3c.dom.Node</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getNode(int)">getNode</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Return an DOM node for the given node.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getNodeName(int)">getNodeName</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, return its DOM-style node name.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getNodeNameX(int)">getNodeNameX</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, return the XPath node name.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getNodeType(int)">getNodeType</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, return its DOM-style node type.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getNodeValue(int)">getNodeValue</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, return its node value.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getOwnerDocument(int)">getOwnerDocument</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, find the owning document node.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getParent(int)">getParent</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, find its parent node.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getPrefix(int)">getPrefix</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a namespace handle, return the prefix that the namespace decl is | |
| mapping.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getPreviousSibling(int)">getPreviousSibling</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, find its preceeding sibling.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> javax.xml.transform.SourceLocator</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getSourceLocatorFor(int)">getSourceLocatorFor</A></B>(int node)</CODE> | |
| <BR> | |
| Get the location of a node in the source document.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xml/utils/XMLString.html" title="interface in org.apache.xml.utils">XMLString</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getStringValue(int)">getStringValue</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Get the string-value of a node as a String object | |
| (see http://www.w3.org/TR/xpath#data-model | |
| for the definition of a node's string-value).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> char[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getStringValueChunk(int, int, int[])">getStringValueChunk</A></B>(int nodeHandle, | |
| int chunkIndex, | |
| int[] startAndLen)</CODE> | |
| <BR> | |
| Get a character array chunk in the string-value of a node.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getStringValueChunkCount(int)">getStringValueChunkCount</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Get number of character array chunks in | |
| the string-value of a node.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getTypedAxisIterator(int, int)">getTypedAxisIterator</A></B>(int axis, | |
| int type)</CODE> | |
| <BR> | |
| Get an iterator that can navigate over an XPath Axis, predicated by | |
| the extended type ID.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#getUnparsedEntityURI(java.lang.String)">getUnparsedEntityURI</A></B>(java.lang.String name)</CODE> | |
| <BR> | |
| The getUnparsedEntityURI function returns the URI of the unparsed | |
| entity with the specified name in the same document as the context | |
| node (see [3.3 Unparsed Entities]).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#hasChildNodes(int)">hasChildNodes</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Given a node handle, test if it has child nodes.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#isAttributeSpecified(int)">isAttributeSpecified</A></B>(int attributeHandle)</CODE> | |
| <BR> | |
| 5.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#isCharacterElementContentWhitespace(int)">isCharacterElementContentWhitespace</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| 2.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#isDocumentAllDeclarationsProcessed(int)">isDocumentAllDeclarationsProcessed</A></B>(int documentHandle)</CODE> | |
| <BR> | |
| 10.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#isNodeAfter(int, int)">isNodeAfter</A></B>(int firstNodeHandle, | |
| int secondNodeHandle)</CODE> | |
| <BR> | |
| Figure out whether nodeHandle2 should be considered as being later | |
| in the document than nodeHandle1, in Document Order as defined | |
| by the XPath model.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#isSupported(java.lang.String, java.lang.String)">isSupported</A></B>(java.lang.String feature, | |
| java.lang.String version)</CODE> | |
| <BR> | |
| Tests whether DTM DOM implementation implements a specific feature and | |
| that feature is supported by this node.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#migrateTo(org.apache.xml.dtm.DTMManager)">migrateTo</A></B>(<A HREF="../../../../org/apache/xml/dtm/DTMManager.html" title="class in org.apache.xml.dtm">DTMManager</A> manager)</CODE> | |
| <BR> | |
| Migrate a DTM built with an old DTMManager to a new DTMManager.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#needsTwoThreads()">needsTwoThreads</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#setDocumentBaseURI(java.lang.String)">setDocumentBaseURI</A></B>(java.lang.String baseURI)</CODE> | |
| <BR> | |
| Set the base URI of the document entity.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#setFeature(java.lang.String, boolean)">setFeature</A></B>(java.lang.String featureId, | |
| boolean state)</CODE> | |
| <BR> | |
| Set an implementation dependent feature.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#setProperty(java.lang.String, java.lang.Object)">setProperty</A></B>(java.lang.String property, | |
| java.lang.Object value)</CODE> | |
| <BR> | |
| Set a run time property for this DTM instance.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTM.html#supportsPreStripping()">supportsPreStripping</A></B>()</CODE> | |
| <BR> | |
| Return true if the xsl:strip-space or xsl:preserve-space was processed | |
| during construction of the document contained in this DTM.</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ FIELD DETAIL =========== --> | |
| <A NAME="field_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Field Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="NULL"><!-- --></A><H3> | |
| NULL</H3> | |
| <PRE> | |
| static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.84"><B>NULL</B></A></PRE> | |
| <DL> | |
| <DD>Null node handles are represented by this value. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.NULL">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="ROOT_NODE"><!-- --></A><H3> | |
| ROOT_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.95"><B>ROOT_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is a <code>Root</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.ROOT_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="ELEMENT_NODE"><!-- --></A><H3> | |
| ELEMENT_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.100"><B>ELEMENT_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is an <code>Element</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.ELEMENT_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="ATTRIBUTE_NODE"><!-- --></A><H3> | |
| ATTRIBUTE_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.105"><B>ATTRIBUTE_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is an <code>Attr</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.ATTRIBUTE_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="TEXT_NODE"><!-- --></A><H3> | |
| TEXT_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.110"><B>TEXT_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is a <code>Text</code> node. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.TEXT_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="CDATA_SECTION_NODE"><!-- --></A><H3> | |
| CDATA_SECTION_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.115"><B>CDATA_SECTION_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is a <code>CDATASection</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.CDATA_SECTION_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="ENTITY_REFERENCE_NODE"><!-- --></A><H3> | |
| ENTITY_REFERENCE_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.120"><B>ENTITY_REFERENCE_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is an <code>EntityReference</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.ENTITY_REFERENCE_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="ENTITY_NODE"><!-- --></A><H3> | |
| ENTITY_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.125"><B>ENTITY_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is an <code>Entity</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.ENTITY_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="PROCESSING_INSTRUCTION_NODE"><!-- --></A><H3> | |
| PROCESSING_INSTRUCTION_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.130"><B>PROCESSING_INSTRUCTION_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is a <code>ProcessingInstruction</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.PROCESSING_INSTRUCTION_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="COMMENT_NODE"><!-- --></A><H3> | |
| COMMENT_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.135"><B>COMMENT_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is a <code>Comment</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.COMMENT_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="DOCUMENT_NODE"><!-- --></A><H3> | |
| DOCUMENT_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.140"><B>DOCUMENT_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is a <code>Document</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.DOCUMENT_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="DOCUMENT_TYPE_NODE"><!-- --></A><H3> | |
| DOCUMENT_TYPE_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.145"><B>DOCUMENT_TYPE_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is a <code>DocumentType</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.DOCUMENT_TYPE_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="DOCUMENT_FRAGMENT_NODE"><!-- --></A><H3> | |
| DOCUMENT_FRAGMENT_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.150"><B>DOCUMENT_FRAGMENT_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is a <code>DocumentFragment</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.DOCUMENT_FRAGMENT_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="NOTATION_NODE"><!-- --></A><H3> | |
| NOTATION_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.155"><B>NOTATION_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is a <code>Notation</code>. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.NOTATION_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="NAMESPACE_NODE"><!-- --></A><H3> | |
| NAMESPACE_NODE</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.161"><B>NAMESPACE_NODE</B></A></PRE> | |
| <DL> | |
| <DD>The node is a <code>namespace node</code>. Note that this is not | |
| currently a node type defined by the DOM API. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.NAMESPACE_NODE">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="NTYPES"><!-- --></A><H3> | |
| NTYPES</H3> | |
| <PRE> | |
| static final short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.166"><B>NTYPES</B></A></PRE> | |
| <DL> | |
| <DD>The number of valid nodetypes. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTM.NTYPES">Constant Field Values</A></DL> | |
| </DL> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <A NAME="method_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Method Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="setFeature(java.lang.String, boolean)"><!-- --></A><H3> | |
| setFeature</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.180"><B>setFeature</B></A>(java.lang.String featureId, | |
| boolean state)</PRE> | |
| <DL> | |
| <DD>Set an implementation dependent feature. | |
| <p> | |
| %REVIEW% Do we really expect to set features on DTMs? | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>featureId</CODE> - A feature URL.<DD><CODE>state</CODE> - true if this feature should be on, false otherwise.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
| setProperty</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.188"><B>setProperty</B></A>(java.lang.String property, | |
| java.lang.Object value)</PRE> | |
| <DL> | |
| <DD>Set a run time property for this DTM instance. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - a <code>String</code> value<DD><CODE>value</CODE> - an <code>Object</code> value</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getAxisTraverser(int)"><!-- --></A><H3> | |
| getAxisTraverser</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/xml/dtm/DTMAxisTraverser.html" title="class in org.apache.xml.dtm">DTMAxisTraverser</A> <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.200"><B>getAxisTraverser</B></A>(int axis)</PRE> | |
| <DL> | |
| <DD>This returns a stateless "traverser", that can navigate over an | |
| XPath axis, though not in document order. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>axis</CODE> - One of Axes.ANCESTORORSELF, etc. | |
| <DT><B>Returns:</B><DD>A DTMAxisIterator, or null if the givin axis isn't supported.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getAxisIterator(int)"><!-- --></A><H3> | |
| getAxisIterator</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A> <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.212"><B>getAxisIterator</B></A>(int axis)</PRE> | |
| <DL> | |
| <DD>This is a shortcut to the iterators that implement | |
| XPath axes. | |
| Returns a bare-bones iterator that must be initialized | |
| with a start node (using iterator.setStartNode()). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>axis</CODE> - One of Axes.ANCESTORORSELF, etc. | |
| <DT><B>Returns:</B><DD>A DTMAxisIterator, or null if the givin axis isn't supported.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getTypedAxisIterator(int, int)"><!-- --></A><H3> | |
| getTypedAxisIterator</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A> <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.223"><B>getTypedAxisIterator</B></A>(int axis, | |
| int type)</PRE> | |
| <DL> | |
| <DD>Get an iterator that can navigate over an XPath Axis, predicated by | |
| the extended type ID. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>axis</CODE> - <DD><CODE>type</CODE> - An extended type ID. | |
| <DT><B>Returns:</B><DD>A DTMAxisIterator, or null if the givin axis isn't supported.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="hasChildNodes(int)"><!-- --></A><H3> | |
| hasChildNodes</H3> | |
| <PRE> | |
| boolean <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.237"><B>hasChildNodes</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, test if it has child nodes. | |
| <p> %REVIEW% This is obviously useful at the DOM layer, where it | |
| would permit testing this without having to create a proxy | |
| node. It's less useful in the DTM API, where | |
| (dtm.getFirstChild(nodeHandle)!=DTM.NULL) is just as fast and | |
| almost as self-evident. But it's a convenience, and eases porting | |
| of DOM code to DTM. </p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - int Handle of the node. | |
| <DT><B>Returns:</B><DD>int true if the given node has child nodes.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getFirstChild(int)"><!-- --></A><H3> | |
| getFirstChild</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.246"><B>getFirstChild</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, get the handle of the node's first child. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - int Handle of the node. | |
| <DT><B>Returns:</B><DD>int DTM node-number of first child, | |
| or DTM.NULL to indicate none exists.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getLastChild(int)"><!-- --></A><H3> | |
| getLastChild</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.255"><B>getLastChild</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, get the handle of the node's last child. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - int Handle of the node. | |
| <DT><B>Returns:</B><DD>int Node-number of last child, | |
| or DTM.NULL to indicate none exists.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getAttributeNode(int, java.lang.String, java.lang.String)"><!-- --></A><H3> | |
| getAttributeNode</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.272"><B>getAttributeNode</B></A>(int elementHandle, | |
| java.lang.String namespaceURI, | |
| java.lang.String name)</PRE> | |
| <DL> | |
| <DD>Retrieves an attribute node by local name and namespace URI | |
| %TBD% Note that we currently have no way to support | |
| the DOM's old getAttribute() call, which accesses only the qname. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>elementHandle</CODE> - Handle of the node upon which to look up this attribute.<DD><CODE>namespaceURI</CODE> - The namespace URI of the attribute to | |
| retrieve, or null.<DD><CODE>name</CODE> - The local name of the attribute to | |
| retrieve. | |
| <DT><B>Returns:</B><DD>The attribute node handle with the specified name ( | |
| <code>nodeName</code>) or <code>DTM.NULL</code> if there is no such | |
| attribute.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getFirstAttribute(int)"><!-- --></A><H3> | |
| getFirstAttribute</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.281"><B>getFirstAttribute</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, get the index of the node's first attribute. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - int Handle of the node. | |
| <DT><B>Returns:</B><DD>Handle of first attribute, or DTM.NULL to indicate none exists.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getFirstNamespaceNode(int, boolean)"><!-- --></A><H3> | |
| getFirstNamespaceNode</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.295"><B>getFirstNamespaceNode</B></A>(int nodeHandle, | |
| boolean inScope)</PRE> | |
| <DL> | |
| <DD>Given a node handle, get the index of the node's first namespace node. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - handle to node, which should probably be an element | |
| node, but need not be.<DD><CODE>inScope</CODE> - true if all namespaces in scope should be | |
| returned, false if only the node's own | |
| namespace declarations should be returned. | |
| <DT><B>Returns:</B><DD>handle of first namespace, | |
| or DTM.NULL to indicate none exists.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNextSibling(int)"><!-- --></A><H3> | |
| getNextSibling</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.303"><B>getNextSibling</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, advance to its next sibling. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - int Handle of the node. | |
| <DT><B>Returns:</B><DD>int Node-number of next sibling, | |
| or DTM.NULL to indicate none exists.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getPreviousSibling(int)"><!-- --></A><H3> | |
| getPreviousSibling</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.314"><B>getPreviousSibling</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, find its preceeding sibling. | |
| WARNING: DTM implementations may be asymmetric; in some, | |
| this operation has been resolved by search, and is relatively expensive. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the id of the node. | |
| <DT><B>Returns:</B><DD>int Node-number of the previous sib, | |
| or DTM.NULL to indicate none exists.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNextAttribute(int)"><!-- --></A><H3> | |
| getNextAttribute</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.325"><B>getNextAttribute</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, advance to the next attribute. If an | |
| element, we advance to its first attribute; if an attr, we advance to | |
| the next attr of the same element. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - int Handle of the node. | |
| <DT><B>Returns:</B><DD>int DTM node-number of the resolved attr, | |
| or DTM.NULL to indicate none exists.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNextNamespaceNode(int, int, boolean)"><!-- --></A><H3> | |
| getNextNamespaceNode</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.339"><B>getNextNamespaceNode</B></A>(int baseHandle, | |
| int namespaceHandle, | |
| boolean inScope)</PRE> | |
| <DL> | |
| <DD>Given a namespace handle, advance to the next namespace in the same scope | |
| (local or local-plus-inherited, as selected by getFirstNamespaceNode) | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>baseHandle</CODE> - handle to original node from where the first child | |
| was relative to (needed to return nodes in document order).<DD><CODE>namespaceHandle</CODE> - handle to node which must be of type | |
| NAMESPACE_NODE. | |
| NEEDSDOC @param inScope | |
| <DT><B>Returns:</B><DD>handle of next namespace, | |
| or DTM.NULL to indicate none exists.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getParent(int)"><!-- --></A><H3> | |
| getParent</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.349"><B>getParent</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, find its parent node. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the id of the node. | |
| <DT><B>Returns:</B><DD>int Node handle of parent, | |
| or DTM.NULL to indicate none exists.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocument()"><!-- --></A><H3> | |
| getDocument</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.363"><B>getDocument</B></A>()</PRE> | |
| <DL> | |
| <DD>Given a DTM which contains only a single document, | |
| find the Node Handle of the Document node. Note | |
| that if the DTM is configured so it can contain multiple | |
| documents, this call will return the Document currently | |
| under construction -- but may return null if it's between | |
| documents. Generally, you should use getOwnerDocument(nodeHandle) | |
| or getDocumentRoot(nodeHandle) instead. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>int Node handle of document, or DTM.NULL if a shared DTM | |
| can not tell us which Document is currently active.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getOwnerDocument(int)"><!-- --></A><H3> | |
| getOwnerDocument</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.374"><B>getOwnerDocument</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, find the owning document node. This version mimics | |
| the behavior of the DOM call by the same name. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the id of the node. | |
| <DT><B>Returns:</B><DD>int Node handle of owning document, or DTM.NULL if the node was | |
| a Document.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTM.html#getDocumentRoot(int)"><CODE>getDocumentRoot(int nodeHandle)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocumentRoot(int)"><!-- --></A><H3> | |
| getDocumentRoot</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.385"><B>getDocumentRoot</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, find the owning document node. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the id of the node. | |
| <DT><B>Returns:</B><DD>int Node handle of owning document, or the node itself if it was | |
| a Document. (Note difference from DOM, where getOwnerDocument returns | |
| null for the Document node.)<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTM.html#getOwnerDocument(int)"><CODE>getOwnerDocument(int nodeHandle)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getStringValue(int)"><!-- --></A><H3> | |
| getStringValue</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/xml/utils/XMLString.html" title="interface in org.apache.xml.utils">XMLString</A> <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.396"><B>getStringValue</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Get the string-value of a node as a String object | |
| (see http://www.w3.org/TR/xpath#data-model | |
| for the definition of a node's string-value). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node ID. | |
| <DT><B>Returns:</B><DD>A string object that represents the string-value of the given node.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getStringValueChunkCount(int)"><!-- --></A><H3> | |
| getStringValueChunkCount</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.410"><B>getStringValueChunkCount</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Get number of character array chunks in | |
| the string-value of a node. | |
| (see http://www.w3.org/TR/xpath#data-model | |
| for the definition of a node's string-value). | |
| Note that a single text node may have multiple text chunks. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node ID. | |
| <DT><B>Returns:</B><DD>number of character array chunks in | |
| the string-value of a node.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getStringValueChunk(int, int, int[])"><!-- --></A><H3> | |
| getStringValueChunk</H3> | |
| <PRE> | |
| char[] <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.426"><B>getStringValueChunk</B></A>(int nodeHandle, | |
| int chunkIndex, | |
| int[] startAndLen)</PRE> | |
| <DL> | |
| <DD>Get a character array chunk in the string-value of a node. | |
| (see http://www.w3.org/TR/xpath#data-model | |
| for the definition of a node's string-value). | |
| Note that a single text node may have multiple text chunks. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node ID.<DD><CODE>chunkIndex</CODE> - Which chunk to get.<DD><CODE>startAndLen</CODE> - A two-integer array which, upon return, WILL | |
| BE FILLED with values representing the chunk's start position | |
| within the returned character buffer and the length of the chunk. | |
| <DT><B>Returns:</B><DD>The character array buffer within which the chunk occurs, | |
| setting startAndLen's contents as a side-effect.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getExpandedTypeID(int)"><!-- --></A><H3> | |
| getExpandedTypeID</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.436"><B>getExpandedTypeID</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, return an ID that represents the node's expanded name. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The handle to the node in question. | |
| <DT><B>Returns:</B><DD>the expanded-name id of the node.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getExpandedTypeID(java.lang.String, java.lang.String, int)"><!-- --></A><H3> | |
| getExpandedTypeID</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.450"><B>getExpandedTypeID</B></A>(java.lang.String namespace, | |
| java.lang.String localName, | |
| int type)</PRE> | |
| <DL> | |
| <DD>Given an expanded name, return an ID. If the expanded-name does not | |
| exist in the internal tables, the entry will be created, and the ID will | |
| be returned. Any additional nodes that are created that have this | |
| expanded name will use this ID. | |
| NEEDSDOC @param namespace | |
| NEEDSDOC @param localName | |
| NEEDSDOC @param type | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the expanded-name id of the node.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getLocalNameFromExpandedNameID(int)"><!-- --></A><H3> | |
| getLocalNameFromExpandedNameID</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.458"><B>getLocalNameFromExpandedNameID</B></A>(int ExpandedNameID)</PRE> | |
| <DL> | |
| <DD>Given an expanded-name ID, return the local name part. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>ExpandedNameID</CODE> - an ID that represents an expanded-name. | |
| <DT><B>Returns:</B><DD>String Local name of this node.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNamespaceFromExpandedNameID(int)"><!-- --></A><H3> | |
| getNamespaceFromExpandedNameID</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.467"><B>getNamespaceFromExpandedNameID</B></A>(int ExpandedNameID)</PRE> | |
| <DL> | |
| <DD>Given an expanded-name ID, return the namespace URI part. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>ExpandedNameID</CODE> - an ID that represents an expanded-name. | |
| <DT><B>Returns:</B><DD>String URI value of this node's namespace, or null if no | |
| namespace was resolved.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNodeName(int)"><!-- --></A><H3> | |
| getNodeName</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.477"><B>getNodeName</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, return its DOM-style node name. This will | |
| include names such as #text or #document. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the id of the node. | |
| <DT><B>Returns:</B><DD>String Name of this node, which may be an empty string. | |
| %REVIEW% Document when empty string is possible...</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNodeNameX(int)"><!-- --></A><H3> | |
| getNodeNameX</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.487"><B>getNodeNameX</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, return the XPath node name. This should be | |
| the name as described by the XPath data model, NOT the DOM-style | |
| name. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the id of the node. | |
| <DT><B>Returns:</B><DD>String Name of this node.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getLocalName(int)"><!-- --></A><H3> | |
| getLocalName</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.497"><B>getLocalName</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, return its DOM-style localname. | |
| (As defined in Namespaces, this is the portion of the name after the | |
| prefix, if present, or the whole node name if no prefix exists) | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the id of the node. | |
| <DT><B>Returns:</B><DD>String Local name of this node.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getPrefix(int)"><!-- --></A><H3> | |
| getPrefix</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.512"><B>getPrefix</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a namespace handle, return the prefix that the namespace decl is | |
| mapping. | |
| Given a node handle, return the prefix used to map to the namespace. | |
| (As defined in Namespaces, this is the portion of the name before any | |
| colon character). | |
| <p> %REVIEW% Are you sure you want "" for no prefix? </p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the id of the node. | |
| <DT><B>Returns:</B><DD>String prefix of this node's name, or "" if no explicit | |
| namespace prefix was given.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNamespaceURI(int)"><!-- --></A><H3> | |
| getNamespaceURI</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.522"><B>getNamespaceURI</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, return its DOM-style namespace URI | |
| (As defined in Namespaces, this is the declared URI which this node's | |
| prefix -- or default in lieu thereof -- was mapped to.) | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the id of the node. | |
| <DT><B>Returns:</B><DD>String URI value of this node's namespace, or null if no | |
| namespace was resolved.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNodeValue(int)"><!-- --></A><H3> | |
| getNodeValue</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.532"><B>getNodeValue</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, return its node value. This is mostly | |
| as defined by the DOM, but may ignore some conveniences. | |
| <p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node id. | |
| <DT><B>Returns:</B><DD>String Value of this node, or null if not | |
| meaningful for this node type.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNodeType(int)"><!-- --></A><H3> | |
| getNodeType</H3> | |
| <PRE> | |
| short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.542"><B>getNodeType</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Given a node handle, return its DOM-style node type. | |
| <p>%REVIEW% Generally, returning short is false economy. Return int?</p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node id. | |
| <DT><B>Returns:</B><DD>int Node type, as per the DOM's Node._NODE constants.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getLevel(int)"><!-- --></A><H3> | |
| getLevel</H3> | |
| <PRE> | |
| short <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.552"><B>getLevel</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Get the depth level of this node in the tree (equals 1 for | |
| a parentless node). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node id. | |
| <DT><B>Returns:</B><DD>the number of ancestors, plus one</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isSupported(java.lang.String, java.lang.String)"><!-- --></A><H3> | |
| isSupported</H3> | |
| <PRE> | |
| boolean <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.567"><B>isSupported</B></A>(java.lang.String feature, | |
| java.lang.String version)</PRE> | |
| <DL> | |
| <DD>Tests whether DTM DOM implementation implements a specific feature and | |
| that feature is supported by this node. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>feature</CODE> - The name of the feature to test.<DD><CODE>version</CODE> - This is the version number of the feature to test. | |
| If the version is not | |
| specified, supporting any version of the feature will cause the | |
| method to return <code>true</code>. | |
| <DT><B>Returns:</B><DD>Returns <code>true</code> if the specified feature is | |
| supported on this node, <code>false</code> otherwise.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocumentBaseURI()"><!-- --></A><H3> | |
| getDocumentBaseURI</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.576"><B>getDocumentBaseURI</B></A>()</PRE> | |
| <DL> | |
| <DD>Return the base URI of the document entity. If it is not known | |
| (because the document was parsed from a socket connection or from | |
| standard input, for example), the value of this property is unknown. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the document base URI String object or null if unknown.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setDocumentBaseURI(java.lang.String)"><!-- --></A><H3> | |
| setDocumentBaseURI</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.583"><B>setDocumentBaseURI</B></A>(java.lang.String baseURI)</PRE> | |
| <DL> | |
| <DD>Set the base URI of the document entity. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>baseURI</CODE> - the document base URI String object or null if unknown.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocumentSystemIdentifier(int)"><!-- --></A><H3> | |
| getDocumentSystemIdentifier</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.592"><B>getDocumentSystemIdentifier</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Return the system identifier of the document entity. If | |
| it is not known, the value of this property is null. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node id, which can be any valid node handle. | |
| <DT><B>Returns:</B><DD>the system identifier String object or null if unknown.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocumentEncoding(int)"><!-- --></A><H3> | |
| getDocumentEncoding</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.601"><B>getDocumentEncoding</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Return the name of the character encoding scheme | |
| in which the document entity is expressed. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node id, which can be any valid node handle. | |
| <DT><B>Returns:</B><DD>the document encoding String object.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocumentStandalone(int)"><!-- --></A><H3> | |
| getDocumentStandalone</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.613"><B>getDocumentStandalone</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Return an indication of the standalone status of the document, | |
| either "yes" or "no". This property is derived from the optional | |
| standalone document declaration in the XML declaration at the | |
| beginning of the document entity, and has no value if there is no | |
| standalone document declaration. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node id, which can be any valid node handle. | |
| <DT><B>Returns:</B><DD>the document standalone String object, either "yes", "no", or null.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocumentVersion(int)"><!-- --></A><H3> | |
| getDocumentVersion</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.624"><B>getDocumentVersion</B></A>(int documentHandle)</PRE> | |
| <DL> | |
| <DD>Return a string representing the XML version of the document. This | |
| property is derived from the XML declaration optionally present at the | |
| beginning of the document entity, and has no value if there is no XML | |
| declaration. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>documentHandle</CODE> - the document handle | |
| <DT><B>Returns:</B><DD>the document version String object</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocumentAllDeclarationsProcessed()"><!-- --></A><H3> | |
| getDocumentAllDeclarationsProcessed</H3> | |
| <PRE> | |
| boolean <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.636"><B>getDocumentAllDeclarationsProcessed</B></A>()</PRE> | |
| <DL> | |
| <DD>Return an indication of | |
| whether the processor has read the complete DTD. Its value is a | |
| boolean. If it is false, then certain properties (indicated in their | |
| descriptions below) may be unknown. If it is true, those properties | |
| are never unknown. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD><code>true</code> if all declarations were processed; | |
| <code>false</code> otherwise.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocumentTypeDeclarationSystemIdentifier()"><!-- --></A><H3> | |
| getDocumentTypeDeclarationSystemIdentifier</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.646"><B>getDocumentTypeDeclarationSystemIdentifier</B></A>()</PRE> | |
| <DL> | |
| <DD>A document type declaration information item has the following properties: | |
| 1. [system identifier] The system identifier of the external subset, if | |
| it exists. Otherwise this property has no value. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the system identifier String object, or null if there is none.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDocumentTypeDeclarationPublicIdentifier()"><!-- --></A><H3> | |
| getDocumentTypeDeclarationPublicIdentifier</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.656"><B>getDocumentTypeDeclarationPublicIdentifier</B></A>()</PRE> | |
| <DL> | |
| <DD>Return the public identifier of the external subset, | |
| normalized as described in 4.2.2 External Entities [XML]. If there is | |
| no external subset or if it has no public identifier, this property | |
| has no value. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the public identifier String object, or null if there is none.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getElementById(java.lang.String)"><!-- --></A><H3> | |
| getElementById</H3> | |
| <PRE> | |
| int <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.675"><B>getElementById</B></A>(java.lang.String elementId)</PRE> | |
| <DL> | |
| <DD>Returns the <code>Element</code> whose <code>ID</code> is given by | |
| <code>elementId</code>. If no such element exists, returns | |
| <code>DTM.NULL</code>. Behavior is not defined if more than one element | |
| has this <code>ID</code>. Attributes (including those | |
| with the name "ID") are not of type ID unless so defined by DTD/Schema | |
| information available to the DTM implementation. | |
| Implementations that do not know whether attributes are of type ID or | |
| not are expected to return <code>DTM.NULL</code>. | |
| <p>%REVIEW% Presumably IDs are still scoped to a single document, | |
| and this operation searches only within a single document, right? | |
| Wouldn't want collisions between DTMs in the same process.</p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>elementId</CODE> - The unique <code>id</code> value for an element. | |
| <DT><B>Returns:</B><DD>The handle of the matching element.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getUnparsedEntityURI(java.lang.String)"><!-- --></A><H3> | |
| getUnparsedEntityURI</H3> | |
| <PRE> | |
| java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.711"><B>getUnparsedEntityURI</B></A>(java.lang.String name)</PRE> | |
| <DL> | |
| <DD>The getUnparsedEntityURI function returns the URI of the unparsed | |
| entity with the specified name in the same document as the context | |
| node (see [3.3 Unparsed Entities]). It returns the empty string if | |
| there is no such entity. | |
| <p> | |
| XML processors may choose to use the System Identifier (if one | |
| is provided) to resolve the entity, rather than the URI in the | |
| Public Identifier. The details are dependent on the processor, and | |
| we would have to support some form of plug-in resolver to handle | |
| this properly. Currently, we simply return the System Identifier if | |
| present, and hope that it a usable URI or that our caller can | |
| map it to one. | |
| %REVIEW% Resolve Public Identifiers... or consider changing function name. | |
| <p> | |
| If we find a relative URI | |
| reference, XML expects it to be resolved in terms of the base URI | |
| of the document. The DOM doesn't do that for us, and it isn't | |
| entirely clear whether that should be done here; currently that's | |
| pushed up to a higher level of our application. (Note that DOM Level | |
| 1 didn't store the document's base URI.) | |
| %REVIEW% Consider resolving Relative URIs. | |
| <p> | |
| (The DOM's statement that "An XML processor may choose to | |
| completely expand entities before the structure model is passed | |
| to the DOM" refers only to parsed entities, not unparsed, and hence | |
| doesn't affect this function.) | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - A string containing the Entity Name of the unparsed | |
| entity. | |
| <DT><B>Returns:</B><DD>String containing the URI of the Unparsed Entity, or an | |
| empty string if no such entity exists.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="supportsPreStripping()"><!-- --></A><H3> | |
| supportsPreStripping</H3> | |
| <PRE> | |
| boolean <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.721"><B>supportsPreStripping</B></A>()</PRE> | |
| <DL> | |
| <DD>Return true if the xsl:strip-space or xsl:preserve-space was processed | |
| during construction of the document contained in this DTM. | |
| NEEDSDOC ($objectName$) @return | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isNodeAfter(int, int)"><!-- --></A><H3> | |
| isNodeAfter</H3> | |
| <PRE> | |
| boolean <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.743"><B>isNodeAfter</B></A>(int firstNodeHandle, | |
| int secondNodeHandle)</PRE> | |
| <DL> | |
| <DD>Figure out whether nodeHandle2 should be considered as being later | |
| in the document than nodeHandle1, in Document Order as defined | |
| by the XPath model. This may not agree with the ordering defined | |
| by other XML applications. | |
| <p> | |
| There are some cases where ordering isn't defined, and neither are | |
| the results of this function -- though we'll generally return true. | |
| <p> | |
| %REVIEW% Make sure this does the right thing with attribute nodes!!! | |
| <p> | |
| %REVIEW% Consider renaming for clarity. Perhaps isDocumentOrder(a,b)? | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>firstNodeHandle</CODE> - DOM Node to perform position comparison on.<DD><CODE>secondNodeHandle</CODE> - DOM Node to perform position comparison on. | |
| <DT><B>Returns:</B><DD>false if secondNode comes before firstNode, otherwise return true. | |
| You can think of this as | |
| <code>(firstNode.documentOrderPosition <= secondNode.documentOrderPosition)</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isCharacterElementContentWhitespace(int)"><!-- --></A><H3> | |
| isCharacterElementContentWhitespace</H3> | |
| <PRE> | |
| boolean <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.772"><B>isCharacterElementContentWhitespace</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>2. [element content whitespace] A boolean indicating whether a | |
| text node represents white space appearing within element content | |
| (see [XML], 2.10 "White Space Handling"). Note that validating | |
| XML processors are required by XML 1.0 to provide this | |
| information... but that DOM Level 2 did not support it, since it | |
| depends on knowledge of the DTD which DOM2 could not guarantee | |
| would be available. | |
| <p> | |
| If there is no declaration for the containing element, an XML | |
| processor must assume that the whitespace could be meaningful and | |
| return false. If no declaration has been read, but the [all | |
| declarations processed] property of the document information item | |
| is false (so there may be an unread declaration), then the value | |
| of this property is indeterminate for white space characters and | |
| should probably be reported as false. It is always false for text | |
| nodes that contain anything other than (or in addition to) white | |
| space. | |
| <p> | |
| Note too that it always returns false for non-Text nodes. | |
| <p> | |
| %REVIEW% Joe wants to rename this isWhitespaceInElementContent() for clarity | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the node ID. | |
| <DT><B>Returns:</B><DD><code>true</code> if the node definitely represents whitespace in | |
| element content; <code>false</code> otherwise.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isDocumentAllDeclarationsProcessed(int)"><!-- --></A><H3> | |
| isDocumentAllDeclarationsProcessed</H3> | |
| <PRE> | |
| boolean <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.786"><B>isDocumentAllDeclarationsProcessed</B></A>(int documentHandle)</PRE> | |
| <DL> | |
| <DD>10. [all declarations processed] This property is not strictly speaking | |
| part of the infoset of the document. Rather it is an indication of | |
| whether the processor has read the complete DTD. Its value is a | |
| boolean. If it is false, then certain properties (indicated in their | |
| descriptions below) may be unknown. If it is true, those properties | |
| are never unknown. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>documentHandle</CODE> - A node handle that must identify a document. | |
| <DT><B>Returns:</B><DD><code>true</code> if all declarations were processed; | |
| <code>false</code> otherwise.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isAttributeSpecified(int)"><!-- --></A><H3> | |
| isAttributeSpecified</H3> | |
| <PRE> | |
| boolean <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.798"><B>isAttributeSpecified</B></A>(int attributeHandle)</PRE> | |
| <DL> | |
| <DD>5. [specified] A flag indicating whether this attribute was actually | |
| specified in the start-tag of its element, or was defaulted from the | |
| DTD (or schema). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>attributeHandle</CODE> - The attribute handle | |
| <DT><B>Returns:</B><DD><code>true</code> if the attribute was specified; | |
| <code>false</code> if it was defaulted or the handle doesn't | |
| refer to an attribute node.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="dispatchCharactersEvents(int, org.xml.sax.ContentHandler, boolean)"><!-- --></A><H3> | |
| dispatchCharactersEvents</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.819"><B>dispatchCharactersEvents</B></A>(int nodeHandle, | |
| org.xml.sax.ContentHandler ch, | |
| boolean normalize) | |
| throws org.xml.sax.SAXException</PRE> | |
| <DL> | |
| <DD>Directly call the | |
| characters method on the passed ContentHandler for the | |
| string-value of the given node (see http://www.w3.org/TR/xpath#data-model | |
| for the definition of a node's string-value). Multiple calls to the | |
| ContentHandler's characters methods may well occur for a single call to | |
| this method. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node ID.<DD><CODE>ch</CODE> - A non-null reference to a ContentHandler.<DD><CODE>normalize</CODE> - true if the content should be normalized according to | |
| the rules for the XPath | |
| <a href="http://www.w3.org/TR/xpath#function-normalize-space">normalize-space</a> | |
| function. | |
| <DT><B>Throws:</B> | |
| <DD><CODE>org.xml.sax.SAXException</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="dispatchToEvents(int, org.xml.sax.ContentHandler)"><!-- --></A><H3> | |
| dispatchToEvents</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.832"><B>dispatchToEvents</B></A>(int nodeHandle, | |
| org.xml.sax.ContentHandler ch) | |
| throws org.xml.sax.SAXException</PRE> | |
| <DL> | |
| <DD>Directly create SAX parser events representing the XML content of | |
| a DTM subtree. This is a "serialize" operation. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node ID.<DD><CODE>ch</CODE> - A non-null reference to a ContentHandler. | |
| <DT><B>Throws:</B> | |
| <DD><CODE>org.xml.sax.SAXException</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNode(int)"><!-- --></A><H3> | |
| getNode</H3> | |
| <PRE> | |
| org.w3c.dom.Node <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.842"><B>getNode</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD>Return an DOM node for the given node. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node ID. | |
| <DT><B>Returns:</B><DD>A node representation of the DTM node.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="needsTwoThreads()"><!-- --></A><H3> | |
| needsTwoThreads</H3> | |
| <PRE> | |
| boolean <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.853"><B>needsTwoThreads</B></A>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>true iff we're building this model incrementally (eg | |
| we're partnered with a CoroutineParser) and thus require that the | |
| transformation and the parse run simultaneously. Guidance to the | |
| DTMManager.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getContentHandler()"><!-- --></A><H3> | |
| getContentHandler</H3> | |
| <PRE> | |
| org.xml.sax.ContentHandler <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.866"><B>getContentHandler</B></A>()</PRE> | |
| <DL> | |
| <DD>Return this DTM's content handler, if it has one. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>null if this model doesn't respond to SAX events.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getLexicalHandler()"><!-- --></A><H3> | |
| getLexicalHandler</H3> | |
| <PRE> | |
| org.xml.sax.ext.LexicalHandler <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.875"><B>getLexicalHandler</B></A>()</PRE> | |
| <DL> | |
| <DD>Return this DTM's lexical handler, if it has one. | |
| %REVIEW% Should this return null if constrution already done/begun? | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>null if this model doesn't respond to lexical SAX events.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getEntityResolver()"><!-- --></A><H3> | |
| getEntityResolver</H3> | |
| <PRE> | |
| org.xml.sax.EntityResolver <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.882"><B>getEntityResolver</B></A>()</PRE> | |
| <DL> | |
| <DD>Return this DTM's EntityResolver, if it has one. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>null if this model doesn't respond to SAX entity ref events.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDTDHandler()"><!-- --></A><H3> | |
| getDTDHandler</H3> | |
| <PRE> | |
| org.xml.sax.DTDHandler <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.889"><B>getDTDHandler</B></A>()</PRE> | |
| <DL> | |
| <DD>Return this DTM's DTDHandler, if it has one. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>null if this model doesn't respond to SAX dtd events.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getErrorHandler()"><!-- --></A><H3> | |
| getErrorHandler</H3> | |
| <PRE> | |
| org.xml.sax.ErrorHandler <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.896"><B>getErrorHandler</B></A>()</PRE> | |
| <DL> | |
| <DD>Return this DTM's ErrorHandler, if it has one. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>null if this model doesn't respond to SAX error events.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDeclHandler()"><!-- --></A><H3> | |
| getDeclHandler</H3> | |
| <PRE> | |
| org.xml.sax.ext.DeclHandler <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.903"><B>getDeclHandler</B></A>()</PRE> | |
| <DL> | |
| <DD>Return this DTM's DeclHandler, if it has one. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>null if this model doesn't respond to SAX Decl events.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="appendChild(int, boolean, boolean)"><!-- --></A><H3> | |
| appendChild</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.923"><B>appendChild</B></A>(int newChild, | |
| boolean clone, | |
| boolean cloneDepth)</PRE> | |
| <DL> | |
| <DD>Append a child to "the end of the document". Please note that | |
| the node is always cloned in a base DTM, since our basic behavior | |
| is immutable so nodes can't be removed from their previous | |
| location. | |
| <p> %REVIEW% DTM maintains an insertion cursor which | |
| performs a depth-first tree walk as nodes come in, and this operation | |
| is really equivalent to: | |
| insertionCursor.appendChild(document.importNode(newChild))) | |
| where the insert point is the last element that was appended (or | |
| the last one popped back to by an end-element operation).</p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>newChild</CODE> - Must be a valid new node handle.<DD><CODE>clone</CODE> - true if the child should be cloned into the document.<DD><CODE>cloneDepth</CODE> - if the clone argument is true, specifies that the | |
| clone should include all it's children.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="appendTextChild(java.lang.String)"><!-- --></A><H3> | |
| appendTextChild</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.931"><B>appendTextChild</B></A>(java.lang.String str)</PRE> | |
| <DL> | |
| <DD>Append a text node child that will be constructed from a string, | |
| to the end of the document. Behavior is otherwise like appendChild(). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>str</CODE> - Non-null reference to a string.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getSourceLocatorFor(int)"><!-- --></A><H3> | |
| getSourceLocatorFor</H3> | |
| <PRE> | |
| javax.xml.transform.SourceLocator <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.940"><B>getSourceLocatorFor</B></A>(int node)</PRE> | |
| <DL> | |
| <DD>Get the location of a node in the source document. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - an <code>int</code> value | |
| <DT><B>Returns:</B><DD>a <code>SourceLocator</code> value or null if no location | |
| is available</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="documentRegistration()"><!-- --></A><H3> | |
| documentRegistration</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.948"><B>documentRegistration</B></A>()</PRE> | |
| <DL> | |
| <DD>As the DTM is registered with the DTMManager, this method | |
| will be called. This will give the DTM implementation a | |
| chance to initialize any subsystems that are required to | |
| build the DTM | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="documentRelease()"><!-- --></A><H3> | |
| documentRelease</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.957"><B>documentRelease</B></A>()</PRE> | |
| <DL> | |
| <DD>As documents are released from the DTMManager, the DTM implementation | |
| will be notified of the event. This will allow the DTM implementation | |
| to shutdown any subsystem activity that may of been assoiated with | |
| the active DTM Implementation. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="migrateTo(org.apache.xml.dtm.DTMManager)"><!-- --></A><H3> | |
| migrateTo</H3> | |
| <PRE> | |
| void <A HREF="../../../../src-html/org/apache/xml/dtm/DTM.html#line.966"><B>migrateTo</B></A>(<A HREF="../../../../org/apache/xml/dtm/DTMManager.html" title="class in org.apache.xml.dtm">DTMManager</A> manager)</PRE> | |
| <DL> | |
| <DD>Migrate a DTM built with an old DTMManager to a new DTMManager. | |
| After the migration, the new DTMManager will treat the DTM as | |
| one that is built by itself. | |
| This is used to support DTM sharing between multiple transformations. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>manager</CODE> - the DTMManager</DL> | |
| </DD> | |
| </DL> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <HR> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <A NAME="navbar_bottom"><!-- --></A> | |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DTM.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../org/apache/xml/dtm/Axis.html" title="class in org.apache.xml.dtm"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xml/dtm/DTM.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="DTM.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| </BODY> | |
| </HTML> |