KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > impl > xs > psvi > XSNamespaceItem


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001, 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) 2001, 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.impl.xs.psvi;
59
60 /**
61  * The interfaces represents the namespace schema information information
62  * item. Each namespace schema information information item corresponds to
63  * an XML Schema with unique namespace name.
64  * The interface may be updated or replaced.
65  */
66 public interface XSNamespaceItem {
67     /**
68      * [schema namespace]: A namespace name or <code>null</code>.
69      */
70     public String JavaDoc getSchemaNamespace();
71
72     /**
73      * [schema components]: a list of top-level components, i.e. element
74      * declarations, attribute declarations, etc.
75      * @param objectType The type of the declaration, i.e.
76      * <code>ELEMENT_DECLARATION</code>. Note that
77      * <code>XSTypeDefinition.SIMPLE_TYPE</code> and
78      * <code>XSTypeDefinition.COMPLEX_TYPE</code> can also be used as the
79      * <code>objectType</code> to retrieve only complex types or simple
80      * types, instead of all types.
81      * @return A list of top-level definition of the specified type in
82      * <code>objectType</code> or <code>null</code>.
83      */
84     public XSNamedMap getComponents(short objectType);
85
86     /**
87      * [annotations]: a set of annotations.
88      */
89     public XSObjectList getAnnotations();
90
91     /**
92      * Convenience method. Returns a top-level element declaration.
93      * @param name The name of the declaration.
94      * @return A top-level element declaration or <code>null</code> if such
95      * declaration does not exist.
96      */
97     public XSElementDeclaration getElementDeclaration(String JavaDoc name);
98
99     /**
100      * Convenience method. Returns a top-level attribute declaration.
101      * @param name The name of the declaration.
102      * @return A top-level attribute declaration or <code>null</code> if such
103      * declaration does not exist.
104      */
105     public XSAttributeDeclaration getAttributeDeclaration(String JavaDoc name);
106
107     /**
108      * Convenience method. Returns a top-level simple or complex type
109      * definition.
110      * @param name The name of the definition.
111      * @return An <code>XSTypeDefinition</code> or <code>null</code> if such
112      * definition does not exist.
113      */
114     public XSTypeDefinition getTypeDefinition(String JavaDoc name);
115
116     /**
117      * Convenience method. Returns a top-level attribute group definition.
118      * @param name The name of the definition.
119      * @return A top-level attribute group definition or <code>null</code> if
120      * such definition does not exist.
121      */
122     public XSAttributeGroupDefinition getAttributeGroup(String JavaDoc name);
123
124     /**
125      * Convenience method. Returns a top-level model group definition.
126      * @param name The name of the definition.
127      * @return A top-level model group definition definition or
128      * <code>null</code> if such definition does not exist.
129      */
130     public XSModelGroupDefinition getModelGroupDefinition(String JavaDoc name);
131
132     /**
133      * Convenience method. Returns a top-level notation declaration.
134      * @param name The name of the declaration.
135      * @return A top-level notation declaration or <code>null</code> if such
136      * declaration does not exist.
137      */
138     public XSNotationDeclaration getNotationDeclaration(String JavaDoc name);
139
140     /**
141      * [document location] - a list of locations URI for the documents that
142      * contributed to the XSModel.
143      */
144     public StringList getDocumentLocations();
145
146 }
147
Popular Tags