286N/A/*
286N/A * reserved comment block
286N/A * DO NOT REMOVE OR ALTER!
286N/A */
286N/A/*
286N/A * Copyright 1999-2004 The Apache Software Foundation.
286N/A *
286N/A * Licensed under the Apache License, Version 2.0 (the "License");
286N/A * you may not use this file except in compliance with the License.
286N/A * You may obtain a copy of the License at
286N/A *
286N/A * http://www.apache.org/licenses/LICENSE-2.0
286N/A *
286N/A * Unless required by applicable law or agreed to in writing, software
286N/A * distributed under the License is distributed on an "AS IS" BASIS,
286N/A * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
286N/A * See the License for the specific language governing permissions and
286N/A * limitations under the License.
286N/A */
286N/A/*
286N/A * $Id: IncrementalSAXSource.java,v 1.2.4.1 2005/09/15 08:15:06 suresh_emailid Exp $
286N/A */
286N/A
286N/Apackage com.sun.org.apache.xml.internal.dtm.ref;
286N/A
286N/Aimport org.xml.sax.ContentHandler;
286N/Aimport org.xml.sax.InputSource;
286N/Aimport org.xml.sax.SAXException;
286N/A
286N/A/** <p>IncrementalSAXSource is an API that delivers a small number of
286N/A * SAX events each time a request is made from a "controller"
286N/A * coroutine. See IncrementalSAXFilter and IncrementalSAXFilter_Xerces
286N/A * for examples.
286N/A *
286N/A * Note that interaction is via the deliverMoreNodes
286N/A * method, and therefore coroutine support is not exposed
286N/A * here.</p>
286N/A * */
286N/Apublic interface IncrementalSAXSource
286N/A{
286N/A // ------------------------------------------------------------------
286N/A // SAX Output API
286N/A // ------------------------------------------------------------------
286N/A
286N/A /** Register a SAX-style content handler for us to output to
286N/A */
286N/A public void setContentHandler(ContentHandler handler);
286N/A
286N/A /** Register a SAX-style lexical handler for us to output to
286N/A */
286N/A public void setLexicalHandler(org.xml.sax.ext.LexicalHandler handler);
286N/A
286N/A /** Register a SAX-style DTD handler for us to output to
286N/A */
286N/A public void setDTDHandler(org.xml.sax.DTDHandler handler);
286N/A
286N/A // ------------------------------------------------------------------
286N/A // Command Input API
286N/A // ------------------------------------------------------------------
286N/A
286N/A /** deliverMoreNodes() is a simple API which tells the thread in which the
286N/A * IncrementalSAXSource is running to deliver more events (true),
286N/A * or stop delivering events and close out its input (false).
286N/A *
286N/A * This is intended to be called from one of our partner coroutines,
286N/A * and serves to encapsulate the coroutine communication protocol.
286N/A *
286N/A * @param parsemore If true, tells the incremental SAX stream to deliver
286N/A * another chunk of events. If false, finishes out the stream.
286N/A *
286N/A * @return Boolean.TRUE if the IncrementalSAXSource believes more data
286N/A * may be available for further parsing. Boolean.FALSE if parsing
286N/A * ran to completion, or was ended by deliverMoreNodes(false).
286N/A * */
286N/A public Object deliverMoreNodes (boolean parsemore);
286N/A
286N/A // ------------------------------------------------------------------
286N/A // Parse Thread Convenience API
286N/A // ------------------------------------------------------------------
286N/A
286N/A /** Launch an XMLReader's parsing operation, feeding events to this
286N/A * IncrementalSAXSource. In some implementations, this may launch a
286N/A * thread which runs the previously supplied XMLReader's parse() operation.
286N/A * In others, it may do other forms of initialization.
286N/A *
286N/A * @throws SAXException is parse thread is already in progress
286N/A * or parsing can not be started.
286N/A * */
286N/A public void startParse(InputSource source) throws SAXException;
286N/A
286N/A} // class IncrementalSAXSource