KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > xerces > dom3 > as > DOMASBuilder


1 /*
2  * Copyright (c) 2001 World Wide Web Consortium,
3  * (Massachusetts Institute of Technology, Institut National de
4  * Recherche en Informatique et en Automatique, Keio University). All
5  * Rights Reserved. This program is distributed under the W3C's Software
6  * Intellectual Property License. This program is distributed in the
7  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
8  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
9  * PURPOSE.
10  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
11  */
12
13 package org.apache.xerces.dom3.as;
14
15 import org.w3c.dom.ls.LSInput JavaDoc;
16 import org.w3c.dom.ls.LSParser JavaDoc;
17
18 /**
19  * @deprecated
20  * An Abstract Schema parser interface.
21  * <p><code>DOMASBuilder</code> provides an API for parsing Abstract Schemas
22  * and building the corresponding <code>ASModel</code> tree.
23  * <p>See also the <a HREF='http://www.w3.org/TR/2001/WD-DOM-Level-3-ASLS-20011025'>Document Object Model (DOM) Level 3 Abstract Schemas and Load
24 and Save Specification</a>.
25  */
26 public interface DOMASBuilder extends LSParser JavaDoc {
27     /**
28      * Associate an <code>ASModel</code> with a <code>LSParser</code>. This
29      * <code>ASModel</code> will be used by the "
30      * <code>validate-if-schema</code>" and "
31      * <code>datatype-normalization</code>" options during the load of a new
32      * <code>Document</code>.
33      */
34     public ASModel getAbstractSchema();
35     /**
36      * Associate an <code>ASModel</code> with a <code>LSParser</code>. This
37      * <code>ASModel</code> will be used by the "
38      * <code>validate-if-schema</code>" and "
39      * <code>datatype-normalization</code>" options during the load of a new
40      * <code>Document</code>.
41      */
42     public void setAbstractSchema(ASModel abstractSchema);
43
44     /**
45      * Parse a Abstract Schema from a location identified by an URI reference.
46      * @param uri The location of the Abstract Schema to be read.
47      * @return The newly created Abstract Schema.
48      * @exception DOMASException
49      * Exceptions raised by <code>parseASURI()</code> originate with the
50      * installed ErrorHandler, and thus depend on the implementation of
51      * the <code>DOMErrorHandler</code> interfaces. The default error
52      * handlers will raise a <code>DOMASException</code> if any form of
53      * Abstract Schema inconsistencies or warning occurs during the parse,
54      * but application defined errorHandlers are not required to do so.
55      * <br> WRONG_MIME_TYPE_ERR: Raised when <code>mimeTypeCheck</code> is
56      * <code>true</code> and the input source has an incorrect MIME Type.
57      * See the attribute <code>mimeTypeCheck</code>.
58      * @exception DOMSystemException
59      * Exceptions raised by <code>parseURI()</code> originate with the
60      * installed ErrorHandler, and thus depend on the implementation of
61      * the <code>DOMErrorHandler</code> interfaces. The default error
62      * handlers will raise a DOMSystemException if any form I/O or other
63      * system error occurs during the parse, but application defined error
64      * handlers are not required to do so.
65      */
66     public ASModel parseASURI(String JavaDoc uri)
67                               throws DOMASException, Exception JavaDoc;
68
69     /**
70      * Parse a Abstract Schema from a location identified by an
71      * <code>LSInput</code>.
72      * @param is The <code>LSInput</code> from which the source
73      * Abstract Schema is to be read.
74      * @return The newly created <code>ASModel</code>.
75      * @exception DOMASException
76      * Exceptions raised by <code>parseASURI()</code> originate with the
77      * installed ErrorHandler, and thus depend on the implementation of
78      * the <code>DOMErrorHandler</code> interfaces. The default error
79      * handlers will raise a <code>DOMASException</code> if any form of
80      * Abstract Schema inconsistencies or warning occurs during the parse,
81      * but application defined errorHandlers are not required to do so.
82      * <br> Raise a WRONG_MIME_TYPE_ERR when <code>mimeTypeCheck</code> is
83      * <code>true</code> and the inputsource has an incorrect MIME Type.
84      * See attribute <code>mimeTypeCheck</code>.
85      * @exception DOMSystemException
86      * Exceptions raised by <code>parseURI()</code> originate with the
87      * installed ErrorHandler, and thus depend on the implementation of
88      * the <code>DOMErrorHandler</code> interfaces. The default error
89      * handlers will raise a DOMSystemException if any form I/O or other
90      * system error occurs during the parse, but application defined error
91      * handlers are not required to do so.
92      */
93     public ASModel parseASInputSource(LSInput JavaDoc is)
94                                       throws DOMASException, Exception JavaDoc;
95
96 }
97
Popular Tags