001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 1999, 2000 The Apache Software Foundation. All rights
006: * 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 following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
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 APACHE SOFTWARE FOUNDATION OR
040: * ITS 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: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package dom;
059:
060: import org.w3c.dom.Document;
061: import org.w3c.dom.Text;
062:
063: import org.xml.sax.InputSource;
064: import org.xml.sax.SAXNotRecognizedException;
065: import org.xml.sax.SAXNotSupportedException;
066:
067: /**
068: * Encapsulates a DOM parser.
069: *
070: * @version $id$ ParserWrapper.java,v 1.3 2002/01/29 01:15:05 lehors Exp $
071: */
072:
073: public interface DOMParserWrapper {
074:
075: //
076: // DOMParserWrapper methods
077: //
078:
079: /** Parses the specified URI and returns the document. */
080: public Document parse(String uri) throws Exception;
081:
082: /** Parses the InputSource and returns the document. */
083: public Document parse(InputSource src) throws Exception;
084:
085: /**
086: * Set the state of a feature.
087: *
088: * Set the state of any feature in a SAX2 parser. The parser
089: * might not recognize the feature, and if it does recognize
090: * it, it might not be able to fulfill the request.
091: *
092: * @param featureId The unique identifier (URI) of the feature.
093: * @param state The requested state of the feature (true or false).
094: *
095: * @exception org.xml.sax.SAXNotRecognizedException If the
096: * requested feature is not known.
097: * @exception org.xml.sax.SAXNotSupportedException If the
098: * requested feature is known, but the requested
099: * state is not supported.
100: * @exception org.xml.sax.SAXException If there is any other
101: * problem fulfilling the request.
102: */
103:
104: public void setFeature(String featureId, boolean state)
105: throws SAXNotRecognizedException, SAXNotSupportedException;
106:
107: /** Returns the document information. */
108: public DocumentInfo getDocumentInfo();
109:
110: //
111: // Interfaces
112: //
113:
114: /**
115: * This interface is here to query information about the document
116: * implementation returned by the <code>ParserWrapper#parse</code>
117: * method.
118: *
119: * @author Andy Clark, IBM
120: */
121: public interface DocumentInfo {
122:
123: //
124: // DocumentInfo methods
125: //
126:
127: /**
128: * Returns true if the specified text node is ignorable whitespace.
129: */
130: public boolean isIgnorableWhitespace(Text text);
131:
132: } // interface DocumentInfo
133: } // interface DOMParserWrapper
|