KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > emf > ecore > xml > namespace > XMLNamespaceDocumentRoot


1 /**
2  * <copyright>
3  *
4  * Copyright (c) 2003-2004 IBM Corporation and others.
5  * All rights reserved. This program and the accompanying materials
6  * are made available under the terms of the Eclipse Public License v1.0
7  * which accompanies this distribution, and is available at
8  * http://www.eclipse.org/legal/epl-v10.html
9  *
10  * Contributors:
11  * IBM - Initial API and implementation
12  *
13  * </copyright>
14  *
15  * $Id: XMLNamespaceDocumentRoot.java,v 1.5 2005/06/08 06:20:10 nickb Exp $
16  */

17 package org.eclipse.emf.ecore.xml.namespace;
18
19
20 import org.eclipse.emf.common.util.EMap;
21 import org.eclipse.emf.ecore.EObject;
22 import org.eclipse.emf.ecore.util.FeatureMap;
23
24
25 /**
26  * <!-- begin-user-doc -->
27  * A representation of the model object '<em><b>Document Root</b></em>'.
28  * <!-- end-user-doc -->
29  *
30  * <p>
31  * The following features are supported:
32  * <ul>
33  * <li>{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getMixed <em>Mixed</em>}</li>
34  * <li>{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getXMLNSPrefixMap <em>XMLNS Prefix Map</em>}</li>
35  * <li>{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getXSISchemaLocation <em>XSI Schema Location</em>}</li>
36  * <li>{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getBase <em>Base</em>}</li>
37  * <li>{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getId <em>Id</em>}</li>
38  * <li>{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getLang <em>Lang</em>}</li>
39  * <li>{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getSpace <em>Space</em>}</li>
40  * </ul>
41  * </p>
42  *
43  * @see org.eclipse.emf.ecore.xml.namespace.XMLNamespacePackage#getXMLNamespaceDocumentRoot()
44  * @model extendedMetaData="name='' kind='mixed'"
45  * @generated
46  */

47 public interface XMLNamespaceDocumentRoot extends EObject
48 {
49   /**
50    * Returns the value of the '<em><b>Mixed</b></em>' attribute list.
51    * The list contents are of type {@link org.eclipse.emf.ecore.util.FeatureMap.Entry}.
52    * <!-- begin-user-doc -->
53    * <p>
54    * If the meaning of the '<em>Mixed</em>' attribute list isn't clear,
55    * there really should be more of a description here...
56    * </p>
57    * <!-- end-user-doc -->
58    * @return the value of the '<em>Mixed</em>' attribute list.
59    * @see org.eclipse.emf.ecore.xml.namespace.XMLNamespacePackage#getXMLNamespaceDocumentRoot_Mixed()
60    * @model unique="false" dataType="org.eclipse.emf.ecore.EFeatureMapEntry" many="true"
61    * extendedMetaData="kind='elementWildcard' name=':mixed'"
62    * @generated
63    */

64   FeatureMap getMixed();
65
66   /**
67    * Returns the value of the '<em><b>XMLNS Prefix Map</b></em>' map.
68    * The key is of type {@link java.lang.String},
69    * and the value is of type {@link java.lang.String},
70    * <!-- begin-user-doc -->
71    * <p>
72    * If the meaning of the '<em>XMLNS Prefix Map</em>' map isn't clear,
73    * there really should be more of a description here...
74    * </p>
75    * <!-- end-user-doc -->
76    * @return the value of the '<em>XMLNS Prefix Map</em>' map.
77    * @see org.eclipse.emf.ecore.xml.namespace.XMLNamespacePackage#getXMLNamespaceDocumentRoot_XMLNSPrefixMap()
78    * @model mapType="org.eclipse.emf.ecore.EStringToStringMapEntry" keyType="java.lang.String" valueType="java.lang.String" transient="true"
79    * extendedMetaData="kind='attribute' name='xmlns:prefix'"
80    * @generated
81    */

82   EMap getXMLNSPrefixMap();
83
84   /**
85    * Returns the value of the '<em><b>XSI Schema Location</b></em>' map.
86    * The key is of type {@link java.lang.String},
87    * and the value is of type {@link java.lang.String},
88    * <!-- begin-user-doc -->
89    * <p>
90    * If the meaning of the '<em>XSI Schema Location</em>' map isn't clear,
91    * there really should be more of a description here...
92    * </p>
93    * <!-- end-user-doc -->
94    * @return the value of the '<em>XSI Schema Location</em>' map.
95    * @see org.eclipse.emf.ecore.xml.namespace.XMLNamespacePackage#getXMLNamespaceDocumentRoot_XSISchemaLocation()
96    * @model mapType="org.eclipse.emf.ecore.EStringToStringMapEntry" keyType="java.lang.String" valueType="java.lang.String" transient="true"
97    * extendedMetaData="kind='attribute' name='xsi:schemaLocation'"
98    * @generated
99    */

100   EMap getXSISchemaLocation();
101
102   /**
103    * Returns the value of the '<em><b>Base</b></em>' attribute.
104    * <!-- begin-user-doc -->
105    * <p>
106    * If the meaning of the '<em>Base</em>' attribute isn't clear,
107    * there really should be more of a description here...
108    * </p>
109    * <!-- end-user-doc -->
110    * @return the value of the '<em>Base</em>' attribute.
111    * @see #setBase(String)
112    * @see org.eclipse.emf.ecore.xml.namespace.XMLNamespacePackage#getXMLNamespaceDocumentRoot_Base()
113    * @model unique="false" dataType="org.eclipse.emf.ecore.xml.type.AnyURI"
114    * extendedMetaData="kind='attribute' name='base' namespace='##targetNamespace'"
115    * @generated
116    */

117   String JavaDoc getBase();
118
119   /**
120    * Sets the value of the '{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getBase <em>Base</em>}' attribute.
121    * <!-- begin-user-doc -->
122    * <!-- end-user-doc -->
123    * @param value the new value of the '<em>Base</em>' attribute.
124    * @see #getBase()
125    * @generated
126    */

127   void setBase(String JavaDoc value);
128
129   /**
130    * Returns the value of the '<em><b>Id</b></em>' attribute.
131    * <!-- begin-user-doc -->
132    * <p>
133    * If the meaning of the '<em>Id</em>' attribute isn't clear,
134    * there really should be more of a description here...
135    * </p>
136    * <!-- end-user-doc -->
137    * @return the value of the '<em>Id</em>' attribute.
138    * @see #setId(String)
139    * @see org.eclipse.emf.ecore.xml.namespace.XMLNamespacePackage#getXMLNamespaceDocumentRoot_Id()
140    * @model unique="false" id="true" dataType="org.eclipse.emf.ecore.xml.type.ID"
141    * extendedMetaData="kind='attribute' name='id' namespace='##targetNamespace'"
142    * @generated
143    */

144   String JavaDoc getId();
145
146   /**
147    * Sets the value of the '{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getId <em>Id</em>}' attribute.
148    * <!-- begin-user-doc -->
149    * <!-- end-user-doc -->
150    * @param value the new value of the '<em>Id</em>' attribute.
151    * @see #getId()
152    * @generated
153    */

154   void setId(String JavaDoc value);
155
156   /**
157    * Returns the value of the '<em><b>Lang</b></em>' attribute.
158    * <!-- begin-user-doc -->
159    * <p>
160    * If the meaning of the '<em>Lang</em>' attribute isn't clear,
161    * there really should be more of a description here...
162    * </p>
163    * <!-- end-user-doc -->
164    * @return the value of the '<em>Lang</em>' attribute.
165    * @see #setLang(String)
166    * @see org.eclipse.emf.ecore.xml.namespace.XMLNamespacePackage#getXMLNamespaceDocumentRoot_Lang()
167    * @model unique="false" dataType="org.eclipse.emf.ecore.xml.type.Language"
168    * extendedMetaData="kind='attribute' name='lang' namespace='##targetNamespace'"
169    * @generated
170    */

171   String JavaDoc getLang();
172
173   /**
174    * Sets the value of the '{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getLang <em>Lang</em>}' attribute.
175    * <!-- begin-user-doc -->
176    * <!-- end-user-doc -->
177    * @param value the new value of the '<em>Lang</em>' attribute.
178    * @see #getLang()
179    * @generated
180    */

181   void setLang(String JavaDoc value);
182
183   /**
184    * Returns the value of the '<em><b>Space</b></em>' attribute.
185    * The default value is <code>"preserve"</code>.
186    * The literals are from the enumeration {@link org.eclipse.emf.ecore.xml.namespace.SpaceType}.
187    * <!-- begin-user-doc -->
188    * <p>
189    * If the meaning of the '<em>Space</em>' attribute isn't clear,
190    * there really should be more of a description here...
191    * </p>
192    * <!-- end-user-doc -->
193    * @return the value of the '<em>Space</em>' attribute.
194    * @see org.eclipse.emf.ecore.xml.namespace.SpaceType
195    * @see #isSetSpace()
196    * @see #unsetSpace()
197    * @see #setSpace(SpaceType)
198    * @see org.eclipse.emf.ecore.xml.namespace.XMLNamespacePackage#getXMLNamespaceDocumentRoot_Space()
199    * @model default="preserve" unique="false" unsettable="true"
200    * extendedMetaData="kind='attribute' name='space' namespace='##targetNamespace'"
201    * @generated
202    */

203   SpaceType getSpace();
204
205   /**
206    * Sets the value of the '{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getSpace <em>Space</em>}' attribute.
207    * <!-- begin-user-doc -->
208    * <!-- end-user-doc -->
209    * @param value the new value of the '<em>Space</em>' attribute.
210    * @see org.eclipse.emf.ecore.xml.namespace.SpaceType
211    * @see #isSetSpace()
212    * @see #unsetSpace()
213    * @see #getSpace()
214    * @generated
215    */

216   void setSpace(SpaceType value);
217
218   /**
219    * Unsets the value of the '{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getSpace <em>Space</em>}' attribute.
220    * <!-- begin-user-doc -->
221    * <!-- end-user-doc -->
222    * @see #isSetSpace()
223    * @see #getSpace()
224    * @see #setSpace(SpaceType)
225    * @generated
226    */

227   void unsetSpace();
228
229   /**
230    * Returns whether the value of the '{@link org.eclipse.emf.ecore.xml.namespace.XMLNamespaceDocumentRoot#getSpace <em>Space</em>}' attribute is set.
231    * <!-- begin-user-doc -->
232    * <!-- end-user-doc -->
233    * @return whether the value of the '<em>Space</em>' attribute is set.
234    * @see #unsetSpace()
235    * @see #getSpace()
236    * @see #setSpace(SpaceType)
237    * @generated
238    */

239   boolean isSetSpace();
240
241 } // DocumentRoot
242
Popular Tags