001: /*--
002:
003: $Id: AbstractDOMAdapter.java,v 1.1 2005/04/27 09:32:43 wittek Exp $
004:
005: Copyright (C) 2000-2004 Jason Hunter & Brett McLaughlin.
006: All rights reserved.
007:
008: Redistribution and use in source and binary forms, with or without
009: modification, are permitted provided that the following conditions
010: are met:
011:
012: 1. Redistributions of source code must retain the above copyright
013: notice, this list of conditions, and the following disclaimer.
014:
015: 2. Redistributions in binary form must reproduce the above copyright
016: notice, this list of conditions, and the disclaimer that follows
017: these conditions in the documentation and/or other materials
018: provided with the distribution.
019:
020: 3. The name "JDOM" must not be used to endorse or promote products
021: derived from this software without prior written permission. For
022: written permission, please contact <request_AT_jdom_DOT_org>.
023:
024: 4. Products derived from this software may not be called "JDOM", nor
025: may "JDOM" appear in their name, without prior written permission
026: from the JDOM Project Management <request_AT_jdom_DOT_org>.
027:
028: In addition, we request (but do not require) that you include in the
029: end-user documentation provided with the redistribution and/or in the
030: software itself an acknowledgement equivalent to the following:
031: "This product includes software developed by the
032: JDOM Project (http://www.jdom.org/)."
033: Alternatively, the acknowledgment may be graphical using the logos
034: available at http://www.jdom.org/images/logos.
035:
036: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
040: CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: SUCH DAMAGE.
048:
049: This software consists of voluntary contributions made by many
050: individuals on behalf of the JDOM Project and was originally
051: created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
052: Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
053: on the JDOM Project, please see <http://www.jdom.org/>.
054:
055: */
056:
057: package org.jdom.adapters;
058:
059: import java.io.*;
060: import java.lang.reflect.*;
061:
062: import org.jdom.*;
063: import org.w3c.dom.*;
064: import org.w3c.dom.Document;
065:
066: /**
067: * A DOMAdapter utility abstract base class.
068: *
069: * @version $Revision: 1.1 $, $Date: 2005/04/27 09:32:43 $
070: * @author Brett McLaughlin
071: * @author Jason Hunter
072: */
073: public abstract class AbstractDOMAdapter implements DOMAdapter {
074:
075: private static final String CVS_ID = "@(#) $RCSfile: AbstractDOMAdapter.java,v $ $Revision: 1.1 $ $Date: 2005/04/27 09:32:43 $ $Name: $";
076:
077: /**
078: * This creates a new <code>{@link Document}</code> from an
079: * existing <code>InputStream</code> by letting a DOM
080: * parser handle parsing using the supplied stream.
081: *
082: * @param filename file to parse.
083: * @param validate <code>boolean</code> to indicate if validation should occur.
084: * @return <code>Document</code> - instance ready for use.
085: * @throws IOException when I/O error occurs.
086: * @throws JDOMException when errors occur in parsing.
087: */
088: public Document getDocument(File filename, boolean validate)
089: throws IOException, JDOMException {
090:
091: return getDocument(new FileInputStream(filename), validate);
092: }
093:
094: /**
095: * This creates a new <code>{@link Document}</code> from an
096: * existing <code>InputStream</code> by letting a DOM
097: * parser handle parsing using the supplied stream.
098: *
099: * @param in <code>InputStream</code> to parse.
100: * @param validate <code>boolean</code> to indicate if validation should occur.
101: * @return <code>Document</code> - instance ready for use.
102: * @throws IOException when I/O error occurs.
103: * @throws JDOMException when errors occur in parsing.
104: */
105: public abstract Document getDocument(InputStream in,
106: boolean validate) throws IOException, JDOMException;
107:
108: /**
109: * This creates an empty <code>Document</code> object based
110: * on a specific parser implementation.
111: *
112: * @return <code>Document</code> - created DOM Document.
113: * @throws JDOMException when errors occur.
114: */
115: public abstract Document createDocument() throws JDOMException;
116:
117: /**
118: * This creates an empty <code>Document</code> object based
119: * on a specific parser implementation with the given DOCTYPE.
120: * If the doctype parameter is null, the behavior is the same as
121: * calling <code>createDocument()</code>.
122: *
123: * @param doctype Initial <code>DocType</code> of the document.
124: * @return <code>Document</code> - created DOM Document.
125: * @throws JDOMException when errors occur.
126: */
127: public Document createDocument(DocType doctype)
128: throws JDOMException {
129: if (doctype == null) {
130: return createDocument();
131: }
132:
133: DOMImplementation domImpl = createDocument()
134: .getImplementation();
135: DocumentType domDocType = domImpl.createDocumentType(doctype
136: .getElementName(), doctype.getPublicID(), doctype
137: .getSystemID());
138:
139: // Set the internal subset if possible
140: setInternalSubset(domDocType, doctype.getInternalSubset());
141:
142: return domImpl.createDocument("http://temporary", doctype
143: .getElementName(), domDocType);
144: }
145:
146: /**
147: * This attempts to change the DocumentType to have the given internal DTD
148: * subset value. This is not a standard ability in DOM, so it's only
149: * available with some parsers. Subclasses can alter the mechanism by
150: * which the attempt is made to set the value.
151: *
152: * @param dt DocumentType to be altered
153: * @param s String to use as the internal DTD subset
154: */
155: protected void setInternalSubset(DocumentType dt, String s) {
156: if (dt == null || s == null)
157: return;
158:
159: // Default behavior is to attempt a setInternalSubset() call using
160: // reflection. This method is not part of the DOM spec, but it's
161: // available on Xerces 1.4.4+. It's not currently in Crimson.
162: try {
163: Class dtclass = dt.getClass();
164: Method setInternalSubset = dtclass.getMethod(
165: "setInternalSubset",
166: new Class[] { java.lang.String.class });
167: setInternalSubset.invoke(dt, new Object[] { s });
168: } catch (Exception e) {
169: // ignore
170: }
171: }
172: }
|