| /* |
| * The Apache Software License, Version 1.1 |
| * |
| * |
| * Copyright (c) 1999-2003 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Xerces" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation and was |
| * originally based on software copyright (c) 1999, International |
| * Business Machines, Inc., http://www.apache.org. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| package org.apache.xml.dtm.ref; |
| |
| import org.xml.sax.ContentHandler; |
| import org.xml.sax.InputSource; |
| import org.xml.sax.SAXException; |
| |
| /** <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> |
| * */ |
| public interface IncrementalSAXSource |
| { |
| // ------------------------------------------------------------------ |
| // SAX Output API |
| // ------------------------------------------------------------------ |
| |
| /** Register a SAX-style content handler for us to output to |
| */ |
| public void setContentHandler(ContentHandler handler); |
| |
| /** Register a SAX-style lexical handler for us to output to |
| */ |
| public void setLexicalHandler(org.xml.sax.ext.LexicalHandler handler); |
| |
| /** Register a SAX-style DTD handler for us to output to |
| */ |
| public void setDTDHandler(org.xml.sax.DTDHandler handler); |
| |
| // ------------------------------------------------------------------ |
| // Command Input API |
| // ------------------------------------------------------------------ |
| |
| /** 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 Object deliverMoreNodes (boolean parsemore); |
| |
| // ------------------------------------------------------------------ |
| // Parse Thread Convenience API |
| // ------------------------------------------------------------------ |
| |
| /** 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. |
| * */ |
| public void startParse(InputSource source) throws SAXException; |
| |
| } // class IncrementalSAXSource |