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. package com.sun.org.apache.xerces.internal.xs;
  58. /**
  59. * The interface represents the Element Declaration schema component.
  60. */
  61. public interface XSElementDeclaration extends XSTerm {
  62. /**
  63. * [type definition]: either a simple type definition or a complex type
  64. * definition.
  65. */
  66. public XSTypeDefinition getTypeDefinition();
  67. /**
  68. * [scope]. One of <code>SCOPE_GLOBAL</code>, <code>SCOPE_LOCAL</code>, or
  69. * <code>SCOPE_ABSENT</code>. If the scope is local, then the
  70. * <code>enclosingCTDefinition</code> is present.
  71. */
  72. public short getScope();
  73. /**
  74. * The complex type definition for locally scoped declarations (see
  75. * <code>scope</code>), otherwise <code>null</code> if no such
  76. * definition exists.
  77. */
  78. public XSComplexTypeDefinition getEnclosingCTDefinition();
  79. /**
  80. * [Value constraint]: one of <code>VC_NONE, VC_DEFAULT, VC_FIXED</code>.
  81. */
  82. public short getConstraintType();
  83. /**
  84. * [Value constraint]: the constraint value with respect to the [type
  85. * definition], otherwise <code>null</code>.
  86. */
  87. public String getConstraintValue();
  88. /**
  89. * Value Constraint: Binding specific actual constraint value or
  90. * <code>null</code> if the value is in error or there is no value
  91. * constraint.
  92. * @exception XSException
  93. * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
  94. * method.
  95. */
  96. public Object getActualVC()
  97. throws XSException;
  98. /**
  99. * The actual constraint value built-in datatype, e.g.
  100. * <code>STRING_DT, SHORT_DT</code>. If the type definition of this
  101. * value is a list type definition, this method returns
  102. * <code>LIST_DT</code>. If the type definition of this value is a list
  103. * type definition whose item type is a union type definition, this
  104. * method returns <code>LISTOFUNION_DT</code>. To query the actual
  105. * constraint value of the list or list of union type definitions use
  106. * <code>itemValueTypes</code>. If the <code>actualNormalizedValue</code>
  107. * is <code>null</code>, this method returns <code>UNAVAILABLE_DT</code>
  108. * .
  109. * @exception XSException
  110. * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
  111. * method.
  112. */
  113. public short getActualVCType()
  114. throws XSException;
  115. /**
  116. * In the case the actual constraint value represents a list, i.e. the
  117. * <code>actualValueType</code> is <code>LIST_DT</code>, the returned
  118. * array consists of one type kind which represents the itemType. If the
  119. * actual constraint value represents a list type definition whose item
  120. * type is a union type definition, i.e. <code>LISTOFUNION_DT</code>,
  121. * for each actual constraint value in the list the array contains the
  122. * corresponding memberType kind. For examples, see
  123. * <code>ItemPSVI.itemValueTypes</code>.
  124. * @exception XSException
  125. * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
  126. * method.
  127. */
  128. public ShortList getItemValueTypes()
  129. throws XSException;
  130. /**
  131. * If nillable is true, then an element may also be valid if it carries
  132. * the namespace qualified attribute with local name <code>nil</code>
  133. * from namespace <code>http://www.w3.org/2001/XMLSchema-instance</code>
  134. * and value <code>true</code> (xsi:nil) even if it has no text or
  135. * element content despite a <code>content type</code> which would
  136. * otherwise require content.
  137. */
  138. public boolean getNillable();
  139. /**
  140. * identity-constraint definitions: a set of constraint definitions if it
  141. * exists, otherwise an empty <code>XSNamedMap</code>.
  142. */
  143. public XSNamedMap getIdentityConstraints();
  144. /**
  145. * [substitution group affiliation]: a top-level element definition if it
  146. * exists, otherwise <code>null</code>.
  147. */
  148. public XSElementDeclaration getSubstitutionGroupAffiliation();
  149. /**
  150. * Convenience method that checks if <code>exclusion</code> is a
  151. * substitution group exclusion for this element declaration.
  152. * @param exclusion
  153. * <code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code> or
  154. * <code>DERIVATION_NONE</code>. Represents final set for the element.
  155. * @return True if <code>exclusion</code> is a part of the substitution
  156. * group exclusion subset.
  157. */
  158. public boolean isSubstitutionGroupExclusion(short exclusion);
  159. /**
  160. * [substitution group exclusions]: the returned value is a bit
  161. * combination of the subset of {
  162. * <code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>} or
  163. * <code>DERIVATION_NONE</code>.
  164. */
  165. public short getSubstitutionGroupExclusions();
  166. /**
  167. * Convenience method that checks if <code>disallowed</code> is a
  168. * disallowed substitution for this element declaration.
  169. * @param disallowed {
  170. * <code>DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>
  171. * } or <code>DERIVATION_NONE</code>. Represents a block set for the
  172. * element.
  173. * @return True if <code>disallowed</code> is a part of the substitution
  174. * group exclusion subset.
  175. */
  176. public boolean isDisallowedSubstitution(short disallowed);
  177. /**
  178. * [disallowed substitutions]: the returned value is a bit combination of
  179. * the subset of {
  180. * <code>DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>
  181. * } corresponding to substitutions disallowed by this
  182. * <code>XSElementDeclaration</code> or <code>DERIVATION_NONE</code>.
  183. */
  184. public short getDisallowedSubstitutions();
  185. /**
  186. * {abstract} A boolean.
  187. */
  188. public boolean getAbstract();
  189. /**
  190. * An annotation if it exists, otherwise <code>null</code>.
  191. */
  192. public XSAnnotation getAnnotation();
  193. }