KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > parsers > XMLParser


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999-2003 The Apache Software Foundation.
6  * All rights 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 com.sun.org.apache.xerces.internal.parsers;
59
60 import java.io.IOException JavaDoc;
61
62 import com.sun.org.apache.xerces.internal.impl.Constants;
63 import com.sun.org.apache.xerces.internal.xni.XNIException;
64 import com.sun.org.apache.xerces.internal.xni.parser.XMLInputSource;
65 import com.sun.org.apache.xerces.internal.xni.parser.XMLParserConfiguration;
66
67 /**
68  * Base class of all XML-related parsers.
69  * <p>
70  * In addition to the features and properties recognized by the parser
71  * configuration, this parser recognizes these additional features and
72  * properties:
73  * <ul>
74  * <li>Properties
75  * <ul>
76  * <li>http://apache.org/xml/properties/internal/error-handler</li>
77  * <li>http://apache.org/xml/properties/internal/entity-resolver</li>
78  * </ul>
79  * </ul>
80  *
81  * @author Arnaud Le Hors, IBM
82  * @author Andy Clark, IBM
83  *
84  * @version $Id: XMLParser.java,v 1.9 2003/05/08 20:11:59 elena Exp $
85  */
86 public abstract class XMLParser {
87
88     //
89 // Constants
90 //
91
92     // properties
93
94     /** Property identifier: entity resolver. */
95     protected static final String JavaDoc ENTITY_RESOLVER =
96         Constants.XERCES_PROPERTY_PREFIX + Constants.ENTITY_RESOLVER_PROPERTY;
97
98     /** Property identifier: error handler. */
99     protected static final String JavaDoc ERROR_HANDLER =
100         Constants.XERCES_PROPERTY_PREFIX + Constants.ERROR_HANDLER_PROPERTY;
101
102     /** Recognized properties. */
103     private static final String JavaDoc[] RECOGNIZED_PROPERTIES = {
104         ENTITY_RESOLVER,
105         ERROR_HANDLER,
106     };
107
108     //
109 // Data
110 //
111
112     /** The parser configuration. */
113     protected XMLParserConfiguration fConfiguration;
114
115     //
116 // Constructors
117 //
118
119     /**
120      * Default Constructor.
121      */
122     protected XMLParser(XMLParserConfiguration config) {
123
124         // save configuration
125 fConfiguration = config;
126
127         // add default recognized properties
128 fConfiguration.addRecognizedProperties(RECOGNIZED_PROPERTIES);
129
130     } // <init>(XMLParserConfiguration)
131
132     //
133 // Public methods
134 //
135
136     /**
137      * parse
138      *
139      * @param inputSource
140      *
141      * @exception XNIException
142      * @exception java.io.IOException
143      */
144     public void parse(XMLInputSource inputSource)
145         throws XNIException, IOException JavaDoc {
146
147         reset();
148         fConfiguration.parse(inputSource);
149
150     } // parse(XMLInputSource)
151
152     //
153 // Protected methods
154 //
155
156     /**
157      * reset all components before parsing
158      */
159     protected void reset() throws XNIException {
160     } // reset()
161
162 } // class XMLParser
163
Popular Tags