| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
|
| <!--NewPage-->
|
| <HTML>
|
| <HEAD>
|
| <!-- Generated by javadoc on Thu Nov 22 17:12:56 EST 2007 -->
|
| <TITLE>
|
| Xalan-Java 2.7.1: Class DTMDocumentImpl
|
| </TITLE>
|
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
| </HEAD>
|
| <BODY BGCOLOR="white">
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <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/DTMDocumentImpl.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/ref/DTMDefaultBaseTraversers.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../../org/apache/xml/dtm/ref/DTMManagerDefault.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="DTMDocumentImpl.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| <!-- ======== START OF CLASS DATA ======== -->
|
| <H2>
|
| <FONT SIZE="-1">
|
| org.apache.xml.dtm.ref</FONT>
|
| <BR>
|
| Class DTMDocumentImpl</H2>
|
| <PRE>
|
| java.lang.Object
|
| |
|
| +--<B>org.apache.xml.dtm.ref.DTMDocumentImpl</B>
|
| </PRE>
|
| <HR>
|
| <DL>
|
| <DT>public class <B>DTMDocumentImpl</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A>, <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A>, <A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A></DL>
|
|
|
| <P>
|
| This is the implementation of the DTM document interface. It receives |
| requests from an XML content handler similar to that of an XML DOM or SAX parser |
| to store information from the xml document in an array based |
| dtm table structure. This informtion is used later for document navigation, |
| query, and SAX event dispatch functions. The DTM can also be used directly as a |
| document composition model for an application. The requests received are: |
| <ul> |
| <li>initiating DTM to set the doc handle</li> |
| <li>resetting DTM for data structure reuse</li> |
| <li>hinting the end of document to adjust the end of data structure pointers</li> |
| <li>createnodes (element, comment, text, attribute, ....)</li> |
| <li>hinting the end of an element to patch parent and siblings<li> |
| <li>setting application provided symbol name stringpool data structures</li> |
| </ul> |
| <p>State: In progress!!</p> |
| |
| %REVIEW% I _think_ the SAX convention is that "no namespace" is expressed |
| as "" rather than as null (which is the DOM's convention). What should |
| DTM expect? What should it do with the other? |
| |
| <p>Origin: the implemention is a composite logic based on the DTM of XalanJ1 and |
| DocImpl, DocumentImpl, ElementImpl, TextImpl, etc. of XalanJ2</p>
|
| <P>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
| <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Constructor Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#DTMDocumentImpl(org.apache.xml.dtm.DTMManager, int, org.apache.xml.dtm.DTMWSFilter, org.apache.xml.utils.XMLStringFactory)">DTMDocumentImpl</A></B>(<A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> mgr, |
| int documentNumber, |
| <A HREF="../../../../../org/apache/xml/dtm/DTMWSFilter.html">DTMWSFilter</A> whiteSpaceFilter, |
| <A HREF="../../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A> xstringfactory)</CODE>
|
|
|
| <BR>
|
| Construct a DTM.</TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <!-- ========== METHOD SUMMARY =========== -->
|
|
|
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Method Summary</B></FONT></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/ref/DTMDocumentImpl.html#appendChild(int, boolean, boolean)">appendChild</A></B>(int newChild, |
| boolean clone, |
| boolean cloneDepth)</CODE>
|
|
|
| <BR>
|
| Append a child to the end of the child list of the current 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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.html#characters(char[], int, int)">characters</A></B>(char[] ch, |
| int start, |
| int length)</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/ref/DTMDocumentImpl.html#comment(char[], int, int)">comment</A></B>(char[] ch, |
| int start, |
| int length)</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/ref/DTMDocumentImpl.html#dispatchCharactersEvents(int, org.xml.sax.ContentHandler, boolean)">dispatchCharactersEvents</A></B>(int nodeHandle, |
| <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> 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/ref/DTMDocumentImpl.html#dispatchToEvents(int, org.xml.sax.ContentHandler)">dispatchToEvents</A></B>(int nodeHandle, |
| <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> ch)</CODE>
|
|
|
| <BR>
|
| Directly create SAX parser events from a 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/ref/DTMDocumentImpl.html#documentRegistration()">documentRegistration</A></B>()</CODE>
|
|
|
| <BR>
|
| A dummy routine to satisify the abstract interface.</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/ref/DTMDocumentImpl.html#documentRelease()">documentRelease</A></B>()</CODE>
|
|
|
| <BR>
|
| A dummy routine to satisify the abstract interface.</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/ref/DTMDocumentImpl.html#endCDATA()">endCDATA</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/ref/DTMDocumentImpl.html#endDocument()">endDocument</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/ref/DTMDocumentImpl.html#endDTD()">endDTD</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/ref/DTMDocumentImpl.html#endElement(java.lang.String, java.lang.String, java.lang.String)">endElement</A></B>(java.lang.String namespaceURI, |
| java.lang.String localName, |
| java.lang.String qName)</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/ref/DTMDocumentImpl.html#endEntity(java.lang.String)">endEntity</A></B>(java.lang.String name)</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/ref/DTMDocumentImpl.html#endPrefixMapping(java.lang.String)">endPrefixMapping</A></B>(java.lang.String prefix)</CODE>
|
|
|
| <BR>
|
| </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/ref/DTMDocumentImpl.html#getAttributeNode(int, java.lang.String, java.lang.String)">getAttributeNode</A></B>(int nodeHandle, |
| java.lang.String namespaceURI, |
| java.lang.String name)</CODE>
|
|
|
| <BR>
|
| Retrieves an attribute node by by qualified name and namespace URI.</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">DTMAxisIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#getAxisIterator(int)">getAxisIterator</A></B>(int axis)</CODE>
|
|
|
| <BR>
|
| This is a shortcut to the iterators that implement the |
| supported XPath axes (only namespace::) is not supported.</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">DTMAxisTraverser</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.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> <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#getContentHandler()">getContentHandler</A></B>()</CODE>
|
|
|
| <BR>
|
| getContentHandler returns "our SAX builder" -- the thing that |
| someone else should send SAX events to in order to extend this |
| DTM model.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../../org/xml/sax/ext/DeclHandler.html">DeclHandler</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#getDeclHandler()">getDeclHandler</A></B>()</CODE>
|
|
|
| <BR>
|
| Return this DTM's DeclHandler.</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/ref/DTMDocumentImpl.html#getDocument()">getDocument</A></B>()</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> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.html#getDocumentRoot()">getDocumentRoot</A></B>()</CODE>
|
|
|
| <BR>
|
| Returns the root element of the document.</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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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> <A HREF="../../../../../org/xml/sax/DTDHandler.html">DTDHandler</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#getDTDHandler()">getDTDHandler</A></B>()</CODE>
|
|
|
| <BR>
|
| Return this DTM's DTDHandler.</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/ref/DTMDocumentImpl.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> <A HREF="../../../../../org/xml/sax/EntityResolver.html">EntityResolver</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#getEntityResolver()">getEntityResolver</A></B>()</CODE>
|
|
|
| <BR>
|
| Return this DTM's EntityResolver.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../../org/xml/sax/ErrorHandler.html">ErrorHandler</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#getErrorHandler()">getErrorHandler</A></B>()</CODE>
|
|
|
| <BR>
|
| Return this DTM's ErrorHandler.</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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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 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/ref/DTMDocumentImpl.html#getLastChild(int)">getLastChild</A></B>(int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Given a node handle, advance to its 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/ref/DTMDocumentImpl.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> <A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#getLexicalHandler()">getLexicalHandler</A></B>()</CODE>
|
|
|
| <BR>
|
| Return this DTM's lexical handler.</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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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> <A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#getLocalNameTable()">getLocalNameTable</A></B>()</CODE>
|
|
|
| <BR>
|
| Get a reference pointer to the element name symbol table.</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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.html#getNextDescendant(int, int)">getNextDescendant</A></B>(int subtreeRootHandle, |
| int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Given a node handle, advance to its next descendant.</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/ref/DTMDocumentImpl.html#getNextFollowing(int, int)">getNextFollowing</A></B>(int axisContextHandle, |
| int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Given a node handle, advance to the next node on the following axis.</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/ref/DTMDocumentImpl.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.</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/ref/DTMDocumentImpl.html#getNextPreceding(int, int)">getNextPreceding</A></B>(int axisContextHandle, |
| int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Given a node handle, advance to the next node on the preceding axis.</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/ref/DTMDocumentImpl.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> <A HREF="../../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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> <A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#getNsNameTable()">getNsNameTable</A></B>()</CODE>
|
|
|
| <BR>
|
| Get a reference pointer to the namespace URI symbol table.</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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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> <A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#getPrefixNameTable()">getPrefixNameTable</A></B>()</CODE>
|
|
|
| <BR>
|
| Get a reference pointer to the prefix name symbol table.</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/ref/DTMDocumentImpl.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> <A HREF="../../../../../javax/xml/transform/SourceLocator.html">SourceLocator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#getSourceLocatorFor(int)">getSourceLocatorFor</A></B>(int node)</CODE>
|
|
|
| <BR>
|
| Source information is not handled yet, so return |
| <code>null</code> here.</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">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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">DTMAxisIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html#ignorableWhitespace(char[], int, int)">ignorableWhitespace</A></B>(char[] ch, |
| int start, |
| int length)</CODE>
|
|
|
| <BR>
|
| </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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.html#isNodeAfter(int, int)">isNodeAfter</A></B>(int nodeHandle1, |
| int nodeHandle2)</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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.html#migrateTo(org.apache.xml.dtm.DTMManager)">migrateTo</A></B>(<A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.html#processingInstruction(java.lang.String, java.lang.String)">processingInstruction</A></B>(java.lang.String target, |
| java.lang.String data)</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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.html#setDocumentLocator(org.xml.sax.Locator)">setDocumentLocator</A></B>(<A HREF="../../../../../org/xml/sax/Locator.html">Locator</A> locator)</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/ref/DTMDocumentImpl.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/ref/DTMDocumentImpl.html#setIncrementalSAXSource(org.apache.xml.dtm.ref.IncrementalSAXSource)">setIncrementalSAXSource</A></B>(<A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html">IncrementalSAXSource</A> source)</CODE>
|
|
|
| <BR>
|
| Bind a IncrementalSAXSource to this DTM.</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/ref/DTMDocumentImpl.html#setLocalNameTable(org.apache.xml.dtm.ref.DTMStringPool)">setLocalNameTable</A></B>(<A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A> poolRef)</CODE>
|
|
|
| <BR>
|
| Set a reference pointer to the element name symbol table.</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/ref/DTMDocumentImpl.html#setNsNameTable(org.apache.xml.dtm.ref.DTMStringPool)">setNsNameTable</A></B>(<A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A> poolRef)</CODE>
|
|
|
| <BR>
|
| Set a reference pointer to the namespace URI symbol table.</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/ref/DTMDocumentImpl.html#setPrefixNameTable(org.apache.xml.dtm.ref.DTMStringPool)">setPrefixNameTable</A></B>(<A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A> poolRef)</CODE>
|
|
|
| <BR>
|
| Set a reference pointer to the prefix name symbol table.</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/ref/DTMDocumentImpl.html#setProperty(java.lang.String, java.lang.Object)">setProperty</A></B>(java.lang.String property, |
| java.lang.Object value)</CODE>
|
|
|
| <BR>
|
| For the moment all the run time properties are ignored by this |
| class.</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/ref/DTMDocumentImpl.html#skippedEntity(java.lang.String)">skippedEntity</A></B>(java.lang.String name)</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/ref/DTMDocumentImpl.html#startCDATA()">startCDATA</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/ref/DTMDocumentImpl.html#startDocument()">startDocument</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/ref/DTMDocumentImpl.html#startDTD(java.lang.String, java.lang.String, java.lang.String)">startDTD</A></B>(java.lang.String name, |
| java.lang.String publicId, |
| java.lang.String systemId)</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/ref/DTMDocumentImpl.html#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)">startElement</A></B>(java.lang.String namespaceURI, |
| java.lang.String localName, |
| java.lang.String qName, |
| <A HREF="../../../../../org/xml/sax/Attributes.html">Attributes</A> atts)</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/ref/DTMDocumentImpl.html#startEntity(java.lang.String)">startEntity</A></B>(java.lang.String name)</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/ref/DTMDocumentImpl.html#startPrefixMapping(java.lang.String, java.lang.String)">startPrefixMapping</A></B>(java.lang.String prefix, |
| java.lang.String uri)</CODE>
|
|
|
| <BR>
|
| </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/ref/DTMDocumentImpl.html#supportsPreStripping()">supportsPreStripping</A></B>()</CODE>
|
|
|
| <BR>
|
| Return true if the xsl:strip-space or xsl:preserve-space was processed |
| during construction of the DTM document.</TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE>equals,
|
| getClass,
|
| hashCode,
|
| notify,
|
| notifyAll,
|
| toString,
|
| wait,
|
| wait,
|
| wait</CODE></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <P>
|
|
|
| <!-- ============ FIELD DETAIL =========== -->
|
|
|
|
|
| <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Constructor Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="DTMDocumentImpl(org.apache.xml.dtm.DTMManager, int, org.apache.xml.dtm.DTMWSFilter, org.apache.xml.utils.XMLStringFactory)"><!-- --></A><H3>
|
| DTMDocumentImpl</H3>
|
| <PRE>
|
| public <B>DTMDocumentImpl</B>(<A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> mgr, |
| int documentNumber, |
| <A HREF="../../../../../org/apache/xml/dtm/DTMWSFilter.html">DTMWSFilter</A> whiteSpaceFilter, |
| <A HREF="../../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A> xstringfactory)</PRE>
|
| <DL>
|
| <DD>Construct a DTM.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>documentNumber</CODE> - the ID number assigned to this document. |
| It will be shifted up into the high bits and returned as part of |
| all node ID numbers, so those IDs indicate which document they |
| came from as well as a location within the document. It is the |
| DTMManager's responsibility to assign a unique number to each |
| document.</DL>
|
| </DD>
|
| </DL>
|
|
|
| <!-- ============ METHOD DETAIL ========== -->
|
|
|
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Method Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="setIncrementalSAXSource(org.apache.xml.dtm.ref.IncrementalSAXSource)"><!-- --></A><H3>
|
| setIncrementalSAXSource</H3>
|
| <PRE>
|
| public void <B>setIncrementalSAXSource</B>(<A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html">IncrementalSAXSource</A> source)</PRE>
|
| <DL>
|
| <DD>Bind a IncrementalSAXSource to this DTM. If we discover we need nodes |
| that have not yet been built, we will ask this object to send us more |
| events, and it will manage interactions with its data sources. |
| |
| Note that we do not actually build the IncrementalSAXSource, since we don't |
| know what source it's reading from, what thread that source will run in, |
| or when it will run.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>source</CODE> - The IncrementalSAXSource that we want to recieve events from |
| on demand.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setFeature(java.lang.String, boolean)"><!-- --></A><H3>
|
| setFeature</H3>
|
| <PRE>
|
| public void <B>setFeature</B>(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?<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#setFeature(java.lang.String, boolean)">setFeature</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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="setLocalNameTable(org.apache.xml.dtm.ref.DTMStringPool)"><!-- --></A><H3>
|
| setLocalNameTable</H3>
|
| <PRE>
|
| public void <B>setLocalNameTable</B>(<A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A> poolRef)</PRE>
|
| <DL>
|
| <DD>Set a reference pointer to the element name symbol table. |
| %REVIEW% Should this really be Public? Changing it while |
| DTM is in use would be a disaster.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>poolRef</CODE> - DTMStringPool reference to an instance of table.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getLocalNameTable()"><!-- --></A><H3>
|
| getLocalNameTable</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A> <B>getLocalNameTable</B>()</PRE>
|
| <DL>
|
| <DD>Get a reference pointer to the element name symbol table.<DD><DL>
|
| <DT><B>Returns:</B><DD>DTMStringPool reference to an instance of table.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setNsNameTable(org.apache.xml.dtm.ref.DTMStringPool)"><!-- --></A><H3>
|
| setNsNameTable</H3>
|
| <PRE>
|
| public void <B>setNsNameTable</B>(<A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A> poolRef)</PRE>
|
| <DL>
|
| <DD>Set a reference pointer to the namespace URI symbol table. |
| %REVIEW% Should this really be Public? Changing it while |
| DTM is in use would be a disaster.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>poolRef</CODE> - DTMStringPool reference to an instance of table.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getNsNameTable()"><!-- --></A><H3>
|
| getNsNameTable</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A> <B>getNsNameTable</B>()</PRE>
|
| <DL>
|
| <DD>Get a reference pointer to the namespace URI symbol table.<DD><DL>
|
| <DT><B>Returns:</B><DD>DTMStringPool reference to an instance of table.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setPrefixNameTable(org.apache.xml.dtm.ref.DTMStringPool)"><!-- --></A><H3>
|
| setPrefixNameTable</H3>
|
| <PRE>
|
| public void <B>setPrefixNameTable</B>(<A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A> poolRef)</PRE>
|
| <DL>
|
| <DD>Set a reference pointer to the prefix name symbol table. |
| %REVIEW% Should this really be Public? Changing it while |
| DTM is in use would be a disaster.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>poolRef</CODE> - DTMStringPool reference to an instance of table.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getPrefixNameTable()"><!-- --></A><H3>
|
| getPrefixNameTable</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html">DTMStringPool</A> <B>getPrefixNameTable</B>()</PRE>
|
| <DL>
|
| <DD>Get a reference pointer to the prefix name symbol table.<DD><DL>
|
| <DT><B>Returns:</B><DD>DTMStringPool reference to an instance of table.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getContentHandler()"><!-- --></A><H3>
|
| getContentHandler</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> <B>getContentHandler</B>()</PRE>
|
| <DL>
|
| <DD>getContentHandler returns "our SAX builder" -- the thing that |
| someone else should send SAX events to in order to extend this |
| DTM model.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getContentHandler()">getContentHandler</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Returns:</B><DD>null if this model doesn't respond to SAX events, |
| "this" if the DTM object has a built-in SAX ContentHandler, |
| the IncrementalSAXSource if we're bound to one and should receive |
| the SAX stream via it for incremental build purposes...</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getLexicalHandler()"><!-- --></A><H3>
|
| getLexicalHandler</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A> <B>getLexicalHandler</B>()</PRE>
|
| <DL>
|
| <DD>Return this DTM's lexical handler. |
| |
| %REVIEW% Should this return null if constrution already done/begun?<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getLexicalHandler()">getLexicalHandler</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Returns:</B><DD>null if this model doesn't respond to lexical SAX events, |
| "this" if the DTM object has a built-in SAX ContentHandler, |
| the IncrementalSAXSource if we're bound to one and should receive |
| the SAX stream via it for incremental build purposes...</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getEntityResolver()"><!-- --></A><H3>
|
| getEntityResolver</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/xml/sax/EntityResolver.html">EntityResolver</A> <B>getEntityResolver</B>()</PRE>
|
| <DL>
|
| <DD>Return this DTM's EntityResolver.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getEntityResolver()">getEntityResolver</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public <A HREF="../../../../../org/xml/sax/DTDHandler.html">DTDHandler</A> <B>getDTDHandler</B>()</PRE>
|
| <DL>
|
| <DD>Return this DTM's DTDHandler.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDTDHandler()">getDTDHandler</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public <A HREF="../../../../../org/xml/sax/ErrorHandler.html">ErrorHandler</A> <B>getErrorHandler</B>()</PRE>
|
| <DL>
|
| <DD>Return this DTM's ErrorHandler.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getErrorHandler()">getErrorHandler</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public <A HREF="../../../../../org/xml/sax/ext/DeclHandler.html">DeclHandler</A> <B>getDeclHandler</B>()</PRE>
|
| <DL>
|
| <DD>Return this DTM's DeclHandler.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDeclHandler()">getDeclHandler</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Returns:</B><DD>null if this model doesn't respond to SAX Decl events.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="needsTwoThreads()"><!-- --></A><H3>
|
| needsTwoThreads</H3>
|
| <PRE>
|
| public boolean <B>needsTwoThreads</B>()</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#needsTwoThreads()">needsTwoThreads</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Returns:</B><DD>true iff we're building this model incrementally (eg |
| we're partnered with a IncrementalSAXSource) and thus require that the |
| transformation and the parse run simultaneously. Guidance to the |
| DTMManager.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="characters(char[], int, int)"><!-- --></A><H3>
|
| characters</H3>
|
| <PRE>
|
| public void <B>characters</B>(char[] ch, |
| int start, |
| int length) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ContentHandler.html#characters(char[], int, int)">characters</A> in interface <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endDocument()"><!-- --></A><H3>
|
| endDocument</H3>
|
| <PRE>
|
| public void <B>endDocument</B>() |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ContentHandler.html#endDocument()">endDocument</A> in interface <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endElement(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| endElement</H3>
|
| <PRE>
|
| public void <B>endElement</B>(java.lang.String namespaceURI, |
| java.lang.String localName, |
| java.lang.String qName) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ContentHandler.html#endElement(java.lang.String, java.lang.String, java.lang.String)">endElement</A> in interface <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endPrefixMapping(java.lang.String)"><!-- --></A><H3>
|
| endPrefixMapping</H3>
|
| <PRE>
|
| public void <B>endPrefixMapping</B>(java.lang.String prefix) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ContentHandler.html#endPrefixMapping(java.lang.String)">endPrefixMapping</A> in interface <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="ignorableWhitespace(char[], int, int)"><!-- --></A><H3>
|
| ignorableWhitespace</H3>
|
| <PRE>
|
| public void <B>ignorableWhitespace</B>(char[] ch, |
| int start, |
| int length) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ContentHandler.html#ignorableWhitespace(char[], int, int)">ignorableWhitespace</A> in interface <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="processingInstruction(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| processingInstruction</H3>
|
| <PRE>
|
| public void <B>processingInstruction</B>(java.lang.String target, |
| java.lang.String data) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ContentHandler.html#processingInstruction(java.lang.String, java.lang.String)">processingInstruction</A> in interface <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setDocumentLocator(org.xml.sax.Locator)"><!-- --></A><H3>
|
| setDocumentLocator</H3>
|
| <PRE>
|
| public void <B>setDocumentLocator</B>(<A HREF="../../../../../org/xml/sax/Locator.html">Locator</A> locator)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ContentHandler.html#setDocumentLocator(org.xml.sax.Locator)">setDocumentLocator</A> in interface <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="skippedEntity(java.lang.String)"><!-- --></A><H3>
|
| skippedEntity</H3>
|
| <PRE>
|
| public void <B>skippedEntity</B>(java.lang.String name) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ContentHandler.html#skippedEntity(java.lang.String)">skippedEntity</A> in interface <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startDocument()"><!-- --></A><H3>
|
| startDocument</H3>
|
| <PRE>
|
| public void <B>startDocument</B>() |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ContentHandler.html#startDocument()">startDocument</A> in interface <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)"><!-- --></A><H3>
|
| startElement</H3>
|
| <PRE>
|
| public void <B>startElement</B>(java.lang.String namespaceURI, |
| java.lang.String localName, |
| java.lang.String qName, |
| <A HREF="../../../../../org/xml/sax/Attributes.html">Attributes</A> atts) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ContentHandler.html#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)">startElement</A> in interface <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startPrefixMapping(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| startPrefixMapping</H3>
|
| <PRE>
|
| public void <B>startPrefixMapping</B>(java.lang.String prefix, |
| java.lang.String uri) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ContentHandler.html#startPrefixMapping(java.lang.String, java.lang.String)">startPrefixMapping</A> in interface <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="comment(char[], int, int)"><!-- --></A><H3>
|
| comment</H3>
|
| <PRE>
|
| public void <B>comment</B>(char[] ch, |
| int start, |
| int length) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html#comment(char[], int, int)">comment</A> in interface <A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endCDATA()"><!-- --></A><H3>
|
| endCDATA</H3>
|
| <PRE>
|
| public void <B>endCDATA</B>() |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html#endCDATA()">endCDATA</A> in interface <A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endDTD()"><!-- --></A><H3>
|
| endDTD</H3>
|
| <PRE>
|
| public void <B>endDTD</B>() |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html#endDTD()">endDTD</A> in interface <A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endEntity(java.lang.String)"><!-- --></A><H3>
|
| endEntity</H3>
|
| <PRE>
|
| public void <B>endEntity</B>(java.lang.String name) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html#endEntity(java.lang.String)">endEntity</A> in interface <A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startCDATA()"><!-- --></A><H3>
|
| startCDATA</H3>
|
| <PRE>
|
| public void <B>startCDATA</B>() |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html#startCDATA()">startCDATA</A> in interface <A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startDTD(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| startDTD</H3>
|
| <PRE>
|
| public void <B>startDTD</B>(java.lang.String name, |
| java.lang.String publicId, |
| java.lang.String systemId) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html#startDTD(java.lang.String, java.lang.String, java.lang.String)">startDTD</A> in interface <A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startEntity(java.lang.String)"><!-- --></A><H3>
|
| startEntity</H3>
|
| <PRE>
|
| public void <B>startEntity</B>(java.lang.String name) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html#startEntity(java.lang.String)">startEntity</A> in interface <A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="hasChildNodes(int)"><!-- --></A><H3>
|
| hasChildNodes</H3>
|
| <PRE>
|
| public boolean <B>hasChildNodes</B>(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><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#hasChildNodes(int)">hasChildNodes</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public int <B>getFirstChild</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, get the handle of the node's first child. |
| If not yet resolved, waits for more nodes to be added to the document and |
| tries again.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getFirstChild(int)">getFirstChild</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public int <B>getLastChild</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, advance to its last child. |
| If not yet resolved, waits for more nodes to be added to the document and |
| tries again.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getLastChild(int)">getLastChild</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public int <B>getAttributeNode</B>(int nodeHandle, |
| java.lang.String namespaceURI, |
| java.lang.String name)</PRE>
|
| <DL>
|
| <DD>Retrieves an attribute node by by qualified name and namespace URI.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getAttributeNode(int, java.lang.String, java.lang.String)">getAttributeNode</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - int 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>
|
| public int <B>getFirstAttribute</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, get the index of the node's first attribute.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getFirstAttribute(int)">getFirstAttribute</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - int Handle of the Element 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>
|
| public int <B>getFirstNamespaceNode</B>(int nodeHandle, |
| boolean inScope)</PRE>
|
| <DL>
|
| <DD>Given a node handle, get the index of the node's first child. |
| If not yet resolved, waits for more nodes to be added to the document and |
| tries again<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getFirstNamespaceNode(int, boolean)">getFirstNamespaceNode</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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 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>
|
| public int <B>getNextSibling</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, advance to its next sibling. |
| |
| %TBD% This currently uses the DTM-internal definition of |
| sibling; eg, the last attr's next sib is the first |
| child. In the old DTM, the DOM proxy layer provided the |
| additional logic for the public view. If we're rewriting |
| for XPath emulation, that test must be done here. |
| |
| %TBD% CODE INTERACTION WITH INCREMENTAL PARSE - If not yet |
| resolved, should wait for more nodes to be added to the document |
| and tries again.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getNextSibling(int)">getNextSibling</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public int <B>getPreviousSibling</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, find its preceeding sibling. |
| WARNING: DTM is asymmetric; this operation is resolved by search, and is |
| relatively expensive.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getPreviousSibling(int)">getPreviousSibling</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public int <B>getNextAttribute</B>(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 on the same node.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getNextAttribute(int)">getNextAttribute</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public int <B>getNextNamespaceNode</B>(int baseHandle, |
| int namespaceHandle, |
| boolean inScope)</PRE>
|
| <DL>
|
| <DD>Given a namespace handle, advance to the next namespace. |
| |
| %TBD% THIS METHOD DOES NOT MATCH THE CURRENT SIGNATURE IN |
| THE DTM INTERFACE. FIX IT, OR JUSTIFY CHANGING THE DTM |
| API.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getNextNamespaceNode(int, int, boolean)">getNextNamespaceNode</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>namespaceHandle</CODE> - handle to node which must be of type NAMESPACE_NODE.<DT><B>Returns:</B><DD>handle of next namespace, or DTM.NULL to indicate none exists.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getNextDescendant(int, int)"><!-- --></A><H3>
|
| getNextDescendant</H3>
|
| <PRE>
|
| public int <B>getNextDescendant</B>(int subtreeRootHandle, |
| int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, advance to its next descendant. |
| If not yet resolved, waits for more nodes to be added to the document and |
| tries again.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>subtreeRootHandle</CODE> - <DD><CODE>nodeHandle</CODE> - int Handle of the node.<DT><B>Returns:</B><DD>handle of next descendant, |
| or DTM.NULL to indicate none exists.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getNextFollowing(int, int)"><!-- --></A><H3>
|
| getNextFollowing</H3>
|
| <PRE>
|
| public int <B>getNextFollowing</B>(int axisContextHandle, |
| int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, advance to the next node on the following axis.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>axisContextHandle</CODE> - the start of the axis that is being traversed.<DD><CODE>nodeHandle</CODE> - <DT><B>Returns:</B><DD>handle of next sibling, |
| or DTM.NULL to indicate none exists.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getNextPreceding(int, int)"><!-- --></A><H3>
|
| getNextPreceding</H3>
|
| <PRE>
|
| public int <B>getNextPreceding</B>(int axisContextHandle, |
| int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, advance to the next node on the preceding axis.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>axisContextHandle</CODE> - the start of the axis that is being traversed.<DD><CODE>nodeHandle</CODE> - the id of the node.<DT><B>Returns:</B><DD>int Node-number of preceding sibling, |
| or DTM.NULL to indicate none exists.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getParent(int)"><!-- --></A><H3>
|
| getParent</H3>
|
| <PRE>
|
| public int <B>getParent</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, find its parent node.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getParent(int)">getParent</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the id of the node.<DT><B>Returns:</B><DD>int Node-number of parent, |
| or DTM.NULL to indicate none exists.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDocumentRoot()"><!-- --></A><H3>
|
| getDocumentRoot</H3>
|
| <PRE>
|
| public int <B>getDocumentRoot</B>()</PRE>
|
| <DL>
|
| <DD>Returns the root element of the document.<DD><DL>
|
| <DT><B>Returns:</B><DD>nodeHandle to the Document Root.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDocument()"><!-- --></A><H3>
|
| getDocument</H3>
|
| <PRE>
|
| public int <B>getDocument</B>()</PRE>
|
| <DL>
|
| <DD>Given a node handle, find the owning document node.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDocument()">getDocument</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Returns:</B><DD>int Node handle of document, which should always be valid.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getOwnerDocument(int)"><!-- --></A><H3>
|
| getOwnerDocument</H3>
|
| <PRE>
|
| public int <B>getOwnerDocument</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, find the owning document node. This has the exact |
| same semantics as the DOM Document method of the same name, in that if |
| the nodeHandle is a document node, it will return NULL. |
| |
| <p>%REVIEW% Since this is DOM-specific, it may belong at the DOM |
| binding layer. Included here as a convenience function and to |
| aid porting of DOM code to DTM.</p><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getOwnerDocument(int)">getOwnerDocument</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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 NULL if the nodeHandle is |
| a document.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDocumentRoot(int)"><!-- --></A><H3>
|
| getDocumentRoot</H3>
|
| <PRE>
|
| public int <B>getDocumentRoot</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, find the owning document node. This has the DTM |
| semantics; a Document node is its own owner. |
| |
| <p>%REVIEW% Since this is DOM-specific, it may belong at the DOM |
| binding layer. Included here as a convenience function and to |
| aid porting of DOM code to DTM.</p><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDocumentRoot(int)">getDocumentRoot</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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 NULL if the nodeHandle is |
| a document.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getStringValue(int)"><!-- --></A><H3>
|
| getStringValue</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/apache/xml/utils/XMLString.html">XMLString</A> <B>getStringValue</B>(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).<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getStringValue(int)">getStringValue</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public int <B>getStringValueChunkCount</B>(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. |
| |
| EXPLANATION: This method is an artifact of the fact that the |
| underlying m_chars object may not store characters in a |
| single contiguous array -- for example,the current |
| FastStringBuffer may split a single node's text across |
| multiple allocation units. This call tells us how many |
| separate accesses will be required to retrieve the entire |
| content. PLEASE NOTE that this may not be the same as the |
| number of SAX characters() events that caused the text node |
| to be built in the first place, since m_chars buffering may |
| be on different boundaries than the parser's buffers.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getStringValueChunkCount(int)">getStringValueChunkCount</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public char[] <B>getStringValueChunk</B>(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. |
| |
| EXPLANATION: This method is an artifact of the fact that |
| the underlying m_chars object may not store characters in a |
| single contiguous array -- for example,the current |
| FastStringBuffer may split a single node's text across |
| multiple allocation units. This call retrieves a single |
| contiguous portion of the text -- as much as m-chars was |
| able to store in a single allocation unit. PLEASE NOTE |
| that this may not be the same granularityas the SAX |
| characters() events that caused the text node to be built |
| in the first place, since m_chars buffering may be on |
| different boundaries than the parser's buffers.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getStringValueChunk(int, int, int[])">getStringValueChunk</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node ID.<DD><CODE>chunkIndex</CODE> - Which chunk to get.<DD><CODE>startAndLen</CODE> - An array of 2 where the start position and length of |
| the chunk will be returned.<DT><B>Returns:</B><DD>The character array reference where the chunk occurs.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getExpandedTypeID(int)"><!-- --></A><H3>
|
| getExpandedTypeID</H3>
|
| <PRE>
|
| public int <B>getExpandedTypeID</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, return an ID that represents the node's expanded name.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getExpandedTypeID(int)">getExpandedTypeID</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public int <B>getExpandedTypeID</B>(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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getExpandedTypeID(java.lang.String, java.lang.String, int)">getExpandedTypeID</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getLocalNameFromExpandedNameID</B>(int ExpandedNameID)</PRE>
|
| <DL>
|
| <DD>Given an expanded-name ID, return the local name part.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getLocalNameFromExpandedNameID(int)">getLocalNameFromExpandedNameID</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getNamespaceFromExpandedNameID</B>(int ExpandedNameID)</PRE>
|
| <DL>
|
| <DD>Given an expanded-name ID, return the namespace URI part.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getNamespaceFromExpandedNameID(int)">getNamespaceFromExpandedNameID</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getNodeName</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, return its DOM-style node name. This will |
| include names such as #text or #document.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getNodeName(int)">getNodeName</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getNodeNameX</B>(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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getNodeNameX(int)">getNodeNameX</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getLocalName</B>(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 any |
| colon character) |
| |
| %REVIEW% What's the local name of something other than Element/Attr? |
| Should this be DOM-style (undefined unless namespaced), or other?<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getLocalName(int)">getLocalName</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getPrefix</B>(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. |
| |
| <p> %REVIEW% Are you sure you want "" for no prefix? </p> |
| |
| %REVIEW% Should this be DOM-style (undefined unless namespaced), |
| or other?<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getPrefix(int)">getPrefix</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getNamespaceURI</B>(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.)<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getNamespaceURI(int)">getNamespaceURI</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getNodeValue</B>(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><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getNodeValue(int)">getNodeValue</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public short <B>getNodeType</B>(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?<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getNodeType(int)">getNodeType</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public short <B>getLevel</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Get the depth level of this node in the tree (equals 1 for |
| a parentless node).<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getLevel(int)">getLevel</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node id.<DT><B>Returns:</B><DD>the number of ancestors, plus one<DT><B>Usage:</B><DD><i><font size="-1" color="#FF0000"> **For internal use only**</font></i></DD> |
| </DD>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isSupported(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| isSupported</H3>
|
| <PRE>
|
| public boolean <B>isSupported</B>(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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#isSupported(java.lang.String, java.lang.String)">isSupported</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getDocumentBaseURI</B>()</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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDocumentBaseURI()">getDocumentBaseURI</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public void <B>setDocumentBaseURI</B>(java.lang.String baseURI)</PRE>
|
| <DL>
|
| <DD>Set the base URI of the document entity.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#setDocumentBaseURI(java.lang.String)">setDocumentBaseURI</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getDocumentSystemIdentifier</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Return the system identifier of the document entity. If |
| it is not known, the value of this property is unknown.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDocumentSystemIdentifier(int)">getDocumentSystemIdentifier</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getDocumentEncoding</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Return the name of the character encoding scheme |
| in which the document entity is expressed.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDocumentEncoding(int)">getDocumentEncoding</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getDocumentStandalone</B>(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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDocumentStandalone(int)">getDocumentStandalone</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getDocumentVersion</B>(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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDocumentVersion(int)">getDocumentVersion</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public boolean <B>getDocumentAllDeclarationsProcessed</B>()</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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDocumentAllDeclarationsProcessed()">getDocumentAllDeclarationsProcessed</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getDocumentTypeDeclarationSystemIdentifier</B>()</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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDocumentTypeDeclarationSystemIdentifier()">getDocumentTypeDeclarationSystemIdentifier</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getDocumentTypeDeclarationPublicIdentifier</B>()</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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getDocumentTypeDeclarationPublicIdentifier()">getDocumentTypeDeclarationPublicIdentifier</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public int <B>getElementById</B>(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><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getElementById(java.lang.String)">getElementById</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public java.lang.String <B>getUnparsedEntityURI</B>(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. |
| TODO: 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.) |
| TODO: 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.)<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getUnparsedEntityURI(java.lang.String)">getUnparsedEntityURI</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public boolean <B>supportsPreStripping</B>()</PRE>
|
| <DL>
|
| <DD>Return true if the xsl:strip-space or xsl:preserve-space was processed |
| during construction of the DTM document. |
| |
| <p>%REVEIW% Presumes a 1:1 mapping from DTM to Document, since |
| we aren't saying which Document to query...?</p><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#supportsPreStripping()">supportsPreStripping</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isNodeAfter(int, int)"><!-- --></A><H3>
|
| isNodeAfter</H3>
|
| <PRE>
|
| public boolean <B>isNodeAfter</B>(int nodeHandle1, |
| int nodeHandle2)</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. |
| |
| TODO: Make sure this does the right thing with attribute nodes!!!<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#isNodeAfter(int, int)">isNodeAfter</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>nodeHandle1</CODE> - DOM Node to perform position comparison on.<DD><CODE>nodeHandle2</CODE> - DOM Node to perform position comparison on .<DT><B>Returns:</B><DD>false if node2 comes before node1, otherwise return true. |
| You can think of this as |
| <code>(node1.documentOrderPosition <= node2.documentOrderPosition)</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isCharacterElementContentWhitespace(int)"><!-- --></A><H3>
|
| isCharacterElementContentWhitespace</H3>
|
| <PRE>
|
| public boolean <B>isCharacterElementContentWhitespace</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>2. [element content whitespace] A boolean indicating whether the |
| character is 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. If there is no |
| declaration for the containing element, this property has no value for |
| white space characters. 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 unknown for white space characters. It is always false for |
| characters that are not white space.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#isCharacterElementContentWhitespace(int)">isCharacterElementContentWhitespace</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the node ID.<DT><B>Returns:</B><DD><code>true</code> if the character data is whitespace; |
| <code>false</code> otherwise.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isDocumentAllDeclarationsProcessed(int)"><!-- --></A><H3>
|
| isDocumentAllDeclarationsProcessed</H3>
|
| <PRE>
|
| public boolean <B>isDocumentAllDeclarationsProcessed</B>(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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#isDocumentAllDeclarationsProcessed(int)">isDocumentAllDeclarationsProcessed</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public boolean <B>isAttributeSpecified</B>(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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#isAttributeSpecified(int)">isAttributeSpecified</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="dispatchCharactersEvents(int, org.xml.sax.ContentHandler, boolean)"><!-- --></A><H3>
|
| dispatchCharactersEvents</H3>
|
| <PRE>
|
| public void <B>dispatchCharactersEvents</B>(int nodeHandle, |
| <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> ch, |
| boolean normalize) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#dispatchCharactersEvents(int, org.xml.sax.ContentHandler, boolean)">dispatchCharactersEvents</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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><A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="dispatchToEvents(int, org.xml.sax.ContentHandler)"><!-- --></A><H3>
|
| dispatchToEvents</H3>
|
| <PRE>
|
| public void <B>dispatchToEvents</B>(int nodeHandle, |
| <A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> ch) |
| throws <A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Directly create SAX parser events from a subtree.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#dispatchToEvents(int, org.xml.sax.ContentHandler)">dispatchToEvents</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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><A HREF="../../../../../org/xml/sax/SAXException.html">SAXException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getNode(int)"><!-- --></A><H3>
|
| getNode</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/w3c/dom/Node.html">Node</A> <B>getNode</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Return an DOM node for the given node.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getNode(int)">getNode</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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="appendChild(int, boolean, boolean)"><!-- --></A><H3>
|
| appendChild</H3>
|
| <PRE>
|
| public void <B>appendChild</B>(int newChild, |
| boolean clone, |
| boolean cloneDepth)</PRE>
|
| <DL>
|
| <DD>Append a child to the end of the child list of the current node. Please note that the node |
| is always cloned if it is owned by another document. |
| |
| <p>%REVIEW% "End of the document" needs to be defined more clearly. |
| Does it become the last child of the Document? Of the root element?</p><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#appendChild(int, boolean, boolean)">appendChild</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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>
|
| public void <B>appendTextChild</B>(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. |
| |
| <p>%REVIEW% "End of the document" needs to be defined more clearly. |
| Does it become the last child of the Document? Of the root element?</p><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#appendTextChild(java.lang.String)">appendTextChild</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>str</CODE> - Non-null reference to a string.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getAxisTraverser(int)"><!-- --></A><H3>
|
| getAxisTraverser</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html">DTMAxisTraverser</A> <B>getAxisTraverser</B>(int axis)</PRE>
|
| <DL>
|
| <DD>This returns a stateless "traverser", that can navigate over an |
| XPath axis, though not in document order.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getAxisTraverser(int)">getAxisTraverser</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>axis</CODE> - One of Axes.ANCESTORORSELF, etc.<DT><B>Returns:</B><DD>A DTMAxisIterator, or null if the given axis isn't supported.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getAxisIterator(int)"><!-- --></A><H3>
|
| getAxisIterator</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html">DTMAxisIterator</A> <B>getAxisIterator</B>(int axis)</PRE>
|
| <DL>
|
| <DD>This is a shortcut to the iterators that implement the |
| supported XPath axes (only namespace::) is not supported. |
| Returns a bare-bones iterator that must be initialized |
| with a start node (using iterator.setStartNode()).<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getAxisIterator(int)">getAxisIterator</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>axis</CODE> - One of Axes.ANCESTORORSELF, etc.<DT><B>Returns:</B><DD>A DTMAxisIterator, or null if the given axis isn't supported.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getTypedAxisIterator(int, int)"><!-- --></A><H3>
|
| getTypedAxisIterator</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html">DTMAxisIterator</A> <B>getTypedAxisIterator</B>(int axis, |
| int type)</PRE>
|
| <DL>
|
| <DD>Get an iterator that can navigate over an XPath Axis, predicated by |
| the extended type ID.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getTypedAxisIterator(int, int)">getTypedAxisIterator</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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 given axis isn't supported.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3>
|
| setProperty</H3>
|
| <PRE>
|
| public void <B>setProperty</B>(java.lang.String property, |
| java.lang.Object value)</PRE>
|
| <DL>
|
| <DD>For the moment all the run time properties are ignored by this |
| class.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#setProperty(java.lang.String, java.lang.Object)">setProperty</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><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="getSourceLocatorFor(int)"><!-- --></A><H3>
|
| getSourceLocatorFor</H3>
|
| <PRE>
|
| public <A HREF="../../../../../javax/xml/transform/SourceLocator.html">SourceLocator</A> <B>getSourceLocatorFor</B>(int node)</PRE>
|
| <DL>
|
| <DD>Source information is not handled yet, so return |
| <code>null</code> here.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#getSourceLocatorFor(int)">getSourceLocatorFor</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>node</CODE> - an <code>int</code> value<DT><B>Returns:</B><DD>null</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="documentRegistration()"><!-- --></A><H3>
|
| documentRegistration</H3>
|
| <PRE>
|
| public void <B>documentRegistration</B>()</PRE>
|
| <DL>
|
| <DD>A dummy routine to satisify the abstract interface. If the DTM |
| implememtation that extends the default base requires notification |
| of registration, they can override this method.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#documentRegistration()">documentRegistration</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="documentRelease()"><!-- --></A><H3>
|
| documentRelease</H3>
|
| <PRE>
|
| public void <B>documentRelease</B>()</PRE>
|
| <DL>
|
| <DD>A dummy routine to satisify the abstract interface. If the DTM |
| implememtation that extends the default base requires notification |
| when the document is being released, they can override this method<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#documentRelease()">documentRelease</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="migrateTo(org.apache.xml.dtm.DTMManager)"><!-- --></A><H3>
|
| migrateTo</H3>
|
| <PRE>
|
| public void <B>migrateTo</B>(<A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../../org/apache/xml/dtm/DTM.html#migrateTo(org.apache.xml.dtm.DTMManager)">migrateTo</A> in interface <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A><DT><B>Parameters:</B><DD><CODE>manager</CODE> - the DTMManager</DL>
|
| </DD>
|
| </DL>
|
| <!-- ========= END OF CLASS DATA ========= -->
|
| <HR>
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <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/DTMDocumentImpl.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/ref/DTMDefaultBaseTraversers.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../../org/apache/xml/dtm/ref/DTMManagerDefault.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="DTMDocumentImpl.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| Copyright © 2006 Apache XML Project. All Rights Reserved.
|
| </BODY>
|
| </HTML>
|
