KickJava   Java API By Example, From Geeks To Geeks.

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


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 Element Declaration schema component.
62  * The interface may be updated or replaced.
63  */
64 public interface XSElementDeclaration extends XSTerm {
65     /**
66      * [type definition]: either a simple type definition or a complex type
67      * definition.
68      */
69     public XSTypeDefinition getTypeDefinition();
70
71     /**
72      * Optional. One of <code>SCOPE_GLOBAL</code>, <code>SCOPE_LOCAL</code>,
73      * or <code>SCOPE_ABSENT</code>. If the scope is local, then the
74      * <code>enclosingCTDefinition</code> is present.
75      */
76     public short getScope();
77
78     /**
79      * The complex type definition for locally scoped declarations (see
80      * <code>scope</code>).
81      */
82     public XSComplexTypeDefinition getEnclosingCTDefinition();
83
84     /**
85      * [Value constraint]: one of <code>VC_NONE, VC_DEFAULT, VC_FIXED</code>.
86      */
87     public short getConstraintType();
88
89     /**
90      * [Value constraint]: the actual value with respect to the [type
91      * definition].
92      */
93     public String JavaDoc getConstraintValue();
94
95     /**
96      * If nillable is true, then an element may also be valid if it carries
97      * the namespace qualified attribute with local name <code>nil</code>
98      * from namespace <code>http://www.w3.org/2001/XMLSchema-instance</code>
99      * and value <code>true</code> (xsi:nil) even if it has no text or
100      * element content despite a <code>content type</code> which would
101      * otherwise require content.
102      */
103     public boolean getNillable();
104
105     /**
106      * identity-constraint definitions: a set of constraint definitions.
107      */
108     public XSNamedMap getIdentityConstraints();
109
110     /**
111      * [substitution group affiliation]: optional. A top-level element
112      * definition.
113      */
114     public XSElementDeclaration getSubstitutionGroupAffiliation();
115
116     /**
117      * Convenience method. Check if <code>exclusion</code> is a substitution
118      * group exclusion for this element declaration.
119      * @param exclusion
120      * <code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code> or
121      * <code>DERIVATION_NONE</code>. Represents final set for the element.
122      * @return True if <code>exclusion</code> is a part of the substitution
123      * group exclusion subset.
124      */
125     public boolean isSubstitutionGroupExclusion(short exclusion);
126
127     /**
128      * [substitution group exclusions]: the returned value is a bit
129      * combination of the subset of {
130      * <code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>} or
131      * <code>DERIVATION_NONE</code>.
132      */
133     public short getSubstitutionGroupExclusions();
134
135     /**
136      * Convenience method. Check if <code>disallowed</code> is a disallowed
137      * substitution for this element declaration.
138      * @param disallowed {
139      * <code>DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>
140      * } or <code>DERIVATION_NONE</code>. Represents a block set for the
141      * element.
142      * @return True if <code>disallowed</code> is a part of the substitution
143      * group exclusion subset.
144      */
145     public boolean isDisallowedSubstitution(short disallowed);
146
147     /**
148      * [disallowed substitutions]: the returned value is a bit combination of
149      * the subset of {
150      * <code>DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>
151      * } corresponding to substitutions disallowed by this
152      * <code>XSElementDeclaration</code> or <code>DERIVATION_NONE</code>.
153      */
154     public short getDisallowedSubstitutions();
155
156     /**
157      * {abstract} A boolean.
158      */
159     public boolean getAbstract();
160
161     /**
162      * Optional. Annotation.
163      */
164     public XSAnnotation getAnnotation();
165
166 }
167
Popular Tags