Last modified by Artur on 2025/09/10 11:19

From version 7.1
edited by Helena
on 2025/06/24 15:09
Change comment: There is no comment for this version
To version 9.1
edited by Helena
on 2025/06/24 15:17
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -32,7 +32,6 @@
32 32  |(% style="width:487px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:120px" %)xs
33 33  
34 34  Contents:
35 -
36 36  13 Complex Types
37 37  
38 38  === 2.1.2 Complex Types ===
... ... @@ -45,15 +45,12 @@
45 45  ** DataSetType
46 46  
47 47  Attributes:
48 -
49 49  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
50 50  
51 51  Content:
52 -
53 53  com:Annotations?, DataProvider?, Attributes?, Group*, (Series+ | Obs+)?
54 54  
55 55  Attribute Documentation:
56 -
57 57  (% style="width:1011.29px" %)
58 58  |**Name**|**Type**|(% style="width:597px" %)**Documentation**
59 59  |structureRef|xs:IDREF|(% style="width:597px" %)The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set).
... ... @@ -67,7 +67,6 @@
67 67  |publicationPeriod|com: ObservationalTimePeriodType|(% style="width:597px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).
68 68  
69 69  Element Documentation:
70 -
71 71  (% style="width:1016.29px" %)
72 72  |**Name**|**Type**|(% style="width:642px" %)**Documentation**
73 73  |com:Annotations|com:AnnotationsType|(% style="width:642px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -80,26 +80,21 @@
80 80  **GroupType: **GroupType defines a structure which is used to communicate attribute values for a group defined in a data structure definition. The group can consist of either a subset of the dimensions defined by the data structure definition, or an association to an attachment constraint, which in turn defines key sets to which attributes can be attached. In the case that the group is based on an attachment constraint, only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the constraint and apply the values provided for the attributes appropriately.
81 81  
82 82  Derivation:
83 -
84 84  * //com:AnnotableType// (extension) 
85 85  ** GroupType
86 86  
87 87  Attributes:
88 -
89 89  type
90 90  
91 91  Content:
92 -
93 93  com:Annotations?, GroupKey?, Attributes
94 94  
95 95  Attribute Documentation:
96 -
97 97  (% style="width:1010.29px" %)
98 98  |**Name**|**Type**|(% style="width:709px" %)**Documentation**
99 99  |type|com:IDType|(% style="width:709px" %)The type attribute holds the identifier assigned to the group in the data structure definition for which attribute values are being provided.
100 100  
101 101  Element Documentation:
102 -
103 103  (% style="width:1014.29px" %)
104 104  |**Name**|**Type**|(% style="width:704px" %)**Documentation**
105 105  |com:Annotations|com:AnnotationsType|(% style="width:704px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -109,16 +109,13 @@
109 109  **SeriesType: **SeriesType defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition, save the dimension declared to be at the observation level for this data set. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both.
110 110  
111 111  Derivation:
112 -
113 113  * //com:AnnotableType// (extension) 
114 114  ** SeriesType
115 115  
116 116  Content:
117 -
118 118  com:Annotations?, SeriesKey, Attributes?, Obs*
119 119  
120 120  Element Documentation:
121 -
122 122  (% style="width:999.294px" %)
123 123  |**Name**|**Type**|(% style="width:689px" %)**Documentation**
124 124  |com:Annotations|com:AnnotationsType|(% style="width:689px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -129,16 +129,13 @@
129 129  **ObsOnlyType: **ObsOnlyType defines the structure for an un-grouped observation. Unlike a group observation, an un-grouped must provided a full set of values for every dimension declared in the data structure definition. The observation can contain an observed value and/or a collection of attribute values.
130 130  
131 131  Derivation:
132 -
133 133  * //com:AnnotableType// (extension) 
134 134  ** ObsOnlyType
135 135  
136 136  Content:
137 -
138 138  com:Annotations?, ObsKey, ObsValue?, Attributes?
139 139  
140 140  Element Documentation:
141 -
142 142  (% style="width:996.294px" %)
143 143  |**Name**|**Type**|(% style="width:651px" %)**Documentation**
144 144  |com:Annotations|com:AnnotationsType|(% style="width:651px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -149,16 +149,13 @@
149 149  **ObsType: **ObsType defines the structure of a grouped observation. The observation must be provided a value for the dimension which is declared to be at the observation level for this data set. This dimension value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same dimension value). The observation can contain an observed value and/or attribute values.
150 150  
151 151  Derivation:
152 -
153 153  * //com:AnnotableType// (extension) 
154 154  ** ObsType
155 155  
156 156  Content:
157 -
158 158  com:Annotations?, ObsDimension, ObsValue?, Attributes?
159 159  
160 160  Element Documentation:
161 -
162 162  (% style="width:1004.29px" %)
163 163  |**Name**|**Type**|(% style="width:694px" %)**Documentation**
164 164  |com:Annotations|com:AnnotationsType|(% style="width:694px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -169,11 +169,9 @@
169 169  **ValuesType: **ValuesType is a general structure which contains a collection of data structure definition component values. This type is used to provide both key and attribute collection values.
170 170  
171 171  Content:
172 -
173 173  Value+
174 174  
175 175  Element Documentation:
176 -
177 177  (% style="width:1008.29px" %)
178 178  |**Name**|(% style="width:185px" %)**Type**|(% style="width:692px" %)**Documentation**
179 179  |Value|(% style="width:185px" %)ComponentValueType|(% style="width:692px" %)Value contains a component value and a reference to the component for which a value is being provided.
... ... @@ -181,15 +181,12 @@
181 181  **BaseValueType: **BaseValueType is a general structure which contains a reference to a data structure definition component and a value for that component. In this structure the reference to the component is optional to allow for usages where the actual reference might be provided in another context.
182 182  
183 183  Attributes:
184 -
185 185  id?, value
186 186  
187 187  Content:
188 -
189 189  {Empty}
190 190  
191 191  Attribute Documentation:
192 -
193 193  (% style="width:1003.29px" %)
194 194  |**Name**|(% style="width:194px" %)**Type**|(% style="width:664px" %)**Documentation**
195 195  |id|(% style="width:194px" %)com:NCNameIDType|(% style="width:664px" %)The id attribute contains the identifier for the component for which a value is being provided.
... ... @@ -198,20 +198,16 @@
198 198  **ObsValueType: **ObsValueType is a derivation of the BaseValueType which is used to provide an observation value. Since an observation value is always associated with the data structure definition primary measure, and the identifier for the primary measure is fixed, the component reference for this structure is fixed. Note that this means that it is not necessary to provide a value in an instance as the fixed value will be provided in the post validation information set.
199 199  
200 200  Derivation:
201 -
202 202  * BaseValueType (restriction) 
203 203  ** ObsValueType
204 204  
205 205  Attributes:
206 -
207 207  id?, value
208 208  
209 209  Content:
210 -
211 211  {Empty}
212 212  
213 213  Attribute Documentation:
214 -
215 215  (% style="width:1004.29px" %)
216 216  |(% style="width:190px" %)**Name**|(% style="width:213px" %)**Type**|(% style="width:598px" %)**Documentation**
217 217  |(% style="width:190px" %)id (fixed: OBS_VALUE)|(% style="width:213px" %)com:NCNameIDType|(% style="width:598px" %)The id attribute contains a fixed reference to the primary measure component of the data structure definition.
... ... @@ -220,20 +220,16 @@
220 220  **ComponentValueType: **ComponentValueType is a derivation of the BaseValueType which requires that the component reference be provided. This is used when the identification of the component cannot be inferred from another context.
221 221  
222 222  Derivation:
223 -
224 224  * BaseValueType (restriction) 
225 225  ** ComponentValueType
226 226  
227 227  Attributes:
228 -
229 229  id, value
230 230  
231 231  Content:
232 -
233 233  {Empty}
234 234  
235 235  Attribute Documentation:
236 -
237 237  (% style="width:1008.29px" %)
238 238  |**Name**|(% style="width:184px" %)**Type**|(% style="width:679px" %)**Documentation**
239 239  |id|(% style="width:184px" %)com:NCNameIDType|(% style="width:679px" %)The id attribute contains the identifier for the component for which a value is being provided.
... ... @@ -242,21 +242,17 @@
242 242  **TimeSeriesDataSetType: **TimeSeriesDataSetType is a derivation of the base DataSetType of the generic format the restricts the data set to only allow for grouped observations where the dimension at the observation level is the time dimension of the data structure definition. This means that unlike the base data set structure, there can be no un-grouped observations. Because this derivation is achieved using restriction, data sets conforming to this type will inherently conform to the base data set structure as well. In fact, data structured here will be identical to data in the base data set when the time dimension is the observation dimension. This means that the data contained in this structure can be processed in exactly the same manner as the base structure.
243 243  
244 244  Derivation:
245 -
246 246  * //com:AnnotableType// (extension) 
247 247  ** DataSetType (restriction) 
248 248  *** TimeSeriesDataSetType
249 249  
250 250  Attributes:
251 -
252 252  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
253 253  
254 254  Content:
255 -
256 256  com:Annotations?, DataProvider?, Attributes?, Group*, Series*
257 257  
258 258  Attribute Documentation:
259 -
260 260  (% style="width:1004.29px" %)
261 261  |**Name**|**Type**|(% style="width:590px" %)**Documentation**
262 262  |structureRef|xs:IDREF|(% style="width:590px" %)The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set).
... ... @@ -270,7 +270,6 @@
270 270  |publicationPeriod|com: ObservationalTimePeriodType|(% style="width:590px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).
271 271  
272 272  Element Documentation:
273 -
274 274  (% style="width:999.294px" %)
275 275  |**Name**|**Type**|(% style="width:622px" %)**Documentation**
276 276  |com:Annotations|com:AnnotationsType|(% style="width:622px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -282,17 +282,14 @@
282 282  **TimeSeriesType: **TimeSeriesType defines a structure which is used to group a collection of observations which have a key in common, organised by time. The key for a series is every dimension defined in the data structure definition, save the time dimension. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the time dimension). It is possible for the series to contain only observations or only attribute values, or both.
283 283  
284 284  Derivation:
285 -
286 286  * //com:AnnotableType// (extension) 
287 287  ** SeriesType (restriction) 
288 288  *** TimeSeriesType
289 289  
290 290  Content:
291 -
292 292  com:Annotations?, SeriesKey, Attributes?, Obs*
293 293  
294 294  Element Documentation:
295 -
296 296  (% style="width:1012.29px" %)
297 297  |**Name**|**Type**|(% style="width:695px" %)**Documentation**
298 298  |com:Annotations|com:AnnotationsType|(% style="width:695px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -303,17 +303,14 @@
303 303  **TimeSeriesObsType: **TimeSeriesObsType defines the structure of a time series observation. The observation must be provided a value for the time dimension. This time value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same time value). The observation can contain an observed value and/or attribute values.
304 304  
305 305  Derivation:
306 -
307 307  * //com:AnnotableType// (extension) 
308 308  ** ObsType (restriction) 
309 309  *** TimeSeriesObsType
310 310  
311 311  Content:
312 -
313 313  com:Annotations?, ObsDimension, ObsValue?, Attributes?
314 314  
315 315  Element Documentation:
316 -
317 317  (% style="width:1019.29px" %)
318 318  |**Name**|**Type**|(% style="width:709px" %)**Documentation**
319 319  |com:Annotations|com:AnnotationsType|(% style="width:709px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -324,20 +324,16 @@
324 324  **TimeValueType: **TimeValueType is a derivation of the BaseValueType which is used to provide a value for the time dimension. Since the identifier for the time dimension is fixed, the component reference for this structure is fixed. Note that this means that it is not necessary to provide a value in an instance as the fixed value will be provided in the post validation information set.
325 325  
326 326  Derivation:
327 -
328 328  * BaseValueType (restriction) 
329 329  ** TimeValueType
330 330  
331 331  Attributes:
332 -
333 333  id?, value
334 334  
335 335  Content:
336 -
337 337  {Empty}
338 338  
339 339  Attribute Documentation:
340 -
341 341  (% style="width:1013.29px" %)
342 342  |(% style="width:205px" %)**Name**|(% style="width:277px" %)**Type**|(% style="width:528px" %)**Documentation**
343 343  |(% style="width:205px" %)id (fixed: TIME_PERIOD)|(% style="width:277px" %)com:NCNameIDType|(% style="width:528px" %)The id attribute contains the identifier for the component for which a value is being provided.
... ... @@ -357,7 +357,6 @@
357 357  |(% style="width:475px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:549px" %)xs
358 358  
359 359  Contents:
360 -
361 361  7 Complex Types
362 362  1 Simple Type
363 363  
... ... @@ -366,20 +366,16 @@
366 366  **//DataSetType//: **DataSetType is the abstract type which defines the base structure for any data structure definition specific data set. A derived data set type will be created that is specific to a data structure definition and the details of the organisation of the data (i.e. which dimension is the observation dimension and whether explicit measures should be used). Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The derived data set type will restrict this choice to be either grouped or un-grouped observations. If this dimension is "AllDimensions" then the derived data set type must consist of a collection of un-grouped observations; otherwise the data set will contain a collection of series with the observations in the series disambiguated by the specified dimension at the observation level. This data set is capable of containing data (observed values) and/or documentation (attribute values) and can be used for incremental updates and deletions (i.e. only the relevant updates or deletes are exchanged). It is assumed that each series or un-grouped observation will be distinct in its purpose. For example, if series contains both data and documentation, it assumed that each series will have a unique key. If the series contains only data or only documentation, then it is possible that another series with the same key might exist, but with not with the same purpose (i.e. to provide data or documentation) as the first series. This base type is designed such that derived types can be processed in a generic manner; it assures that data structure definition specific data will have a consistent structure. The group, series, and observation elements are unqualified, meaning that they are not qualified with a namespace in an instance. This means that in the derived data set types, the elements will always be the same, regardless of the target namespace of the schemas which defines these derived types. This allows for consistent processing of the structure without regard to what the namespace might be for the data structure definition specific schema. The data set can contain values for attributes which do not have an attribute relationship with any data structure definition components. These attribute values will exist in XML attributes in this element based on this type (DataSet). This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived data set type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). To allow for generic processing, it is required that the only unqualified XML attributes in the derived data set type (outside of the standard data set attributes) be for attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition attribute.
367 367  
368 368  Derivation:
369 -
370 370  * //com:AnnotableType// (extension)
371 371  ** //DataSetType//
372 372  
373 373  Attributes:
374 -
375 375  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?
376 376  
377 377  Content:
378 -
379 379  com:Annotations?, DataProvider?, Group*, (Series+ | Obs+)?
380 380  
381 381  Attribute Documentation:
382 -
383 383  (% style="width:1005.29px" %)
384 384  |(% style="width:199px" %)**Name**|(% style="width:216px" %)**Type**|(% style="width:521px" %)**Documentation**
385 385  |(% style="width:199px" %)structureRef|(% style="width:216px" %)xs:IDREF|(% style="width:521px" %)The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set).
... ... @@ -395,7 +395,6 @@
395 395  |(% style="width:199px" %)REPORTING_YEAR_START_DAY|(% style="width:216px" %)xs:gMonthDay|(% style="width:521px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived data set type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
396 396  
397 397  Element Documentation:
398 -
399 399  (% style="width:1005.29px" %)
400 400  |**Name**|**Type**|(% style="width:630px" %)**Documentation**
401 401  |com:Annotations|com:AnnotationsType|(% style="width:630px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -407,20 +407,16 @@
407 407  **//GroupType//: **GroupType is the abstract type which defines a structure which is used to communicate attribute values for a group defined in a data structure definition. The group can consist of either a subset of the dimensions defined by the data structure definition, or an association to an attachment constraint, which in turn defines key sets to which attributes can be attached. In the case that the group is based on an attachment constraint, only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the constraint and apply the values provided for the attributes appropriately. Data structure definition schemas will drive types based on this for each group defined in the data structure definition. Both the dimension values which make up the key (if applicable) and the attribute values associated with the group will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived group type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the group dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
408 408  
409 409  Derivation:
410 -
411 411  * //com:AnnotableType// (extension) 
412 412  ** //GroupType//
413 413  
414 414  Attributes:
415 -
416 416  type?, REPORTING_YEAR_START_DAY?
417 417  
418 418  Content:
419 -
420 420  com:Annotations?
421 421  
422 422  Attribute Documentation:
423 -
424 424  (% style="width:1008.29px" %)
425 425  |**Name**|**Type**|(% style="width:621px" %)**Documentation**
426 426  |type|com:IDType|(% style="width:621px" %)The type attribute reference the identifier of the group as defined in the data structure definition. This is optional, but derived group types will provide a fixed value for this so that it always available in the post validation information set. This allows the group to be processed in a generic manner.
... ... @@ -427,7 +427,6 @@
427 427  |REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:621px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived group types may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
428 428  
429 429  Element Documentation:
430 -
431 431  |**Name**|**Type**|**Documentation**
432 432  |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
433 433  
... ... @@ -434,20 +434,16 @@
434 434  **//SeriesType//: **SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition, save the dimension declared to be at the observation level for this data set. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both. Data structure definition schemas will drive a type based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. Both the dimension values which make up the key and the attribute values associated with the key dimensions will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
435 435  
436 436  Derivation:
437 -
438 438  * //com:AnnotableType// (extension) 
439 439  ** //SeriesType//
440 440  
441 441  Attributes:
442 -
443 443  TIME_PERIOD?, REPORTING_YEAR_START_DAY?
444 444  
445 445  Content:
446 -
447 447  com:Annotations?, Obs*
448 448  
449 449  Attribute Documentation:
450 -
451 451  (% style="width:1002.29px" %)
452 452  |**Name**|**Type**|(% style="width:533px" %)**Documentation**
453 453  |TIME_PERIOD|com: ObservationalTimePer iodType|(% style="width:533px" %)The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.
... ... @@ -454,7 +454,6 @@
454 454  |REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:533px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived series type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
455 455  
456 456  Element Documentation:
457 -
458 458  |**Name**|**Type**|**Documentation**
459 459  |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
460 460  |Obs|//ObsType//|
... ... @@ -462,20 +462,16 @@
462 462  **//ObsType//: **ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values. Data structure definition schemas will drive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attribute(s) will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived observation type be for the observation dimension(s) and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute. If the data structure definition specific schema requires that explicit measures be used (only possible when the measure dimension is specified at the observation), then there will be types derived for each measure defined by the measure dimension. In this case, the types will be specific to each measure, which is to say that the representation of the primary measure (i.e. the observed value) will be restricted to that which is specified by the specific measure.
463 463  
464 464  Derivation:
465 -
466 466  * //com:AnnotableType// (extension) 
467 467  ** //ObsType//
468 468  
469 469  Attributes:
470 -
471 471  type?, TIME_PERIOD?, REPORTING_YEAR_START_DAY?, OBS_VALUE?
472 472  
473 473  Content:
474 -
475 475  com:Annotations?
476 476  
477 477  Attribute Documentation:
478 -
479 479  (% style="width:1014.29px" %)
480 480  |**Name**|**Type**|(% style="width:505px" %)**Documentation**
481 481  |type|com:IDType|(% style="width:505px" %)The type attribute is used when the derived format requires that explicit measure be used. In this case, the derived type based on the measure will fix this value to be the identification of the measure concept. This will not be required, but since it is fixed it will be available in the post validation information set which will allow for generic processing of the data. If explicit measures are not used, then the derived type will prohibit the use of this attribute.
... ... @@ -484,7 +484,6 @@
484 484  |OBS_VALUE|xs:anySimpleType|(% style="width:505px" %)The OBS_VALUE attribute is an explicit attribute for the primary measure, which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This attribute is un-typed, since the representation of the observed value can vary widely. Derived types will restrict this to be a type based on the representation of the primary measure. In the case that an explicit measure is used, the derived type for a given measure might further restrict the type of the primary measure to be more specific to the core representation for the measure concept. Note that it is required that in the case of multiple measures being used, that the representation of the primary measure is broad enough to handle the various representations of the measure concepts.
485 485  
486 486  Element Documentation:
487 -
488 488  |**Name**|**Type**|**Documentation**
489 489  |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
490 490  
... ... @@ -491,21 +491,17 @@
491 491  **//TimeSeriesDataSetType//: **TimeSeriesDataSetType is the abstract type which defines the base structure for any data structure definition specific time series based data set. A derived data set type will be created that is specific to a data structure definition. Unlike the base format, only one variation of this is allowed for a data structure definition. This variation is the time dimension as the observation dimension. Data is organised into a collection of time series. Because this derivation is achieved using restriction, data sets conforming to this type will inherently conform to the base data set structure as well. In fact, data structure specific here will be identical to data in the base data set when the time dimension is the observation dimension, even for the derived data set types. This means that the data contained in this structure can be processed in exactly the same manner as the base structure. The same rules for derivation as the base data set type apply to this specialized data set.
492 492  
493 493  Derivation:
494 -
495 495  * //com:AnnotableType// (extension) 
496 496  ** //DataSetType// (restriction) 
497 497  *** //TimeSeriesDataSetType//
498 498  
499 499  Attributes:
500 -
501 501  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?
502 502  
503 503  Content:
504 -
505 505  com:Annotations?, DataProvider?, Group*, Series*
506 506  
507 507  Attribute Documentation:
508 -
509 509  (% style="width:1003.29px" %)
510 510  |(% style="width:213px" %)**Name**|(% style="width:274px" %)**Type**|(% style="width:461px" %)**Documentation**
511 511  |(% style="width:213px" %)structureRef|(% style="width:274px" %)xs:IDREF|(% style="width:461px" %)The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set).
... ... @@ -521,7 +521,6 @@
521 521  |(% style="width:213px" %)REPORTING_YEAR_START_DAY|(% style="width:274px" %)xs:gMonthDay|(% style="width:461px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived data set type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
522 522  
523 523  Element Documentation:
524 -
525 525  (% style="width:1007.29px" %)
526 526  |**Name**|**Type**|(% style="width:632px" %)**Documentation**
527 527  |com:Annotations|com:AnnotationsType|(% style="width:632px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -532,27 +532,22 @@
532 532  **TimeSeriesType: **TimeSeriesType defines an abstract structure which is used to group a collection of observations which have a key in common, organised by time. The key for a series is every dimension defined in the data structure definition, save the time dimension. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the time dimension). It is possible for the series to contain only observations or only attribute values, or both. The same rules for derivation as the base series type apply to this specialized series.
533 533  
534 534  Derivation:
535 -
536 536  * //com:AnnotableType// (extension) 
537 537  ** //SeriesType// (restriction) 
538 538  *** TimeSeriesType
539 539  
540 540  Attributes:
541 -
542 542  REPORTING_YEAR_START_DAY?
543 543  
544 544  Content:
545 -
546 546  com:Annotations?, Obs*
547 547  
548 548  Attribute Documentation:
549 -
550 550  (% style="width:1004.29px" %)
551 551  |**Name**|**Type**|(% style="width:617px" %)**Documentation**
552 552  |REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:617px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived series type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
553 553  
554 554  Element Documentation:
555 -
556 556  (% style="width:1003.29px" %)
557 557  |**Name**|**Type**|(% style="width:593px" %)**Documentation**
558 558  |com:Annotations|com:AnnotationsType|(% style="width:593px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -561,21 +561,17 @@
561 561  **//TimeSeriesObsType//: **TimeSeriesObsType defines the abstract structure of a time series observation. The observation must be provided a value for the time dimension. This time value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same time value). The observation can contain an observed value and/or attribute values. The same rules for derivation as the base observation type apply to this specialized observation.
562 562  
563 563  Derivation:
564 -
565 565  * //com:AnnotableType// (extension) 
566 566  ** //ObsType// (restriction) 
567 567  *** //TimeSeriesObsType//
568 568  
569 569  Attributes:
570 -
571 571  TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE?
572 572  
573 573  Content:
574 -
575 575  com:Annotations?
576 576  
577 577  Attribute Documentation:
578 -
579 579  (% style="width:1005.29px" %)
580 580  |**Name**|**Type**|(% style="width:496px" %)**Documentation**
581 581  |TIME_PERIOD|com: ObservationalTimePeriodType|(% style="width:496px" %)The TIME_PERIOD attribute is an explicit attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. Since this data is structured to be time series only, this attribute is always required. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.
... ... @@ -583,7 +583,6 @@
583 583  |OBS_VALUE|xs:anySimpleType|(% style="width:496px" %)The OBS_VALUE attribute is an explicit attribute for the primary measure, which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This attribute is un-typed, since the representation of the observed value can vary widely. Derived types will restrict this to be a type based on the representation of the primary measure. In the case that an explicit measure is used, the derived type for a given measure might further restrict the type of the primary measure to be more specific to the core representation for the measure concept. Note that it is required that in the case of multiple measures being used, that the representation of the primary measure is broad enough to handle the various representations of the measure concepts.
584 584  
585 585  Element Documentation:
586 -
587 587  (% style="width:1013.29px" %)
588 588  |**Name**|**Type**|(% style="width:603px" %)**Documentation**
589 589  |com:Annotations|com:AnnotationsType|(% style="width:603px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -625,16 +625,13 @@
625 625  **MetadataSetType: **MetadataSetType describes the structure for a metadata set, which contains a collection of reported metadata against a set of values for a given full or partial target identifier, as described in a metadata structure definition. The metadata set may contain reported metadata for multiple report structures defined in a metadata structure definition.
626 626  
627 627  Derivation:
628 -
629 629  * //com:AnnotableType// (extension) 
630 630  ** MetadataSetType
631 631  
632 632  Attributes:
633 -
634 634  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
635 635  
636 636  Content:
637 -
638 638  com:Annotations?, com:Name*, DataProvider?, Report+
639 639  
640 640  Attribute Documentation:
... ... @@ -652,7 +652,6 @@
652 652  |publicationPeriod|com: ObservationalTimePeriodType|(% style="width:592px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).
653 653  
654 654  Element Documentation:
655 -
656 656  (% style="width:1006.29px" %)
657 657  |**Name**|(% style="width:268px" %)**Type**|(% style="width:562px" %)**Documentation**
658 658  |com:Annotations|(% style="width:268px" %)com:AnnotationsType|(% style="width:562px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -663,26 +663,21 @@
663 663  **ReportType: **ReportType contains a set of report attributes and identifies a target objects] to which they apply.
664 664  
665 665  Derivation:
666 -
667 667  * //com:AnnotableType// (extension) 
668 668  ** ReportType
669 669  
670 670  Attributes:
671 -
672 672  id
673 673  
674 674  Content:
675 -
676 676  com:Annotations?, Target, AttributeSet
677 677  
678 678  Attribute Documentation:
679 -
680 680  (% style="width:1003.29px" %)
681 681  |**Name**|**Type**|(% style="width:788px" %)**Documentation**
682 682  |id|com:IDType|(% style="width:788px" %)The id attribute holds the identifier of the report structure as defined in the metadata structure definition. This identifies the report structure which defines the structure of metadata that is being reported.
683 683  
684 684  Element Documentation:
685 -
686 686  (% style="width:1003.29px" %)
687 687  |**Name**|**Type**|(% style="width:593px" %)**Documentation**
688 688  |com:Annotations|com:AnnotationsType|(% style="width:593px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -692,21 +692,17 @@
692 692  **TargetType: **TargetType defines the structure of a target. It contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply.
693 693  
694 694  Attributes:
695 -
696 696  id
697 697  
698 698  Content:
699 -
700 700  ReferenceValue+
701 701  
702 702  Attribute Documentation:
703 -
704 704  (% style="width:1003.29px" %)
705 705  |**Name**|**Type**|(% style="width:805px" %)**Documentation**
706 706  |id|com:IDType|(% style="width:805px" %)The id attribute holds the identifier of the metadata target as defined in the metadata structure definition. This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata.
707 707  
708 708  Element Documentation:
709 -
710 710  (% style="width:1009.29px" %)
711 711  |**Name**|**Type**|(% style="width:710px" %)**Documentation**
712 712  |ReferenceValue|ReferenceValueType|(% style="width:710px" %)ReferenceValue contains a value for a target reference object reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period.
... ... @@ -714,15 +714,12 @@
714 714  **ReferenceValueType: **ReferenceValueType defines the structure of a target object reference value. A target reference value will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period.
715 715  
716 716  Attributes:
717 -
718 718  id
719 719  
720 720  Content:
721 -
722 722  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
723 723  
724 724  Attribute Documentation:
725 -
726 726  (% style="width:1013.29px" %)
727 727  |**Name**|**Type**|(% style="width:847px" %)**Documentation**
728 728  |id|com:IDType|(% style="width:847px" %)The id attribute holds the identifier of the target reference object as defined in the metadata structure definition. This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata.
... ... @@ -740,11 +740,9 @@
740 740  **AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata attributes.
741 741  
742 742  Content:
743 -
744 744  ReportedAttribute+
745 745  
746 746  Element Documentation:
747 -
748 748  (% style="width:1023.29px" %)
749 749  |(% style="width:150px" %)**Name**|(% style="width:202px" %)**Type**|(% style="width:668px" %)**Documentation**
750 750  |(% style="width:150px" %)ReportedAttribute|(% style="width:202px" %)ReportedAttributeType|(% style="width:668px" %)ReportedAttribute provides the details of a reported attribute, including a value and/or child reported attributes.
... ... @@ -752,20 +752,16 @@
752 752  **ReportedAttributeType: **ReportedAttributeType defines the structure for a reported metadata attribute. A value for the attribute can be supplied as either a single value, or multi-lingual text values (either structured or unstructured). An optional set of child metadata attributes is also available if the metadata attribute definition defines nested metadata attributes.
753 753  
754 754  Derivation:
755 -
756 756  * //com:AnnotableType// (extension) 
757 757  ** ReportedAttributeType
758 758  
759 759  Attributes:
760 -
761 761  id, value?
762 762  
763 763  Content:
764 -
765 765  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
766 766  
767 767  Attribute Documentation:
768 -
769 769  (% style="width:996.294px" %)
770 770  |**Name**|(% style="width:170px" %)**Type**|(% style="width:657px" %)**Documentation**
771 771  |id|(% style="width:170px" %)com:IDType|(% style="width:657px" %)The id attribute identifies the metadata attribute that the value is being reported for.
... ... @@ -772,7 +772,6 @@
772 772  |value|(% style="width:170px" %)xs:string|(% style="width:657px" %)The value attribute holds any simple value for the metadata attribute.
773 773  
774 774  Element Documentation:
775 -
776 776  (% style="width:999.294px" %)
777 777  |**Name**|**Type**|(% style="width:670px" %)**Documentation**
778 778  |com:Annotations|com:AnnotationsType|(% style="width:670px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -795,7 +795,6 @@
795 795  |(% style="width:492px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:159px" %)xs
796 796  
797 797  Contents:
798 -
799 799  5 Complex Types
800 800  
801 801  === 2.4.2 Complex Types ===
... ... @@ -803,7 +803,6 @@
803 803  **//MetadataSetType//: **MetadataSetType is an abstract base type the forms the basis for a metadata structure specific metadata set. It is restricted by the metadata structure definition specific schema to meet its needs.
804 804  
805 805  Derivation:
806 -
807 807  * //com:AnnotableType// (extension) 
808 808  ** //MetadataSetType//
809 809  
... ... @@ -812,11 +812,9 @@
812 812  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
813 813  
814 814  Content:
815 -
816 816  com:Annotations?, com:Name*, DataProvider?, Report+
817 817  
818 818  Attribute Documentation:
819 -
820 820  (% style="width:1003.29px" %)
821 821  |**Name**|**Type**|(% style="width:607px" %)**Documentation**
822 822  |structureRef|xs:IDREF|(% style="width:607px" %)The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set).
... ... @@ -830,7 +830,6 @@
830 830  |publicationPeriod|com: ObservationalTimePeriodType|(% style="width:607px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).
831 831  
832 832  Element Documentation:
833 -
834 834  (% style="width:1006.29px" %)
835 835  |**Name**|**Type**|(% style="width:631px" %)**Documentation**
836 836  |com:Annotations|com:AnnotationsType|(% style="width:631px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -841,26 +841,21 @@
841 841  **//ReportType//: **ReportType is an abstract base type the forms the basis for a metadata structure definition specific report, based on the defined report structures. This type is restricted in the metadata structure definition specific schema so that the Target and AttributeSet conform to the prescribed report structure.
842 842  
843 843  Derivation:
844 -
845 845  * //com:AnnotableType// (extension) 
846 846  ** //ReportType//
847 847  
848 848  Attributes:
849 -
850 850  id?
851 851  
852 852  Content:
853 -
854 854  com:Annotations?, Target, AttributeSet
855 855  
856 856  Attribute Documentation:
857 -
858 858  (% style="width:1003.29px" %)
859 859  |**Name**|**Type**|(% style="width:837px" %)**Documentation**
860 860  |id|com:IDType|(% style="width:837px" %)The id attribute holds the identifier of the report structure as defined in the metadata structure definition. This identifies the report structure which defines the structure of metadata that is being reported. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the report structure will always be available if required for processing.
861 861  
862 862  Element Documentation:
863 -
864 864  (% style="width:1005.29px" %)
865 865  |**Name**|**Type**|(% style="width:695px" %)**Documentation**
866 866  |com:Annotations|com:AnnotationsType|(% style="width:695px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -870,21 +870,17 @@
870 870  **//TargetType//: **TargetType is an abstract base type that forms the basis of a the metadata report's metadata target value. This type is restricted in the metadata structure definition specific schema so that the ReferenceValue elements conform to the targets specified in the metadata target defined in the metadata structure definition.
871 871  
872 872  Attributes:
873 -
874 874  id?
875 875  
876 876  Content:
877 -
878 878  ReferenceValue+
879 879  
880 880  Attribute Documentation:
881 -
882 882  (% style="width:999.294px" %)
883 883  |**Name**|**Type**|(% style="width:833px" %)**Documentation**
884 884  |id|com:IDType|(% style="width:833px" %)The id attribute holds the identifier of the metadata target as defined in the metadata structure definition. This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the metadata target will always be available if required for processing.
885 885  
886 886  Element Documentation:
887 -
888 888  (% style="width:999.294px" %)
889 889  |**Name**|**Type**|(% style="width:700px" %)**Documentation**
890 890  |ReferenceValue|//ReferenceValueType//|(% style="width:700px" %)ReferenceValue contains a value for a target reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that value can be validated against the format defined in the metadata structure definition.
... ... @@ -892,21 +892,17 @@
892 892  **//ReferenceValueType//: **ReferenceValueType is an abstract base type that forms the basis of a target reference value. A target reference value will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period. The choice of these options will be refined to only one according to the definition of the target in the metadata structure definition.
893 893  
894 894  Attributes:
895 -
896 896  id?
897 897  
898 898  Content:
899 -
900 900  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
901 901  
902 902  Attribute Documentation:
903 -
904 904  (% style="width:1013.29px" %)
905 905  |**Name**|**Type**|(% style="width:847px" %)**Documentation**
906 906  |id|com:IDType|(% style="width:847px" %)The id attribute holds the identifier of the target reference object reference as defined in the metadata structure definition. This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the target object definition will always be available if required for processing.
907 907  
908 908  Element Documentation:
909 -
910 910  (% style="width:1000.29px" %)
911 911  |**Name**|**Type**|(% style="width:563px" %)**Documentation**
912 912  |ObjectReference|//com:ReferenceType//|(% style="width:563px" %)ObjectReference provides a reference to an identifiable object in the SDMX information model. An identifiable object target will utilize this option as the representation of the target reference value. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that the type of reference is valid according to the object type specified in the identifiable object target in the metadata structure definition. At the very least, the reference will be specific to the type of object being referenced so that a complete set of reference fields must be provided. In cases where an item object is restricted to be from a particular scheme, this type will be further restricted so that only a valid item reference can be supplied. The structure of this reference is such that it can be generically processed without needing to know what the intended target object type is prior to processing, as this information is part of the reference.
... ... @@ -918,20 +918,16 @@
918 918  **//ReportedAttributeType//: **ReportedAttributeType is an abstract base type that forms the basis for a metadata structure specific metadata attribute. A value for the attribute can be supplied as either a single value, or multi-lingual text values (either structured or unstructured). An optional set of child metadata attributes is also available if the metadata attribute definition defines nested metadata attributes. The metadata structure definition specific schema will refine this type for each metadata attribute such that the content can be validation against what is defined in the metadata structure definition.
919 919  
920 920  Derivation:
921 -
922 922  * //com:AnnotableType// (extension) 
923 923  ** //ReportedAttributeType//
924 924  
925 925  Attributes:
926 -
927 927  id?, value?, isMetadataAttribute?
928 928  
929 929  Content:
930 -
931 931  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
932 932  
933 933  Attribute Documentation:
934 -
935 935  (% style="width:999.294px" %)
936 936  |**Name**|**Type**|(% style="width:660px" %)**Documentation**
937 937  |id|com:IDType|(% style="width:660px" %)The id attribute identifies the metadata attribute that the value is being reported for. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the metadata attribute will always be available if required for processing.
... ... @@ -939,7 +939,6 @@
939 939  |isMetadataAttribute (fixed: true)|xs:boolean|(% style="width:660px" %)The isMetadataAttribute attribute is a fixed boolean (true) and is intended to designate to processing applications that a given element represents a reported attribute. This attribute is qualified (meaning that it will be qualified in an instance with the target namespace) to ensure that it can be properly identified by applications. The purpose of this is to allow applications to identify elements with unknown names as reported attributes so that they may process a metadata structure definition specific instance without knowledge of the underlying metadata structure definition.
940 940  
941 941  Element Documentation:
942 -
943 943  (% style="width:997.294px" %)
944 944  |**Name**|**Type**|(% style="width:668px" %)**Documentation**
945 945  |com:Annotations|com:AnnotationsType|(% style="width:668px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it.
... ... @@ -1057,7 +1057,6 @@
1057 1057  > </xs:annotation>
1058 1058  > </xs:enumeration>
1059 1059  
1060 -
1061 1061  === 3.3.5 Representation with Text Format ===
1062 1062  
1063 1063  A representation which defines a text format will result in a simple type or primitive type. The first step is to determine the base type from the text format data type:
... ... @@ -1115,7 +1115,7 @@
1115 1115  |(% style="width:291px" %)**SDMX Facet**|(% style="width:479px" %)**XML Schema Facet**
1116 1116  |(% style="width:291px" %)minLength|(% style="width:479px" %)xs:minLength
1117 1117  |(% style="width:291px" %)maxLength|(% style="width:479px" %)xs:maxLength
1118 -|(% style="width:291px" %)minValue{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric{{/footnote}}^^{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric{{/footnote}}^^|(% style="width:479px" %)if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
988 +|(% style="width:291px" %)minValue{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric{{/footnote}}|(% style="width:479px" %)if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
1119 1119  |(% style="width:291px" %)maxValue^^2^^|(% style="width:479px" %)if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive
1120 1120  |(% style="width:291px" %)decimals^^2^^|(% style="width:479px" %)xs:fractionDigits
1121 1121  |(% style="width:291px" %)pattern|(% style="width:479px" %)xs:pattern
... ... @@ -1157,7 +1157,6 @@
1157 1157  A complex type named DataSetType must be created. Its content model will be derived via restriction. If the dimension at the observation level is the time dimension (TIME_PERIOD) the base type of the restriction is dsd:TimeSeriesDataSetType. Otherwise, the base type of the restriction is dsd:DataSetType. The complex type content model will be as follows:
1158 1158  
1159 1159  ~1. A sequence consisting of:
1160 -
1161 1161  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1162 1162  * b. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
1163 1163  * c. If the data structure defines groups, a local element named Group with a form of unqualified, a minimum occurrence of 0, and a maximum occurrence of unbounded. The type of this element should be the type that is described in the GroupType section which follows.
... ... @@ -1164,9 +1164,7 @@
1164 1164  * d. A choice with a minimum occurrence of 0 consisting of:
1165 1165  ** i. If the dimension at the observation level is not AllDimensions, a local element named Series with a form of unqualified, a maximum occurrence of unbounded, and a type of SeriesType (as defined in the SeriesType section which follows)
1166 1166  ** ii. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)
1167 -
1168 1168  2. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship of None, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1169 -
1170 1170  3. An attribute for each attribute defined in the data structured definition that declares an attribute relationship of None. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
1171 1171  
1172 1172  === 3.4.2 GroupType ===
... ... @@ -1174,25 +1174,17 @@
1174 1174  If the data structure definition defines only one group, a complex type with its name taken from the identifier of the lone group must be defined. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the dsd:GroupType. The complex type content model will be as follows:
1175 1175  
1176 1176  ~1. A sequence consisting of:
1177 -
1178 1178  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1179 -
1180 1180  2. An attribute for each dimension referenced by the group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
1181 -
1182 1182  3. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship with the group and does not specify the group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1183 -
1184 1184  4. An attribute for each attribute defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
1185 -
1186 1186  5. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group
1187 1187  
1188 1188  If the data structure definitions defines more than one group, an abstract complex type with name GroupType must be created. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the dsd:GroupType. The complex type content model will be as follows:
1189 1189  
1190 1190  ~1. A sequence consisting of:
1191 -
1192 1192  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1193 -
1194 1194  2. An attribute named type with a type of Group.ID, and a usage of optional
1195 -
1196 1196  3. An anyAttribute declaration with a namespace of ~#~#local
1197 1197  
1198 1198  A simple type named Group.ID must be created. This should restrict the common:IDType. For each group defined by the data structure definition, an enumeration will be created within the restriction with a value of the group identifier.
... ... @@ -1200,15 +1200,10 @@
1200 1200  For each group defined in the data structure definition, a complex type with its name taken from the group identifier is defined. Its content model will be derived via restriction of the previously defined GroupType. The complex type content model will be as follows:
1201 1201  
1202 1202  ~1. A sequence consisting of:
1203 -
1204 1204  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1205 -
1206 1206  2. An attribute for each dimension referenced by the group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
1207 -
1208 1208  3. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship with the group and does not specify the group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1209 -
1210 1210  4. An attribute for each attribute defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
1211 -
1212 1212  5. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group
1213 1213  
1214 1214  === 3.4.3 SeriesType ===
... ... @@ -1216,15 +1216,10 @@
1216 1216  If the dimension at the observation is not AllDimensions, a complex type name SeriesType must be created. Its content model will be derived via restriction. If the dimension at the observation level is the time dimension (TIME_PERIOD) the base type of the restriction is dsd:TimeSeriesType. Otherwise, the base type of the restriction is dsd:SeriesType. The complex type content model will be as follows:
1217 1217  
1218 1218  ~1. A sequence consisting of:
1219 -
1220 1220  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1221 -
1222 1222  2. A local element named Obs with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)
1223 -
1224 1224  3. An attribute for each dimension defined by the data structure definition, except for the dimension at the observation level. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
1225 -
1226 1226  4. If the reporting year start day attribute is not declared in the data structure definition or if it is declared and declares an attribute relationship of None, or with a group, or the dimension at the observation level, or specifies a group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1227 -
1228 1228  5. An attribute for each attribute defined in the data structure that declares an attribute relationship with any dimension outside of the dimension at the observation level (so long as it does not also declare an attachment group). The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional.
1229 1229  
1230 1230  === 3.4.4 ObsType ===
... ... @@ -1232,15 +1232,10 @@
1232 1232  A complex type name ObsType must be created. Its content model will be derived via restriction. If the dimension at the observation level is the time dimension (TIME_PERIOD) the base type of the restriction is dsd:TimeSeriesObsType. Otherwise, the base type of the restriction is dsd:ObsType. If the explicit measure option is used, this complex type must be abstract. The complex type content model will be as follows:
1233 1233  
1234 1234  ~1. A sequence consisting of:
1235 -
1236 1236  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1237 -
1238 1238  2. If the dimension at the observation level is not the time dimension (TIME_PERIOD) an attribute named TIME_PERIOD with a type of common:TimePeriodType and a usage of prohibited
1239 -
1240 1240  3. If the dimension at the observation level is not the time dimension (TIME_PERIOD) an attribute for the dimension at the observation level. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
1241 -
1242 1242  4. An attribute for the primary measure (OBS_VALUE) defined by the data structure definition. The XML attribute name and type is defined according to the general rules defined in the previous section, and the usage is optional
1243 -
1244 1244  5. An attribute for each attribute defined in the data structure that declares an attribute relationship with the dimension at the observation level or the primary measure (OBS_VALUE). The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
1245 1245  
1246 1246  An attribute named type. If the explicit measure option is not used, this attribute must have a type of common:IDType and a usage of prohibited. If the explicit measure option is used, this attribute must have a type of the simple type generated for the representation of the measure dimension that is the dimension at the observation level (this will be an simple type with enumerations with values of the concept identifiers which make up the concept scheme that is the representation of the measure dimension) a and a usage of optional
... ... @@ -1248,9 +1248,7 @@
1248 1248  If the explicit measure option is used, then complex type must be created for every concept which make up the representation of the measure dimension which is the dimension at the observation level. The name of this complex type will be taken from the identifier of the concept. Its content model will be derived via restriction of the ObsType. The complex type content model will be as follows:
1249 1249  
1250 1250  ~1. A sequence consisting of:
1251 -
1252 1252  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1253 -
1254 1254  2. If the core representation of the Concept differs from that of the primary measure, an attribute for the primary measure (OBS_VALUE) defined by the data structure definition, except for the dimension at the observation level. The XML name is defined according to the general rules defined in the previous section, and the usage is optional. The type of the attribute is the type that is generated for the core representation of the measure concept. Note that this representation type must have an explicit derivation from the type resulting from the primary measure. For example, if the primary measure type is xyz:CodeType, then the simple type which is defined for the core representation of the concept must restrict xyz:CodeType or one another type which restricts it
1255 1255  
1256 1256  3. An attribute named type with a type of the simple type generated for the representation of the measure dimension that is the dimension at the observation level, a usage of optional, and a fixed value of the concept identifier.
... ... @@ -1266,7 +1266,6 @@
1266 1266  A complex type that must be named MetadataSetType must be created. Its content model will be derived via restriction of the base type, msd:MetadataSetType. The complex type content model will be as follows:
1267 1267  
1268 1268  ~1. A sequence consisting of:
1269 -
1270 1270  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1271 1271  * b. An element reference to common:Name, with a minimum occurrence of 0 and a maximum occurrence of unbounded
1272 1272  * c. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
... ... @@ -1277,9 +1277,7 @@
1277 1277  An abstract complex type with a recommended name of TargetType must be created. Its content model will be derived via restriction of the msd:TargetType. The complex type content model will be as follows:
1278 1278  
1279 1279  ~1. A sequence consisting of:
1280 -
1281 1281  * a. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1282 -
1283 1283  2. An attribute named id with a type of Target.ID, and a usage of optional
1284 1284  
1285 1285  A simple type with a recommended name of Target.ID must be created. This should restrict the common:IDType. For each report structure defined by the metadata structure definition, an enumeration will be created within the restriction with a value of the report structure identifier.
... ... @@ -1289,36 +1289,30 @@
1289 1289  An abstract complex type with a recommended name of [metadata target identifier].ReferenceValueType will be created. Its content model will be derived via restriction of the msd:ReferenceValueType. The complex type content model will be as follows:
1290 1290  
1291 1291  ~1. A choice consisting of:
1292 -
1293 1293  * a. A local element named ObjectReference with a type of common:ReferenceType, and a form of unqualified
1294 1294  * b. A local element named DataKey with a type of common:DataKeyType, and a form of unqualified
1295 1295  * c. A local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified
1296 1296  * d. A local element named ReportPeriod with a type of common:ObservationalTimePeriodType, and a form of unqualified
1297 -
1298 1298  2. An attribute named id with the type defined previously as [metadata target identifier].TargetObject.ID, and a usage of optional
1299 1299  
1300 1300  For each metadata target defined in the metadata structure definition, a content group with a recommended name of [metadata target identifier] with be defined. Its content model will be as follows:
1301 1301  
1302 1302  ~1. A sequence consisting of:
1303 -
1304 1304  * a. A local element named ReferenceValue with the type previously defined as [metadata target identifier].ReferenceValueType, a form of unqualified, and a minimum and maximum occurrence of the number of target objects defined within the metadata target
1305 1305  
1306 1306  For each target object defined by the metadata target, a complex type that must be named [metadata target identifier].[target object identifier] must be created. Its content model will be derived via restriction of the type previously created as [metadata target identifier].ReferenceValueType type created prior to this. The complex type content model will be as follows:
1307 1307  
1308 1308  ~1. A choice consisting of:
1309 -
1310 1310  * a. If the target object is an identifiable object target, a local element named ObjectReference with a type determined as defined in Identifiable Object Target Type Determination:
1311 1311  * b. If the target object is an key descriptor values target, a local element named DataKey with a type of common:DataKeyType, and a form of unqualified
1312 1312  * c. If the target object is a data set target, a local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified
1313 1313  * d. If the target object is a constraint target, a local element named ConstraintReference with a type of common:AttachmentConstraintReferenceType, and a form of unqualified
1314 1314  * e. If the target object is report period target, a local element named ReportPeriod with a form of unqualified, and a [[type>>path:#_Simple_/_Primitive]] as defined based on the data type of the local representation according to the general rules defined in the previous section
1315 -
1316 1316  2. An attribute named id with a type previously created as [metadata target identifier].TargetObject.ID, a usage of optional, and fixed value of the target object identifier
1317 1317  
1318 1318  The final complex type (which will be the determined type) is derived by restriction from the reference type determined above. The suggested name of this type is [metadata target identifier].[target object identifier].Reference. The content model of this type will be as follows:
1319 1319  
1320 1320  ~1. A choice consisting of:
1321 -
1322 1322  * a. A sequence consisting of
1323 1323  ** i. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref
1324 1324  ** ii. A local element named URN, with a form of unqualified, a minimum occurrence of 0, and the type defined above as [item scheme agency].[item scheme identifier].[item scheme version].URN
... ... @@ -1350,11 +1350,9 @@
1350 1350  An abstract complex type with a recommended name of ReportType must be created. Its content model will be derived via restriction of the msd:ReportType. The complex type content model will be as follows:
1351 1351  
1352 1352  ~1. A sequence consisting of:
1353 -
1354 1354  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1355 1355  * b. A local element named Target with the type previously defined as TargetType and a form of unqualified
1356 1356  * c. A local element named AttributeSet with no type assigned and a form of unqualified
1357 -
1358 1358  2. An attribute named id with a type previously defined as Report.ID, and a usage of optional
1359 1359  
1360 1360  For each report structure defined in the metadata structure definition, a complex type with its name taken from the report structure identifier must be defined. In order to construct this type, some other complex type must be defined first.
... ... @@ -1364,9 +1364,7 @@
1364 1364  An abstract complex type must be create, with a recommended name of [report structure identifier].TargetType. Its content model will be derived by restriction of the type previously created as TargetType. The content model of this type must be as follows:
1365 1365  
1366 1366  ~1. A sequence consisting of:
1367 -
1368 1368  * a. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1369 -
1370 1370  2. An attribute named id with the type previously created as [report structure identifier].Target.ID, and a use of optional
1371 1371  
1372 1372  For each metadata target referenced from the report structure, a complex type that must be named [report structure identifier].[metadata target identifier] must be created. This type must derived its content by restriction of the type previously defined as [report structure identifier].TargetType. The content model is as follows:
... ... @@ -1377,14 +1377,11 @@
1377 1377  For every metadata attribute defined by the report structure a complex type must be created with the recommended name of [report structure identifier].[nested metadata attribute identifier]. Note that the recommend name assumes the metadata attribute identifier is the nested identifier for the full hierarchy in which the metadata attribute was defined. This content model of this type is derived from restriction of the msd:ReportedAttributeType. The content of this must consists be as follows:
1378 1378  
1379 1379  ~1. A sequence consisting of:
1380 -
1381 1381  a. An element reference to common:Annotations, with a minimum occurrence of 0
1382 -
1383 1383  * a. If the isPresentational flag is not set to true:
1384 1384  * b. If the determined representation has data type of XHTML, an element reference to common:StructuredText with a maximum occurrence of unbounded
1385 1385  ** i. If the determined representation has is not XHTML, but has a facet of isMultiLinguale, an element reference to common: Text with a maximum occurrence of unbounded
1386 1386  ** ii. If the metadata attribute defines which child metadata attributes, a local element named AttributeSet with a form of unqualified, and a type as defined according to the rules defined in Attribute Set Complex Type Creation
1387 -
1388 1388  2. An attribute named id with a type of common:IDType, a use of optional, and a fixed value of [metadata attribute identifier], where this identifier is not nested
1389 1389  
1390 1390  If the isPresentational flag is not set to true, and the determined representation is not XHTML and does not have a facet of isMultiLingual, an attribute named value where the [[type>>path:#_Simple_/_Primitive]] is defined according to the general rules defined in the previous section, and the use is required
... ... @@ -1392,13 +1392,11 @@
1392 1392  For each report structure defined in the metadata structure, a complex type that must be named [report structure identifier] must be created. Its content model will be derived via restriction of the previously defined ReportType. The complex type content model will be as follows:
1393 1393  
1394 1394  ~1. A sequence consisting of:
1395 -
1396 1396  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1397 1397  * b. A local element named Target with the type previously defined as [report structure identifier].TargetType, and a form of unqualified. This element must define a uniqueness constraint with a recommended name of [report structure identifier].Target.ReferenceValue.Unique. This uniqueness constraint must contain:
1398 1398  ** i. A selector with an xpath of "*"
1399 1399  ** ii. A field with an xpath of "@id"
1400 1400  * c. A local element named AttributeSet with a form of unqualified and a type as defined according to the rules defined in Attribute Set Complex Type Creation
1401 -
1402 1402  2. An attribute named id with the type previously defined as Report.ID, a use of optional, and a fixed value of [report structure identifier]
1403 1403  
1404 1404  ==== 3.5.3.1 Attribute Set Complex Type Creation ====
... ... @@ -1406,7 +1406,6 @@
1406 1406  An attribute set is created for a report structure or a metadata attribute which contains child metadata attributes. This type is a complex type with a recommend name of [report structure identifier].[nested metadata attribute identifier].AttributeSet, where the metadata attribute section only applies to attribute sets created for metadata attributes and is assumed to consist of the full hierarchy of the metadata attribute's definition. This complex type must consists of:
1407 1407  
1408 1408  ~1. A sequence consisting of:
1409 -
1410 1410  * a. A local element for each metadata attribute defined as a direct child of the object for which the attribute set is being created. The recommended name of this element is [metadata attribute identifier] and it has a form of unqualified. If the metadata attribute defines a minOccurs and maxOccurs, these values are translated to this element. The type of this element is the type previously created as [report structure identifier].[nested metadata attribute identifier].
1411 1411  
1412 1412  = 4. Special data functions =