XMLEntityReaderFactory


1   /*
2    * The Apache Software License, Version 1.1
3    *
4    *
5    * Copyright (c) 1999 The Apache Software Foundation.  All rights 
6    * reserved.
7    *
8    * Redistribution and use in source and binary forms, with or without
9    * modification, are permitted provided that the following conditions
10   * are met:
11   *
12   * 1. Redistributions of source code must retain the above copyright
13   *    notice, this list of conditions and the following disclaimer. 
14   *
15   * 2. Redistributions in binary form must reproduce the above copyright
16   *    notice, this list of conditions and the following disclaimer in
17   *    the documentation and/or other materials provided with the
18   *    distribution.
19   *
20   * 3. The end-user documentation included with the redistribution,
21   *    if any, must include the following acknowledgment:  
22   *       "This product includes software developed by the
23   *        Apache Software Foundation (http://www.apache.org/)."
24   *    Alternately, this acknowledgment may appear in the software itself,
25   *    if and wherever such third-party acknowledgments normally appear.
26   *
27   * 4. The names "Xerces" and "Apache Software Foundation" must
28   *    not be used to endorse or promote products derived from this
29   *    software without prior written permission. For written 
30   *    permission, please contact apache@apache.org.
31   *
32   * 5. Products derived from this software may not be called "Apache",
33   *    nor may "Apache" appear in their name, without prior written
34   *    permission of the Apache Software Foundation.
35   *
36   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47   * SUCH DAMAGE.
48   * ====================================================================
49   *
50   * This software consists of voluntary contributions made by many
51   * individuals on behalf of the Apache Software Foundation and was
52   * originally based on software copyright (c) 1999, International
53   * Business Machines, Inc., http://www.apache.org.  For more
54   * information on the Apache Software Foundation, please see
55   * <http://www.apache.org/>.
56   */
57  
58  package org.enhydra.apache.xerces.readers;
59  
60  import java.io.InputStream  ;
61  import java.io.Reader  ;
62  
63  import org.enhydra.apache.xerces.framework.XMLErrorReporter;
64  import org.enhydra.apache.xerces.utils.StringPool;
65  import org.xml.sax.InputSource  ;
66  
67  /**
68   * This is the factory interface used to create readers.
69   *
70   * @version
71   */
72  public interface XMLEntityReaderFactory {
73      /**
74       * Adds a recognizer.
75       *
76       * @param recognizer The XML recognizer to add.
77       */
78      public void addRecognizer(XMLDeclRecognizer recognizer);
79  
80      /**
81       * Set char data processing preference.
82       */
83      public void setSendCharDataAsCharArray(boolean flag);
84  
85      /**
86       *
87       */
88      public void setAllowJavaEncodingName(boolean flag);
89  
90      /**
91       *
92       */
93      public boolean getAllowJavaEncodingName();
94  
95      /**
96       * Create an entity reader for the source.
97       *
98       * @param source The input source.
99       * @param systemId The system identifier for the input.
100      * @param xmlDecl <code>true</code> if an XMLDecl may be present; otherwise
101      *                <code>false</code> if a TextDecl may be present.
102      * @param stringPool The string pool.
103      * @return The reader that will process the source.
104      * @exception java.lang.Exception
105      */
106     public XMLEntityHandler.EntityReader createReader(XMLEntityHandler entityHandler,
107                                                       XMLErrorReporter errorReporter,
108                                                       InputSource   source,
109                                                       String   systemId,
110                                                       boolean xmlDecl,
111                                                       StringPool stringPool) throws Exception  ;
112 
113     /**
114      * Create an entity reader for a character stream.
115      *
116      * @param enityHandler The entity handler.
117      * @param errorReporter The error reporter.
118      * @param sendCharDataAsCharArray true if char data should be reported using
119      *                                char arrays instead of string handles.
120      * @param reader The character stream.
121      * @param stringPool The string pool.
122      * @return The reader that will process the character data.
123      * @exception java.lang.Exception
124      */
125     public XMLEntityHandler.EntityReader createCharReader(XMLEntityHandler entityHandler,
126                                                           XMLErrorReporter errorReporter,
127                                                           boolean sendCharDataAsCharArray,
128                                                           Reader   reader,
129                                                           StringPool stringPool) throws Exception  ;
130 
131     /**
132      * Create an entity reader for a byte stream encoded in UTF-8.
133      *
134      * @param enityHandler The entity handler.
135      * @param errorReporter The error reporter.
136      * @param sendCharDataAsCharArray true if char data should be reported using
137      *                                char arrays instead of string handles.
138      * @param data The byte stream.
139      * @param stringPool The string pool.
140      * @return The reader that will process the UTF-8 data.
141      * @exception java.lang.Exception
142      */
143     public XMLEntityHandler.EntityReader createUTF8Reader(XMLEntityHandler entityHandler,
144                                                           XMLErrorReporter errorReporter,
145                                                           boolean sendCharDataAsCharArray,
146                                                           InputStream   data,
147                                                           StringPool stringPool) throws Exception  ;
148 
149     /**
150      * Create an entity reader for data from a String.
151      *
152      * @param entityHandler The current entity handler.
153      * @param errorReporter The current error reporter.
154      * @param sendCharDataAsCharArray true if char data should be reported using
155      *                                char arrays instead of string handles.
156      * @param lineNumber The line number to return as our position.
157      * @param columnNumber The column number to return as our position.
158      * @param stringHandle The StringPool handle for the data to process.
159      * @param stringPool The string pool.
160      * @param addEnclosingSpaces If true, treat the data to process as if
161      *                           there were a leading and trailing space
162      *                           character enclosing the string data.
163      * @return The reader that will process the string data.
164      * @exception java.lang.Exception
165      */
166     public XMLEntityHandler.EntityReader createStringReader(XMLEntityHandler entityHandler,
167                                                             XMLErrorReporter errorReporter,
168                                                             boolean sendCharDataAsCharArray,
169                                                             int lineNumber,
170                                                             int columnNumber,
171                                                             int stringHandle,
172                                                             StringPool stringPool,
173                                                             boolean addEnclosingSpaces) throws Exception  ;
174 }
175
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags