001: /*
002: * $Id: DocumentBuilderImpl.java,v 1.9 2001/06/20 02:40:28 edwingo Exp $
003: *
004: * The Apache Software License, Version 1.1
005: *
006: *
007: * Copyright (c) 2000 The Apache Software Foundation. All rights
008: * reserved.
009: *
010: * Redistribution and use in source and binary forms, with or without
011: * modification, are permitted provided that the following conditions
012: * are met:
013: *
014: * 1. Redistributions of source code must retain the above copyright
015: * notice, this list of conditions and the following disclaimer.
016: *
017: * 2. Redistributions in binary form must reproduce the above copyright
018: * notice, this list of conditions and the following disclaimer in
019: * the documentation and/or other materials provided with the
020: * distribution.
021: *
022: * 3. The end-user documentation included with the redistribution,
023: * if any, must include the following acknowledgment:
024: * "This product includes software developed by the
025: * Apache Software Foundation (http://www.apache.org/)."
026: * Alternately, this acknowledgment may appear in the software itself,
027: * if and wherever such third-party acknowledgments normally appear.
028: *
029: * 4. The names "Xerces" and "Apache Software Foundation" must
030: * not be used to endorse or promote products derived from this
031: * software without prior written permission. For written
032: * permission, please contact apache@apache.org.
033: *
034: * 5. Products derived from this software may not be called "Apache",
035: * nor may "Apache" appear in their name, without prior written
036: * permission of the Apache Software Foundation.
037: *
038: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
039: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
040: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
041: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
042: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
043: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
044: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
045: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
046: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
047: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
048: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
049: * SUCH DAMAGE.
050: * ====================================================================
051: *
052: * This software consists of voluntary contributions made by many
053: * individuals on behalf of the Apache Software Foundation and was
054: * originally based on software copyright (c) 1999, Sun Microsystems, Inc.,
055: * http://www.sun.com. For more information on the Apache Software
056: * Foundation, please see <http://www.apache.org/>.
057: */
058:
059: package org.apache.xerces.jaxp;
060:
061: import java.util.Hashtable;
062: import java.util.Enumeration;
063: import java.io.IOException;
064:
065: import javax.xml.parsers.DocumentBuilder;
066: import javax.xml.parsers.DocumentBuilderFactory;
067: import javax.xml.parsers.ParserConfigurationException;
068:
069: import org.w3c.dom.Document;
070: import org.w3c.dom.DOMImplementation;
071: import org.w3c.dom.DocumentType;
072:
073: import org.xml.sax.XMLReader;
074: import org.xml.sax.InputSource;
075: import org.xml.sax.SAXException;
076: import org.xml.sax.SAXParseException;
077: import org.xml.sax.SAXNotRecognizedException;
078: import org.xml.sax.SAXNotSupportedException;
079: import org.xml.sax.EntityResolver;
080: import org.xml.sax.ErrorHandler;
081: import org.xml.sax.helpers.DefaultHandler;
082:
083: import org.apache.xerces.parsers.DOMParser;
084: import org.apache.xerces.dom.DOMImplementationImpl;
085:
086: /**
087: * @author Rajiv Mordani
088: * @author Edwin Goei
089: * @version $Revision: 1.9 $
090: */
091: public class DocumentBuilderImpl extends DocumentBuilder {
092: /** Xerces features */
093: static final String XERCES_FEATURE_PREFIX = "http://apache.org/xml/features/";
094: static final String CREATE_ENTITY_REF_NODES_FEATURE = "dom/create-entity-ref-nodes";
095: static final String INCLUDE_IGNORABLE_WHITESPACE = "dom/include-ignorable-whitespace";
096:
097: private EntityResolver er = null;
098: private ErrorHandler eh = null;
099: private DOMParser domParser = null;
100:
101: private boolean namespaceAware = false;
102: private boolean validating = false;
103:
104: DocumentBuilderImpl(DocumentBuilderFactory dbf, Hashtable dbfAttrs)
105: throws SAXNotRecognizedException, SAXNotSupportedException {
106: domParser = new DOMParser();
107:
108: // Validation
109: validating = dbf.isValidating();
110: String validation = "http://xml.org/sax/features/validation";
111: domParser.setFeature(validation, validating);
112:
113: // If validating, provide a default ErrorHandler that prints
114: // validation errors with a warning telling the user to set an
115: // ErrorHandler
116: if (validating) {
117: setErrorHandler(new DefaultValidationErrorHandler());
118: }
119:
120: // "namespaceAware" == SAX Namespaces feature
121: namespaceAware = dbf.isNamespaceAware();
122: domParser.setFeature("http://xml.org/sax/features/namespaces",
123: namespaceAware);
124:
125: // Set various parameters obtained from DocumentBuilderFactory
126: domParser.setFeature(XERCES_FEATURE_PREFIX
127: + INCLUDE_IGNORABLE_WHITESPACE, !dbf
128: .isIgnoringElementContentWhitespace());
129: domParser.setFeature(XERCES_FEATURE_PREFIX
130: + CREATE_ENTITY_REF_NODES_FEATURE, !dbf
131: .isExpandEntityReferences());
132:
133: // XXX No way to control dbf.isIgnoringComments() or
134: // dbf.isCoalescing()
135:
136: setDocumentBuilderFactoryAttributes(dbfAttrs);
137: }
138:
139: /**
140: * Set any DocumentBuilderFactory attributes of our underlying DOMParser
141: *
142: * Note: code does not handle possible conflicts between DOMParser
143: * attribute names and JAXP specific attribute names,
144: * eg. DocumentBuilderFactory.setValidating()
145: */
146: private void setDocumentBuilderFactoryAttributes(Hashtable dbfAttrs)
147: throws SAXNotSupportedException, SAXNotRecognizedException {
148: if (dbfAttrs != null) {
149: for (Enumeration e = dbfAttrs.keys(); e.hasMoreElements();) {
150: String name = (String) e.nextElement();
151: Object val = dbfAttrs.get(name);
152: if (val instanceof Boolean) {
153: // Assume feature
154: domParser.setFeature(name, ((Boolean) val)
155: .booleanValue());
156: } else {
157: // Assume property
158: domParser.setProperty(name, val);
159: }
160: }
161: }
162: }
163:
164: /**
165: * Non-preferred: use the getDOMImplementation() method instead of this
166: * one to get a DOM Level 2 DOMImplementation object and then use DOM
167: * Level 2 methods to create a DOM Document object.
168: */
169: public Document newDocument() {
170: return new org.apache.xerces.dom.DocumentImpl();
171: }
172:
173: public DOMImplementation getDOMImplementation() {
174: return DOMImplementationImpl.getDOMImplementation();
175: }
176:
177: public Document parse(InputSource is) throws SAXException,
178: IOException {
179: if (is == null) {
180: throw new IllegalArgumentException(
181: "InputSource cannot be null");
182: }
183:
184: if (er != null) {
185: domParser.setEntityResolver(er);
186: }
187:
188: if (eh != null) {
189: domParser.setErrorHandler(eh);
190: }
191:
192: domParser.parse(is);
193: return domParser.getDocument();
194: }
195:
196: public boolean isNamespaceAware() {
197: return namespaceAware;
198: }
199:
200: public boolean isValidating() {
201: return validating;
202: }
203:
204: public void setEntityResolver(org.xml.sax.EntityResolver er) {
205: this .er = er;
206: }
207:
208: public void setErrorHandler(org.xml.sax.ErrorHandler eh) {
209: // If app passes in a ErrorHandler of null, then ignore all errors
210: // and warnings
211: this .eh = (eh == null) ? new DefaultHandler() : eh;
212: }
213:
214: // package private
215: DOMParser getDOMParser() {
216: return domParser;
217: }
218: }
|