KickJava   Java API By Example, From Geeks To Geeks.

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


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  * This interface represents a complex or simple type definition.
62  * The interface may be updated or replaced.
63  */
64 public interface XSTypeDefinition extends XSObject {
65     /**
66      * This constant value signifies a complex type.
67      */
68     public static final short COMPLEX_TYPE = 13;
69     /**
70      * This constant value signifies a simple type.
71      */
72     public static final short SIMPLE_TYPE = 14;
73     /**
74      * Return whether this type definition is a simple type or complex type.
75      */
76     public short getTypeCategory();
77
78     /**
79      * {base type definition}: either a simple type definition or a complex
80      * type definition.
81      */
82     public XSTypeDefinition getBaseType();
83
84     /**
85      * {final}. For complex type definition it is a subset of {extension,
86      * restriction}. For simple type definition it is a subset of
87      * {extension, list, restriction, union}.
88      * @param restriction Extension, restriction, list, union constants
89      * (defined in <code>XSConstants</code>).
90      * @return True if restriction is in the final set, otherwise false.
91      */
92     public boolean isFinal(short restriction);
93
94     /**
95      * For complex types the returned value is a bit combination of the subset
96      * of {<code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>}
97      * corresponding to <code>final</code> set of this type or
98      * <code>DERIVATION_NONE</code>. For simple types the returned value is
99      * a bit combination of the subset of {
100      * <code>DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST</code>
101      * } corresponding to <code>final</code> set of this type or
102      * <code>DERIVATION_NONE</code>.
103      */
104     public short getFinal();
105
106     /**
107      * Convenience. A boolean that specifies if the type definition is
108      * anonymous. Convenience attribute.
109      */
110     public boolean getAnonymous();
111
112     /**
113      * Convenience method: check if this type is derived from the given
114      * <code>ancestorType</code>.
115      * @param ancestorType An ancestor type definition.
116      * @param derivationMethod A bit combination representing a subset of {
117      * <code>DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST</code>
118      * }.
119      * @return Return true if this type is derived from
120      * <code>ancestorType</code> using only derivation methods from the
121      * <code>derivationMethod</code>. Return true if this type is derived
122      * from <code>ancestorType</code>.
123      */
124     public boolean derivedFromType(XSTypeDefinition ancestorType,
125                                    short derivationMethod);
126
127     /**
128      * Convenience method: check if this type is derived from the given
129      * ancestor type.
130      * @param namespace An ancestor type namespace.
131      * @param name An ancestor type name.
132      * @param derivationMethod A bit combination representing a subset of {
133      * <code>DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST</code>
134      * }.
135      * @return Return true if this type is derived from
136      * <code>ancestorType</code> using only derivation methods from the
137      * <code>derivationMethod</code>. Return true if this type is derived
138      * from <code>ancestorType</code>.
139      */
140     public boolean derivedFrom(String JavaDoc namespace,
141                                String JavaDoc name,
142                                short derivationMethod);
143
144 }
145
Popular Tags