blob: 97592eb689e71a7f23059a259e43b6c5f050b70d [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:32 PDT 2012 -->
<TITLE>
IncrementalSAXSource_Filter
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xml.dtm.ref.IncrementalSAXSource_Filter class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IncrementalSAXSource_Filter";
}
</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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IncrementalSAXSource_Filter.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/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.StopException.html" title="class in org.apache.xml.dtm.ref"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IncrementalSAXSource_Filter.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>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.xml.dtm.ref</FONT>
<BR>
Class IncrementalSAXSource_Filter</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xml.dtm.ref.IncrementalSAXSource_Filter</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Runnable, <A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref">IncrementalSAXSource</A>, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.ErrorHandler, org.xml.sax.ext.LexicalHandler</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.67"><B>IncrementalSAXSource_Filter</B></A><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref">IncrementalSAXSource</A>, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.ext.LexicalHandler, org.xml.sax.ErrorHandler, java.lang.Runnable</DL>
</PRE>
<P>
<p>IncrementalSAXSource_Filter implements IncrementalSAXSource, using a
standard SAX2 event source as its input and parcelling out those
events gradually in reponse to deliverMoreNodes() requests. Output from the
filter will be passed along to a SAX handler registered as our
listener, but those callbacks will pass through a counting stage
which periodically yields control back to the controller coroutine.
</p>
<p>%REVIEW%: This filter is not currenly intended to be reusable
for parsing additional streams/documents. We may want to consider
making it resettable at some point in the future. But it's a
small object, so that'd be mostly a convenience issue; the cost
of allocating each time is trivial compared to the cost of processing
any nontrival stream.</p>
<p>For a brief usage example, see the unit-test main() method.</p>
<p>This is a simplification of the old CoroutineSAXParser, focusing
specifically on filtering. The resulting controller protocol is _far_
simpler and less error-prone; the only controller operation is deliverMoreNodes(),
and the only requirement is that deliverMoreNodes(false) be called if you want to
discard the rest of the stream and the previous deliverMoreNodes() didn't return
false.
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;class</CODE></FONT></TD>
<TD><CODE><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></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to quickly terminate parse when running under a
startParse() thread.</TD>
</TR>
</TABLE>
&nbsp;<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;org.xml.sax.ContentHandler</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#clientContentHandler">clientContentHandler</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;org.xml.sax.DTDHandler</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#clientDTDHandler">clientDTDHandler</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;org.xml.sax.ErrorHandler</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#clientErrorHandler">clientErrorHandler</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;org.xml.sax.ext.LexicalHandler</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#clientLexicalHandler">clientLexicalHandler</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#DEBUG">DEBUG</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#eventcounter">eventcounter</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#fControllerCoroutineID">fControllerCoroutineID</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html" title="class in org.apache.xml.dtm.ref">CoroutineManager</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#fCoroutineManager">fCoroutineManager</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#fNoMoreEvents">fNoMoreEvents</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#frequency">frequency</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#fSourceCoroutineID">fSourceCoroutineID</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;org.xml.sax.XMLReader</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#fXMLReader">fXMLReader</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;org.xml.sax.InputSource</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#fXMLReaderInputSource">fXMLReaderInputSource</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#IncrementalSAXSource_Filter()">IncrementalSAXSource_Filter</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#IncrementalSAXSource_Filter(org.apache.xml.dtm.ref.CoroutineManager, int)">IncrementalSAXSource_Filter</A></B>(<A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html" title="class in org.apache.xml.dtm.ref">CoroutineManager</A>&nbsp;co,
int&nbsp;controllerCoroutineID)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a IncrementalSAXSource_Filter which is not yet bound to a specific
SAX event source.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#characters(char[], int, int)">characters</A></B>(char[]&nbsp;ch,
int&nbsp;start,
int&nbsp;length)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#co_entry_pause()">co_entry_pause</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;co_entry_pause is called in startDocument() before anything else
happens.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#co_yield(boolean)">co_yield</A></B>(boolean&nbsp;moreRemains)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Co_Yield handles coroutine interactions while a parse is in progress.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#comment(char[], int, int)">comment</A></B>(char[]&nbsp;ch,
int&nbsp;start,
int&nbsp;length)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#count_and_yield(boolean)">count_and_yield</A></B>(boolean&nbsp;moreExpected)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;In the SAX delegation code, I've inlined the count-down in
the hope of encouraging compilers to deliver better
performance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref">IncrementalSAXSource</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#createIncrementalSAXSource(org.apache.xml.dtm.ref.CoroutineManager, int)">createIncrementalSAXSource</A></B>(<A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html" title="class in org.apache.xml.dtm.ref">CoroutineManager</A>&nbsp;co,
int&nbsp;controllerCoroutineID)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#deliverMoreNodes(boolean)">deliverMoreNodes</A></B>(boolean&nbsp;parsemore)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;deliverMoreNodes() is a simple API which tells the coroutine
parser that we need more nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#endCDATA()">endCDATA</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#endDocument()">endDocument</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#endDTD()">endDTD</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#endElement(java.lang.String, java.lang.String, java.lang.String)">endElement</A></B>(java.lang.String&nbsp;namespaceURI,
java.lang.String&nbsp;localName,
java.lang.String&nbsp;qName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#endEntity(java.lang.String)">endEntity</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#endPrefixMapping(java.lang.String)">endPrefixMapping</A></B>(java.lang.String&nbsp;prefix)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#error(org.xml.sax.SAXParseException)">error</A></B>(org.xml.sax.SAXParseException&nbsp;exception)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#fatalError(org.xml.sax.SAXParseException)">fatalError</A></B>(org.xml.sax.SAXParseException&nbsp;exception)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#getControllerCoroutineID()">getControllerCoroutineID</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html" title="class in org.apache.xml.dtm.ref">CoroutineManager</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#getCoroutineManager()">getCoroutineManager</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#getSourceCoroutineID()">getSourceCoroutineID</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#ignorableWhitespace(char[], int, int)">ignorableWhitespace</A></B>(char[]&nbsp;ch,
int&nbsp;start,
int&nbsp;length)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#init(org.apache.xml.dtm.ref.CoroutineManager, int, int)">init</A></B>(<A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html" title="class in org.apache.xml.dtm.ref">CoroutineManager</A>&nbsp;co,
int&nbsp;controllerCoroutineID,
int&nbsp;sourceCoroutineID)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#notationDecl(java.lang.String, java.lang.String, java.lang.String)">notationDecl</A></B>(java.lang.String&nbsp;a,
java.lang.String&nbsp;b,
java.lang.String&nbsp;c)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#processingInstruction(java.lang.String, java.lang.String)">processingInstruction</A></B>(java.lang.String&nbsp;target,
java.lang.String&nbsp;data)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#run()">run</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#setContentHandler(org.xml.sax.ContentHandler)">setContentHandler</A></B>(org.xml.sax.ContentHandler&nbsp;handler)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Register a SAX-style content handler for us to output to</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#setDocumentLocator(org.xml.sax.Locator)">setDocumentLocator</A></B>(org.xml.sax.Locator&nbsp;locator)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#setDTDHandler(org.xml.sax.DTDHandler)">setDTDHandler</A></B>(org.xml.sax.DTDHandler&nbsp;handler)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Register a SAX-style DTD handler for us to output to</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#setErrHandler(org.xml.sax.ErrorHandler)">setErrHandler</A></B>(org.xml.sax.ErrorHandler&nbsp;handler)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#setLexicalHandler(org.xml.sax.ext.LexicalHandler)">setLexicalHandler</A></B>(org.xml.sax.ext.LexicalHandler&nbsp;handler)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Register a SAX-style lexical handler for us to output to</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#setReturnFrequency(int)">setReturnFrequency</A></B>(int&nbsp;events)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#setXMLReader(org.xml.sax.XMLReader)">setXMLReader</A></B>(org.xml.sax.XMLReader&nbsp;eventsource)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Bind our input streams to an XMLReader.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#skippedEntity(java.lang.String)">skippedEntity</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#startCDATA()">startCDATA</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#startDocument()">startDocument</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#startDTD(java.lang.String, java.lang.String, java.lang.String)">startDTD</A></B>(java.lang.String&nbsp;name,
java.lang.String&nbsp;publicId,
java.lang.String&nbsp;systemId)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)">startElement</A></B>(java.lang.String&nbsp;namespaceURI,
java.lang.String&nbsp;localName,
java.lang.String&nbsp;qName,
org.xml.sax.Attributes&nbsp;atts)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#startEntity(java.lang.String)">startEntity</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#startParse(org.xml.sax.InputSource)">startParse</A></B>(org.xml.sax.InputSource&nbsp;source)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Launch a thread that will run an XMLReader's parse() operation within
a thread, feeding events to this IncrementalSAXSource_Filter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#startPrefixMapping(java.lang.String, java.lang.String)">startPrefixMapping</A></B>(java.lang.String&nbsp;prefix,
java.lang.String&nbsp;uri)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">unparsedEntityDecl</A></B>(java.lang.String&nbsp;a,
java.lang.String&nbsp;b,
java.lang.String&nbsp;c,
java.lang.String&nbsp;d)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#warning(org.xml.sax.SAXParseException)">warning</A></B>(org.xml.sax.SAXParseException&nbsp;exception)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="DEBUG"><!-- --></A><H3>
DEBUG</H3>
<PRE>
boolean <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.70"><B>DEBUG</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="fCoroutineManager"><!-- --></A><H3>
fCoroutineManager</H3>
<PRE>
private <A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html" title="class in org.apache.xml.dtm.ref">CoroutineManager</A> <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.75"><B>fCoroutineManager</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="fControllerCoroutineID"><!-- --></A><H3>
fControllerCoroutineID</H3>
<PRE>
private int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.76"><B>fControllerCoroutineID</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="fSourceCoroutineID"><!-- --></A><H3>
fSourceCoroutineID</H3>
<PRE>
private int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.77"><B>fSourceCoroutineID</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="clientContentHandler"><!-- --></A><H3>
clientContentHandler</H3>
<PRE>
private org.xml.sax.ContentHandler <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.79"><B>clientContentHandler</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="clientLexicalHandler"><!-- --></A><H3>
clientLexicalHandler</H3>
<PRE>
private org.xml.sax.ext.LexicalHandler <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.80"><B>clientLexicalHandler</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="clientDTDHandler"><!-- --></A><H3>
clientDTDHandler</H3>
<PRE>
private org.xml.sax.DTDHandler <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.81"><B>clientDTDHandler</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="clientErrorHandler"><!-- --></A><H3>
clientErrorHandler</H3>
<PRE>
private org.xml.sax.ErrorHandler <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.82"><B>clientErrorHandler</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="eventcounter"><!-- --></A><H3>
eventcounter</H3>
<PRE>
private int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.83"><B>eventcounter</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="frequency"><!-- --></A><H3>
frequency</H3>
<PRE>
private int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.84"><B>frequency</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="fNoMoreEvents"><!-- --></A><H3>
fNoMoreEvents</H3>
<PRE>
private boolean <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.89"><B>fNoMoreEvents</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="fXMLReader"><!-- --></A><H3>
fXMLReader</H3>
<PRE>
private org.xml.sax.XMLReader <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.92"><B>fXMLReader</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="fXMLReaderInputSource"><!-- --></A><H3>
fXMLReaderInputSource</H3>
<PRE>
private org.xml.sax.InputSource <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.93"><B>fXMLReaderInputSource</B></A></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="IncrementalSAXSource_Filter()"><!-- --></A><H3>
IncrementalSAXSource_Filter</H3>
<PRE>
public <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.99"><B>IncrementalSAXSource_Filter</B></A>()</PRE>
<DL>
</DL>
<HR>
<A NAME="IncrementalSAXSource_Filter(org.apache.xml.dtm.ref.CoroutineManager, int)"><!-- --></A><H3>
IncrementalSAXSource_Filter</H3>
<PRE>
public <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.106"><B>IncrementalSAXSource_Filter</B></A>(<A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html" title="class in org.apache.xml.dtm.ref">CoroutineManager</A>&nbsp;co,
int&nbsp;controllerCoroutineID)</PRE>
<DL>
<DD>Create a IncrementalSAXSource_Filter which is not yet bound to a specific
SAX event source.
<P>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="createIncrementalSAXSource(org.apache.xml.dtm.ref.CoroutineManager, int)"><!-- --></A><H3>
createIncrementalSAXSource</H3>
<PRE>
public static <A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref">IncrementalSAXSource</A> <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.114"><B>createIncrementalSAXSource</B></A>(<A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html" title="class in org.apache.xml.dtm.ref">CoroutineManager</A>&nbsp;co,
int&nbsp;controllerCoroutineID)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="init(org.apache.xml.dtm.ref.CoroutineManager, int, int)"><!-- --></A><H3>
init</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.122"><B>init</B></A>(<A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html" title="class in org.apache.xml.dtm.ref">CoroutineManager</A>&nbsp;co,
int&nbsp;controllerCoroutineID,
int&nbsp;sourceCoroutineID)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setXMLReader(org.xml.sax.XMLReader)"><!-- --></A><H3>
setXMLReader</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.142"><B>setXMLReader</B></A>(org.xml.sax.XMLReader&nbsp;eventsource)</PRE>
<DL>
<DD>Bind our input streams to an XMLReader.
Just a convenience routine; obviously you can explicitly register
this as a listener with the same effect.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setContentHandler(org.xml.sax.ContentHandler)"><!-- --></A><H3>
setContentHandler</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.170"><B>setContentHandler</B></A>(org.xml.sax.ContentHandler&nbsp;handler)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#setContentHandler(org.xml.sax.ContentHandler)">IncrementalSAXSource</A></CODE></B></DD>
<DD>Register a SAX-style content handler for us to output to
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#setContentHandler(org.xml.sax.ContentHandler)">setContentHandler</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref">IncrementalSAXSource</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setDTDHandler(org.xml.sax.DTDHandler)"><!-- --></A><H3>
setDTDHandler</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.175"><B>setDTDHandler</B></A>(org.xml.sax.DTDHandler&nbsp;handler)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#setDTDHandler(org.xml.sax.DTDHandler)">IncrementalSAXSource</A></CODE></B></DD>
<DD>Register a SAX-style DTD handler for us to output to
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#setDTDHandler(org.xml.sax.DTDHandler)">setDTDHandler</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref">IncrementalSAXSource</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setLexicalHandler(org.xml.sax.ext.LexicalHandler)"><!-- --></A><H3>
setLexicalHandler</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.183"><B>setLexicalHandler</B></A>(org.xml.sax.ext.LexicalHandler&nbsp;handler)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#setLexicalHandler(org.xml.sax.ext.LexicalHandler)">IncrementalSAXSource</A></CODE></B></DD>
<DD>Register a SAX-style lexical handler for us to output to
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#setLexicalHandler(org.xml.sax.ext.LexicalHandler)">setLexicalHandler</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref">IncrementalSAXSource</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setErrHandler(org.xml.sax.ErrorHandler)"><!-- --></A><H3>
setErrHandler</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.189"><B>setErrHandler</B></A>(org.xml.sax.ErrorHandler&nbsp;handler)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setReturnFrequency(int)"><!-- --></A><H3>
setReturnFrequency</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.196"><B>setReturnFrequency</B></A>(int&nbsp;events)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="characters(char[], int, int)"><!-- --></A><H3>
characters</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.221"><B>characters</B></A>(char[]&nbsp;ch,
int&nbsp;start,
int&nbsp;length)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>characters</CODE> in interface <CODE>org.xml.sax.ContentHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="endDocument()"><!-- --></A><H3>
endDocument</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.232"><B>endDocument</B></A>()
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>endDocument</CODE> in interface <CODE>org.xml.sax.ContentHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="endElement(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
endElement</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.242"><B>endElement</B></A>(java.lang.String&nbsp;namespaceURI,
java.lang.String&nbsp;localName,
java.lang.String&nbsp;qName)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>endElement</CODE> in interface <CODE>org.xml.sax.ContentHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="endPrefixMapping(java.lang.String)"><!-- --></A><H3>
endPrefixMapping</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.254"><B>endPrefixMapping</B></A>(java.lang.String&nbsp;prefix)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>endPrefixMapping</CODE> in interface <CODE>org.xml.sax.ContentHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="ignorableWhitespace(char[], int, int)"><!-- --></A><H3>
ignorableWhitespace</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.265"><B>ignorableWhitespace</B></A>(char[]&nbsp;ch,
int&nbsp;start,
int&nbsp;length)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>ignorableWhitespace</CODE> in interface <CODE>org.xml.sax.ContentHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="processingInstruction(java.lang.String, java.lang.String)"><!-- --></A><H3>
processingInstruction</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.276"><B>processingInstruction</B></A>(java.lang.String&nbsp;target,
java.lang.String&nbsp;data)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>processingInstruction</CODE> in interface <CODE>org.xml.sax.ContentHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setDocumentLocator(org.xml.sax.Locator)"><!-- --></A><H3>
setDocumentLocator</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.287"><B>setDocumentLocator</B></A>(org.xml.sax.Locator&nbsp;locator)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setDocumentLocator</CODE> in interface <CODE>org.xml.sax.ContentHandler</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="skippedEntity(java.lang.String)"><!-- --></A><H3>
skippedEntity</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.298"><B>skippedEntity</B></A>(java.lang.String&nbsp;name)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>skippedEntity</CODE> in interface <CODE>org.xml.sax.ContentHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="startDocument()"><!-- --></A><H3>
startDocument</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.309"><B>startDocument</B></A>()
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>startDocument</CODE> in interface <CODE>org.xml.sax.ContentHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)"><!-- --></A><H3>
startElement</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.323"><B>startElement</B></A>(java.lang.String&nbsp;namespaceURI,
java.lang.String&nbsp;localName,
java.lang.String&nbsp;qName,
org.xml.sax.Attributes&nbsp;atts)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>startElement</CODE> in interface <CODE>org.xml.sax.ContentHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="startPrefixMapping(java.lang.String, java.lang.String)"><!-- --></A><H3>
startPrefixMapping</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.335"><B>startPrefixMapping</B></A>(java.lang.String&nbsp;prefix,
java.lang.String&nbsp;uri)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>startPrefixMapping</CODE> in interface <CODE>org.xml.sax.ContentHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="comment(char[], int, int)"><!-- --></A><H3>
comment</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.357"><B>comment</B></A>(char[]&nbsp;ch,
int&nbsp;start,
int&nbsp;length)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>comment</CODE> in interface <CODE>org.xml.sax.ext.LexicalHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="endCDATA()"><!-- --></A><H3>
endCDATA</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.363"><B>endCDATA</B></A>()
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>endCDATA</CODE> in interface <CODE>org.xml.sax.ext.LexicalHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="endDTD()"><!-- --></A><H3>
endDTD</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.369"><B>endDTD</B></A>()
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>endDTD</CODE> in interface <CODE>org.xml.sax.ext.LexicalHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="endEntity(java.lang.String)"><!-- --></A><H3>
endEntity</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.375"><B>endEntity</B></A>(java.lang.String&nbsp;name)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>endEntity</CODE> in interface <CODE>org.xml.sax.ext.LexicalHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="startCDATA()"><!-- --></A><H3>
startCDATA</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.381"><B>startCDATA</B></A>()
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>startCDATA</CODE> in interface <CODE>org.xml.sax.ext.LexicalHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="startDTD(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
startDTD</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.387"><B>startDTD</B></A>(java.lang.String&nbsp;name,
java.lang.String&nbsp;publicId,
java.lang.String&nbsp;systemId)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>startDTD</CODE> in interface <CODE>org.xml.sax.ext.LexicalHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="startEntity(java.lang.String)"><!-- --></A><H3>
startEntity</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.394"><B>startEntity</B></A>(java.lang.String&nbsp;name)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>startEntity</CODE> in interface <CODE>org.xml.sax.ext.LexicalHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="notationDecl(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
notationDecl</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.404"><B>notationDecl</B></A>(java.lang.String&nbsp;a,
java.lang.String&nbsp;b,
java.lang.String&nbsp;c)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>notationDecl</CODE> in interface <CODE>org.xml.sax.DTDHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
unparsedEntityDecl</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.409"><B>unparsedEntityDecl</B></A>(java.lang.String&nbsp;a,
java.lang.String&nbsp;b,
java.lang.String&nbsp;c,
java.lang.String&nbsp;d)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>unparsedEntityDecl</CODE> in interface <CODE>org.xml.sax.DTDHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="error(org.xml.sax.SAXParseException)"><!-- --></A><H3>
error</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.430"><B>error</B></A>(org.xml.sax.SAXParseException&nbsp;exception)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>error</CODE> in interface <CODE>org.xml.sax.ErrorHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="fatalError(org.xml.sax.SAXParseException)"><!-- --></A><H3>
fatalError</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.436"><B>fatalError</B></A>(org.xml.sax.SAXParseException&nbsp;exception)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>fatalError</CODE> in interface <CODE>org.xml.sax.ErrorHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="warning(org.xml.sax.SAXParseException)"><!-- --></A><H3>
warning</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.448"><B>warning</B></A>(org.xml.sax.SAXParseException&nbsp;exception)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>warning</CODE> in interface <CODE>org.xml.sax.ErrorHandler</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getSourceCoroutineID()"><!-- --></A><H3>
getSourceCoroutineID</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.459"><B>getSourceCoroutineID</B></A>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getControllerCoroutineID()"><!-- --></A><H3>
getControllerCoroutineID</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.462"><B>getControllerCoroutineID</B></A>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getCoroutineManager()"><!-- --></A><H3>
getCoroutineManager</H3>
<PRE>
public <A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html" title="class in org.apache.xml.dtm.ref">CoroutineManager</A> <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.471"><B>getCoroutineManager</B></A>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the CoroutineManager this CoroutineFilter object is bound to.
If you're using the do...() methods, applications should only
need to talk to the CoroutineManager once, to obtain the
application's Coroutine ID.</DL>
</DD>
</DL>
<HR>
<A NAME="count_and_yield(boolean)"><!-- --></A><H3>
count_and_yield</H3>
<PRE>
protected void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.487"><B>count_and_yield</B></A>(boolean&nbsp;moreExpected)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD><p>In the SAX delegation code, I've inlined the count-down in
the hope of encouraging compilers to deliver better
performance. However, if we subclass (eg to directly connect the
output to a DTM builder), that would require calling super in
order to run that logic... which seems inelegant. Hence this
routine for the convenience of subclasses: every [frequency]
invocations, issue a co_yield.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>moreExepected</CODE> - Should always be true unless this is being called
at the end of endDocument() handling.
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="co_entry_pause()"><!-- --></A><H3>
co_entry_pause</H3>
<PRE>
private void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.505"><B>co_entry_pause</B></A>()
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>co_entry_pause is called in startDocument() before anything else
happens. It causes the filter to wait for a "go ahead" request
from the controller before delivering any events. Note that
the very first thing the controller tells us may be "I don't
need events after all"!
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="co_yield(boolean)"><!-- --></A><H3>
co_yield</H3>
<PRE>
private void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.550"><B>co_yield</B></A>(boolean&nbsp;moreRemains)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Co_Yield handles coroutine interactions while a parse is in progress.
When moreRemains==true, we are pausing after delivering events, to
ask if more are needed. We will resume the controller thread with
co_resume(Boolean.TRUE, ...)
When control is passed back it may indicate
Boolean.TRUE indication to continue delivering events
Boolean.FALSE indication to discontinue events and shut down.
When moreRemains==false, we shut down immediately without asking the
controller's permission. Normally this means end of document has been
reached.
Shutting down a IncrementalSAXSource_Filter requires terminating the incoming
SAX event stream. If we are in control of that stream (if it came
from an XMLReader passed to our startReader() method), we can do so
very quickly by throwing a reserved exception to it. If the stream is
coming from another source, we can't do that because its caller may
not be prepared for this "normal abnormal exit", and instead we put
ourselves in a "spin" mode where events are discarded.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="startParse(org.xml.sax.InputSource)"><!-- --></A><H3>
startParse</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.603"><B>startParse</B></A>(org.xml.sax.InputSource&nbsp;source)
throws org.xml.sax.SAXException</PRE>
<DL>
<DD>Launch a thread that will run an XMLReader's parse() operation within
a thread, feeding events to this IncrementalSAXSource_Filter. Mostly a convenience
routine, but has the advantage that -- since we invoked parse() --
we can halt parsing quickly via a StopException rather than waiting
for the SAX stream to end by itself.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#startParse(org.xml.sax.InputSource)">startParse</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref">IncrementalSAXSource</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.xml.sax.SAXException</CODE> - is parse thread is already in progress
or parsing can not be started.</DL>
</DD>
</DL>
<HR>
<A NAME="run()"><!-- --></A><H3>
run</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.619"><B>run</B></A>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>run</CODE> in interface <CODE>java.lang.Runnable</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="deliverMoreNodes(boolean)"><!-- --></A><H3>
deliverMoreNodes</H3>
<PRE>
public java.lang.Object <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html#line.708"><B>deliverMoreNodes</B></A>(boolean&nbsp;parsemore)</PRE>
<DL>
<DD>deliverMoreNodes() is a simple API which tells the coroutine
parser that we need more nodes. This is intended to be called
from one of our partner routines, and serves to encapsulate the
details of how incremental parsing has been achieved.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#deliverMoreNodes(boolean)">deliverMoreNodes</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref">IncrementalSAXSource</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parsemore</CODE> - If true, tells the incremental filter to generate
another chunk of output. If false, tells the filter that we're
satisfied and it can terminate parsing of this document.
<DT><B>Returns:</B><DD>Boolean.TRUE if there may be more events available by invoking
deliverMoreNodes() again. Boolean.FALSE if parsing has run to completion (or been
terminated by deliverMoreNodes(false). Or an exception object if something
malfunctioned. %REVIEW% We _could_ actually throw the exception, but
that would require runinng deliverMoreNodes() in a try/catch... and for many
applications, exception will be simply be treated as "not TRUE" in
any case.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IncrementalSAXSource_Filter.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/ref/IncrementalSAXSource.html" title="interface in org.apache.xml.dtm.ref"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.StopException.html" title="class in org.apache.xml.dtm.ref"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IncrementalSAXSource_Filter.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>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>