FileDocCategorySizeDatePackage
IncrementalSAXSource.javaAPI DocJava SE 5 API3424Fri Aug 26 14:56:00 BST 2005com.sun.org.apache.xml.internal.dtm.ref

IncrementalSAXSource

public interface IncrementalSAXSource

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.

Fields Summary
Constructors Summary
Methods Summary
public java.lang.ObjectdeliverMoreNodes(boolean parsemore)
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.

param
parsemore If true, tells the incremental SAX stream to deliver another chunk of events. If false, finishes out the stream.
return
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).

public voidsetContentHandler(org.xml.sax.ContentHandler handler)
Register a SAX-style content handler for us to output to

public voidsetDTDHandler(org.xml.sax.DTDHandler handler)
Register a SAX-style DTD handler for us to output to

public voidsetLexicalHandler(org.xml.sax.ext.LexicalHandler handler)
Register a SAX-style lexical handler for us to output to

public voidstartParse(org.xml.sax.InputSource source)
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.

throws
SAXException is parse thread is already in progress or parsing can not be started.