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
-
... ... @@ -206,21 +206,17 @@ 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 209 209 210 -//com:AnnotableType// (extension) 211 - [[image:1750765436901-853.png]]DataSetType (restriction) 212 - [[image:1750765436906-461.png]]TimeSeriesDataSetType 213 - 214 214 Attributes: 215 - 216 216 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 217 217 218 218 Content: 219 - 220 220 com:Annotations?, DataProvider?, Attributes?, Group*, Series* 221 221 222 222 Attribute Documentation: 223 - 224 224 |**Name**|**Type**|**Documentation** 225 225 |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). 226 226 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -244,17 +244,14 @@ 244 244 **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. 245 245 246 246 Derivation: 243 +* //com:AnnotableType// (extension) 244 +** SeriesType (restriction) 245 +*** TimeSeriesType 247 247 248 -//com:AnnotableType// (extension) 249 - [[image:1750765436911-979.png]]SeriesType (restriction) 250 - [[image:1750765436912-452.png]]TimeSeriesType 251 - 252 252 Content: 253 - 254 254 com:Annotations?, SeriesKey, Attributes?, Obs* 255 255 256 256 Element Documentation: 257 - 258 258 |**Name**|**Type**|**Documentation** 259 259 |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. 260 260 |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. ... ... @@ -264,17 +264,14 @@ 264 264 **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. 265 265 266 266 Derivation: 260 +* //com:AnnotableType// (extension) 261 +** ObsType (restriction) 262 +*** TimeSeriesObsType 267 267 268 -//com:AnnotableType// (extension) 269 - [[image:1750765436913-909.png]]ObsType (restriction) 270 - [[image:1750765436914-333.png]]TimeSeriesObsType 271 - 272 272 Content: 273 - 274 274 com:Annotations?, ObsDimension, ObsValue?, Attributes? 275 275 276 276 Element Documentation: 277 - 278 278 |**Name**|**Type**|**Documentation** 279 279 |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. 280 280 |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. ... ... @@ -284,35 +284,27 @@ 284 284 **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. 285 285 286 286 Derivation: 277 +* BaseValueType (restriction) 278 +** TimeValueType 287 287 288 -BaseValueType (restriction) 289 - [[image:1750765436914-771.png]]TimeValueType 290 - 291 291 Attributes: 292 - 293 293 id?, value 294 294 295 295 Content: 296 - 297 297 {Empty} 298 298 299 299 Attribute Documentation: 300 - 301 301 |**Name**|**Type**|**Documentation** 302 302 |id (fixed: TIME_PERIOD)|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided. 303 303 |value|com: ObservationalTimePer iodType|The value attribute contains the provided component value. 304 304 305 -1. 306 -11. Structure Specific Data Namespace 291 +== 2.2 Structure Specific Data Namespace == 307 307 308 308 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific** 309 309 310 -1. 311 -11. 312 -111. Summary 295 +=== Summary === 313 313 314 314 Referenced Namespaces: 315 - 316 316 |**Namespace**|**Prefix** 317 317 | | 318 318 |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com ... ... @@ -319,31 +319,24 @@ 319 319 |http:~/~/www.w3.org/2001/XMLSchema|xs 320 320 321 321 Contents: 322 - 323 323 7 Complex Types 324 324 1 Simple Type 325 325 326 -1. 327 -11. 328 -111. Complex Types 307 +=== Complex Types === 329 329 330 330 **//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. 331 331 332 332 Derivation: 312 +* //com:AnnotableType// (extension) 313 +** //DataSetType// 333 333 334 -//com:AnnotableType// (extension) 335 - [[image:1750765436915-836.png]]//DataSetType// 336 - 337 337 Attributes: 338 - 339 339 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY? 340 340 341 341 Content: 342 - 343 343 com:Annotations?, DataProvider?, Group*, (Series+ | Obs+)? 344 344 345 345 Attribute Documentation: 346 - 347 347 |**Name**|**Type**|**Documentation** 348 348 |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). 349 349 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -369,20 +369,16 @@ 369 369 **//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. 370 370 371 371 Derivation: 347 +* //com:AnnotableType// (extension) 348 +** //GroupType// 372 372 373 -//com:AnnotableType// (extension) 374 - [[image:1750765436916-983.png]]//GroupType// 375 - 376 376 Attributes: 377 - 378 378 type?, REPORTING_YEAR_START_DAY? 379 379 380 380 Content: 381 - 382 382 com:Annotations? 383 383 384 384 Attribute Documentation: 385 - 386 386 |**Name**|**Type**|**Documentation** 387 387 |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. 388 388 |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. ... ... @@ -395,20 +395,16 @@ 395 395 **//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. 396 396 397 397 Derivation: 369 +* //com:AnnotableType// (extension) 370 +** //SeriesType// 398 398 399 -//com:AnnotableType// (extension) 400 - //SeriesType// 401 - 402 402 Attributes: 403 - 404 404 TIME_PERIOD?, REPORTING_YEAR_START_DAY? 405 405 406 406 Content: 407 - 408 408 com:Annotations?, Obs* 409 409 410 410 Attribute Documentation: 411 - 412 412 |**Name**|**Type**|**Documentation** 413 413 |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. 414 414 |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. ... ... @@ -422,20 +422,16 @@ 422 422 **//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. 423 423 424 424 Derivation: 392 +* //com:AnnotableType// (extension) 393 +** //ObsType// 425 425 426 -//com:AnnotableType// (extension) 427 - //ObsType// 428 - 429 429 Attributes: 430 - 431 431 type?, TIME_PERIOD?, REPORTING_YEAR_START_DAY?, OBS_VALUE? 432 432 433 433 Content: 434 - 435 435 com:Annotations? 436 436 437 437 Attribute Documentation: 438 - 439 439 |**Name**|**Type**|**Documentation** 440 440 |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. 441 441 |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. ... ... @@ -450,21 +450,17 @@ 450 450 **//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. 451 451 452 452 Derivation: 416 +* //com:AnnotableType// (extension) 417 +** //DataSetType// (restriction) 418 +*** //TimeSeriesDataSetType// 453 453 454 -//com:AnnotableType// (extension) 455 - //DataSetType// (restriction) 456 - //TimeSeriesDataSetType// 457 - 458 458 Attributes: 459 - 460 460 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY? 461 461 462 462 Content: 463 - 464 464 com:Annotations?, DataProvider?, Group*, Series* 465 465 466 466 Attribute Documentation: 467 - 468 468 |**Name**|**Type**|**Documentation** 469 469 |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). 470 470 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -489,21 +489,17 @@ 489 489 **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. 490 490 491 491 Derivation: 451 +* //com:AnnotableType// (extension) 452 +** //SeriesType// (restriction) 453 +*** TimeSeriesType 492 492 493 -//com:AnnotableType// (extension) 494 - //SeriesType// (restriction) 495 - TimeSeriesType 496 - 497 497 Attributes: 498 - 499 499 REPORTING_YEAR_START_DAY? 500 500 501 501 Content: 502 - 503 503 com:Annotations?, Obs* 504 504 505 505 Attribute Documentation: 506 - 507 507 |**Name**|**Type**|**Documentation** 508 508 |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. 509 509 ... ... @@ -516,21 +516,17 @@ 516 516 **//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. 517 517 518 518 Derivation: 474 +* //com:AnnotableType// (extension) 475 +** //ObsType// (restriction) 476 +*** //TimeSeriesObsType// 519 519 520 -//com:AnnotableType// (extension) 521 - //ObsType// (restriction) 522 - //TimeSeriesObsType// 523 - 524 524 Attributes: 525 - 526 526 TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE? 527 527 528 528 Content: 529 - 530 530 com:Annotations? 531 531 532 532 Attribute Documentation: 533 - 534 534 |**Name**|**Type**|**Documentation** 535 535 |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. 536 536 |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. ... ... @@ -537,13 +537,10 @@ 537 537 |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. 538 538 539 539 Element Documentation: 540 - 541 541 |**Name**|**Type**|**Documentation** 542 542 |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. 543 543 544 -1. 545 -11. 546 -111. Simple Types 494 +=== Simple Types === 547 547 548 548 **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. 549 549 ... ... @@ -550,7 +550,6 @@ 550 550 Derived by restriction of xs:string . 551 551 552 552 Enumerations: 553 - 554 554 |**Value**|**Documentation** 555 555 |DataStructure|The data set conforms simply to the data structure definition as it is defined, without regard to any constraints. 556 556 |ConstrainedDataStructure|The data set conforms to the known allowable content constraints applied to the data structure definition. ... ... @@ -557,46 +557,35 @@ 557 557 |Dataflow|The data set conforms to the known allowable content constraints applied to the dataflow. 558 558 |ProvisionAgreement|The data set conforms to the known allowable content constraints applied to the provision agreement. 559 559 560 -1. 561 -11. Generic Metadata Namespace 507 +== Generic Metadata Namespace == 562 562 563 563 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic** 564 564 565 -1. 566 -11. 567 -111. Summary 511 +=== Summary === 568 568 569 569 Referenced Namespaces: 570 - 571 571 |**Namespace**|**Prefix** 572 572 |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com 573 573 |http:~/~/www.w3.org/2001/XMLSchema|xs 574 574 575 575 Contents: 576 - 577 577 6 Complex Types 578 578 579 -1. 580 -11. 581 -111. Complex Types 521 +=== Complex Types === 582 582 583 583 **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. 584 584 585 585 Derivation: 526 +* //com:AnnotableType// (extension) 527 +** MetadataSetType 586 586 587 -//com:AnnotableType// (extension) 588 - MetadataSetType 589 - 590 590 Attributes: 591 - 592 592 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 593 593 594 594 Content: 595 - 596 596 com:Annotations?, com:Name*, DataProvider?, Report+ 597 597 598 598 Attribute Documentation: 599 - 600 600 |**Name**|**Type**|**Documentation** 601 601 |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). 602 602 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -619,20 +619,16 @@ 619 619 **ReportType: **ReportType contains a set of report attributes and identifies a target objects] to which they apply. 620 620 621 621 Derivation: 558 +* //com:AnnotableType// (extension) 559 +** ReportType 622 622 623 -//com:AnnotableType// (extension) 624 - ReportType 625 - 626 626 Attributes: 627 - 628 628 id 629 629 630 630 Content: 631 - 632 632 com:Annotations?, Target, AttributeSet 633 633 634 634 Attribute Documentation: 635 - 636 636 |**Name**|**Type**|**Documentation** 637 637 |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. 638 638 ... ... @@ -646,20 +646,16 @@ 646 646 **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. 647 647 648 648 Attributes: 649 - 650 650 id 651 651 652 652 Content: 653 - 654 654 ReferenceValue+ 655 655 656 656 Attribute Documentation: 657 - 658 658 |**Name**|**Type**|**Documentation** 659 659 |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. 660 660 661 661 Element Documentation: 662 - 663 663 |**Name**|**Type**|**Documentation** 664 664 |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. 665 665 ... ... @@ -666,20 +666,16 @@ 666 666 **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. 667 667 668 668 Attributes: 669 - 670 670 id 671 671 672 672 Content: 673 - 674 674 (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod) 675 675 676 676 Attribute Documentation: 677 - 678 678 |**Name**|**Type**|**Documentation** 679 679 |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. 680 680 681 681 Element Documentation: 682 - 683 683 |**Name**|**Type**|**Documentation** 684 684 |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. 685 685 |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. ... ... @@ -690,11 +690,9 @@ 690 690 **AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata attributes. 691 691 692 692 Content: 693 - 694 694 ReportedAttribute+ 695 695 696 696 Element Documentation: 697 - 698 698 |**Name**|**Type**|**Documentation** 699 699 |ReportedAttribute|ReportedAttributeTyp e|ReportedAttribute provides the details of a reported attribute, including a value and/or child reported attributes. 700 700 ... ... @@ -701,26 +701,21 @@ 701 701 **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. 702 702 703 703 Derivation: 626 +* //com:AnnotableType// (extension) 627 +** ReportedAttributeType 704 704 705 -//com:AnnotableType// (extension) 706 - ReportedAttributeType 707 - 708 708 Attributes: 709 - 710 710 id, value? 711 711 712 712 Content: 713 - 714 714 com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet? 715 715 716 716 Attribute Documentation: 717 - 718 718 |**Name**|**Type**|**Documentation** 719 719 |id|com:IDType|The id attribute identifies the metadata attribute that the value is being reported for. 720 720 |value|xs:string|The value attribute holds any simple value for the metadata attribute. 721 721 722 722 Element Documentation: 723 - 724 724 |**Name**|**Type**|**Documentation** 725 725 |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. 726 726 |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. ... ... @@ -727,14 +727,11 @@ 727 727 |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. 728 728 |AttributeSet|AttributeSetType|AttributeSet contains the reported metadata attribute values for the child metadata attributes. 729 729 730 -1. 731 -11. Structure Specific Metadata Namespace 647 +== Structure Specific Metadata Namespace == 732 732 733 733 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific** 734 734 735 -1. 736 -11. 737 -111. Summary 651 +=== Summary === 738 738 739 739 Referenced Namespaces: 740 740 ... ... @@ -744,30 +744,23 @@ 744 744 |http:~/~/www.w3.org/2001/XMLSchema|xs 745 745 746 746 Contents: 747 - 748 748 5 Complex Types 749 749 750 -1. 751 -11. 752 -111. Complex Types 663 +=== Complex Types === 753 753 754 754 **//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. 755 755 756 756 Derivation: 668 +* //com:AnnotableType// (extension) 669 +** //MetadataSetType// 757 757 758 -//com:AnnotableType// (extension) 759 - //MetadataSetType// 760 - 761 761 Attributes: 762 - 763 763 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 764 764 765 765 Content: 766 - 767 767 com:Annotations?, com:Name*, DataProvider?, Report+ 768 768 769 769 Attribute Documentation: 770 - 771 771 |**Name**|**Type**|**Documentation** 772 772 |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). 773 773 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -780,7 +780,6 @@ 780 780 |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). 781 781 782 782 Element Documentation: 783 - 784 784 |**Name**|**Type**|**Documentation** 785 785 |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. 786 786 |com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object. ... ... @@ -790,25 +790,20 @@ 790 790 **//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. 791 791 792 792 Derivation: 699 +* //com:AnnotableType// (extension) 700 +** //ReportType// 793 793 794 -//com:AnnotableType// (extension) 795 - //ReportType// 796 - 797 797 Attributes: 798 - 799 799 id? 800 800 801 801 Content: 802 - 803 803 com:Annotations?, Target, AttributeSet 804 804 805 805 Attribute Documentation: 806 - 807 807 |**Name**|**Type**|**Documentation** 808 808 |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. 809 809 810 810 Element Documentation: 811 - 812 812 |**Name**|**Type**|**Documentation** 813 813 |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. 814 814 |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. ... ... @@ -817,20 +817,16 @@ 817 817 **//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. 818 818 819 819 Attributes: 820 - 821 821 id? 822 822 823 823 Content: 824 - 825 825 ReferenceValue+ 826 826 827 827 Attribute Documentation: 828 - 829 829 |**Name**|**Type**|**Documentation** 830 830 |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. 831 831 832 832 Element Documentation: 833 - 834 834 |**Name**|**Type**|**Documentation** 835 835 |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. 836 836 ... ... @@ -837,20 +837,16 @@ 837 837 **//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. 838 838 839 839 Attributes: 840 - 841 841 id? 842 842 843 843 Content: 844 - 845 845 (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod) 846 846 847 847 Attribute Documentation: 848 - 849 849 |**Name**|**Type**|**Documentation** 850 850 |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. 851 851 852 852 Element Documentation: 853 - 854 854 |**Name**|**Type**|**Documentation** 855 855 |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. 856 856 |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. ... ... @@ -861,20 +861,16 @@ 861 861 **//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. 862 862 863 863 Derivation: 757 +* //com:AnnotableType// (extension) 758 +** //ReportedAttributeType// 864 864 865 -//com:AnnotableType// (extension) 866 - //ReportedAttributeType// 867 - 868 868 Attributes: 869 - 870 870 id?, value?, isMetadataAttribute? 871 871 872 872 Content: 873 - 874 874 com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet? 875 875 876 876 Attribute Documentation: 877 - 878 878 |**Name**|**Type**|**Documentation** 879 879 |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. 880 880 |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. ... ... @@ -881,7 +881,6 @@ 881 881 |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. 882 882 883 883 Element Documentation: 884 - 885 885 |**Name**|**Type**|**Documentation** 886 886 |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. 887 887 |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. ... ... @@ -888,9 +888,10 @@ 888 888 |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. 889 889 |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. 890 890 891 -1. Mapping to Structure-Specific Schemas 892 -11. General 779 += Mapping to Structure-Specific Schemas = 893 893 781 +== General == 782 + 894 894 Data structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces; 895 895 896 896 Data - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific ... ... @@ -899,9 +899,7 @@ 899 899 900 900 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. 901 901 902 -1. 903 -11. 904 -111. Basic Terminology 791 +=== Basic Terminology === 905 905 906 906 In the subsequent sections, the following namespace prefixes are used: 907 907 ... ... @@ -947,8 +947,7 @@ 947 947 948 948 **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). 949 949 950 -1. 951 -11. Namespace Rules 837 +== Namespace Rules == 952 952 953 953 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. 954 954 ... ... @@ -956,21 +956,17 @@ 956 956 957 957 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". 958 958 959 -1. 960 -11. General Rules 845 +== General Rules == 961 961 962 962 The following section details the general rules which apply to all structure specific schema creation. 963 963 964 -1. 965 -11. 966 -111. Component Name Determination 849 +=== Component Name Determination === 967 967 968 968 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: 969 969 970 -1. If the component defines an identifier, the element or attribute name is the value of that identifier 971 -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). 972 -11. 973 -111. Representation Determination 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 974 974 975 975 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). 976 976 ... ... @@ -984,40 +984,27 @@ 984 984 985 985 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. 986 986 987 -1. 988 -11. 989 -111. Simple / Primitive Type Determination 869 +=== Simple / Primitive Type Determination === 990 990 991 991 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:]]. 992 992 993 993 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. 994 994 995 -1. 996 -11. 997 -111. Representation with Enumeration 875 +=== Representation with Enumeration === 998 998 999 999 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: 1000 1000 1001 1001 1002 -<xs:simpleType name="ESTAT.CL_COUNTRY.1.0"> 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> 1003 1003 1004 - <xs:restrictionbase="common:IDType">888 +=== Representation with Text Format === 1005 1005 1006 -<xs:enumeration value="BE"> 1007 - 1008 -<xs:annotation> 1009 - 1010 -<xs:documentation xml:lang="en">Belgium</xs:documentation> 1011 - 1012 -</xs:annotation> 1013 - 1014 -</xs:enumeration> 1015 - 1016 - 1017 -1. 1018 -11. 1019 -111. Representation with Text Format 1020 - 1021 1021 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: 1022 1022 1023 1023 |**SDMX Data Type**|**XML Schema Data Type** ... ... @@ -1078,9 +1078,7 @@ 1078 1078 1079 1079 Any other facets are informational only, and will not affect the determined type. 1080 1080 1081 -1. 1082 -11. 1083 -111. //Type Names// 950 +=== Type Names === 1084 1084 1085 1085 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. 1086 1086 ... ... @@ -1107,16 +1107,13 @@ 1107 1107 1108 1108 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. 1109 1109 1110 -1. 1111 -11. Data Structure Specific Schema 977 +== Data Structure Specific Schema == 1112 1112 1113 1113 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. 1114 1114 1115 1115 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. 1116 1116 1117 -1. 1118 -11. 1119 -111. DataSetType 983 +=== DataSetType === 1120 1120 1121 1121 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: 1122 1122 ... ... @@ -1130,8 +1130,9 @@ 1130 1130 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 1131 1131 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 1132 1132 11. 1133 -111. GroupType 1134 1134 998 +=== GroupType === 999 + 1135 1135 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: 1136 1136 1137 1137 1. A sequence consisting of: ... ... @@ -1158,9 +1158,9 @@ 1158 1158 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 1159 1159 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 1160 1160 1. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group 1161 -11. 1162 -111. SeriesType 1163 1163 1027 +=== SeriesType === 1028 + 1164 1164 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: 1165 1165 1166 1166 1. A sequence consisting of: ... ... @@ -1169,9 +1169,9 @@ 1169 1169 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 1170 1170 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 1171 1171 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 1172 -11. 1173 -111. ObsType 1174 1174 1038 +=== ObsType === 1039 + 1175 1175 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: 1176 1176 1177 1177 1. A sequence consisting of: ... ... @@ -1194,9 +1194,7 @@ 1194 1194 1195 1195 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. 1196 1196 1197 -1. 1198 -11. 1199 -111. MetadataSetType 1062 +=== MetadataSetType === 1200 1200 1201 1201 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: 1202 1202 ... ... @@ -1248,9 +1248,10 @@ 1248 1248 111. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref 1249 1249 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 1250 1250 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 1251 -111. 1252 -1111. Identifiable Object Target Type Determination 1253 1253 1115 + 1116 +==== Identifiable Object Target Type Determination ==== 1117 + 1254 1254 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. 1255 1255 1256 1256 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. ... ... @@ -1267,9 +1267,9 @@ 1267 1267 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 1268 1268 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 1269 1269 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. 1270 -11. 1271 -111. ReportType 1272 1272 1135 +=== ReportType === 1136 + 1273 1273 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. 1274 1274 1275 1275 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: ... ... @@ -1317,17 +1317,16 @@ 1317 1317 1. 1318 1318 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 1319 1319 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] 1320 -11. 1321 -111. 1322 -1111. Attribute Set Complex Type Creation 1323 1323 1185 +=== Attribute Set Complex Type Creation === 1186 + 1324 1324 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: 1325 1325 1326 1326 1. A sequence consisting of: 1327 1327 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]. 1328 1328 1329 - 1.Special data functions1330 - 11.Updates1192 += Special data functions = 1193 +== Updates == 1331 1331 1332 1332 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. 1333 1333