| <!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 | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.xml.dtm.ref.IncrementalSAXSource interface"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="IncrementalSAXSource"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <A NAME="navbar_top"><!-- --></A> | |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_top_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IncrementalSAXSource.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/ExtendedType.html" title="class in org.apache.xml.dtm.ref"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.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.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="IncrementalSAXSource.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_top"></A> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <HR> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <H2> | |
| <FONT SIZE="-1"> | |
| org.apache.xml.dtm.ref</FONT> | |
| <BR> | |
| Interface IncrementalSAXSource</H2> | |
| <DL> | |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.html" title="class in org.apache.xml.dtm.ref">IncrementalSAXSource_Filter</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Xerces.html" title="class in org.apache.xml.dtm.ref">IncrementalSAXSource_Xerces</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public interface <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource.html#line.37"><B>IncrementalSAXSource</B></A></DL> | |
| </PRE> | |
| <P> | |
| <p>IncrementalSAXSource is an API that delivers a small number of | |
| SAX events each time a request is made from a "controller" | |
| coroutine. See IncrementalSAXFilter and IncrementalSAXFilter_Xerces | |
| for examples. | |
| Note that interaction is via the deliverMoreNodes | |
| method, and therefore coroutine support is not exposed | |
| here.</p> | |
| <P> | |
| <P> | |
| <HR> | |
| <P> | |
| <!-- ========== 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> java.lang.Object</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#deliverMoreNodes(boolean)">deliverMoreNodes</A></B>(boolean parsemore)</CODE> | |
| <BR> | |
| deliverMoreNodes() is a simple API which tells the thread in which the | |
| IncrementalSAXSource is running to deliver more events (true), | |
| or stop delivering events and close out its input (false).</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/IncrementalSAXSource.html#setContentHandler(org.xml.sax.ContentHandler)">setContentHandler</A></B>(org.xml.sax.ContentHandler handler)</CODE> | |
| <BR> | |
| 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> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#setDTDHandler(org.xml.sax.DTDHandler)">setDTDHandler</A></B>(org.xml.sax.DTDHandler handler)</CODE> | |
| <BR> | |
| 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> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#setLexicalHandler(org.xml.sax.ext.LexicalHandler)">setLexicalHandler</A></B>(org.xml.sax.ext.LexicalHandler handler)</CODE> | |
| <BR> | |
| 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> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html#startParse(org.xml.sax.InputSource)">startParse</A></B>(org.xml.sax.InputSource source)</CODE> | |
| <BR> | |
| Launch an XMLReader's parsing operation, feeding events to this | |
| IncrementalSAXSource.</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ 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="setContentHandler(org.xml.sax.ContentHandler)"><!-- --></A><H3> | |
| setContentHandler</H3> | |
| <PRE> | |
| void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource.html#line.45"><B>setContentHandler</B></A>(org.xml.sax.ContentHandler handler)</PRE> | |
| <DL> | |
| <DD>Register a SAX-style content handler for us to output to | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setLexicalHandler(org.xml.sax.ext.LexicalHandler)"><!-- --></A><H3> | |
| setLexicalHandler</H3> | |
| <PRE> | |
| void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource.html#line.49"><B>setLexicalHandler</B></A>(org.xml.sax.ext.LexicalHandler handler)</PRE> | |
| <DL> | |
| <DD>Register a SAX-style lexical handler for us to output to | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setDTDHandler(org.xml.sax.DTDHandler)"><!-- --></A><H3> | |
| setDTDHandler</H3> | |
| <PRE> | |
| void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource.html#line.53"><B>setDTDHandler</B></A>(org.xml.sax.DTDHandler handler)</PRE> | |
| <DL> | |
| <DD>Register a SAX-style DTD handler for us to output to | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="deliverMoreNodes(boolean)"><!-- --></A><H3> | |
| deliverMoreNodes</H3> | |
| <PRE> | |
| java.lang.Object <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource.html#line.73"><B>deliverMoreNodes</B></A>(boolean parsemore)</PRE> | |
| <DL> | |
| <DD>deliverMoreNodes() is a simple API which tells the thread in which the | |
| IncrementalSAXSource is running to deliver more events (true), | |
| or stop delivering events and close out its input (false). | |
| This is intended to be called from one of our partner coroutines, | |
| and serves to encapsulate the coroutine communication protocol. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>parsemore</CODE> - If true, tells the incremental SAX stream to deliver | |
| another chunk of events. If false, finishes out the stream. | |
| <DT><B>Returns:</B><DD>Boolean.TRUE if the IncrementalSAXSource believes more data | |
| may be available for further parsing. Boolean.FALSE if parsing | |
| ran to completion, or was ended by deliverMoreNodes(false).</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="startParse(org.xml.sax.InputSource)"><!-- --></A><H3> | |
| startParse</H3> | |
| <PRE> | |
| void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/IncrementalSAXSource.html#line.87"><B>startParse</B></A>(org.xml.sax.InputSource source) | |
| throws org.xml.sax.SAXException</PRE> | |
| <DL> | |
| <DD>Launch an XMLReader's parsing operation, feeding events to this | |
| IncrementalSAXSource. In some implementations, this may launch a | |
| thread which runs the previously supplied XMLReader's parse() operation. | |
| In others, it may do other forms of initialization. | |
| <P> | |
| <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> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <HR> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <A NAME="navbar_bottom"><!-- --></A> | |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IncrementalSAXSource.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/ExtendedType.html" title="class in org.apache.xml.dtm.ref"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource_Filter.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.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="IncrementalSAXSource.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| </BODY> | |
| </HTML> |