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

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

Summary

Details

Page properties
Content
... ... @@ -32,6 +32,7 @@
32 32  |(% style="width:487px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:120px" %)xs
33 33  
34 34  Contents:
35 +
35 35  13 Complex Types
36 36  
37 37  === 2.1.2 Complex Types ===
... ... @@ -44,12 +44,15 @@
44 44  ** DataSetType
45 45  
46 46  Attributes:
48 +
47 47  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
48 48  
49 49  Content:
52 +
50 50  com:Annotations?, DataProvider?, Attributes?, Group*, (Series+ | Obs+)?
51 51  
52 52  Attribute Documentation:
56 +
53 53  (% style="width:1011.29px" %)
54 54  |**Name**|**Type**|(% style="width:597px" %)**Documentation**
55 55  |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).
... ... @@ -63,6 +63,7 @@
63 63  |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).
64 64  
65 65  Element Documentation:
70 +
66 66  (% style="width:1016.29px" %)
67 67  |**Name**|**Type**|(% style="width:642px" %)**Documentation**
68 68  |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.
... ... @@ -75,21 +75,26 @@
75 75  **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.
76 76  
77 77  Derivation:
83 +
78 78  * //com:AnnotableType// (extension) 
79 79  ** GroupType
80 80  
81 81  Attributes:
88 +
82 82  type
83 83  
84 84  Content:
92 +
85 85  com:Annotations?, GroupKey?, Attributes
86 86  
87 87  Attribute Documentation:
96 +
88 88  (% style="width:1010.29px" %)
89 89  |**Name**|**Type**|(% style="width:709px" %)**Documentation**
90 90  |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.
91 91  
92 92  Element Documentation:
102 +
93 93  (% style="width:1014.29px" %)
94 94  |**Name**|**Type**|(% style="width:704px" %)**Documentation**
95 95  |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.
... ... @@ -99,13 +99,16 @@
99 99  **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.
100 100  
101 101  Derivation:
112 +
102 102  * //com:AnnotableType// (extension) 
103 103  ** SeriesType
104 104  
105 105  Content:
117 +
106 106  com:Annotations?, SeriesKey, Attributes?, Obs*
107 107  
108 108  Element Documentation:
121 +
109 109  (% style="width:999.294px" %)
110 110  |**Name**|**Type**|(% style="width:689px" %)**Documentation**
111 111  |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.
... ... @@ -116,13 +116,16 @@
116 116  **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.
117 117  
118 118  Derivation:
132 +
119 119  * //com:AnnotableType// (extension) 
120 120  ** ObsOnlyType
121 121  
122 122  Content:
137 +
123 123  com:Annotations?, ObsKey, ObsValue?, Attributes?
124 124  
125 125  Element Documentation:
141 +
126 126  (% style="width:996.294px" %)
127 127  |**Name**|**Type**|(% style="width:651px" %)**Documentation**
128 128  |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.
... ... @@ -133,13 +133,16 @@
133 133  **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.
134 134  
135 135  Derivation:
152 +
136 136  * //com:AnnotableType// (extension) 
137 137  ** ObsType
138 138  
139 139  Content:
157 +
140 140  com:Annotations?, ObsDimension, ObsValue?, Attributes?
141 141  
142 142  Element Documentation:
161 +
143 143  (% style="width:1004.29px" %)
144 144  |**Name**|**Type**|(% style="width:694px" %)**Documentation**
145 145  |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.
... ... @@ -150,9 +150,11 @@
150 150  **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.
151 151  
152 152  Content:
172 +
153 153  Value+
154 154  
155 155  Element Documentation:
176 +
156 156  (% style="width:1008.29px" %)
157 157  |**Name**|(% style="width:185px" %)**Type**|(% style="width:692px" %)**Documentation**
158 158  |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.
... ... @@ -160,12 +160,15 @@
160 160  **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.
161 161  
162 162  Attributes:
184 +
163 163  id?, value
164 164  
165 165  Content:
188 +
166 166  {Empty}
167 167  
168 168  Attribute Documentation:
192 +
169 169  (% style="width:1003.29px" %)
170 170  |**Name**|(% style="width:194px" %)**Type**|(% style="width:664px" %)**Documentation**
171 171  |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.
... ... @@ -174,16 +174,20 @@
174 174  **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.
175 175  
176 176  Derivation:
201 +
177 177  * BaseValueType (restriction) 
178 178  ** ObsValueType
179 179  
180 180  Attributes:
206 +
181 181  id?, value
182 182  
183 183  Content:
210 +
184 184  {Empty}
185 185  
186 186  Attribute Documentation:
214 +
187 187  (% style="width:1004.29px" %)
188 188  |(% style="width:190px" %)**Name**|(% style="width:213px" %)**Type**|(% style="width:598px" %)**Documentation**
189 189  |(% 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.
... ... @@ -192,16 +192,20 @@
192 192  **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.
193 193  
194 194  Derivation:
223 +
195 195  * BaseValueType (restriction) 
196 196  ** ComponentValueType
197 197  
198 198  Attributes:
228 +
199 199  id, value
200 200  
201 201  Content:
232 +
202 202  {Empty}
203 203  
204 204  Attribute Documentation:
236 +
205 205  (% style="width:1008.29px" %)
206 206  |**Name**|(% style="width:184px" %)**Type**|(% style="width:679px" %)**Documentation**
207 207  |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.
... ... @@ -210,17 +210,21 @@
210 210  **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.
211 211  
212 212  Derivation:
245 +
213 213  * //com:AnnotableType// (extension) 
214 214  ** DataSetType (restriction) 
215 215  *** TimeSeriesDataSetType
216 216  
217 217  Attributes:
251 +
218 218  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
219 219  
220 220  Content:
255 +
221 221  com:Annotations?, DataProvider?, Attributes?, Group*, Series*
222 222  
223 223  Attribute Documentation:
259 +
224 224  (% style="width:1004.29px" %)
225 225  |**Name**|**Type**|(% style="width:590px" %)**Documentation**
226 226  |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).
... ... @@ -234,6 +234,7 @@
234 234  |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).
235 235  
236 236  Element Documentation:
273 +
237 237  (% style="width:999.294px" %)
238 238  |**Name**|**Type**|(% style="width:622px" %)**Documentation**
239 239  |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.
... ... @@ -245,14 +245,17 @@
245 245  **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.
246 246  
247 247  Derivation:
285 +
248 248  * //com:AnnotableType// (extension) 
249 249  ** SeriesType (restriction) 
250 250  *** TimeSeriesType
251 251  
252 252  Content:
291 +
253 253  com:Annotations?, SeriesKey, Attributes?, Obs*
254 254  
255 255  Element Documentation:
295 +
256 256  (% style="width:1012.29px" %)
257 257  |**Name**|**Type**|(% style="width:695px" %)**Documentation**
258 258  |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.
... ... @@ -263,14 +263,17 @@
263 263  **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.
264 264  
265 265  Derivation:
306 +
266 266  * //com:AnnotableType// (extension) 
267 267  ** ObsType (restriction) 
268 268  *** TimeSeriesObsType
269 269  
270 270  Content:
312 +
271 271  com:Annotations?, ObsDimension, ObsValue?, Attributes?
272 272  
273 273  Element Documentation:
316 +
274 274  (% style="width:1019.29px" %)
275 275  |**Name**|**Type**|(% style="width:709px" %)**Documentation**
276 276  |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.
... ... @@ -281,16 +281,20 @@
281 281  **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.
282 282  
283 283  Derivation:
327 +
284 284  * BaseValueType (restriction) 
285 285  ** TimeValueType
286 286  
287 287  Attributes:
332 +
288 288  id?, value
289 289  
290 290  Content:
336 +
291 291  {Empty}
292 292  
293 293  Attribute Documentation:
340 +
294 294  (% style="width:1013.29px" %)
295 295  |(% style="width:205px" %)**Name**|(% style="width:277px" %)**Type**|(% style="width:528px" %)**Documentation**
296 296  |(% 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.
... ... @@ -310,6 +310,7 @@
310 310  |(% style="width:475px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:549px" %)xs
311 311  
312 312  Contents:
360 +
313 313  7 Complex Types
314 314  1 Simple Type
315 315  
... ... @@ -318,16 +318,20 @@
318 318  **//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.
319 319  
320 320  Derivation:
369 +
321 321  * //com:AnnotableType// (extension)
322 322  ** //DataSetType//
323 323  
324 324  Attributes:
374 +
325 325  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?
326 326  
327 327  Content:
378 +
328 328  com:Annotations?, DataProvider?, Group*, (Series+ | Obs+)?
329 329  
330 330  Attribute Documentation:
382 +
331 331  (% style="width:1005.29px" %)
332 332  |(% style="width:199px" %)**Name**|(% style="width:216px" %)**Type**|(% style="width:521px" %)**Documentation**
333 333  |(% 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).
... ... @@ -343,6 +343,7 @@
343 343  |(% 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.
344 344  
345 345  Element Documentation:
398 +
346 346  (% style="width:1005.29px" %)
347 347  |**Name**|**Type**|(% style="width:630px" %)**Documentation**
348 348  |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.
... ... @@ -354,16 +354,20 @@
354 354  **//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.
355 355  
356 356  Derivation:
410 +
357 357  * //com:AnnotableType// (extension) 
358 358  ** //GroupType//
359 359  
360 360  Attributes:
415 +
361 361  type?, REPORTING_YEAR_START_DAY?
362 362  
363 363  Content:
419 +
364 364  com:Annotations?
365 365  
366 366  Attribute Documentation:
423 +
367 367  (% style="width:1008.29px" %)
368 368  |**Name**|**Type**|(% style="width:621px" %)**Documentation**
369 369  |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.
... ... @@ -370,6 +370,7 @@
370 370  |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.
371 371  
372 372  Element Documentation:
430 +
373 373  |**Name**|**Type**|**Documentation**
374 374  |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.
375 375  
... ... @@ -376,16 +376,20 @@
376 376  **//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.
377 377  
378 378  Derivation:
437 +
379 379  * //com:AnnotableType// (extension) 
380 380  ** //SeriesType//
381 381  
382 382  Attributes:
442 +
383 383  TIME_PERIOD?, REPORTING_YEAR_START_DAY?
384 384  
385 385  Content:
446 +
386 386  com:Annotations?, Obs*
387 387  
388 388  Attribute Documentation:
450 +
389 389  (% style="width:1002.29px" %)
390 390  |**Name**|**Type**|(% style="width:533px" %)**Documentation**
391 391  |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.
... ... @@ -392,6 +392,7 @@
392 392  |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.
393 393  
394 394  Element Documentation:
457 +
395 395  |**Name**|**Type**|**Documentation**
396 396  |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.
397 397  |Obs|//ObsType//|
... ... @@ -399,16 +399,20 @@
399 399  **//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.
400 400  
401 401  Derivation:
465 +
402 402  * //com:AnnotableType// (extension) 
403 403  ** //ObsType//
404 404  
405 405  Attributes:
470 +
406 406  type?, TIME_PERIOD?, REPORTING_YEAR_START_DAY?, OBS_VALUE?
407 407  
408 408  Content:
474 +
409 409  com:Annotations?
410 410  
411 411  Attribute Documentation:
478 +
412 412  (% style="width:1014.29px" %)
413 413  |**Name**|**Type**|(% style="width:505px" %)**Documentation**
414 414  |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.
... ... @@ -417,6 +417,7 @@
417 417  |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.
418 418  
419 419  Element Documentation:
487 +
420 420  |**Name**|**Type**|**Documentation**
421 421  |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.
422 422  
... ... @@ -423,17 +423,21 @@
423 423  **//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.
424 424  
425 425  Derivation:
494 +
426 426  * //com:AnnotableType// (extension) 
427 427  ** //DataSetType// (restriction) 
428 428  *** //TimeSeriesDataSetType//
429 429  
430 430  Attributes:
500 +
431 431  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?
432 432  
433 433  Content:
504 +
434 434  com:Annotations?, DataProvider?, Group*, Series*
435 435  
436 436  Attribute Documentation:
508 +
437 437  (% style="width:1003.29px" %)
438 438  |(% style="width:213px" %)**Name**|(% style="width:274px" %)**Type**|(% style="width:461px" %)**Documentation**
439 439  |(% 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).
... ... @@ -449,6 +449,7 @@
449 449  |(% 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.
450 450  
451 451  Element Documentation:
524 +
452 452  (% style="width:1007.29px" %)
453 453  |**Name**|**Type**|(% style="width:632px" %)**Documentation**
454 454  |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.
... ... @@ -459,22 +459,27 @@
459 459  **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.
460 460  
461 461  Derivation:
535 +
462 462  * //com:AnnotableType// (extension) 
463 463  ** //SeriesType// (restriction) 
464 464  *** TimeSeriesType
465 465  
466 466  Attributes:
541 +
467 467  REPORTING_YEAR_START_DAY?
468 468  
469 469  Content:
545 +
470 470  com:Annotations?, Obs*
471 471  
472 472  Attribute Documentation:
549 +
473 473  (% style="width:1004.29px" %)
474 474  |**Name**|**Type**|(% style="width:617px" %)**Documentation**
475 475  |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.
476 476  
477 477  Element Documentation:
555 +
478 478  (% style="width:1003.29px" %)
479 479  |**Name**|**Type**|(% style="width:593px" %)**Documentation**
480 480  |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.
... ... @@ -483,17 +483,21 @@
483 483  **//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.
484 484  
485 485  Derivation:
564 +
486 486  * //com:AnnotableType// (extension) 
487 487  ** //ObsType// (restriction) 
488 488  *** //TimeSeriesObsType//
489 489  
490 490  Attributes:
570 +
491 491  TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE?
492 492  
493 493  Content:
574 +
494 494  com:Annotations?
495 495  
496 496  Attribute Documentation:
578 +
497 497  (% style="width:1005.29px" %)
498 498  |**Name**|**Type**|(% style="width:496px" %)**Documentation**
499 499  |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.
... ... @@ -501,6 +501,7 @@
501 501  |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.
502 502  
503 503  Element Documentation:
586 +
504 504  (% style="width:1013.29px" %)
505 505  |**Name**|**Type**|(% style="width:603px" %)**Documentation**
506 506  |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.
... ... @@ -542,13 +542,16 @@
542 542  **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.
543 543  
544 544  Derivation:
628 +
545 545  * //com:AnnotableType// (extension) 
546 546  ** MetadataSetType
547 547  
548 548  Attributes:
633 +
549 549  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
550 550  
551 551  Content:
637 +
552 552  com:Annotations?, com:Name*, DataProvider?, Report+
553 553  
554 554  Attribute Documentation:
... ... @@ -566,6 +566,7 @@
566 566  |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).
567 567  
568 568  Element Documentation:
655 +
569 569  (% style="width:1006.29px" %)
570 570  |**Name**|(% style="width:268px" %)**Type**|(% style="width:562px" %)**Documentation**
571 571  |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.
... ... @@ -576,21 +576,26 @@
576 576  **ReportType: **ReportType contains a set of report attributes and identifies a target objects] to which they apply.
577 577  
578 578  Derivation:
666 +
579 579  * //com:AnnotableType// (extension) 
580 580  ** ReportType
581 581  
582 582  Attributes:
671 +
583 583  id
584 584  
585 585  Content:
675 +
586 586  com:Annotations?, Target, AttributeSet
587 587  
588 588  Attribute Documentation:
679 +
589 589  (% style="width:1003.29px" %)
590 590  |**Name**|**Type**|(% style="width:788px" %)**Documentation**
591 591  |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.
592 592  
593 593  Element Documentation:
685 +
594 594  (% style="width:1003.29px" %)
595 595  |**Name**|**Type**|(% style="width:593px" %)**Documentation**
596 596  |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.
... ... @@ -600,17 +600,21 @@
600 600  **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.
601 601  
602 602  Attributes:
695 +
603 603  id
604 604  
605 605  Content:
699 +
606 606  ReferenceValue+
607 607  
608 608  Attribute Documentation:
703 +
609 609  (% style="width:1003.29px" %)
610 610  |**Name**|**Type**|(% style="width:805px" %)**Documentation**
611 611  |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.
612 612  
613 613  Element Documentation:
709 +
614 614  (% style="width:1009.29px" %)
615 615  |**Name**|**Type**|(% style="width:710px" %)**Documentation**
616 616  |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.
... ... @@ -618,12 +618,15 @@
618 618  **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.
619 619  
620 620  Attributes:
717 +
621 621  id
622 622  
623 623  Content:
721 +
624 624  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
625 625  
626 626  Attribute Documentation:
725 +
627 627  (% style="width:1013.29px" %)
628 628  |**Name**|**Type**|(% style="width:847px" %)**Documentation**
629 629  |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.
... ... @@ -641,9 +641,11 @@
641 641  **AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata attributes.
642 642  
643 643  Content:
743 +
644 644  ReportedAttribute+
645 645  
646 646  Element Documentation:
747 +
647 647  (% style="width:1023.29px" %)
648 648  |(% style="width:150px" %)**Name**|(% style="width:202px" %)**Type**|(% style="width:668px" %)**Documentation**
649 649  |(% 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.
... ... @@ -651,16 +651,20 @@
651 651  **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.
652 652  
653 653  Derivation:
755 +
654 654  * //com:AnnotableType// (extension) 
655 655  ** ReportedAttributeType
656 656  
657 657  Attributes:
760 +
658 658  id, value?
659 659  
660 660  Content:
764 +
661 661  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
662 662  
663 663  Attribute Documentation:
768 +
664 664  (% style="width:996.294px" %)
665 665  |**Name**|(% style="width:170px" %)**Type**|(% style="width:657px" %)**Documentation**
666 666  |id|(% style="width:170px" %)com:IDType|(% style="width:657px" %)The id attribute identifies the metadata attribute that the value is being reported for.
... ... @@ -667,6 +667,7 @@
667 667  |value|(% style="width:170px" %)xs:string|(% style="width:657px" %)The value attribute holds any simple value for the metadata attribute.
668 668  
669 669  Element Documentation:
775 +
670 670  (% style="width:999.294px" %)
671 671  |**Name**|**Type**|(% style="width:670px" %)**Documentation**
672 672  |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.
... ... @@ -689,6 +689,7 @@
689 689  |(% style="width:492px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:159px" %)xs
690 690  
691 691  Contents:
798 +
692 692  5 Complex Types
693 693  
694 694  === 2.4.2 Complex Types ===
... ... @@ -696,6 +696,7 @@
696 696  **//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.
697 697  
698 698  Derivation:
806 +
699 699  * //com:AnnotableType// (extension) 
700 700  ** //MetadataSetType//
701 701  
... ... @@ -704,9 +704,11 @@
704 704  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
705 705  
706 706  Content:
815 +
707 707  com:Annotations?, com:Name*, DataProvider?, Report+
708 708  
709 709  Attribute Documentation:
819 +
710 710  (% style="width:1003.29px" %)
711 711  |**Name**|**Type**|(% style="width:607px" %)**Documentation**
712 712  |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).
... ... @@ -720,6 +720,7 @@
720 720  |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).
721 721  
722 722  Element Documentation:
833 +
723 723  (% style="width:1006.29px" %)
724 724  |**Name**|**Type**|(% style="width:631px" %)**Documentation**
725 725  |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.
... ... @@ -730,21 +730,26 @@
730 730  **//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.
731 731  
732 732  Derivation:
844 +
733 733  * //com:AnnotableType// (extension) 
734 734  ** //ReportType//
735 735  
736 736  Attributes:
849 +
737 737  id?
738 738  
739 739  Content:
853 +
740 740  com:Annotations?, Target, AttributeSet
741 741  
742 742  Attribute Documentation:
857 +
743 743  (% style="width:1003.29px" %)
744 744  |**Name**|**Type**|(% style="width:837px" %)**Documentation**
745 745  |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.
746 746  
747 747  Element Documentation:
863 +
748 748  (% style="width:1005.29px" %)
749 749  |**Name**|**Type**|(% style="width:695px" %)**Documentation**
750 750  |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.
... ... @@ -754,17 +754,21 @@
754 754  **//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.
755 755  
756 756  Attributes:
873 +
757 757  id?
758 758  
759 759  Content:
877 +
760 760  ReferenceValue+
761 761  
762 762  Attribute Documentation:
881 +
763 763  (% style="width:999.294px" %)
764 764  |**Name**|**Type**|(% style="width:833px" %)**Documentation**
765 765  |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.
766 766  
767 767  Element Documentation:
887 +
768 768  (% style="width:999.294px" %)
769 769  |**Name**|**Type**|(% style="width:700px" %)**Documentation**
770 770  |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.
... ... @@ -772,17 +772,21 @@
772 772  **//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.
773 773  
774 774  Attributes:
895 +
775 775  id?
776 776  
777 777  Content:
899 +
778 778  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
779 779  
780 780  Attribute Documentation:
903 +
781 781  (% style="width:1013.29px" %)
782 782  |**Name**|**Type**|(% style="width:847px" %)**Documentation**
783 783  |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.
784 784  
785 785  Element Documentation:
909 +
786 786  (% style="width:1000.29px" %)
787 787  |**Name**|**Type**|(% style="width:563px" %)**Documentation**
788 788  |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.
... ... @@ -794,16 +794,20 @@
794 794  **//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.
795 795  
796 796  Derivation:
921 +
797 797  * //com:AnnotableType// (extension) 
798 798  ** //ReportedAttributeType//
799 799  
800 800  Attributes:
926 +
801 801  id?, value?, isMetadataAttribute?
802 802  
803 803  Content:
930 +
804 804  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
805 805  
806 806  Attribute Documentation:
934 +
807 807  (% style="width:999.294px" %)
808 808  |**Name**|**Type**|(% style="width:660px" %)**Documentation**
809 809  |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.
... ... @@ -811,6 +811,7 @@
811 811  |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.
812 812  
813 813  Element Documentation:
942 +
814 814  (% style="width:997.294px" %)
815 815  |**Name**|**Type**|(% style="width:668px" %)**Documentation**
816 816  |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.
... ... @@ -928,6 +928,7 @@
928 928  > </xs:annotation>
929 929  > </xs:enumeration>
930 930  
1060 +
931 931  === 3.3.5 Representation with Text Format ===
932 932  
933 933  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:
... ... @@ -1027,6 +1027,7 @@
1027 1027  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:
1028 1028  
1029 1029  ~1. A sequence consisting of:
1160 +
1030 1030  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1031 1031  * b. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
1032 1032  * 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.
... ... @@ -1033,7 +1033,9 @@
1033 1033  * d. A choice with a minimum occurrence of 0 consisting of:
1034 1034  ** 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)
1035 1035  ** 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 +
1036 1036  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 +
1037 1037  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
1038 1038  
1039 1039  === 3.4.2 GroupType ===
... ... @@ -1041,17 +1041,25 @@
1041 1041  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:
1042 1042  
1043 1043  ~1. A sequence consisting of:
1177 +
1044 1044  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1179 +
1045 1045  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 +
1046 1046  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 +
1047 1047  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 +
1048 1048  5. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group
1049 1049  
1050 1050  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:
1051 1051  
1052 1052  ~1. A sequence consisting of:
1191 +
1053 1053  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1193 +
1054 1054  2. An attribute named type with a type of Group.ID, and a usage of optional
1195 +
1055 1055  3. An anyAttribute declaration with a namespace of ~#~#local
1056 1056  
1057 1057  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.
... ... @@ -1059,10 +1059,15 @@
1059 1059  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:
1060 1060  
1061 1061  ~1. A sequence consisting of:
1203 +
1062 1062  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1205 +
1063 1063  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 +
1064 1064  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 +
1065 1065  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 +
1066 1066  5. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group
1067 1067  
1068 1068  === 3.4.3 SeriesType ===
... ... @@ -1070,10 +1070,15 @@
1070 1070  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:
1071 1071  
1072 1072  ~1. A sequence consisting of:
1219 +
1073 1073  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1221 +
1074 1074  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 +
1075 1075  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 +
1076 1076  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 +
1077 1077  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.
1078 1078  
1079 1079  === 3.4.4 ObsType ===
... ... @@ -1081,10 +1081,15 @@
1081 1081  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:
1082 1082  
1083 1083  ~1. A sequence consisting of:
1235 +
1084 1084  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1237 +
1085 1085  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 +
1086 1086  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 +
1087 1087  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 +
1088 1088  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
1089 1089  
1090 1090  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
... ... @@ -1092,7 +1092,9 @@
1092 1092  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:
1093 1093  
1094 1094  ~1. A sequence consisting of:
1251 +
1095 1095  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1253 +
1096 1096  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
1097 1097  
1098 1098  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.
... ... @@ -1108,6 +1108,7 @@
1108 1108  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:
1109 1109  
1110 1110  ~1. A sequence consisting of:
1269 +
1111 1111  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1112 1112  * b. An element reference to common:Name, with a minimum occurrence of 0 and a maximum occurrence of unbounded
1113 1113  * c. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
... ... @@ -1118,7 +1118,9 @@
1118 1118  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:
1119 1119  
1120 1120  ~1. A sequence consisting of:
1280 +
1121 1121  * a. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1282 +
1122 1122  2. An attribute named id with a type of Target.ID, and a usage of optional
1123 1123  
1124 1124  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.
... ... @@ -1128,30 +1128,36 @@
1128 1128  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:
1129 1129  
1130 1130  ~1. A choice consisting of:
1292 +
1131 1131  * a. A local element named ObjectReference with a type of common:ReferenceType, and a form of unqualified
1132 1132  * b. A local element named DataKey with a type of common:DataKeyType, and a form of unqualified
1133 1133  * c. A local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified
1134 1134  * d. A local element named ReportPeriod with a type of common:ObservationalTimePeriodType, and a form of unqualified
1297 +
1135 1135  2. An attribute named id with the type defined previously as [metadata target identifier].TargetObject.ID, and a usage of optional
1136 1136  
1137 1137  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:
1138 1138  
1139 1139  ~1. A sequence consisting of:
1303 +
1140 1140  * 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
1141 1141  
1142 1142  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:
1143 1143  
1144 1144  ~1. A choice consisting of:
1309 +
1145 1145  * 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:
1146 1146  * 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
1147 1147  * 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
1148 1148  * 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
1149 1149  * 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 +
1150 1150  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
1151 1151  
1152 1152  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:
1153 1153  
1154 1154  ~1. A choice consisting of:
1321 +
1155 1155  * a. A sequence consisting of
1156 1156  ** i. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref
1157 1157  ** 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
... ... @@ -1183,9 +1183,11 @@
1183 1183  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:
1184 1184  
1185 1185  ~1. A sequence consisting of:
1353 +
1186 1186  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1187 1187  * b. A local element named Target with the type previously defined as TargetType and a form of unqualified
1188 1188  * c. A local element named AttributeSet with no type assigned and a form of unqualified
1357 +
1189 1189  2. An attribute named id with a type previously defined as Report.ID, and a usage of optional
1190 1190  
1191 1191  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.
... ... @@ -1195,7 +1195,9 @@
1195 1195  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:
1196 1196  
1197 1197  ~1. A sequence consisting of:
1367 +
1198 1198  * a. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1369 +
1199 1199  2. An attribute named id with the type previously created as [report structure identifier].Target.ID, and a use of optional
1200 1200  
1201 1201  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:
... ... @@ -1206,11 +1206,14 @@
1206 1206  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:
1207 1207  
1208 1208  ~1. A sequence consisting of:
1380 +
1209 1209  a. An element reference to common:Annotations, with a minimum occurrence of 0
1382 +
1210 1210  * a. If the isPresentational flag is not set to true:
1211 1211  * b. If the determined representation has data type of XHTML, an element reference to common:StructuredText with a maximum occurrence of unbounded
1212 1212  ** 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
1213 1213  ** 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 +
1214 1214  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
1215 1215  
1216 1216  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
... ... @@ -1218,11 +1218,13 @@
1218 1218  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:
1219 1219  
1220 1220  ~1. A sequence consisting of:
1395 +
1221 1221  * a. An element reference to common:Annotations, with a minimum occurrence of 0
1222 1222  * 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:
1223 1223  ** i. A selector with an xpath of "*"
1224 1224  ** ii. A field with an xpath of "@id"
1225 1225  * 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 +
1226 1226  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]
1227 1227  
1228 1228  ==== 3.5.3.1 Attribute Set Complex Type Creation ====
... ... @@ -1230,6 +1230,7 @@
1230 1230  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:
1231 1231  
1232 1232  ~1. A sequence consisting of:
1409 +
1233 1233  * 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].
1234 1234  
1235 1235  = 4. Special data functions =