| org.apache.xml.dtm.ref.CoroutineParser
| CoroutineParser | | public interface CoroutineParser (Code) | | CoroutineParser is an API for parser threads that operate as
coroutines. See CoroutineSAXParser and CoroutineSAXParser_Xerces
for examples.
<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:
- public CoroutineParser(CoroutineManager co, int appCoroutine);
- public CoroutineParser createCoroutineParser(CoroutineManager co, int appCoroutine);
</grumble>
IncrementalSAXSource |
| Method Summary | |
| public Object | doMore(boolean parsemore, int appCoroutine)
doMore() is a simple API which tells the coroutine parser
that we need more nodes. | | public Object | doParse(InputSource source, int appCoroutine)
doParse() is a simple API which tells the coroutine parser
to begin reading from a file. | | public void | doTerminate(int appCoroutine)
doTerminate() is a simple API which tells the coroutine
parser to terminate itself. | | public CoroutineManager | getCoroutineManager()
| | public int | getParserCoroutineID()
the coroutine ID number for this CoroutineParser object.Note that this isn't useful unless you know which CoroutineManageryou're talking to. | | public void | init(CoroutineManager co, int appCoroutineID, XMLReader parser)
Initialize the coroutine parser. | | public void | setContentHandler(ContentHandler handler)
| | public void | setLexHandler(org.xml.sax.ext.LexicalHandler handler)
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. |
| doMore | | public Object doMore(boolean parsemore, int appCoroutine)(Code) | | 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.
Parameters:
parsemore - If true, tells the incremental parser to generateanother chunk of output. If false, tells the parser that we'resatisfied and it can terminate parsing of this document.
Parameters:
appCoroutine - The coroutine ID number of the coroutine invokingthis method, so it can be resumed after the parser has responded to therequest. Boolean.TRUE if the CoroutineParser believes more data may be availablefor further parsing. Boolean.FALSE if parsing ran to completion.Exception if the parser objected for some reason. |
| doParse | | public Object doParse(InputSource source, int appCoroutine)(Code) | | 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...?
Parameters:
source - The InputSource to parse from.
Parameters:
appCoroutine - The coroutine ID number of the coroutine invokingthis method, so it can be resumed after the parser has responded to therequest. Boolean.TRUE if the CoroutineParser believes more data may be availablefor further parsing. Boolean.FALSE if parsing ran to completion.Exception if the parser objected for some reason. |
| doTerminate | | public void doTerminate(int appCoroutine)(Code) | | 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.
Parameters:
appCoroutine - The coroutine ID number of the coroutine invokingthis method, so it can be resumed after the parser has responded to therequest. |
| getCoroutineManager | | public CoroutineManager getCoroutineManager()(Code) | | the CoroutineManager for this CoroutineParser object.If you're using the do...() methods, applications should onlyneed to talk to the CoroutineManager once, to obtain theapplication's Coroutine ID. |
| getParserCoroutineID | | public int getParserCoroutineID()(Code) | | the coroutine ID number for this CoroutineParser object.Note that this isn't useful unless you know which CoroutineManageryou're talking to. Also note that the do...() methods encapsulatethe common transactions with the CoroutineParser, so you shouldn'tneed this in most cases. |
| init | | public void init(CoroutineManager co, int appCoroutineID, XMLReader parser)(Code) | | 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()
|
| setContentHandler | | public void setContentHandler(ContentHandler handler)(Code) | | Register a SAX-style content handler for us to output to
|
| setLexHandler | | public void setLexHandler(org.xml.sax.ext.LexicalHandler handler)(Code) | | 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.
|
|
|