← Back to branch summary

~ubuntu-branches/ubuntu/karmic/libxerces2-java/karmic

« back to all changes in this revision

Viewing changes to samples/dom/ParserWrapper.java

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Gybas
  • Date: 2004-06-06 18:00:26 UTC
  • Revision ID: james.westby@ubuntu.com-20040606180026-a3vh56uc95hjbyfh
Tags: upstream-2.6.2
Import upstream version 2.6.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
samples/dom/ParserWrapper.java
 
1
/*
 
2
 * The Apache Software License, Version 1.1
 
3
 *
 
4
 *
 
5
 * Copyright (c) 1999-2002 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 dom;
 
59
 
 
60
import org.w3c.dom.Document;
 
61
import org.w3c.dom.Text;
 
62
 
 
63
import org.xml.sax.SAXNotRecognizedException;
 
64
import org.xml.sax.SAXNotSupportedException;
 
65
 
 
66
/**
 
67
 * Encapsulates a DOM parser.
 
68
 *
 
69
 * @version $Id: ParserWrapper.java,v 1.3 2002/01/29 01:15:05 lehors Exp $
 
70
 */
 
71
public interface ParserWrapper {
 
72
 
 
73
    //
 
74
    // ParserWrapper methods
 
75
    //
 
76
 
 
77
    /** Parses the specified URI and returns the document. */
 
78
    public Document parse(String uri) throws Exception;
 
79
 
 
80
    /**
 
81
     * Set the state of a feature.
 
82
     *
 
83
     * Set the state of any feature in a SAX2 parser.  The parser
 
84
     * might not recognize the feature, and if it does recognize
 
85
     * it, it might not be able to fulfill the request.
 
86
     *
 
87
     * @param featureId The unique identifier (URI) of the feature.
 
88
     * @param state The requested state of the feature (true or false).
 
89
     *
 
90
     * @exception org.xml.sax.SAXNotRecognizedException If the
 
91
     *            requested feature is not known.
 
92
     * @exception org.xml.sax.SAXNotSupportedException If the
 
93
     *            requested feature is known, but the requested
 
94
     *            state is not supported.
 
95
     * @exception org.xml.sax.SAXException If there is any other
 
96
     *            problem fulfilling the request.
 
97
     */
 
98
    public void setFeature(String featureId, boolean state)
 
99
        throws  SAXNotRecognizedException, SAXNotSupportedException; 
 
100
 
 
101
    /** Returns the document information. */
 
102
    public DocumentInfo getDocumentInfo();
 
103
 
 
104
    //
 
105
    // Interfaces
 
106
    //
 
107
 
 
108
    /**
 
109
     * This interface is here to query information about the document
 
110
     * implementation returned by the <code>ParserWrapper#parse</code>
 
111
     * method.
 
112
     *
 
113
     * @author Andy Clark, IBM
 
114
     */
 
115
    public interface DocumentInfo {
 
116
 
 
117
        //
 
118
        // DocumentInfo methods
 
119
        //
 
120
 
 
121
        /** 
 
122
         * Returns true if the specified text node is ignorable whitespace. 
 
123
         */
 
124
        public boolean isIgnorableWhitespace(Text text);
 
125
 
 
126
    } // interface DocumentInfo
 
127
 
 
128
} // interface ParserWrapper