| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
|
| <!--NewPage-->
|
| <HTML>
|
| <HEAD>
|
| <!-- Generated by javadoc on Thu Nov 22 17:12:56 EST 2007 -->
|
| <TITLE>
|
| Xalan-Java 2.7.1: Interface CoroutineParser
|
| </TITLE>
|
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
| </HEAD>
|
| <BODY BGCOLOR="white">
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CoroutineParser.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">
|
| PREV CLASS
|
| <A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="CoroutineParser.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | 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>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| <!-- ======== START OF CLASS DATA ======== -->
|
| <H2>
|
| <FONT SIZE="-1">
|
| org.apache.xml.dtm.ref</FONT>
|
| <BR>
|
| Interface CoroutineParser</H2>
|
| <HR>
|
| <B>Deprecated.</B> <I>Since the ability to start a parse via the |
| coroutine protocol was not being used and was complicating design. |
| See <A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html"><CODE>IncrementalSAXSource</CODE></A>.</I>
|
| <P>
|
| <DL>
|
| <DT>public interface <B>CoroutineParser</B></DL>
|
|
|
| <P>
|
| <p>CoroutineParser is an API for parser threads that operate as |
| coroutines. See CoroutineSAXParser and CoroutineSAXParser_Xerces |
| for examples.</p> |
| |
| <p><grumble> I'd like the interface to require a specific form |
| for either the base constructor or a static factory method. Java |
| doesn't allow us to specify either, so I'll just document them |
| here: |
| |
| <ul> |
| <li>public CoroutineParser(CoroutineManager co, int appCoroutine);</li> |
| <li>public CoroutineParser createCoroutineParser(CoroutineManager co, int appCoroutine);</li> |
| </ul> |
| |
| </grumble></p>
|
| <P>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
| <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
| <!-- ========== METHOD SUMMARY =========== -->
|
|
|
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Method Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.lang.Object</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineParser.html#doMore(boolean, int)">doMore</A></B>(boolean parsemore, |
| int appCoroutine)</CODE>
|
|
|
| <BR>
|
| <B>Deprecated.</B> doMore() 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> java.lang.Object</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineParser.html#doParse(org.xml.sax.InputSource, int)">doParse</A></B>(<A HREF="../../../../../org/xml/sax/InputSource.html">InputSource</A> source, |
| int appCoroutine)</CODE>
|
|
|
| <BR>
|
| <B>Deprecated.</B> doParse() is a simple API which tells the coroutine parser |
| to begin reading from a file.</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/CoroutineParser.html#doTerminate(int)">doTerminate</A></B>(int appCoroutine)</CODE>
|
|
|
| <BR>
|
| <B>Deprecated.</B> doTerminate() is a simple API which tells the coroutine |
| parser to terminate itself.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html">CoroutineManager</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineParser.html#getCoroutineManager()">getCoroutineManager</A></B>()</CODE>
|
|
|
| <BR>
|
| <B>Deprecated.</B> </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineParser.html#getParserCoroutineID()">getParserCoroutineID</A></B>()</CODE>
|
|
|
| <BR>
|
| <B>Deprecated.</B> </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/CoroutineParser.html#init(org.apache.xml.dtm.ref.CoroutineManager, int, org.xml.sax.XMLReader)">init</A></B>(<A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html">CoroutineManager</A> co, |
| int appCoroutineID, |
| <A HREF="../../../../../org/xml/sax/XMLReader.html">XMLReader</A> parser)</CODE>
|
|
|
| <BR>
|
| <B>Deprecated.</B> Initialize the coroutine parser.</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/CoroutineParser.html#setContentHandler(org.xml.sax.ContentHandler)">setContentHandler</A></B>(<A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> handler)</CODE>
|
|
|
| <BR>
|
| <B>Deprecated.</B> 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/CoroutineParser.html#setLexHandler(org.xml.sax.ext.LexicalHandler)">setLexHandler</A></B>(<A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A> handler)</CODE>
|
|
|
| <BR>
|
| <B>Deprecated.</B> Register a SAX-style lexical handler for us to output to |
| Not all parsers support this...</TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <P>
|
|
|
| <!-- ============ FIELD DETAIL =========== -->
|
|
|
|
|
| <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
|
| <!-- ============ METHOD DETAIL ========== -->
|
|
|
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Method Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="getParserCoroutineID()"><!-- --></A><H3>
|
| getParserCoroutineID</H3>
|
| <PRE>
|
| public int <B>getParserCoroutineID</B>()</PRE>
|
| <DL>
|
| <DD><B>Deprecated.</B> <DD><DL>
|
| <DT><B>Returns:</B><DD>the coroutine ID number for this CoroutineParser object. |
| Note that this isn't useful unless you know which CoroutineManager |
| you're talking to. Also note that the do...() methods encapsulate |
| the common transactions with the CoroutineParser, so you shouldn't |
| need this in most cases.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getCoroutineManager()"><!-- --></A><H3>
|
| getCoroutineManager</H3>
|
| <PRE>
|
| public <A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html">CoroutineManager</A> <B>getCoroutineManager</B>()</PRE>
|
| <DL>
|
| <DD><B>Deprecated.</B> <DD><DL>
|
| <DT><B>Returns:</B><DD>the CoroutineManager for this CoroutineParser object. |
| 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="setContentHandler(org.xml.sax.ContentHandler)"><!-- --></A><H3>
|
| setContentHandler</H3>
|
| <PRE>
|
| public void <B>setContentHandler</B>(<A HREF="../../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> handler)</PRE>
|
| <DL>
|
| <DD><B>Deprecated.</B> <DD>Register a SAX-style content handler for us to output to</DL>
|
| <HR>
|
|
|
| <A NAME="setLexHandler(org.xml.sax.ext.LexicalHandler)"><!-- --></A><H3>
|
| setLexHandler</H3>
|
| <PRE>
|
| public void <B>setLexHandler</B>(<A HREF="../../../../../org/xml/sax/ext/LexicalHandler.html">LexicalHandler</A> handler)</PRE>
|
| <DL>
|
| <DD><B>Deprecated.</B> <DD>Register a SAX-style lexical handler for us to output to |
| Not all parsers support this... |
| |
| %REVIEW% Not called setLexicalHandler because Xalan uses that name |
| internally, which causes subclassing nuisances.</DL>
|
| <HR>
|
|
|
| <A NAME="doParse(org.xml.sax.InputSource, int)"><!-- --></A><H3>
|
| doParse</H3>
|
| <PRE>
|
| public java.lang.Object <B>doParse</B>(<A HREF="../../../../../org/xml/sax/InputSource.html">InputSource</A> source, |
| int appCoroutine)</PRE>
|
| <DL>
|
| <DD><B>Deprecated.</B> <DD>doParse() is a simple API which tells the coroutine parser |
| to begin reading from a file. This is intended to be called from one |
| of our partner coroutines, and serves both to encapsulate the |
| communication protocol and to avoid having to explicitly use the |
| CoroutineParser's coroutine ID number. |
| |
| %REVIEW% Can/should this unify with doMore? (if URI hasn't changed, |
| parse more from same file, else end and restart parsing...?<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>source</CODE> - The InputSource to parse from.<DD><CODE>appCoroutine</CODE> - The coroutine ID number of the coroutine invoking |
| this method, so it can be resumed after the parser has responded to the |
| request.<DT><B>Returns:</B><DD>Boolean.TRUE if the CoroutineParser believes more data may be available |
| for further parsing. Boolean.FALSE if parsing ran to completion. |
| Exception if the parser objected for some reason.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="doMore(boolean, int)"><!-- --></A><H3>
|
| doMore</H3>
|
| <PRE>
|
| public java.lang.Object <B>doMore</B>(boolean parsemore, |
| int appCoroutine)</PRE>
|
| <DL>
|
| <DD><B>Deprecated.</B> <DD>doMore() 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 coroutines, and serves both to encapsulate the |
| communication protocol and to avoid having to explicitly use the |
| CoroutineParser's coroutine ID number.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>parsemore</CODE> - If true, tells the incremental parser to generate |
| another chunk of output. If false, tells the parser that we're |
| satisfied and it can terminate parsing of this document.<DD><CODE>appCoroutine</CODE> - The coroutine ID number of the coroutine invoking |
| this method, so it can be resumed after the parser has responded to the |
| request.<DT><B>Returns:</B><DD>Boolean.TRUE if the CoroutineParser believes more data may be available |
| for further parsing. Boolean.FALSE if parsing ran to completion. |
| Exception if the parser objected for some reason.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="doTerminate(int)"><!-- --></A><H3>
|
| doTerminate</H3>
|
| <PRE>
|
| public void <B>doTerminate</B>(int appCoroutine)</PRE>
|
| <DL>
|
| <DD><B>Deprecated.</B> <DD>doTerminate() is a simple API which tells the coroutine |
| parser to terminate itself. This is intended to be called from |
| one of our partner coroutines, and serves both to encapsulate the |
| communication protocol and to avoid having to explicitly use the |
| CoroutineParser's coroutine ID number. |
| |
| Returns only after the CoroutineParser has acknowledged the request.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>appCoroutine</CODE> - The coroutine ID number of the coroutine invoking |
| this method, so it can be resumed after the parser has responded to the |
| request.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="init(org.apache.xml.dtm.ref.CoroutineManager, int, org.xml.sax.XMLReader)"><!-- --></A><H3>
|
| init</H3>
|
| <PRE>
|
| public void <B>init</B>(<A HREF="../../../../../org/apache/xml/dtm/ref/CoroutineManager.html">CoroutineManager</A> co, |
| int appCoroutineID, |
| <A HREF="../../../../../org/xml/sax/XMLReader.html">XMLReader</A> parser)</PRE>
|
| <DL>
|
| <DD><B>Deprecated.</B> <DD>Initialize the coroutine parser. Same parameters could be passed |
| in a non-default constructor, or by using using context ClassLoader |
| and newInstance and then calling init()</DL>
|
| <!-- ========= END OF CLASS DATA ========= -->
|
| <HR>
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CoroutineParser.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">
|
| PREV CLASS
|
| <A HREF="../../../../../org/apache/xml/dtm/ref/IncrementalSAXSource.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="CoroutineParser.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | 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>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| Copyright © 2006 Apache XML Project. All Rights Reserved.
|
| </BODY>
|
| </HTML>
|
