/emf-2.8.0/org.eclipse.xsd/src/org/eclipse/xsd/XSDConcreteComponent.java

# · Java · 576 lines · 52 code · 49 blank · 475 comment · 0 complexity · 59d7a8cc5faa94ad14dfb1dadb081a79 MD5 · raw file 

    

  1. /**
    2. 

  2.  * Copyright (c) 2002-2006 IBM Corporation and others.
    3. 

  3.  * All rights reserved.   This program and the accompanying materials
    4. 

  4.  * are made available under the terms of the Eclipse Public License v1.0
    5. 

  5.  * which accompanies this distribution, and is available at
    6. 

  6.  * http://www.eclipse.org/legal/epl-v10.html
    7. 

  7.  * 
    8. 

  8.  * Contributors: 
    9. 

  9.  *   IBM - Initial API and implementation
    10. 

  10.  */
    11. 

  11. package org.eclipse.xsd;
    12. 

  12. 

  13. 

  14. import java.util.Collection;
    15. 

  15. 

  16. import org.w3c.dom.Element;
    17. 

  17. 

  18. import org.eclipse.emf.common.util.EList;
    19. 

  19. import org.eclipse.emf.ecore.EObject;
    20. 

  20. 

  21. 

  22. /**
    23. 

  23.  * <!-- begin-user-doc -->
    24. 

  24.  * A representation of the model object '<em><b>Concrete Component</b></em>'.
    25. 

  25.  * It is the root of all concrete components.
    26. 

  26.  * <!-- end-user-doc -->
    27. 

  27.  *
    28. 

  28.  * <p>
    29. 

  29.  * The following features are supported:
    30. 

  30.  * <ul>
    31. 

  31.  *   <li>{@link org.eclipse.xsd.XSDConcreteComponent#getElement <em>Element</em>}</li>
    32. 

  32.  *   <li>{@link org.eclipse.xsd.XSDConcreteComponent#getContainer <em>Container</em>}</li>
    33. 

  33.  *   <li>{@link org.eclipse.xsd.XSDConcreteComponent#getRootContainer <em>Root Container</em>}</li>
    34. 

  34.  *   <li>{@link org.eclipse.xsd.XSDConcreteComponent#getSchema <em>Schema</em>}</li>
    35. 

  35.  *   <li>{@link org.eclipse.xsd.XSDConcreteComponent#getDiagnostics <em>Diagnostics</em>}</li>
    36. 

  36.  * </ul>
    37. 

  37.  * </p>
    38. 

  38.  *
    39. 

  39.  * @see org.eclipse.xsd.XSDPackage#getXSDConcreteComponent()
    40. 

  40.  * @model abstract="true"
    41. 

  41.  * @generated
    42. 

  42.  */
    43. 

  43. public interface XSDConcreteComponent extends EObject
    44. 

  44. {
    45. 

  45.   /**
    46. 

  46.    * Returns the value of the '<em><b>Element</b></em>' attribute.
    47. 

  47.    * <!-- begin-user-doc -->
    48. 

  48.    * <p>
    49. 

  49.    * This is the underlying DOM element associated with this component, 
    50. 

  50.    * i.e., the {@link #updateElement() serialization} of this component.
    51. 

  51.    * </p>
    52. 

  52.    * <!-- end-user-doc -->
    53. 

  53.    * @return the value of the '<em>Element</em>' attribute.
    54. 

  54.    * @see #setElement(Element)
    55. 

  55.    * @see org.eclipse.xsd.XSDPackage#getXSDConcreteComponent_Element()
    56. 

  56.    * @model dataType="org.eclipse.xsd.DOMElement"
    57. 

  57.    * @generated
    58. 

  58.    */
    59. 

  59.   Element getElement();
    60. 

  60. 

  61.   /**
    62. 

  62.    * Sets the value of the '{@link org.eclipse.xsd.XSDConcreteComponent#getElement <em>Element</em>}' attribute.
    63. 

  63.    * <!-- begin-user-doc -->
    64. 

  64.    * <!-- end-user-doc -->
    65. 

  65.    * @param value the new value of the '<em>Element</em>' attribute.
    66. 

  66.    * @see #getElement()
    67. 

  67.    * @generated
    68. 

  68.    */
    69. 

  69.   void setElement(Element value);
    70. 

  70. 

  71.   /**
    72. 

  72.    * Ensures that the underlying DOM {@link #getElement element} both exists and is up-to-date with respect to the model,
    73. 

  73.    * i.e., it serializes the component and maintains an association with that serialization.
    74. 

  74.    * @see #updateElement(boolean)
    75. 

  75.    * @see #getElement
    76. 

  76.    */
    77. 

  77.   void updateElement();
    78. 

  78. 

  79.   /**
    80. 

  80.    * Ensures that the underlying DOM {@link #getElement element} both exists and is up-to-date with respect to the model,
    81. 

  81.    * i.e., it serializes the component and maintains an association with that serialization.
    82. 

  82.    * For <code>deep == true</code>, 
    83. 

  83.    * or when <code>{@link #getElement getElement()} == null</code>, 
    84. 

  84.    * this does the same thing as {@link #updateElement()};
    85. 

  85.    * otherwise, it updates just the DOM element associated with this component to reflect the current state.
    86. 

  86.    * @see #updateElement()
    87. 

  87.    * @see #getElement
    88. 

  88.    */
    89. 

  89.   void updateElement(boolean deep);
    90. 

  90. 

  91.   /**
    92. 

  92.    * Returns the value of the '<em><b>Container</b></em>' reference.
    93. 

  93.    * <!-- begin-user-doc -->
    94. 

  94.    * <p>
    95. 

  95.    * This represents the concrete container of this component, 
    96. 

  96.    * i.e., the inverse of the black diamond relations in the UML model.
    97. 

  97.    * </p>
    98. 

  98.    * <!-- end-user-doc -->
    99. 

  99.    * @return the value of the '<em>Container</em>' reference.
    100. 

  100.    * @see org.eclipse.xsd.XSDPackage#getXSDConcreteComponent_Container()
    101. 

  101.    * @model resolveProxies="false" transient="true" changeable="false" volatile="true"
    102. 

  102.    * @generated
    103. 

  103.    */
    104. 

  104.   XSDConcreteComponent getContainer();
    105. 

  105. 

  106.   /**
    107. 

  107.    * Returns the value of the '<em><b>Root Container</b></em>' reference.
    108. 

  108.    * <!-- begin-user-doc -->
    109. 

  109.    * <p>
    110. 

  110.    * This walks the {@link #getContainer() containers}
    111. 

  111.    * until it hits one that has no container.
    112. 

  112.    * </p>
    113. 

  113.    * <!-- end-user-doc -->
    114. 

  114.    * @return the value of the '<em>Root Container</em>' reference.
    115. 

  115.    * @see org.eclipse.xsd.XSDPackage#getXSDConcreteComponent_RootContainer()
    116. 

  116.    * @model resolveProxies="false" required="true" transient="true" changeable="false" volatile="true"
    117. 

  117.    * @generated
    118. 

  118.    */
    119. 

  119.   XSDConcreteComponent getRootContainer();
    120. 

  120. 

  121.   /**
    122. 

  122.    * Returns the value of the '<em><b>Schema</b></em>' reference.
    123. 

  123.    * <!-- begin-user-doc -->
    124. 

  124.    * <p>
    125. 

  125.    * This walks the {@link #getContainer() containers}
    126. 

  126.    * until it reaches a schema.
    127. 

  127.    * </p>
    128. 

  128.    * <!-- end-user-doc -->
    129. 

  129.    * @return the value of the '<em>Schema</em>' reference.
    130. 

  130.    * @see org.eclipse.xsd.XSDPackage#getXSDConcreteComponent_Schema()
    131. 

  131.    * @model resolveProxies="false" transient="true" changeable="false" volatile="true"
    132. 

  132.    * @generated
    133. 

  133.    */
    134. 

  134.   XSDSchema getSchema();
    135. 

  135. 

  136.   /**
    137. 

  137.    * Returns the value of the '<em><b>Diagnostics</b></em>' containment reference list.
    138. 

  138.    * The list contents are of type {@link org.eclipse.xsd.XSDDiagnostic}.
    139. 

  139.    * <!-- begin-user-doc -->
    140. 

  140.    * <p>
    141. 

  141.    * These diagnostics are produced by {@link #validate() validation}.
    142. 

  142.    * </p>
    143. 

  143.    * <!-- end-user-doc -->
    144. 

  144.    * @return the value of the '<em>Diagnostics</em>' containment reference list.
    145. 

  145.    * @see org.eclipse.xsd.XSDPackage#getXSDConcreteComponent_Diagnostics()
    146. 

  146.    * @model containment="true" transient="true"
    147. 

  147.    * @generated
    148. 

  148.    */
    149. 

  149.   EList<XSDDiagnostic> getDiagnostics();
    150. 

  150. 

  151.   /**
    152. 

  152.    * Called to indicate that the given element has changed;
    153. 

  153.    * the element should typically be the same as the one returned {@link #getElement}.
    154. 

  154.    * It is expected that clients will not call this themselves 
    155. 

  155.    * since the DOM event listeners attached to the underlying DOM will invoke these automatically.
    156. 

  156.    */
    157. 

  157.   void elementChanged(Element changedElement);
    158. 

  158. 

  159.   /**
    160. 

  160.    * Called to indicate that the given element has changed attributes;
    161. 

  161.    * the element should typically be the same as the one returned {@link #getElement}.
    162. 

  162.    * It is expected that clients will not call this themselves 
    163. 

  163.    * since the DOM event listeners attached to the underlying DOM will invoke these automatically.
    164. 

  164.    */
    165. 

  165.   void elementAttributesChanged(Element changedElement);
    166. 

  166. 

  167.   /**
    168. 

  168.    * Called to indicate that the given element has changed contents;
    169. 

  169.    * the element should typically be the same as the one returned {@link #getElement}.
    170. 

  170.    * It is expected that clients will not call this themselves 
    171. 

  171.    * since the DOM event listeners attached to the underlying DOM will invoke these automatically.
    172. 

  172.    */
    173. 

  173.   void elementContentsChanged(Element changedElement);
    174. 

  174. 

  175.   /**
    176. 

  176.    * Returns the resolved type definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getURI() URI}.
    177. 

  177.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    178. 

  178.    * @see #resolveTypeDefinition(java.lang.String, java.lang.String)
    179. 

  179.    * @see #resolveTypeDefinition(java.lang.String)
    180. 

  180.    * @see org.eclipse.xsd.XSDNamedComponent#getURI()
    181. 

  181.    * @param uri the URI to resolve.
    182. 

  182.    * @return the resolved type definition.
    183. 

  183.    */
    184. 

  184.   XSDTypeDefinition resolveTypeDefinitionURI(String uri);
    185. 

  185. 

  186.   /**
    187. 

  187.    * Returns the resolved type definition of the given  
    188. 

  188.    * {@link org.eclipse.xsd.XSDNamedComponent#getTargetNamespace() namespace} and {@link org.eclipse.xsd.XSDNamedComponent#getName() name}.
    189. 

  189.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    190. 

  190.    * @see #resolveTypeDefinitionURI(java.lang.String)
    191. 

  191.    * @see #resolveTypeDefinition(java.lang.String)
    192. 

  192.    * @see org.eclipse.xsd.XSDNamedComponent#getTargetNamespace()
    193. 

  193.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    194. 

  194.    * @param namespace the namespace to resolve.
    195. 

  195.    * @param localName the name to resolve.
    196. 

  196.    * @return the resolved type definition.
    197. 

  197.    */
    198. 

  198.   XSDTypeDefinition resolveTypeDefinition(String namespace, String localName);
    199. 

  199. 

  200.   /**
    201. 

  201.    * Returns the resolved type definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getName() name} 
    202. 

  202.    * within the {@link #getSchema() schema}.
    203. 

  203.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    204. 

  204.    * @see #getSchema()
    205. 

  205.    * @see org.eclipse.xsd.XSDSchema#getTargetNamespace()
    206. 

  206.    * @see #resolveTypeDefinitionURI(java.lang.String)
    207. 

  207.    * @see #resolveTypeDefinition(java.lang.String, java.lang.String)
    208. 

  208.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    209. 

  209.    * @param localName the name to resolve.
    210. 

  210.    * @return the resolved type definition.
    211. 

  211.    */
    212. 

  212.   XSDTypeDefinition resolveTypeDefinition(String localName);
    213. 

  213.   
    214. 

  214.   /**
    215. 

  215.    * Returns the resolved simple type definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getURI() URI}.
    216. 

  216.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    217. 

  217.    * @see #resolveSimpleTypeDefinition(java.lang.String, java.lang.String)
    218. 

  218.    * @see #resolveSimpleTypeDefinition(java.lang.String)
    219. 

  219.    * @see org.eclipse.xsd.XSDNamedComponent#getURI()
    220. 

  220.    * @param uri the URI to resolve.
    221. 

  221.    * @return the resolved simple type definition.
    222. 

  222.    */
    223. 

  223.   XSDSimpleTypeDefinition resolveSimpleTypeDefinitionURI(String uri);
    224. 

  224. 

  225.   /**
    226. 

  226.    * Returns the resolved simple type definition of the given  
    227. 

  227.    * {@link org.eclipse.xsd.XSDNamedComponent#getTargetNamespace() namespace} and {@link org.eclipse.xsd.XSDNamedComponent#getName() name}.
    228. 

  228.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    229. 

  229.    * @see #resolveSimpleTypeDefinitionURI(java.lang.String)
    230. 

  230.    * @see #resolveSimpleTypeDefinition(java.lang.String)
    231. 

  231.    * @see org.eclipse.xsd.XSDNamedComponent#getTargetNamespace()
    232. 

  232.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    233. 

  233.    * @param namespace the namespace to resolve.
    234. 

  234.    * @param localName the name to resolve.
    235. 

  235.    * @return the resolved simple type definition.
    236. 

  236.    */
    237. 

  237.   XSDSimpleTypeDefinition resolveSimpleTypeDefinition(String namespace, String localName);
    238. 

  238. 

  239.   /**
    240. 

  240.    * Returns the resolved simple type definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getName() name} 
    241. 

  241.    * within the {@link #getSchema() schema}.
    242. 

  242.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    243. 

  243.    * @see #getSchema()
    244. 

  244.    * @see org.eclipse.xsd.XSDSchema#getTargetNamespace()
    245. 

  245.    * @see #resolveSimpleTypeDefinitionURI(java.lang.String)
    246. 

  246.    * @see #resolveSimpleTypeDefinition(java.lang.String, java.lang.String)
    247. 

  247.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    248. 

  248.    * @param localName the name to resolve.
    249. 

  249.    * @return the resolved simple type definition.
    250. 

  250.    */
    251. 

  251.   XSDSimpleTypeDefinition resolveSimpleTypeDefinition(String localName);
    252. 

  252.   
    253. 

  253.   /**
    254. 

  254.    * Returns the resolved complex type definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getURI() URI}.
    255. 

  255.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    256. 

  256.    * @see #resolveComplexTypeDefinition(java.lang.String, java.lang.String)
    257. 

  257.    * @see #resolveComplexTypeDefinition(java.lang.String)
    258. 

  258.    * @see org.eclipse.xsd.XSDNamedComponent#getURI()
    259. 

  259.    * @param uri the URI to resolve.
    260. 

  260.    * @return the resolved complex type definition.
    261. 

  261.    */
    262. 

  262.   XSDComplexTypeDefinition resolveComplexTypeDefinitionURI(String uri);
    263. 

  263. 

  264.   /**
    265. 

  265.    * Returns the resolved complex type definition of the given  
    266. 

  266.    * {@link org.eclipse.xsd.XSDNamedComponent#getTargetNamespace() namespace} and {@link org.eclipse.xsd.XSDNamedComponent#getName() name}.
    267. 

  267.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    268. 

  268.    * @see #resolveComplexTypeDefinitionURI(java.lang.String)
    269. 

  269.    * @see #resolveComplexTypeDefinition(java.lang.String)
    270. 

  270.    * @see org.eclipse.xsd.XSDNamedComponent#getTargetNamespace()
    271. 

  271.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    272. 

  272.    * @param namespace the namespace to resolve.
    273. 

  273.    * @param localName the name to resolve.
    274. 

  274.    * @return the resolved complex type definition.
    275. 

  275.    */
    276. 

  276.   XSDComplexTypeDefinition resolveComplexTypeDefinition(String namespace, String localName);
    277. 

  277. 

  278.   /**
    279. 

  279.    * Returns the resolved complex type definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getName() name} 
    280. 

  280.    * within the {@link #getSchema() schema}.
    281. 

  281.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    282. 

  282.    * @see #getSchema()
    283. 

  283.    * @see org.eclipse.xsd.XSDSchema#getTargetNamespace()
    284. 

  284.    * @see #resolveComplexTypeDefinitionURI(java.lang.String)
    285. 

  285.    * @see #resolveComplexTypeDefinition(java.lang.String, java.lang.String)
    286. 

  286.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    287. 

  287.    * @param localName the name to resolve.
    288. 

  288.    * @return the resolved complex type definition.
    289. 

  289.    */
    290. 

  290.   XSDComplexTypeDefinition resolveComplexTypeDefinition(String localName);
    291. 

  291. 

  292.   /**
    293. 

  293.    * Returns the resolved attribute declaration of the given {@link org.eclipse.xsd.XSDNamedComponent#getURI() URI}.
    294. 

  294.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    295. 

  295.    * @see #resolveAttributeDeclaration(java.lang.String, java.lang.String)
    296. 

  296.    * @see #resolveAttributeDeclaration(java.lang.String)
    297. 

  297.    * @see org.eclipse.xsd.XSDNamedComponent#getURI()
    298. 

  298.    * @param uri the URI to resolve.
    299. 

  299.    * @return the resolved attribute declaration.
    300. 

  300.    */
    301. 

  301.   XSDAttributeDeclaration resolveAttributeDeclarationURI(String uri);
    302. 

  302. 

  303.   /**
    304. 

  304.    * Returns the resolved attribute declaration of the given  
    305. 

  305.    * {@link org.eclipse.xsd.XSDNamedComponent#getTargetNamespace() namespace} and {@link org.eclipse.xsd.XSDNamedComponent#getName() name}.
    306. 

  306.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    307. 

  307.    * @see #resolveAttributeDeclarationURI(java.lang.String)
    308. 

  308.    * @see #resolveAttributeDeclaration(java.lang.String)
    309. 

  309.    * @see org.eclipse.xsd.XSDNamedComponent#getTargetNamespace()
    310. 

  310.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    311. 

  311.    * @param namespace the namespace to resolve.
    312. 

  312.    * @param localName the name to resolve.
    313. 

  313.    * @return the resolved attribute declaration.
    314. 

  314.    */
    315. 

  315.   XSDAttributeDeclaration resolveAttributeDeclaration(String namespace, String localName);
    316. 

  316. 

  317.   /**
    318. 

  318.    * Returns the resolved attribute declaration of the given {@link org.eclipse.xsd.XSDNamedComponent#getName() name} 
    319. 

  319.    * within the {@link #getSchema() schema}.
    320. 

  320.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    321. 

  321.    * @see #getSchema()
    322. 

  322.    * @see org.eclipse.xsd.XSDSchema#getTargetNamespace()
    323. 

  323.    * @see #resolveAttributeDeclarationURI(java.lang.String)
    324. 

  324.    * @see #resolveAttributeDeclaration(java.lang.String, java.lang.String)
    325. 

  325.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    326. 

  326.    * @param localName the name to resolve.
    327. 

  327.    * @return the resolved attribute declaration.
    328. 

  328.    */
    329. 

  329.   XSDAttributeDeclaration resolveAttributeDeclaration(String localName);
    330. 

  330. 

  331.   /**
    332. 

  332.    * Returns the resolved element declaration of the given {@link org.eclipse.xsd.XSDNamedComponent#getURI() URI}.
    333. 

  333.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    334. 

  334.    * @see #resolveElementDeclaration(java.lang.String, java.lang.String)
    335. 

  335.    * @see #resolveElementDeclaration(java.lang.String)
    336. 

  336.    * @see org.eclipse.xsd.XSDNamedComponent#getURI()
    337. 

  337.    * @param uri the URI to resolve.
    338. 

  338.    * @return the resolved element declaration.
    339. 

  339.    */
    340. 

  340.   XSDElementDeclaration resolveElementDeclarationURI(String uri);
    341. 

  341. 

  342.   /**
    343. 

  343.    * Returns the resolved element declaration of the given  
    344. 

  344.    * {@link org.eclipse.xsd.XSDNamedComponent#getTargetNamespace() namespace} and {@link org.eclipse.xsd.XSDNamedComponent#getName() name}.
    345. 

  345.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    346. 

  346.    * @see #resolveElementDeclarationURI(java.lang.String)
    347. 

  347.    * @see #resolveElementDeclaration(java.lang.String)
    348. 

  348.    * @see org.eclipse.xsd.XSDNamedComponent#getTargetNamespace()
    349. 

  349.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    350. 

  350.    * @param namespace the namespace to resolve.
    351. 

  351.    * @param localName the name to resolve.
    352. 

  352.    * @return the resolved element declaration.
    353. 

  353.    */
    354. 

  354.   XSDElementDeclaration resolveElementDeclaration(String namespace, String localName);
    355. 

  355. 

  356.   /**
    357. 

  357.    * Returns the resolved element declaration of the given {@link org.eclipse.xsd.XSDNamedComponent#getName() name} 
    358. 

  358.    * within the {@link #getSchema() schema}.
    359. 

  359.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    360. 

  360.    * @see #getSchema()
    361. 

  361.    * @see org.eclipse.xsd.XSDSchema#getTargetNamespace()
    362. 

  362.    * @see #resolveElementDeclarationURI(java.lang.String)
    363. 

  363.    * @see #resolveElementDeclaration(java.lang.String, java.lang.String)
    364. 

  364.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    365. 

  365.    * @param localName the name to resolve.
    366. 

  366.    * @return the resolved element declaration.
    367. 

  367.    */
    368. 

  368.   XSDElementDeclaration resolveElementDeclaration(String localName);
    369. 

  369.   
    370. 

  370.   /**
    371. 

  371.    * Returns the resolved attribute group definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getURI() URI}.
    372. 

  372.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    373. 

  373.    * @see #resolveAttributeGroupDefinition(java.lang.String, java.lang.String)
    374. 

  374.    * @see #resolveAttributeGroupDefinition(java.lang.String)
    375. 

  375.    * @see org.eclipse.xsd.XSDNamedComponent#getURI()
    376. 

  376.    * @param uri the URI to resolve.
    377. 

  377.    * @return the resolved attribute group definition.
    378. 

  378.    */
    379. 

  379.   XSDAttributeGroupDefinition resolveAttributeGroupDefinitionURI(String uri);
    380. 

  380. 

  381.   /**
    382. 

  382.    * Returns the resolved attribute group definition the given  
    383. 

  383.    * {@link org.eclipse.xsd.XSDNamedComponent#getTargetNamespace() namespace} and {@link org.eclipse.xsd.XSDNamedComponent#getName() name}.
    384. 

  384.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    385. 

  385.    * @see #resolveAttributeGroupDefinitionURI(java.lang.String)
    386. 

  386.    * @see #resolveAttributeGroupDefinition(java.lang.String)
    387. 

  387.    * @see org.eclipse.xsd.XSDNamedComponent#getTargetNamespace()
    388. 

  388.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    389. 

  389.    * @param namespace the namespace to resolve.
    390. 

  390.    * @param localName the name to resolve.
    391. 

  391.    * @return the resolved attribute group definition
    392. 

  392.    */
    393. 

  393.   XSDAttributeGroupDefinition resolveAttributeGroupDefinition(String namespace, String localName);
    394. 

  394. 

  395.   /**
    396. 

  396.    * Returns the resolved attribute group definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getName() name} 
    397. 

  397.    * within the {@link #getSchema() schema}.
    398. 

  398.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    399. 

  399.    * @see #getSchema()
    400. 

  400.    * @see org.eclipse.xsd.XSDSchema#getTargetNamespace()
    401. 

  401.    * @see #resolveAttributeGroupDefinitionURI(java.lang.String)
    402. 

  402.    * @see #resolveAttributeGroupDefinition(java.lang.String, java.lang.String)
    403. 

  403.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    404. 

  404.    * @param localName the name to resolve.
    405. 

  405.    * @return the resolved attribute group definition.
    406. 

  406.    */
    407. 

  407.   XSDAttributeGroupDefinition resolveAttributeGroupDefinition(String localName);
    408. 

  408.   
    409. 

  409.   /**
    410. 

  410.    * Returns the resolved model group definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getURI() URI}.
    411. 

  411.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    412. 

  412.    * @see #resolveModelGroupDefinition(java.lang.String, java.lang.String)
    413. 

  413.    * @see #resolveModelGroupDefinition(java.lang.String)
    414. 

  414.    * @see org.eclipse.xsd.XSDNamedComponent#getURI()
    415. 

  415.    * @param uri the URI to resolve.
    416. 

  416.    * @return the resolved model group definition.
    417. 

  417.    */
    418. 

  418.   XSDModelGroupDefinition resolveModelGroupDefinitionURI(String uri);
    419. 

  419. 

  420.   /**
    421. 

  421.    * Returns the resolved model group definition of the given  
    422. 

  422.    * {@link org.eclipse.xsd.XSDNamedComponent#getTargetNamespace() namespace} and {@link org.eclipse.xsd.XSDNamedComponent#getName() name}.
    423. 

  423.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    424. 

  424.    * @see #resolveModelGroupDefinitionURI(java.lang.String)
    425. 

  425.    * @see #resolveModelGroupDefinition(java.lang.String)
    426. 

  426.    * @see org.eclipse.xsd.XSDNamedComponent#getTargetNamespace()
    427. 

  427.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    428. 

  428.    * @param namespace the namespace to resolve.
    429. 

  429.    * @param localName the name to resolve.
    430. 

  430.    * @return the resolved model group definition.
    431. 

  431.    */
    432. 

  432.   XSDModelGroupDefinition resolveModelGroupDefinition(String namespace, String localName);
    433. 

  433. 

  434.   /**
    435. 

  435.    * Returns the resolved model group definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getName() name} 
    436. 

  436.    * within the {@link #getSchema() schema}.
    437. 

  437.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    438. 

  438.    * @see #getSchema()
    439. 

  439.    * @see org.eclipse.xsd.XSDSchema#getTargetNamespace()
    440. 

  440.    * @see #resolveModelGroupDefinitionURI(java.lang.String)
    441. 

  441.    * @see #resolveModelGroupDefinition(java.lang.String, java.lang.String)
    442. 

  442.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    443. 

  443.    * @param localName the name to resolve.
    444. 

  444.    * @return the resolved model group definition.
    445. 

  445.    */
    446. 

  446.   XSDModelGroupDefinition resolveModelGroupDefinition(String localName);
    447. 

  447. 

  448.   /**
    449. 

  449.    * Returns the resolved identity constraint definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getURI() URI}.
    450. 

  450.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    451. 

  451.    * @see #resolveIdentityConstraintDefinition(java.lang.String, java.lang.String)
    452. 

  452.    * @see #resolveIdentityConstraintDefinition(java.lang.String)
    453. 

  453.    * @see org.eclipse.xsd.XSDNamedComponent#getURI()
    454. 

  454.    * @param uri the URI to resolve.
    455. 

  455.    * @return the resolved identity constraint definition.
    456. 

  456.    */
    457. 

  457.   XSDIdentityConstraintDefinition resolveIdentityConstraintDefinitionURI(String uri);
    458. 

  458. 

  459.   /**
    460. 

  460.    * Returns the resolved identity constraint definition of the given  
    461. 

  461.    * {@link org.eclipse.xsd.XSDNamedComponent#getTargetNamespace() namespace} and {@link org.eclipse.xsd.XSDNamedComponent#getName() name}.
    462. 

  462.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    463. 

  463.    * @see #resolveIdentityConstraintDefinitionURI(java.lang.String)
    464. 

  464.    * @see #resolveIdentityConstraintDefinition(java.lang.String)
    465. 

  465.    * @see org.eclipse.xsd.XSDNamedComponent#getTargetNamespace()
    466. 

  466.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    467. 

  467.    * @param namespace the namespace to resolve.
    468. 

  468.    * @param localName the name to resolve.
    469. 

  469.    * @return the resolved identity constraint definition.
    470. 

  470.    */
    471. 

  471.   XSDIdentityConstraintDefinition resolveIdentityConstraintDefinition(String namespace, String localName);
    472. 

  472. 

  473.   /**
    474. 

  474.    * Returns the resolved identity constraint definition of the given {@link org.eclipse.xsd.XSDNamedComponent#getName() name} 
    475. 

  475.    * within the {@link #getSchema() schema}.
    476. 

  476.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    477. 

  477.    * @see #getSchema()
    478. 

  478.    * @see org.eclipse.xsd.XSDSchema#getTargetNamespace()
    479. 

  479.    * @see #resolveIdentityConstraintDefinitionURI(java.lang.String)
    480. 

  480.    * @see #resolveIdentityConstraintDefinition(java.lang.String, java.lang.String)
    481. 

  481.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    482. 

  482.    * @param localName the name to resolve.
    483. 

  483.    * @return the resolved identity constraint definition.
    484. 

  484.    */
    485. 

  485.   XSDIdentityConstraintDefinition resolveIdentityConstraintDefinition(String localName);
    486. 

  486. 

  487.   /**
    488. 

  488.    * Returns the resolved notation declaration of the given {@link org.eclipse.xsd.XSDNamedComponent#getURI() URI}.
    489. 

  489.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    490. 

  490.    * @see #resolveNotationDeclaration(java.lang.String, java.lang.String)
    491. 

  491.    * @see #resolveNotationDeclaration(java.lang.String)
    492. 

  492.    * @see org.eclipse.xsd.XSDNamedComponent#getURI()
    493. 

  493.    * @param uri the URI to resolve.
    494. 

  494.    * @return the resolved notation declaration.
    495. 

  495.    */
    496. 

  496.   XSDNotationDeclaration resolveNotationDeclarationURI(String uri);
    497. 

  497. 

  498.   /**
    499. 

  499.    * Returns the resolved notation declaration of the given  
    500. 

  500.    * {@link org.eclipse.xsd.XSDNamedComponent#getTargetNamespace() namespace} and {@link org.eclipse.xsd.XSDNamedComponent#getName() name}.
    501. 

  501.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    502. 

  502.    * @see #resolveNotationDeclarationURI(java.lang.String)
    503. 

  503.    * @see #resolveNotationDeclaration(java.lang.String)
    504. 

  504.    * @see org.eclipse.xsd.XSDNamedComponent#getTargetNamespace()
    505. 

  505.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    506. 

  506.    * @param namespace the namespace to resolve.
    507. 

  507.    * @param localName the name to resolve.
    508. 

  508.    * @return the resolved notation declaration.
    509. 

  509.    */
    510. 

  510.   XSDNotationDeclaration resolveNotationDeclaration(String namespace, String localName);
    511. 

  511. 

  512.   /**
    513. 

  513.    * Returns the resolved notation declaration the given {@link org.eclipse.xsd.XSDNamedComponent#getName() name} 
    514. 

  514.    * within the {@link #getSchema() schema}.
    515. 

  515.    * An unresolved instance is synthesized to hold the namespace and name if an existing instance cannot be found.
    516. 

  516.    * @see #getSchema()
    517. 

  517.    * @see org.eclipse.xsd.XSDSchema#getTargetNamespace()
    518. 

  518.    * @see #resolveNotationDeclarationURI(java.lang.String)
    519. 

  519.    * @see #resolveNotationDeclaration(java.lang.String, java.lang.String)
    520. 

  520.    * @see org.eclipse.xsd.XSDNamedComponent#getName()
    521. 

  521.    * @param localName the name to resolve.
    522. 

  522.    * @return the resolved notation declaration
    523. 

  523.    */
    524. 

  524.   XSDNotationDeclaration resolveNotationDeclaration(String localName);
    525. 

  525. 

  526.   /**
    527. 

  527.    * Returns the collection of components that have an {@link org.eclipse.xsd.XSDAnnotation annotation} 
    528. 

  528.    * containing an {@link org.eclipse.xsd.XSDAnnotation#getApplicationInformation() appinfo} with given source URI.
    529. 

  529.    * @see org.eclipse.xsd.XSDAnnotation#getApplicationInformationSources()
    530. 

  530.    * @param sourceURI the source URI to match.
    531. 

  531.    * @return the collection of matching components.
    532. 

  532.    */
    533. 

  533.   Collection<XSDConcreteComponent> getComponentsWithApplicationInformation(String sourceURI);
    534. 

  534. 

  535.   /**
    536. 

  536.    * Returns the collection of components that have an {@link org.eclipse.xsd.XSDAnnotation annotation} 
    537. 

  537.    * containing a {@link org.eclipse.xsd.XSDAnnotation#getUserInformation() documentation} with given source URI.
    538. 

  538.    * @see org.eclipse.xsd.XSDAnnotation#getApplicationInformationSources()
    539. 

  539.    * @param sourceURI the source URI to match.
    540. 

  540.    * @return the collection of matching components.
    541. 

  541.    */
    542. 

  542.   Collection<XSDConcreteComponent> getComponentsWithUserInformation(String sourceURI);
    543. 

  543. 

  544.   /**
    545. 

  545.    * Validates whether this component conforms to the constraints defined in the XML Schema standard.
    546. 

  546.    * {@link #getDiagnostics() Diagnostics} are produced to report any problems.
    547. 

  547.    * The effect of calling this for a component not directly or indirectly contained by a {@link org.eclipse.xsd.XSDSchema schema}
    548. 

  548.    * is undefined, and is likely to result in null pointer exceptions.
    549. 

  549.    * @see #getDiagnostics()
    550. 

  550.    * @see #clearDiagnostics()
    551. 

  551.    */
    552. 

  552.   void validate();
    553. 

  553. 

  554.   /**
    555. 

  555.    * Clears any {@link #getDiagnostics() diagnostics} associated with the component and all those it contains.
    556. 

  556.    * @see #validate()
    557. 

  557.    * @see #getDiagnostics()
    558. 

  558.    */
    559. 

  559.   void clearDiagnostics();
    560. 

  560. 

  561.   /**
    562. 

  562.    * Creates a clone of the component.
    563. 

  563.    * The clone may be deep and may share the DOM of this component.
    564. 

  564.    * @param deep whether the clone should be deep.
    565. 

  565.    * @param shareDOM whether the clone should share the original DOM
    566. 

  566.    * @return a clone of the component.
    567. 

  567.    */
    568. 

  568.   XSDConcreteComponent cloneConcreteComponent(boolean deep, boolean shareDOM);
    569. 

  569. 

  570.   /**
    571. 

  571.    * Returns whether the given component is contained by this component.
    572. 

  572.    * @param xsdConcreteComponent a component.
    573. 

  573.    * @return whether the component is contained by this component.
    574. 

  574.    */
    575. 

  575.   boolean contains(XSDConcreteComponent xsdConcreteComponent);
    576. 

  576. }
    577.