19f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/* 29f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Licensed to the Apache Software Foundation (ASF) under one 39f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * or more contributor license agreements. See the NOTICE file 49f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * distributed with this work for additional information 59f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * regarding copyright ownership. The ASF licenses this file 69f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * to you under the Apache License, Version 2.0 (the "License"); 79f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * you may not use this file except in compliance with the License. 89f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * You may obtain a copy of the License at 99f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 109f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * http://www.apache.org/licenses/LICENSE-2.0 119f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 129f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Unless required by applicable law or agreed to in writing, software 139f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS, 149f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 159f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * See the License for the specific language governing permissions and 169f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * limitations under the License. 179f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 189f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/* 199f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * $Id: IncrementalSAXSource.java 468653 2006-10-28 07:07:05Z minchau $ 209f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 219f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 229f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonpackage org.apache.xml.dtm.ref; 239f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 249f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport org.xml.sax.ContentHandler; 259f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport org.xml.sax.InputSource; 269f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport org.xml.sax.SAXException; 279f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 289f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/** <p>IncrementalSAXSource is an API that delivers a small number of 299f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * SAX events each time a request is made from a "controller" 309f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * coroutine. See IncrementalSAXFilter and IncrementalSAXFilter_Xerces 319f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * for examples. 329f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 339f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Note that interaction is via the deliverMoreNodes 349f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * method, and therefore coroutine support is not exposed 359f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * here.</p> 369f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * */ 379f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonpublic interface IncrementalSAXSource 389f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson{ 399f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // ------------------------------------------------------------------ 409f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // SAX Output API 419f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // ------------------------------------------------------------------ 429f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 439f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** Register a SAX-style content handler for us to output to 449f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 459f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public void setContentHandler(ContentHandler handler); 469f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 479f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** Register a SAX-style lexical handler for us to output to 489f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 499f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public void setLexicalHandler(org.xml.sax.ext.LexicalHandler handler); 509f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 519f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** Register a SAX-style DTD handler for us to output to 529f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 539f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public void setDTDHandler(org.xml.sax.DTDHandler handler); 549f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 559f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // ------------------------------------------------------------------ 569f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // Command Input API 579f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // ------------------------------------------------------------------ 589f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 599f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** deliverMoreNodes() is a simple API which tells the thread in which the 609f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * IncrementalSAXSource is running to deliver more events (true), 619f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * or stop delivering events and close out its input (false). 629f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 639f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * This is intended to be called from one of our partner coroutines, 649f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * and serves to encapsulate the coroutine communication protocol. 659f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 669f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @param parsemore If true, tells the incremental SAX stream to deliver 679f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * another chunk of events. If false, finishes out the stream. 689f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 699f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return Boolean.TRUE if the IncrementalSAXSource believes more data 709f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * may be available for further parsing. Boolean.FALSE if parsing 719f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * ran to completion, or was ended by deliverMoreNodes(false). 729f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * */ 739f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public Object deliverMoreNodes (boolean parsemore); 749f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 759f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // ------------------------------------------------------------------ 769f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // Parse Thread Convenience API 779f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // ------------------------------------------------------------------ 789f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 799f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** Launch an XMLReader's parsing operation, feeding events to this 809f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * IncrementalSAXSource. In some implementations, this may launch a 819f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * thread which runs the previously supplied XMLReader's parse() operation. 829f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * In others, it may do other forms of initialization. 839f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 849f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @throws SAXException is parse thread is already in progress 859f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * or parsing can not be started. 869f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * */ 879f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public void startParse(InputSource source) throws SAXException; 889f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 899f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson} // class IncrementalSAXSource 90