| <!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 DTMDefaultBase
|
| </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/DTMDefaultBase.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/DTMChildIterNodeList.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseIterators.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="DTMDefaultBase.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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 DTMDefaultBase</H2>
|
| <PRE>
|
| java.lang.Object
|
| |
|
| +--<B>org.apache.xml.dtm.ref.DTMDefaultBase</B>
|
| </PRE>
|
| <DL>
|
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.html">DTMDefaultBaseTraversers</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public abstract class <B>DTMDefaultBase</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/xml/dtm/DTM.html">DTM</A></DL>
|
|
|
| <P>
|
| The <code>DTMDefaultBase</code> class serves as a helper base for DTMs. |
| It sets up structures for navigation and type, while leaving data |
| management and construction to the derived classes.
|
| <P>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Field Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#DEFAULT_BLOCKSIZE">DEFAULT_BLOCKSIZE</A></B></CODE>
|
|
|
| <BR>
|
| The default block size of the node arrays</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#DEFAULT_NUMBLOCKS">DEFAULT_NUMBLOCKS</A></B></CODE>
|
|
|
| <BR>
|
| The number of blocks for the node arrays</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#DEFAULT_NUMBLOCKS_SMALL">DEFAULT_NUMBLOCKS_SMALL</A></B></CODE>
|
|
|
| <BR>
|
| The number of blocks used for small documents & RTFs</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#m_mgr">m_mgr</A></B></CODE>
|
|
|
| <BR>
|
| The DTM manager who "owns" this DTM.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#ROOTNODE">ROOTNODE</A></B></CODE>
|
|
|
| <BR>
|
| The identity of the root node.</TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <!-- ======== 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/DTMDefaultBase.html#DTMDefaultBase(org.apache.xml.dtm.DTMManager, javax.xml.transform.Source, int, org.apache.xml.dtm.DTMWSFilter, org.apache.xml.utils.XMLStringFactory, boolean)">DTMDefaultBase</A></B>(<A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> mgr, |
| <A HREF="../../../../../javax/xml/transform/Source.html">Source</A> source, |
| int dtmIdentity, |
| <A HREF="../../../../../org/apache/xml/dtm/DTMWSFilter.html">DTMWSFilter</A> whiteSpaceFilter, |
| <A HREF="../../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A> xstringfactory, |
| boolean doIndexing)</CODE>
|
|
|
| <BR>
|
| Construct a DTMDefaultBase object using the default block size.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#DTMDefaultBase(org.apache.xml.dtm.DTMManager, javax.xml.transform.Source, int, org.apache.xml.dtm.DTMWSFilter, org.apache.xml.utils.XMLStringFactory, boolean, int, boolean, boolean)">DTMDefaultBase</A></B>(<A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> mgr, |
| <A HREF="../../../../../javax/xml/transform/Source.html">Source</A> source, |
| int dtmIdentity, |
| <A HREF="../../../../../org/apache/xml/dtm/DTMWSFilter.html">DTMWSFilter</A> whiteSpaceFilter, |
| <A HREF="../../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A> xstringfactory, |
| boolean doIndexing, |
| int blocksize, |
| boolean usePrevsib, |
| boolean newNameTable)</CODE>
|
|
|
| <BR>
|
| Construct a DTMDefaultBase object from a DOM node.</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/DTMDefaultBase.html#appendChild(int, boolean, boolean)">appendChild</A></B>(int newChild, |
| boolean clone, |
| boolean cloneDepth)</CODE>
|
|
|
| <BR>
|
| Append a child to the end of the document.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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>abstract void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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>abstract void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.html#dumpDTM(java.io.OutputStream)">dumpDTM</A></B>(java.io.OutputStream os)</CODE>
|
|
|
| <BR>
|
| Diagnostics function to dump the DTM.</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/DTMDefaultBase.html#dumpNode(int)">dumpNode</A></B>(int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Diagnostics function to dump a single node.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#getDocument()">getDocument</A></B>()</CODE>
|
|
|
| <BR>
|
| Find the Document node handle for the document currently under construction.</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/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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>abstract java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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>abstract java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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/DTMDefaultBase.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/apache/xml/utils/SuballocatedIntVector.html">SuballocatedIntVector</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#getDTMIDs()">getDTMIDs</A></B>()</CODE>
|
|
|
| <BR>
|
| Query which DTMIDs this DTM is currently using within the DTMManager.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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>abstract java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#getLocalName(int)">getLocalName</A></B>(int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Given a node handle, return its XPath-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/DTMDefaultBase.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/DTMManager.html">DTMManager</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#getManager()">getManager</A></B>()</CODE>
|
|
|
| <BR>
|
| Query which DTMManager this DTM is currently being handled by.</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/DTMDefaultBase.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> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#getNamespaceType(int)">getNamespaceType</A></B>(int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Returns the namespace type of a specific node</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.html#getNextNamespaceNode(int, int, boolean)">getNextNamespaceNode</A></B>(int baseHandle, |
| int nodeHandle, |
| 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/DTMDefaultBase.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/DTMDefaultBase.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> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#getNodeHandle(int)">getNodeHandle</A></B>(int nodeId)</CODE>
|
|
|
| <BR>
|
| Get the handle of this node in the tree</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/DTMDefaultBase.html#getNodeIdent(int)">getNodeIdent</A></B>(int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Get the identity of this node in the tree</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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>abstract java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#getNodeValue(int)">getNodeValue</A></B>(int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Given a node handle, return its node value.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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/DTMDefaultBase.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>abstract java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#getPrefix(int)">getPrefix</A></B>(int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Given a namespace handle, return the prefix that the namespace decl is |
| mapping.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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>abstract <A HREF="../../../../../org/apache/xml/utils/XMLString.html">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#getTypedFirstChild(int, int)">getTypedFirstChild</A></B>(int nodeHandle, |
| int nodeType)</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/DTMDefaultBase.html#getTypedNextSibling(int, int)">getTypedNextSibling</A></B>(int nodeHandle, |
| int nodeType)</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>abstract java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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/DTMDefaultBase.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>abstract boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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/DTMDefaultBase.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> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html#makeNodeHandle(int)">makeNodeHandle</A></B>(int nodeIdentity)</CODE>
|
|
|
| <BR>
|
| Given a node identity, return a node handle.</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/DTMDefaultBase.html#makeNodeIdentity(int)">makeNodeIdentity</A></B>(int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Given a node handle, return a node identity.</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/DTMDefaultBase.html#migrateTo(org.apache.xml.dtm.DTMManager)">migrateTo</A></B>(<A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> mgr)</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> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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/DTMDefaultBase.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> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.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 =========== -->
|
|
|
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Field Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="ROOTNODE"><!-- --></A><H3>
|
| ROOTNODE</H3>
|
| <PRE>
|
| public static final int <B>ROOTNODE</B></PRE>
|
| <DL>
|
| <DD>The identity of the root node.</DL>
|
| <HR>
|
|
|
| <A NAME="DEFAULT_BLOCKSIZE"><!-- --></A><H3>
|
| DEFAULT_BLOCKSIZE</H3>
|
| <PRE>
|
| public static final int <B>DEFAULT_BLOCKSIZE</B></PRE>
|
| <DL>
|
| <DD>The default block size of the node arrays</DL>
|
| <HR>
|
|
|
| <A NAME="DEFAULT_NUMBLOCKS"><!-- --></A><H3>
|
| DEFAULT_NUMBLOCKS</H3>
|
| <PRE>
|
| public static final int <B>DEFAULT_NUMBLOCKS</B></PRE>
|
| <DL>
|
| <DD>The number of blocks for the node arrays</DL>
|
| <HR>
|
|
|
| <A NAME="DEFAULT_NUMBLOCKS_SMALL"><!-- --></A><H3>
|
| DEFAULT_NUMBLOCKS_SMALL</H3>
|
| <PRE>
|
| public static final int <B>DEFAULT_NUMBLOCKS_SMALL</B></PRE>
|
| <DL>
|
| <DD>The number of blocks used for small documents & RTFs</DL>
|
| <HR>
|
|
|
| <A NAME="m_mgr"><!-- --></A><H3>
|
| m_mgr</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> <B>m_mgr</B></PRE>
|
| <DL>
|
| <DD>The DTM manager who "owns" this DTM.</DL>
|
|
|
| <!-- ========= 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="DTMDefaultBase(org.apache.xml.dtm.DTMManager, javax.xml.transform.Source, int, org.apache.xml.dtm.DTMWSFilter, org.apache.xml.utils.XMLStringFactory, boolean)"><!-- --></A><H3>
|
| DTMDefaultBase</H3>
|
| <PRE>
|
| public <B>DTMDefaultBase</B>(<A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> mgr, |
| <A HREF="../../../../../javax/xml/transform/Source.html">Source</A> source, |
| int dtmIdentity, |
| <A HREF="../../../../../org/apache/xml/dtm/DTMWSFilter.html">DTMWSFilter</A> whiteSpaceFilter, |
| <A HREF="../../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A> xstringfactory, |
| boolean doIndexing)</PRE>
|
| <DL>
|
| <DD>Construct a DTMDefaultBase object using the default block size.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>mgr</CODE> - The DTMManager who owns this DTM.<DD><CODE>source</CODE> - The object that is used to specify the construction source.<DD><CODE>dtmIdentity</CODE> - The DTM identity ID for this DTM.<DD><CODE>whiteSpaceFilter</CODE> - The white space filter for this DTM, which may |
| be null.<DD><CODE>xstringfactory</CODE> - The factory to use for creating XMLStrings.<DD><CODE>doIndexing</CODE> - true if the caller considers it worth it to use |
| indexing schemes.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="DTMDefaultBase(org.apache.xml.dtm.DTMManager, javax.xml.transform.Source, int, org.apache.xml.dtm.DTMWSFilter, org.apache.xml.utils.XMLStringFactory, boolean, int, boolean, boolean)"><!-- --></A><H3>
|
| DTMDefaultBase</H3>
|
| <PRE>
|
| public <B>DTMDefaultBase</B>(<A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> mgr, |
| <A HREF="../../../../../javax/xml/transform/Source.html">Source</A> source, |
| int dtmIdentity, |
| <A HREF="../../../../../org/apache/xml/dtm/DTMWSFilter.html">DTMWSFilter</A> whiteSpaceFilter, |
| <A HREF="../../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A> xstringfactory, |
| boolean doIndexing, |
| int blocksize, |
| boolean usePrevsib, |
| boolean newNameTable)</PRE>
|
| <DL>
|
| <DD>Construct a DTMDefaultBase object from a DOM node.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>mgr</CODE> - The DTMManager who owns this DTM.<DD><CODE>source</CODE> - The object that is used to specify the construction source.<DD><CODE>dtmIdentity</CODE> - The DTM identity ID for this DTM.<DD><CODE>whiteSpaceFilter</CODE> - The white space filter for this DTM, which may |
| be null.<DD><CODE>xstringfactory</CODE> - The factory to use for creating XMLStrings.<DD><CODE>doIndexing</CODE> - true if the caller considers it worth it to use |
| indexing schemes.<DD><CODE>blocksize</CODE> - The block size of the DTM.<DD><CODE>usePrevsib</CODE> - true if we want to build the previous sibling node array.<DD><CODE>newNameTable</CODE> - true if we want to use a new ExpandedNameTable for this DTM.</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="dumpDTM(java.io.OutputStream)"><!-- --></A><H3>
|
| dumpDTM</H3>
|
| <PRE>
|
| public void <B>dumpDTM</B>(java.io.OutputStream os)</PRE>
|
| <DL>
|
| <DD>Diagnostics function to dump the DTM.<DD><DL>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="dumpNode(int)"><!-- --></A><H3>
|
| dumpNode</H3>
|
| <PRE>
|
| public java.lang.String <B>dumpNode</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Diagnostics function to dump a single node. |
| |
| %REVIEW% KNOWN GLITCH: If you pass it a node index rather than a |
| node handle, it works just fine... but the displayed identity |
| number before the colon is different, which complicates comparing |
| it with nodes printed the other way. We could always OR the DTM ID |
| into the value, to suppress that distinction... |
| |
| %REVIEW% This might want to be moved up to DTMDefaultBase, or possibly |
| DTM itself, since it's a useful diagnostic and uses only DTM's public |
| APIs.<DD><DL>
|
| </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="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="makeNodeHandle(int)"><!-- --></A><H3>
|
| makeNodeHandle</H3>
|
| <PRE>
|
| public final int <B>makeNodeHandle</B>(int nodeIdentity)</PRE>
|
| <DL>
|
| <DD>Given a node identity, return a node handle. If extended addressing |
| has been used (multiple DTM IDs), we need to map the high bits of the |
| identity into the proper DTM ID. |
| |
| This has been made FINAL to facilitate inlining, since we do not expect |
| any subclass of DTMDefaultBase to ever change the algorithm. (I don't |
| really like doing so, and would love to have an excuse not to...) |
| |
| %REVIEW% Is it worth trying to specialcase small documents? |
| %REVIEW% Should this be exposed at the package/public layers?<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>nodeIdentity</CODE> - Internal offset to this node's records.<DT><B>Returns:</B><DD>NodeHandle (external representation of node)</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="makeNodeIdentity(int)"><!-- --></A><H3>
|
| makeNodeIdentity</H3>
|
| <PRE>
|
| public final int <B>makeNodeIdentity</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, return a node identity. If extended addressing |
| has been used (multiple DTM IDs), we need to map the high bits of the |
| identity into the proper DTM ID and thence find the proper offset |
| to add to the low bits of the identity |
| |
| This has been made FINAL to facilitate inlining, since we do not expect |
| any subclass of DTMDefaultBase to ever change the algorithm. (I don't |
| really like doing so, and would love to have an excuse not to...) |
| |
| %OPT% Performance is critical for this operation. |
| |
| %REVIEW% Should this be exposed at the package/public layers?<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - (external representation of node)<DT><B>Returns:</B><DD>nodeIdentity Internal offset to this node's records.</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="getTypedFirstChild(int, int)"><!-- --></A><H3>
|
| getTypedFirstChild</H3>
|
| <PRE>
|
| public int <B>getTypedFirstChild</B>(int nodeHandle, |
| int nodeType)</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>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 abstract 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 node.<DT><B>Returns:</B><DD>Handle of first attribute, 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. |
| 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#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="getTypedNextSibling(int, int)"><!-- --></A><H3>
|
| getTypedNextSibling</H3>
|
| <PRE>
|
| public int <B>getTypedNextSibling</B>(int nodeHandle, |
| int nodeType)</PRE>
|
| <DL>
|
| <DD>Given a node handle, advance to its next sibling. |
| 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>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 attr, we advance to |
| the next attr on the same node. If not an attribute, we return NULL.<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="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="getNextNamespaceNode(int, int, boolean)"><!-- --></A><H3>
|
| getNextNamespaceNode</H3>
|
| <PRE>
|
| public int <B>getNextNamespaceNode</B>(int baseHandle, |
| int nodeHandle, |
| boolean inScope)</PRE>
|
| <DL>
|
| <DD>Given a namespace handle, advance to the next namespace.<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>baseHandle</CODE> - handle to original node from where the first namespace |
| was relative to (needed to return nodes in document order).<DD><CODE>nodeHandle</CODE> - A namespace handle for which we will find the next node.<DD><CODE>inScope</CODE> - true if all namespaces that are in scope should be processed, |
| otherwise just process the nodes in the given element handle.<DT><B>Returns:</B><DD>handle of next namespace, or DTM.NULL to indicate none exists.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getParent(int)"><!-- --></A><H3>
|
| getParent</H3>
|
| <PRE>
|
| 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="getDocument()"><!-- --></A><H3>
|
| getDocument</H3>
|
| <PRE>
|
| public int <B>getDocument</B>()</PRE>
|
| <DL>
|
| <DD>Find the Document node handle for the document currently under construction. |
| PLEASE NOTE that most people should use getOwnerDocument(nodeHandle) instead; |
| this version of the operation is primarily intended for use during negotiation |
| with the DTM Manager.<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 -1 if the node was a Docment</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. Unlike the DOM, |
| this considers the owningDocument of a Document to be itself.<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 the nodeHandle if it is |
| a Document.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getStringValue(int)"><!-- --></A><H3>
|
| getStringValue</H3>
|
| <PRE>
|
| public abstract <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.<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.<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>Parameters:</B><DD><CODE>type</CODE> - The simple type, i.e. one of ELEMENT, ATTRIBUTE, etc.<DD><CODE>namespace</CODE> - The namespace URI, which may be null, may be an empty |
| string (which will be the same as null), or may be a |
| namespace URI.<DD><CODE>localName</CODE> - The local name string, which must be a valid |
| <a href="http://www.w3.org/TR/REC-xml-names/">NCName</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="getNamespaceType(int)"><!-- --></A><H3>
|
| getNamespaceType</H3>
|
| <PRE>
|
| public int <B>getNamespaceType</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Returns the namespace type of a specific node<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the id of the node.<DT><B>Returns:</B><DD>the ID of the namespace.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getNodeName(int)"><!-- --></A><H3>
|
| getNodeName</H3>
|
| <PRE>
|
| public abstract 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... |
| %REVIEW-COMMENT% It should never be empty, should it?</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, which may be an empty string.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getLocalName(int)"><!-- --></A><H3>
|
| getLocalName</H3>
|
| <PRE>
|
| public abstract java.lang.String <B>getLocalName</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Given a node handle, return its XPath-style localname. |
| (As defined in Namespaces, this is the portion of the name after any |
| colon character).<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 abstract 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> |
| <p> %REVIEW-COMMENT% I think so... not totally sure. -sb </p><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 abstract 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.) |
| |
| <p>%REVIEW% Null or ""? -sb</p><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 abstract 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? |
| %REVIEW% Make assumption that node has already arrived. Is OK?<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="getNodeIdent(int)"><!-- --></A><H3>
|
| getNodeIdent</H3>
|
| <PRE>
|
| public int <B>getNodeIdent</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Get the identity of this node in the tree<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - The node handle.<DT><B>Returns:</B><DD>the node identity<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="getNodeHandle(int)"><!-- --></A><H3>
|
| getNodeHandle</H3>
|
| <PRE>
|
| public int <B>getNodeHandle</B>(int nodeId)</PRE>
|
| <DL>
|
| <DD>Get the handle of this node in the tree<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>nodeId</CODE> - The node identity.<DT><B>Returns:</B><DD>the node handle<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.<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="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 abstract 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 abstract 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 abstract 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 abstract 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.<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><DT><B>Returns:</B><DD>true if this DTM supports prestripping.</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 false.<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> - Node handle to perform position comparison on.<DD><CODE>nodeHandle2</CODE> - Second Node handle to perform position comparison on .<DT><B>Returns:</B><DD>true if node1 comes before node2, otherwise return false. |
| 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 abstract 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 in question.<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 abstract 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.<DD><CODE>normalize</CODE> - true if the content should be normalized according to |
| the rules for the XPath |
| <a href="http://www.w3.org/TR/xpath#function-normalize-space">normalize-space</a> |
| function.<DT><B>Throws:</B><DD><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 abstract 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 document. 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 reverence to a string.</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> mgr)</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>mgr</CODE> - the DTMManager</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getManager()"><!-- --></A><H3>
|
| getManager</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> <B>getManager</B>()</PRE>
|
| <DL>
|
| <DD>Query which DTMManager this DTM is currently being handled by. |
| |
| %REVEW% Should this become part of the base DTM API?<DD><DL>
|
| <DT><B>Returns:</B><DD>a DTMManager, or null if this is a "stand-alone" DTM.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDTMIDs()"><!-- --></A><H3>
|
| getDTMIDs</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/apache/xml/utils/SuballocatedIntVector.html">SuballocatedIntVector</A> <B>getDTMIDs</B>()</PRE>
|
| <DL>
|
| <DD>Query which DTMIDs this DTM is currently using within the DTMManager. |
| |
| %REVEW% Should this become part of the base DTM API?<DD><DL>
|
| <DT><B>Returns:</B><DD>an IntVector, or null if this is a "stand-alone" DTM.</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/DTMDefaultBase.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/DTMChildIterNodeList.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseIterators.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="DTMDefaultBase.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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>
|
