blob: 7b9fc7412e7c1694f66bc3d4b3d6dc347a689509 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_18) on Sun Apr 01 21:18:48 PDT 2012 -->
<TITLE>
org.apache.xml.dtm.ref
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xml.dtm.ref package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="org.apache.xml.dtm.ref";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/dom2dtm/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/xml/dtm/ref/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package org.apache.xml.dtm.ref
</H2>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineParser.html" title="interface in org.apache.xml.dtm.ref">CoroutineParser</A></B></TD>
<TD><B>Deprecated.</B>&nbsp;<I>Since the ability to start a parse via the
coroutine protocol was not being used and was complicating design.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref">IncrementalSAXSource</A></B></TD>
<TD>IncrementalSAXSource is an API that delivers a small number of
SAX events each time a request is made from a "controller"
coroutine.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/ChunkedIntArray.html" title="class in org.apache.xml.dtm.ref">ChunkedIntArray</A></B></TD>
<TD><code>ChunkedIntArray</code> is an extensible array of blocks of integers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/ChunkedIntArray.ChunksVector.html" title="class in org.apache.xml.dtm.ref">ChunkedIntArray.ChunksVector</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html" title="class in org.apache.xml.dtm.ref">CoroutineManager</A></B></TD>
<TD>Support the coroutine design pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/CustomStringPool.html" title="class in org.apache.xml.dtm.ref">CustomStringPool</A></B></TD>
<TD>CustomStringPool is an example of appliction provided data structure
for a DTM implementation to hold symbol references, e.g.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html" title="class in org.apache.xml.dtm.ref">DTMAxisIteratorBase</A></B></TD>
<TD>This class serves as a default base for implementations of mutable
DTMAxisIterators.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIterNodeList.html" title="class in org.apache.xml.dtm.ref">DTMAxisIterNodeList</A></B></TD>
<TD><code>DTMAxisNodeList</code> gives us an implementation of the DOM's
NodeList interface wrapped around a DTM Iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMChildIterNodeList.html" title="class in org.apache.xml.dtm.ref">DTMChildIterNodeList</A></B></TD>
<TD><code>DTMNodeList</code> gives us an implementation of the DOM's
NodeList interface wrapped around a DTM Iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBase.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBase</A></B></TD>
<TD>The <code>DTMDefaultBase</code> class serves as a helper base for DTMs.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseIterators.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseIterators</A></B></TD>
<TD>This class implements the traversers for DTMDefaultBase.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers</A></B></TD>
<TD>This class implements the traversers for DTMDefaultBase.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDocumentImpl.html" title="class in org.apache.xml.dtm.ref">DTMDocumentImpl</A></B></TD>
<TD>This is the implementation of the DTM document interface.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMManagerDefault.html" title="class in org.apache.xml.dtm.ref">DTMManagerDefault</A></B></TD>
<TD>The default implementation for the DTMManager.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMNamedNodeMap.html" title="class in org.apache.xml.dtm.ref">DTMNamedNodeMap</A></B></TD>
<TD>DTMNamedNodeMap is a quickie (as opposed to quick) implementation of the DOM's
NamedNodeMap interface, intended to support DTMProxy's getAttributes()
call.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMNodeIterator.html" title="class in org.apache.xml.dtm.ref">DTMNodeIterator</A></B></TD>
<TD><code>DTMNodeIterator</code> gives us an implementation of the
DTMNodeIterator which returns DOM nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMNodeList.html" title="class in org.apache.xml.dtm.ref">DTMNodeList</A></B></TD>
<TD><code>DTMNodeList</code> gives us an implementation of the DOM's
NodeList interface wrapped around a DTM Iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMNodeListBase.html" title="class in org.apache.xml.dtm.ref">DTMNodeListBase</A></B></TD>
<TD><code>DTMNodeList</code> gives us an implementation of the DOM's
NodeList interface wrapped around a DTM Iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMNodeProxy.html" title="class in org.apache.xml.dtm.ref">DTMNodeProxy</A></B></TD>
<TD><code>DTMNodeProxy</code> presents a DOM Node API front-end to the DTM model.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMNodeProxy.DTMNodeProxyImplementation.html" title="class in org.apache.xml.dtm.ref">DTMNodeProxy.DTMNodeProxyImplementation</A></B></TD>
<TD>Inner class to support getDOMImplementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMSafeStringPool.html" title="class in org.apache.xml.dtm.ref">DTMSafeStringPool</A></B></TD>
<TD>Like DTMStringPool, but threadsafe.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMStringPool.html" title="class in org.apache.xml.dtm.ref">DTMStringPool</A></B></TD>
<TD>DTMStringPool is an "interning" mechanism for strings.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMTreeWalker.html" title="class in org.apache.xml.dtm.ref">DTMTreeWalker</A></B></TD>
<TD>This class does a pre-order walk of the DTM tree, calling a ContentHandler
interface as it goes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/EmptyIterator.html" title="class in org.apache.xml.dtm.ref">EmptyIterator</A></B></TD>
<TD>DTM Empty Axis Iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/ExpandedNameTable.html" title="class in org.apache.xml.dtm.ref">ExpandedNameTable</A></B></TD>
<TD>This is a default implementation of a table that manages mappings from
expanded names to expandedNameIDs.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/ExpandedNameTable.HashEntry.html" title="class in org.apache.xml.dtm.ref">ExpandedNameTable.HashEntry</A></B></TD>
<TD>Inner class which represents a hash table entry.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/ExtendedType.html" title="class in org.apache.xml.dtm.ref">ExtendedType</A></B></TD>
<TD>The class ExtendedType represents an extended type object used by
ExpandedNameTable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html" title="class in org.apache.xml.dtm.ref">IncrementalSAXSource_Filter</A></B></TD>
<TD>IncrementalSAXSource_Filter implements IncrementalSAXSource, using a
standard SAX2 event source as its input and parcelling out those
events gradually in reponse to deliverMoreNodes() requests.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Xerces.html" title="class in org.apache.xml.dtm.ref">IncrementalSAXSource_Xerces</A></B></TD>
<TD>IncrementalSAXSource_Xerces takes advantage of the fact that Xerces1
incremental mode is already a coroutine of sorts, and just wraps our
IncrementalSAXSource API around it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/NodeLocator.html" title="class in org.apache.xml.dtm.ref">NodeLocator</A></B></TD>
<TD><code>NodeLocator</code> maintains information on an XML source
node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/ObjectFactory.html" title="class in org.apache.xml.dtm.ref">ObjectFactory</A></B></TD>
<TD>This class is duplicated for each JAXP subpackage so keep it in sync.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/SecuritySupport.html" title="class in org.apache.xml.dtm.ref">SecuritySupport</A></B></TD>
<TD>This class is duplicated for each Xalan-Java subpackage so keep it in sync.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Exception Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMNamedNodeMap.DTMException.html" title="class in org.apache.xml.dtm.ref">DTMNamedNodeMap.DTMException</A></B></TD>
<TD>Simple implementation of DOMException.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.StopException.html" title="class in org.apache.xml.dtm.ref">IncrementalSAXSource_Filter.StopException</A></B></TD>
<TD>Used to quickly terminate parse when running under a
startParse() thread.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Error Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/xml/dtm/ref/ObjectFactory.ConfigurationError.html" title="class in org.apache.xml.dtm.ref">ObjectFactory.ConfigurationError</A></B></TD>
<TD>A configuration error.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/dom2dtm/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/xml/dtm/ref/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>