KickJava   Java API By Example, From Geeks To Geeks.

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


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 /**
61  * This interface represents an XML Schema.
62  */
63 public interface XSModel {
64     /**
65      * Convenience method. Returns a list of all namespaces that belong to
66      * this schema. The value <code>null</code> is not a valid namespace
67      * name, but if there are components that do not have a target namespace
68      * , <code>null</code> is included in this list.
69      */
70     public StringList getNamespaces();
71
72     /**
73      * A set of namespace schema information information items (of type
74      * <code>XSNamespaceItem</code>), one for each namespace name which
75      * appears as the target namespace of any schema component in the schema
76      * used for that assessment, and one for absent if any schema component
77      * in the schema had no target namespace. For more information see
78      * schema information.
79      */
80     public XSNamespaceItemList getNamespaceItems();
81
82     /**
83      * Returns a list of top-level components, i.e. element declarations,
84      * attribute declarations, etc.
85      * @param objectType The type of the declaration, i.e.
86      * <code>ELEMENT_DECLARATION</code>. Note that
87      * <code>XSTypeDefinition.SIMPLE_TYPE</code> and
88      * <code>XSTypeDefinition.COMPLEX_TYPE</code> can also be used as the
89      * <code>objectType</code> to retrieve only complex types or simple
90      * types, instead of all types.
91      * @return A list of top-level definitions of the specified type in
92      * <code>objectType</code> or an empty <code>XSNamedMap</code> if no
93      * such definitions exist.
94      */
95     public XSNamedMap getComponents(short objectType);
96
97     /**
98      * Convenience method. Returns a list of top-level component declarations
99      * that are defined within the specified namespace, i.e. element
100      * declarations, attribute declarations, etc.
101      * @param objectType The type of the declaration, i.e.
102      * <code>ELEMENT_DECLARATION</code>.
103      * @param namespace The namespace to which the declaration belongs or
104      * <code>null</code> (for components with no target namespace).
105      * @return A list of top-level definitions of the specified type in
106      * <code>objectType</code> and defined in the specified
107      * <code>namespace</code> or an empty <code>XSNamedMap</code>.
108      */
109     public XSNamedMap getComponentsByNamespace(short objectType,
110                                                String JavaDoc namespace);
111
112     /**
113      * [annotations]: a set of annotations if it exists, otherwise an empty
114      * <code>XSObjectList</code>.
115      */
116     public XSObjectList getAnnotations();
117
118     /**
119      * Convenience method. Returns a top-level element declaration.
120      * @param namespace The namespace of the declaration, otherwise
121      * <code>null</code>.
122      * @param name The name of the declaration.
123      * @return A top-level element declaration or <code>null</code> if such a
124      * declaration does not exist.
125      */
126     public XSElementDeclaration getElementDeclaration(String JavaDoc namespace,
127                                                       String JavaDoc name);
128
129     /**
130      * Convenience method. Returns a top-level attribute declaration.
131      * @param namespace The namespace of the declaration, otherwise
132      * <code>null</code>.
133      * @param name The name of the declaration.
134      * @return A top-level attribute declaration or <code>null</code> if such
135      * a declaration does not exist.
136      */
137     public XSAttributeDeclaration getAttributeDeclaration(String JavaDoc namespace,
138                                                           String JavaDoc name);
139
140     /**
141      * Convenience method. Returns a top-level simple or complex type
142      * definition.
143      * @param namespace The namespace of the declaration, otherwise
144      * <code>null</code>.
145      * @param name The name of the definition.
146      * @return An <code>XSTypeDefinition</code> or <code>null</code> if such
147      * a definition does not exist.
148      */
149     public XSTypeDefinition getTypeDefinition(String JavaDoc namespace,
150                                               String JavaDoc name);
151
152     /**
153      * Convenience method. Returns a top-level attribute group definition.
154      * @param namespace The namespace of the definition, otherwise
155      * <code>null</code>.
156      * @param name The name of the definition.
157      * @return A top-level attribute group definition or <code>null</code> if
158      * such a definition does not exist.
159      */
160     public XSAttributeGroupDefinition getAttributeGroup(String JavaDoc namespace,
161                                                         String JavaDoc name);
162
163     /**
164      * Convenience method. Returns a top-level model group definition.
165      * @param namespace The namespace of the definition, otherwise
166      * <code>null</code>.
167      * @param name The name of the definition.
168      * @return A top-level model group definition or <code>null</code> if
169      * such a definition does not exist.
170      */
171     public XSModelGroupDefinition getModelGroupDefinition(String JavaDoc namespace,
172                                                           String JavaDoc name);
173
174     /**
175      * Convenience method. Returns a top-level notation declaration.
176      * @param namespace The namespace of the declaration, otherwise
177      * <code>null</code>.
178      * @param name The name of the declaration.
179      * @return A top-level notation declaration or <code>null</code> if such
180      * a declaration does not exist.
181      */
182     public XSNotationDeclaration getNotationDeclaration(String JavaDoc namespace,
183                                                         String JavaDoc name);
184
185 }
186
Popular Tags