Changes for page Part IV. Data and Metadata Namespaces
Last modified by Artur on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -158,12 +158,15 @@ 158 158 **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. 159 159 160 160 Attributes: 161 + 161 161 id?, value 162 162 163 163 Content: 165 + 164 164 {Empty} 165 165 166 166 Attribute Documentation: 169 + 167 167 |**Name**|**Type**|**Documentation** 168 168 |id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided. 169 169 |value|xs:anySimpleType|The value attribute contains the provided component value. ... ... @@ -172,16 +172,19 @@ 172 172 173 173 Derivation: 174 174 175 - *BaseValueType (restriction)176 - **ObsValueType178 +BaseValueType (restriction) 179 + [[image:1750765436897-317.png]]ObsValueType 177 177 178 178 Attributes: 182 + 179 179 id?, value 180 180 181 181 Content: 186 + 182 182 {Empty} 183 183 184 184 Attribute Documentation: 190 + 185 185 |**Name**|**Type**|**Documentation** 186 186 |id (fixed: OBS_VALUE)|com:NCNameIDType|The id attribute contains a fixed reference to the primary measure component of the data structure definition. 187 187 |value|xs:string|The value attribute contains the provided component value. ... ... @@ -189,16 +189,20 @@ 189 189 **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. 190 190 191 191 Derivation: 192 -* BaseValueType (restriction) 193 -** ComponentValueType 194 194 199 +BaseValueType (restriction) 200 + [[image:1750765436899-296.png]]ComponentValueType 201 + 195 195 Attributes: 203 + 196 196 id, value 197 197 198 198 Content: 207 + 199 199 {Empty} 200 200 201 201 Attribute Documentation: 211 + 202 202 |**Name**|**Type**|**Documentation** 203 203 |id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided. 204 204 |value|xs:string|The value attribute contains the provided component value. ... ... @@ -206,17 +206,21 @@ 206 206 **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. 207 207 208 208 Derivation: 209 -* //com:AnnotableType// (extension) 210 -** DataSetType (restriction) 211 -*** TimeSeriesDataSetType 212 212 220 +//com:AnnotableType// (extension) 221 + [[image:1750765436901-853.png]]DataSetType (restriction) 222 + [[image:1750765436906-461.png]]TimeSeriesDataSetType 223 + 213 213 Attributes: 225 + 214 214 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 215 215 216 216 Content: 229 + 217 217 com:Annotations?, DataProvider?, Attributes?, Group*, Series* 218 218 219 219 Attribute Documentation: 233 + 220 220 |**Name**|**Type**|**Documentation** 221 221 |structureRef|xs:IDREF|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). 222 222 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -240,14 +240,17 @@ 240 240 **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. 241 241 242 242 Derivation: 243 -* //com:AnnotableType// (extension) 244 -** SeriesType (restriction) 245 -*** TimeSeriesType 246 246 258 +//com:AnnotableType// (extension) 259 + [[image:1750765436911-979.png]]SeriesType (restriction) 260 + [[image:1750765436912-452.png]]TimeSeriesType 261 + 247 247 Content: 263 + 248 248 com:Annotations?, SeriesKey, Attributes?, Obs* 249 249 250 250 Element Documentation: 267 + 251 251 |**Name**|**Type**|**Documentation** 252 252 |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. 253 253 |SeriesKey|ValuesType|SeriesKey contains the values for each all dimensions defined in the data structure definition, except for that which is declared to be at the observation level for this data set. This key is required, and every dimension must be provided a value. ... ... @@ -257,14 +257,17 @@ 257 257 **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. 258 258 259 259 Derivation: 260 -* //com:AnnotableType// (extension) 261 -** ObsType (restriction) 262 -*** TimeSeriesObsType 263 263 278 +//com:AnnotableType// (extension) 279 + [[image:1750765436913-909.png]]ObsType (restriction) 280 + [[image:1750765436914-333.png]]TimeSeriesObsType 281 + 264 264 Content: 283 + 265 265 com:Annotations?, ObsDimension, ObsValue?, Attributes? 266 266 267 267 Element Documentation: 287 + 268 268 |**Name**|**Type**|**Documentation** 269 269 |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. 270 270 |ObsDimension|TimeValueType|ObsDimension holds the key for the grouped observation, i.e. the value of the observation dimension. Note that in this element, the reference to the dimension is optional, since it can be inferred from the structure specification for the data set. This saves having to repeat the value unnecessarily. It is assumed that any application processing the data set will have the information from the structure specification available, so that if a dimension identifier is not supplied here, the proper reference can be applied. ... ... @@ -274,27 +274,35 @@ 274 274 **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. 275 275 276 276 Derivation: 277 -* BaseValueType (restriction) 278 -** TimeValueType 279 279 298 +BaseValueType (restriction) 299 + [[image:1750765436914-771.png]]TimeValueType 300 + 280 280 Attributes: 302 + 281 281 id?, value 282 282 283 283 Content: 306 + 284 284 {Empty} 285 285 286 286 Attribute Documentation: 310 + 287 287 |**Name**|**Type**|**Documentation** 288 288 |id (fixed: TIME_PERIOD)|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided. 289 289 |value|com: ObservationalTimePer iodType|The value attribute contains the provided component value. 290 290 291 -== 2.2 Structure Specific Data Namespace == 315 +1. 316 +11. Structure Specific Data Namespace 292 292 293 293 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific** 294 294 295 -=== Summary === 320 +1. 321 +11. 322 +111. Summary 296 296 297 297 Referenced Namespaces: 325 + 298 298 |**Namespace**|**Prefix** 299 299 | | 300 300 |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com ... ... @@ -301,24 +301,31 @@ 301 301 |http:~/~/www.w3.org/2001/XMLSchema|xs 302 302 303 303 Contents: 332 + 304 304 7 Complex Types 305 305 1 Simple Type 306 306 307 -=== Complex Types === 336 +1. 337 +11. 338 +111. Complex Types 308 308 309 309 **//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. 310 310 311 311 Derivation: 312 -* //com:AnnotableType// (extension) 313 -** //DataSetType// 314 314 344 +//com:AnnotableType// (extension) 345 + [[image:1750765436915-836.png]]//DataSetType// 346 + 315 315 Attributes: 348 + 316 316 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY? 317 317 318 318 Content: 352 + 319 319 com:Annotations?, DataProvider?, Group*, (Series+ | Obs+)? 320 320 321 321 Attribute Documentation: 356 + 322 322 |**Name**|**Type**|**Documentation** 323 323 |structureRef|xs:IDREF|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). 324 324 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -344,16 +344,20 @@ 344 344 **//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. 345 345 346 346 Derivation: 347 -* //com:AnnotableType// (extension) 348 -** //GroupType// 349 349 383 +//com:AnnotableType// (extension) 384 + [[image:1750765436916-983.png]]//GroupType// 385 + 350 350 Attributes: 387 + 351 351 type?, REPORTING_YEAR_START_DAY? 352 352 353 353 Content: 391 + 354 354 com:Annotations? 355 355 356 356 Attribute Documentation: 395 + 357 357 |**Name**|**Type**|**Documentation** 358 358 |type|com:IDType|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. 359 359 |REPORTING_YEAR_START_DAY|xs:gMonthDay|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. ... ... @@ -366,16 +366,20 @@ 366 366 **//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. 367 367 368 368 Derivation: 369 -* //com:AnnotableType// (extension) 370 -** //SeriesType// 371 371 409 +//com:AnnotableType// (extension) 410 + //SeriesType// 411 + 372 372 Attributes: 413 + 373 373 TIME_PERIOD?, REPORTING_YEAR_START_DAY? 374 374 375 375 Content: 417 + 376 376 com:Annotations?, Obs* 377 377 378 378 Attribute Documentation: 421 + 379 379 |**Name**|**Type**|**Documentation** 380 380 |TIME_PERIOD|com: ObservationalTimePer iodType|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. 381 381 |REPORTING_YEAR_START_DAY|xs:gMonthDay|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. ... ... @@ -389,16 +389,20 @@ 389 389 **//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. 390 390 391 391 Derivation: 392 -* //com:AnnotableType// (extension) 393 -** //ObsType// 394 394 436 +//com:AnnotableType// (extension) 437 + //ObsType// 438 + 395 395 Attributes: 440 + 396 396 type?, TIME_PERIOD?, REPORTING_YEAR_START_DAY?, OBS_VALUE? 397 397 398 398 Content: 444 + 399 399 com:Annotations? 400 400 401 401 Attribute Documentation: 448 + 402 402 |**Name**|**Type**|**Documentation** 403 403 |type|com:IDType|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. 404 404 |TIME_PERIOD|com: ObservationalTimePer iodType|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. 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. ... ... @@ -413,17 +413,21 @@ 413 413 **//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. 414 414 415 415 Derivation: 416 -* //com:AnnotableType// (extension) 417 -** //DataSetType// (restriction) 418 -*** //TimeSeriesDataSetType// 419 419 464 +//com:AnnotableType// (extension) 465 + //DataSetType// (restriction) 466 + //TimeSeriesDataSetType// 467 + 420 420 Attributes: 469 + 421 421 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY? 422 422 423 423 Content: 473 + 424 424 com:Annotations?, DataProvider?, Group*, Series* 425 425 426 426 Attribute Documentation: 477 + 427 427 |**Name**|**Type**|**Documentation** 428 428 |structureRef|xs:IDREF|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). 429 429 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -448,17 +448,21 @@ 448 448 **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. 449 449 450 450 Derivation: 451 -* //com:AnnotableType// (extension) 452 -** //SeriesType// (restriction) 453 -*** TimeSeriesType 454 454 503 +//com:AnnotableType// (extension) 504 + //SeriesType// (restriction) 505 + TimeSeriesType 506 + 455 455 Attributes: 508 + 456 456 REPORTING_YEAR_START_DAY? 457 457 458 458 Content: 512 + 459 459 com:Annotations?, Obs* 460 460 461 461 Attribute Documentation: 516 + 462 462 |**Name**|**Type**|**Documentation** 463 463 |REPORTING_YEAR_START_DAY|xs:gMonthDay|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. 464 464 ... ... @@ -471,17 +471,21 @@ 471 471 **//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. 472 472 473 473 Derivation: 474 -* //com:AnnotableType// (extension) 475 -** //ObsType// (restriction) 476 -*** //TimeSeriesObsType// 477 477 530 +//com:AnnotableType// (extension) 531 + //ObsType// (restriction) 532 + //TimeSeriesObsType// 533 + 478 478 Attributes: 535 + 479 479 TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE? 480 480 481 481 Content: 539 + 482 482 com:Annotations? 483 483 484 484 Attribute Documentation: 543 + 485 485 |**Name**|**Type**|**Documentation** 486 486 |TIME_PERIOD|com: ObservationalTimePer iodType|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. 487 487 |REPORTING_YEAR_START_DAY|xs:gMonthDay|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 observation 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. ... ... @@ -488,10 +488,13 @@ 488 488 |OBS_VALUE|xs:anySimpleType|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. 489 489 490 490 Element Documentation: 550 + 491 491 |**Name**|**Type**|**Documentation** 492 492 |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. 493 493 494 -=== Simple Types === 554 +1. 555 +11. 556 +111. Simple Types 495 495 496 496 **DataScopeType: **DataScopeType is an enumeration of the possible validity scopes for a data set. These scopes indicate the level at which the data is stated to be valid. 497 497 ... ... @@ -498,6 +498,7 @@ 498 498 Derived by restriction of xs:string . 499 499 500 500 Enumerations: 563 + 501 501 |**Value**|**Documentation** 502 502 |DataStructure|The data set conforms simply to the data structure definition as it is defined, without regard to any constraints. 503 503 |ConstrainedDataStructure|The data set conforms to the known allowable content constraints applied to the data structure definition. ... ... @@ -504,35 +504,46 @@ 504 504 |Dataflow|The data set conforms to the known allowable content constraints applied to the dataflow. 505 505 |ProvisionAgreement|The data set conforms to the known allowable content constraints applied to the provision agreement. 506 506 507 -== Generic Metadata Namespace == 570 +1. 571 +11. Generic Metadata Namespace 508 508 509 509 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic** 510 510 511 -=== Summary === 575 +1. 576 +11. 577 +111. Summary 512 512 513 513 Referenced Namespaces: 580 + 514 514 |**Namespace**|**Prefix** 515 515 |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com 516 516 |http:~/~/www.w3.org/2001/XMLSchema|xs 517 517 518 518 Contents: 586 + 519 519 6 Complex Types 520 520 521 -=== Complex Types === 589 +1. 590 +11. 591 +111. Complex Types 522 522 523 523 **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. 524 524 525 525 Derivation: 526 -* //com:AnnotableType// (extension) 527 -** MetadataSetType 528 528 597 +//com:AnnotableType// (extension) 598 + MetadataSetType 599 + 529 529 Attributes: 601 + 530 530 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 531 531 532 532 Content: 605 + 533 533 com:Annotations?, com:Name*, DataProvider?, Report+ 534 534 535 535 Attribute Documentation: 609 + 536 536 |**Name**|**Type**|**Documentation** 537 537 |structureRef|xs:IDREF|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). 538 538 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -555,16 +555,20 @@ 555 555 **ReportType: **ReportType contains a set of report attributes and identifies a target objects] to which they apply. 556 556 557 557 Derivation: 558 -* //com:AnnotableType// (extension) 559 -** ReportType 560 560 633 +//com:AnnotableType// (extension) 634 + ReportType 635 + 561 561 Attributes: 637 + 562 562 id 563 563 564 564 Content: 641 + 565 565 com:Annotations?, Target, AttributeSet 566 566 567 567 Attribute Documentation: 645 + 568 568 |**Name**|**Type**|**Documentation** 569 569 |id|com:IDType|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. 570 570 ... ... @@ -578,16 +578,20 @@ 578 578 **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. 579 579 580 580 Attributes: 659 + 581 581 id 582 582 583 583 Content: 663 + 584 584 ReferenceValue+ 585 585 586 586 Attribute Documentation: 667 + 587 587 |**Name**|**Type**|**Documentation** 588 588 |id|com:IDType|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. 589 589 590 590 Element Documentation: 672 + 591 591 |**Name**|**Type**|**Documentation** 592 592 |ReferenceValue|ReferenceValueType|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. 593 593 ... ... @@ -594,16 +594,20 @@ 594 594 **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. 595 595 596 596 Attributes: 679 + 597 597 id 598 598 599 599 Content: 683 + 600 600 (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod) 601 601 602 602 Attribute Documentation: 687 + 603 603 |**Name**|**Type**|**Documentation** 604 604 |id|com:IDType|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. 605 605 606 606 Element Documentation: 692 + 607 607 |**Name**|**Type**|**Documentation** 608 608 |ObjectReference|com: ObjectReferenceType|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. 609 609 |DataKey|com:DataKeyType|ObjectReference provides a set of dimension references and values for those dimension for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the representation of the target reference value. ... ... @@ -614,9 +614,11 @@ 614 614 **AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata attributes. 615 615 616 616 Content: 703 + 617 617 ReportedAttribute+ 618 618 619 619 Element Documentation: 707 + 620 620 |**Name**|**Type**|**Documentation** 621 621 |ReportedAttribute|ReportedAttributeTyp e|ReportedAttribute provides the details of a reported attribute, including a value and/or child reported attributes. 622 622 ... ... @@ -623,21 +623,26 @@ 623 623 **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. 624 624 625 625 Derivation: 626 -* //com:AnnotableType// (extension) 627 -** ReportedAttributeType 628 628 715 +//com:AnnotableType// (extension) 716 + ReportedAttributeType 717 + 629 629 Attributes: 719 + 630 630 id, value? 631 631 632 632 Content: 723 + 633 633 com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet? 634 634 635 635 Attribute Documentation: 727 + 636 636 |**Name**|**Type**|**Documentation** 637 637 |id|com:IDType|The id attribute identifies the metadata attribute that the value is being reported for. 638 638 |value|xs:string|The value attribute holds any simple value for the metadata attribute. 639 639 640 640 Element Documentation: 733 + 641 641 |**Name**|**Type**|**Documentation** 642 642 |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. 643 643 |com:Text|com:TextType|Text is used to supply parallel multi-lingual textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of string and the multi-lingual value is set to true. ... ... @@ -644,11 +644,14 @@ 644 644 |com:StructuredText|com:XHTMLType|StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of XHTML and the multi-lingual value is set to true. 645 645 |AttributeSet|AttributeSetType|AttributeSet contains the reported metadata attribute values for the child metadata attributes. 646 646 647 -== Structure Specific Metadata Namespace == 740 +1. 741 +11. Structure Specific Metadata Namespace 648 648 649 649 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific** 650 650 651 -=== Summary === 745 +1. 746 +11. 747 +111. Summary 652 652 653 653 Referenced Namespaces: 654 654 ... ... @@ -658,23 +658,30 @@ 658 658 |http:~/~/www.w3.org/2001/XMLSchema|xs 659 659 660 660 Contents: 757 + 661 661 5 Complex Types 662 662 663 -=== Complex Types === 760 +1. 761 +11. 762 +111. Complex Types 664 664 665 665 **//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. 666 666 667 667 Derivation: 668 -* //com:AnnotableType// (extension) 669 -** //MetadataSetType// 670 670 768 +//com:AnnotableType// (extension) 769 + //MetadataSetType// 770 + 671 671 Attributes: 772 + 672 672 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 673 673 674 674 Content: 776 + 675 675 com:Annotations?, com:Name*, DataProvider?, Report+ 676 676 677 677 Attribute Documentation: 780 + 678 678 |**Name**|**Type**|**Documentation** 679 679 |structureRef|xs:IDREF|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). 680 680 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -687,6 +687,7 @@ 687 687 |publicationPeriod|com: ObservationalTimePer iodType|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). 688 688 689 689 Element Documentation: 793 + 690 690 |**Name**|**Type**|**Documentation** 691 691 |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. 692 692 |com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object. ... ... @@ -696,20 +696,25 @@ 696 696 **//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. 697 697 698 698 Derivation: 699 -* //com:AnnotableType// (extension) 700 -** //ReportType// 701 701 804 +//com:AnnotableType// (extension) 805 + //ReportType// 806 + 702 702 Attributes: 808 + 703 703 id? 704 704 705 705 Content: 812 + 706 706 com:Annotations?, Target, AttributeSet 707 707 708 708 Attribute Documentation: 816 + 709 709 |**Name**|**Type**|**Documentation** 710 710 |id|com:IDType|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. 711 711 712 712 Element Documentation: 821 + 713 713 |**Name**|**Type**|**Documentation** 714 714 |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. 715 715 |Target|//TargetType//|Target contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that the references values can be validated against those defined in the metadata targets for the report structure. ... ... @@ -718,16 +718,20 @@ 718 718 **//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. 719 719 720 720 Attributes: 830 + 721 721 id? 722 722 723 723 Content: 834 + 724 724 ReferenceValue+ 725 725 726 726 Attribute Documentation: 838 + 727 727 |**Name**|**Type**|**Documentation** 728 728 |id|com:IDType|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. 729 729 730 730 Element Documentation: 843 + 731 731 |**Name**|**Type**|**Documentation** 732 732 |ReferenceValue|//ReferenceValueType//|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. 733 733 ... ... @@ -734,16 +734,20 @@ 734 734 **//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. 735 735 736 736 Attributes: 850 + 737 737 id? 738 738 739 739 Content: 854 + 740 740 (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod) 741 741 742 742 Attribute Documentation: 858 + 743 743 |**Name**|**Type**|**Documentation** 744 744 |id|com:IDType|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. 745 745 746 746 Element Documentation: 863 + 747 747 |**Name**|**Type**|**Documentation** 748 748 |ObjectReference|//com:ReferenceType//|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. 749 749 |DataKey|com:DataKeyType|ObjectReference provides a set of dimension references and values for those dimension for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the representation of the target reference value. It is not expect that the metadata structure definition specific schema would refine this, but none the less, it is an unqualified element. ... ... @@ -754,16 +754,20 @@ 754 754 **//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. 755 755 756 756 Derivation: 757 -* //com:AnnotableType// (extension) 758 -** //ReportedAttributeType// 759 759 875 +//com:AnnotableType// (extension) 876 + //ReportedAttributeType// 877 + 760 760 Attributes: 879 + 761 761 id?, value?, isMetadataAttribute? 762 762 763 763 Content: 883 + 764 764 com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet? 765 765 766 766 Attribute Documentation: 887 + 767 767 |**Name**|**Type**|**Documentation** 768 768 |id|com:IDType|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. 769 769 |value|xs:anySimpleType|The value attribute holds any simple value for the metadata attribute. This attribute is un-typed such that the metadata structure definition specific schema can specify any simple type according the text format / local representation defined by the metadata structure definition. ... ... @@ -770,6 +770,7 @@ 770 770 |isMetadataAttribute (fixed: true)|xs:boolean|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. 771 771 772 772 Element Documentation: 894 + 773 773 |**Name**|**Type**|**Documentation** 774 774 |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. 775 775 |com:Text|com:TextType|Text is used to supply parallel multi-lingual textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of string and the multi-lingual value is set to true. ... ... @@ -776,10 +776,9 @@ 776 776 |com:StructuredText|com:XHTMLType|StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of XHTML and the multi-lingual value is set to true. If the multi-lingual flag is not set to true, it is expected that the maximum occurrence of this will be refined to be 1 in the metadata structure definition specific schema. 777 777 |AttributeSet|xs:anyType|AttributeSet contains the reported metadata attribute values for the child metadata attributes. This element is unqualified and un-typed so that it can refined by the metadata structure definition specific schema to validate that the reported metadata attributes conform to those prescribed by the metadata attribute definition. The content of this must be element only, and these elements must always represent a reported attribute. Since this can not be strictly enforced in XML Schema, additional steps have been added to make generic processing of this element simpler. When processing this element, any element found with the attribute isMetadataAttribute in this target namespace is assumed to be a reported metadata attribute and can be processed as such. 778 778 779 -= Mapping to Structure-Specific Schemas = 901 +1. Mapping to Structure-Specific Schemas 902 +11. General 780 780 781 -== General == 782 - 783 783 Data structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces; 784 784 785 785 Data - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific ... ... @@ -788,7 +788,9 @@ 788 788 789 789 For a metadata structure, only a single schema will be created for the entire structure definition. For data structures, many variations of the base schema are possible, each specific as to how the data is organised. This will be discussed in more details in the specific rules for the data structure schemas. 790 790 791 -=== Basic Terminology === 912 +1. 913 +11. 914 +111. Basic Terminology 792 792 793 793 In the subsequent sections, the following namespace prefixes are used: 794 794 ... ... @@ -834,7 +834,8 @@ 834 834 835 835 **XML Attribute:** Refers to the definition of an XML attribute for a complex type (i.e. and xs:attribute element in a xs:complexType element). An attribute must define a name and type (name and type attributes) and may also specify a usage (use attribute). 836 836 837 -== Namespace Rules == 960 +1. 961 +11. Namespace Rules 838 838 839 839 Each format specific schema will specify its namespace in the target namespace of the schema (the targetNamespace attribute of the schema). This document also assumes that the root namespace (that which is defined by the xmlns attribute) of the schema will be the same as the target namespace. Therefore any types or global elements referenced in these descriptions without a namespace prefix are assumed to be in the format specific namespace. 840 840 ... ... @@ -842,17 +842,21 @@ 842 842 843 843 For the purpose of the descriptions here, the default element form for the schema (as specified in the elementFormDefault attribute of the schema) is “qualified", and the default attribute form (as specified in the attributeFormDefault attribute of the schema) is "unqualified". 844 844 845 -== General Rules == 969 +1. 970 +11. General Rules 846 846 847 847 The following section details the general rules which apply to all structure specific schema creation. 848 848 849 -=== Component Name Determination === 974 +1. 975 +11. 976 +111. Component Name Determination 850 850 851 851 When required to create an XML element or attribute, the name for a component is always its identifier. However, the identifier may be inherited. Therefore, the general rules is as follows: 852 852 853 -If the component defines an identifier, the element or attribute name is the value of that identifier 854 -Otherwise, the element or attribute name is the identifier of the concept from which it takes its semantic (Note that this is technically the component identifer). 855 -Representation Determination 980 +1. If the component defines an identifier, the element or attribute name is the value of that identifier 981 +1. Otherwise, the element or attribute name is the identifier of the concept from which it takes its semantic (Note that this is technically the component identifer). 982 +11. 983 +111. Representation Determination 856 856 857 857 Every component has a representation associated with it, whether it is defined as a local representation in the component definition, or it is inherited from the concept from which the component takes it semantic (as defined in the concept identity of the component). 858 858 ... ... @@ -866,27 +866,40 @@ 866 866 867 867 A text format consists of a data type and an optional collection of facets. It is the combination of these which determine the exact nature of the component representation. An enumeration consists of a reference to an item scheme, for which an enumerated list of possible values can be created. 868 868 869 -=== Simple / Primitive Type Determination === 997 +1. 998 +11. 999 +111. Simple / Primitive Type Determination 870 870 871 871 For any given representation, there exist rules for determining the simple or primitive type which should be used to validate the value. There are no specific requirements to how a simple type is named or if it is referenced or used as an anonymous type. This section simply serves to state the requirements of the type for a component based on its [[determined representation>>path:#_Representation_Determination:]]. 872 872 873 873 For example, a dimension may inherit its representation for a concept, and the data type of a representation data type may be a String. The simplest solution would be to use the xs:string primitive type. However, an implementer may have chosen to generate simple types for all concepts to avoid having to look up the concept core representation for very component. In this case, the type may be given a name based on the concept and be a simple derivation from the xs:string type that places no further restrictions. The result would be that the type that is actually used for the dimension, although named after the concept, is effectively the required xs:string. These rules are meant to allow such flexibility in how types are created. The only requirement is that the type meet the requirements stated here. 874 874 875 -=== Representation with Enumeration === 1005 +1. 1006 +11. 1007 +111. Representation with Enumeration 876 876 877 877 A representation which defines an enumeration will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each item in the item scheme. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required. Example: 878 878 879 879 880 -> <xs:simpleType name="ESTAT.CL_COUNTRY.1.0"> 881 -> <xs:restriction base="common:IDType"> 882 -> <xs:enumeration value="BE"> 883 -> <xs:annotation> 884 -> <xs:documentation xml:lang="en">Belgium</xs:documentation> 885 -> </xs:annotation> 886 -> </xs:enumeration> 1012 +<xs:simpleType name="ESTAT.CL_COUNTRY.1.0"> 887 887 888 - === Representationwith Text Format ===1014 +<xs:restriction base="common:IDType"> 889 889 1016 +<xs:enumeration value="BE"> 1017 + 1018 +<xs:annotation> 1019 + 1020 +<xs:documentation xml:lang="en">Belgium</xs:documentation> 1021 + 1022 +</xs:annotation> 1023 + 1024 +</xs:enumeration> 1025 + 1026 + 1027 +1. 1028 +11. 1029 +111. Representation with Text Format 1030 + 890 890 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: 891 891 892 892 |**SDMX Data Type**|**XML Schema Data Type** ... ... @@ -947,7 +947,9 @@ 947 947 948 948 Any other facets are informational only, and will not affect the determined type. 949 949 950 -=== Type Names === 1091 +1. 1092 +11. 1093 +111. //Type Names// 951 951 952 952 These rules will only dictate type names where absolutely necessary. In all other cases, it is the decision of the implementer as to how to name or use the type. It is also the implementer's requirement to ensure that any type name is properly unique within its scope. To assist in this, the following recommendations are offered for naming types such that they are unique. 953 953 ... ... @@ -974,13 +974,16 @@ 974 974 975 975 Only the constructs that will be detailed in the data and metadata structure-specific rules below are required to be in the specified target namespace of the structure-specific schema. So long as any other generated type conforms to the rules specified, it may exist in any namespace. 976 976 977 -== Data Structure Specific Schema == 1120 +1. 1121 +11. Data Structure Specific Schema 978 978 979 979 Separate schemas will be created for the data structure depending on which dimension occurs at the observation level, and whether explicit measures are used in the case that the observation dimension is the measure dimension. The recommended target namespace of the data structured specific schema is: [Data Structure URN]:ObsLevelDim:[Observation Dimensions](:explicit)?. Note that the explicit trailer is only used when the measure dimension is used at the observation level and the explicit measure concepts are to be used. 980 980 981 981 The rules for generating the data structure specific-schema are broken into sections based on the level within the structure (i.e. data set, group, series, observation). Each section will state the rules for each variation of the structure specific format. 982 982 983 -=== DataSetType === 1127 +1. 1128 +11. 1129 +111. DataSetType 984 984 985 985 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: 986 986 ... ... @@ -994,9 +994,8 @@ 994 994 1. 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 995 995 1. An attribute for each attribute defined in the data structured definition that declares an attribute relationship of None. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional 996 996 11. 1143 +111. GroupType 997 997 998 -=== GroupType === 999 - 1000 1000 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: 1001 1001 1002 1002 1. A sequence consisting of: ... ... @@ -1023,9 +1023,9 @@ 1023 1023 1. 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 1024 1024 1. 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>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional 1025 1025 1. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group 1171 +11. 1172 +111. SeriesType 1026 1026 1027 -=== SeriesType === 1028 - 1029 1029 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: 1030 1030 1031 1031 1. A sequence consisting of: ... ... @@ -1034,9 +1034,9 @@ 1034 1034 1. An attribute for each dimension defined by the data structure definition, except for the dimension at the observation level. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is required 1035 1035 1. 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 1036 1036 1. 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>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional 1182 +11. 1183 +111. ObsType 1037 1037 1038 -=== ObsType === 1039 - 1040 1040 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: 1041 1041 1042 1042 1. A sequence consisting of: ... ... @@ -1059,7 +1059,9 @@ 1059 1059 1060 1060 The rules for generating the data structure specific-schema are broken into sections based on the level within the structure (i.e. metadata set, metadata targets, reports, metadata attributes). These rules will recommend names for generated types, and will refer back to these names throughout the description. These names are simply recommendations that should produce a unique name, but there is no requirement to use them. When a name is required, it will be made clear this is the case. 1061 1061 1062 -=== MetadataSetType === 1207 +1. 1208 +11. 1209 +111. MetadataSetType 1063 1063 1064 1064 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: 1065 1065 ... ... @@ -1111,10 +1111,9 @@ 1111 1111 111. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref 1112 1112 111. 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 1113 1113 11. A local element named URN, with a form of unqualified, and the type defined above as [item scheme agency].[item scheme identifier].[item scheme version].URN 1261 +111. 1262 +1111. Identifiable Object Target Type Determination 1114 1114 1115 - 1116 -==== Identifiable Object Target Type Determination ==== 1117 - 1118 1118 An identifiable object target is meant to reference an SDMX identifiable object. In the metadata structure specific schema, the complex type which defines the reference is restricted according to the local representation and object type of the identifiable object target. If the identifiable object target does not provide an enumeration in its local representation, then the complex type for the target object is the specific reference type from the common namespace, based on the object type defined by the target object. For example, if the object type is DataProivder, the type will be common:DataProviderReferenceType. The general rule for the name of this type is common:[object type]ReferenceType. 1119 1119 1120 1120 If the target object defines an enumeration in its local representation, then the declared object type must be for the items contained the enumeration's referenced item scheme. If this is not true, the reference type as defined above is the type for the target object. ... ... @@ -1131,9 +1131,9 @@ 1131 1131 1. An attribute named maintinableParentID with a type of common:IDType, a use of required, and a fixed value of the identifier of the item scheme referenced from the enumeration 1132 1132 1. An attribute named maintainableParentVersion with a type of common:VersionType, a use of optional, and a fixed value of the version of the item scheme referenced from the enumeration 1133 1133 1. An attribute named id, with a use of option, and the type defined above as [item scheme agency].[item scheme identifier].[item scheme version].ID. 1280 +11. 1281 +111. ReportType 1134 1134 1135 -=== ReportType === 1136 - 1137 1137 A simple type with a recommend name of Report.ID must be created. This must 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. 1138 1138 1139 1139 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: ... ... @@ -1181,16 +1181,17 @@ 1181 1181 1. 1182 1182 11. 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 1183 1183 1. An attribute named id with the type previously defined as Report.ID, a use of optional, and a fixed value of [report structure identifier] 1330 +11. 1331 +111. 1332 +1111. Attribute Set Complex Type Creation 1184 1184 1185 -=== Attribute Set Complex Type Creation === 1186 - 1187 1187 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: 1188 1188 1189 1189 1. A sequence consisting of: 1190 1190 11. 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]. 1191 1191 1192 - =Special data functions=1193 - ==Updates==1339 +1. Special data functions 1340 +11. Updates 1194 1194 1195 1195 Both the generic and the structure-specific data messages allow for incremental updating of data. This purpose is noted in the action for the data set, which is either inherited from the header of the data message or explicitly stated at the data set level. 1196 1196