KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > xs > XSLoader


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2003 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) 2003, 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.xs;
59
60 import org.w3c.dom.DOMConfiguration JavaDoc;
61 import org.w3c.dom.ls.LSInput JavaDoc;
62
63 /**
64  * An interface that provides a method to load XML Schema documents. This
65  * interface uses the DOM Level 3 Core and Load and Save interfaces.
66  */
67 public interface XSLoader {
68     /**
69      * The configuration of a document. It maintains a table of recognized
70      * parameters. Using the configuration, it is possible to change the
71      * behavior of the load methods. The configuration may support the
72      * setting of and the retrieval of the following non-boolean parameters
73      * defined on the <code>DOMConfiguration</code> interface:
74      * <code>error-handler</code> (<code>DOMErrorHandler</code>) and
75      * <code>resource-resolver</code> (<code>LSResourceResolver</code>).
76      * <br> The following list of boolean parameters is defined:
77      * <dl>
78      * <dt>
79      * <code>"validate"</code></dt>
80      * <dd>
81      * <dl>
82      * <dt><code>true</code></dt>
83      * <dd>[required] (default) Validate an XML
84      * Schema during loading. If validation errors are found, the error
85      * handler is notified. </dd>
86      * <dt><code>false</code></dt>
87      * <dd>[optional] Do not
88      * report errors during the loading of an XML Schema document. </dd>
89      * </dl></dd>
90      * </dl>
91      */
92     public DOMConfiguration JavaDoc getConfig();
93
94     /**
95      * Parses the content of XML Schema documents specified as the list of URI
96      * references. If the URI contains a fragment identifier, the behavior
97      * is not defined by this specification.
98      * @param uri The list of URI locations.
99      * @return An XSModel representing the schema documents.
100      */
101     public XSModel loadURIList(StringList uriList);
102
103     /**
104      * Parses the content of XML Schema documents specified as a list of
105      * <code>LSInput</code>s.
106      * @param is The list of <code>LSInput</code>s from which the XML
107      * Schema documents are to be read.
108      * @return An XSModel representing schema documents.
109      */
110     public XSModel loadInputList(LSInputList is);
111
112     /**
113      * Parse an XML Schema document from a location identified by a URI
114      * reference. If the URI contains a fragment identifier, the behavior is
115      * not defined by this specification.
116      * @param uri The location of the XML Schema document to be read.
117      * @return An XSModel representing this schema.
118      */
119     public XSModel loadURI(String JavaDoc uri);
120
121     /**
122      * Parse an XML Schema document from a resource identified by a
123      * <code>LSInput</code> .
124      * @param is The <code>DOMInputSource</code> from which the source
125      * document is to be read.
126      * @return An XSModel representing this schema.
127      */
128     public XSModel load(LSInput JavaDoc is);
129
130 }
131
Popular Tags