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
-
... ... @@ -74,7 +74,6 @@ 74 74 **GroupType: **GroupType defines a structure which is used to communicate attribute values for a group defined in a data structure definition. The group can consist of either a subset of the dimensions defined by the data structure definition, or an association to an attachment constraint, which in turn defines key sets to which attributes can be attached. In the case that the group is based on an attachment constraint, only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the constraint and apply the values provided for the attributes appropriately. 75 75 76 76 Derivation: 77 - 78 78 * //com:AnnotableType// (extension) 79 79 ** GroupType 80 80 ... ... @@ -107,7 +107,6 @@ 107 107 com:Annotations?, SeriesKey, Attributes?, Obs* 108 108 109 109 Element Documentation: 110 - 111 111 |**Name**|**Type**|**Documentation** 112 112 |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. 113 113 |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. ... ... @@ -125,7 +125,6 @@ 125 125 com:Annotations?, ObsKey, ObsValue?, Attributes? 126 126 127 127 Element Documentation: 128 - 129 129 |**Name**|**Type**|**Documentation** 130 130 |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. 131 131 |ObsKey|ValuesType|ObsKey contains the values for every dimension defined in the data structure definition. A value must be provided for each dimension. This key serves to disambiguate the un-grouped observation within the data set. ... ... @@ -143,7 +143,6 @@ 143 143 com:Annotations?, ObsDimension, ObsValue?, Attributes? 144 144 145 145 Element Documentation: 146 - 147 147 |**Name**|**Type**|**Documentation** 148 148 |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. 149 149 |ObsDimension|BaseValueType|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. ... ... @@ -156,7 +156,6 @@ 156 156 Value+ 157 157 158 158 Element Documentation: 159 - 160 160 |**Name**|**Type**|**Documentation** 161 161 |Value|ComponentValueType|Value contains a component value and a reference to the component for which a value is being provided. 162 162 ... ... @@ -169,7 +169,6 @@ 169 169 {Empty} 170 170 171 171 Attribute Documentation: 172 - 173 173 |**Name**|**Type**|**Documentation** 174 174 |id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided. 175 175 |value|xs:anySimpleType|The value attribute contains the provided component value. ... ... @@ -188,7 +188,6 @@ 188 188 {Empty} 189 189 190 190 Attribute Documentation: 191 - 192 192 |**Name**|**Type**|**Documentation** 193 193 |id (fixed: OBS_VALUE)|com:NCNameIDType|The id attribute contains a fixed reference to the primary measure component of the data structure definition. 194 194 |value|xs:string|The value attribute contains the provided component value. ... ... @@ -196,7 +196,6 @@ 196 196 **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. 197 197 198 198 Derivation: 199 - 200 200 * BaseValueType (restriction) 201 201 ** ComponentValueType 202 202 ... ... @@ -207,7 +207,6 @@ 207 207 {Empty} 208 208 209 209 Attribute Documentation: 210 - 211 211 |**Name**|**Type**|**Documentation** 212 212 |id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided. 213 213 |value|xs:string|The value attribute contains the provided component value. ... ... @@ -215,7 +215,6 @@ 215 215 **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. 216 216 217 217 Derivation: 218 - 219 219 * //com:AnnotableType// (extension) 220 220 ** DataSetType (restriction) 221 221 *** TimeSeriesDataSetType ... ... @@ -227,7 +227,6 @@ 227 227 com:Annotations?, DataProvider?, Attributes?, Group*, Series* 228 228 229 229 Attribute Documentation: 230 - 231 231 |**Name**|**Type**|**Documentation** 232 232 |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). 233 233 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -251,7 +251,6 @@ 251 251 **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. 252 252 253 253 Derivation: 254 - 255 255 * //com:AnnotableType// (extension) 256 256 ** SeriesType (restriction) 257 257 *** TimeSeriesType ... ... @@ -260,7 +260,6 @@ 260 260 com:Annotations?, SeriesKey, Attributes?, Obs* 261 261 262 262 Element Documentation: 263 - 264 264 |**Name**|**Type**|**Documentation** 265 265 |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. 266 266 |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. ... ... @@ -270,7 +270,6 @@ 270 270 **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. 271 271 272 272 Derivation: 273 - 274 274 * //com:AnnotableType// (extension) 275 275 ** ObsType (restriction) 276 276 *** TimeSeriesObsType ... ... @@ -279,7 +279,6 @@ 279 279 com:Annotations?, ObsDimension, ObsValue?, Attributes? 280 280 281 281 Element Documentation: 282 - 283 283 |**Name**|**Type**|**Documentation** 284 284 |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. 285 285 |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. ... ... @@ -289,7 +289,6 @@ 289 289 **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. 290 290 291 291 Derivation: 292 - 293 293 * BaseValueType (restriction) 294 294 ** TimeValueType 295 295 ... ... @@ -300,7 +300,6 @@ 300 300 {Empty} 301 301 302 302 Attribute Documentation: 303 - 304 304 |**Name**|**Type**|**Documentation** 305 305 |id (fixed: TIME_PERIOD)|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided. 306 306 |value|com: ObservationalTimePer iodType|The value attribute contains the provided component value. ... ... @@ -312,7 +312,6 @@ 312 312 === 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 ... ... @@ -327,7 +327,6 @@ 327 327 **//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. 328 328 329 329 Derivation: 330 - 331 331 * //com:AnnotableType// (extension) 332 332 ** //DataSetType// 333 333 ... ... @@ -338,7 +338,6 @@ 338 338 com:Annotations?, DataProvider?, Group*, (Series+ | Obs+)? 339 339 340 340 Attribute Documentation: 341 - 342 342 |**Name**|**Type**|**Documentation** 343 343 |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). 344 344 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -364,7 +364,6 @@ 364 364 **//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. 365 365 366 366 Derivation: 367 - 368 368 * //com:AnnotableType// (extension) 369 369 ** //GroupType// 370 370 ... ... @@ -375,7 +375,6 @@ 375 375 com:Annotations? 376 376 377 377 Attribute Documentation: 378 - 379 379 |**Name**|**Type**|**Documentation** 380 380 |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. 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 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. ... ... @@ -388,7 +388,6 @@ 388 388 **//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. 389 389 390 390 Derivation: 391 - 392 392 * //com:AnnotableType// (extension) 393 393 ** //SeriesType// 394 394 ... ... @@ -399,7 +399,6 @@ 399 399 com:Annotations?, Obs* 400 400 401 401 Attribute Documentation: 402 - 403 403 |**Name**|**Type**|**Documentation** 404 404 |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. 405 405 |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. ... ... @@ -414,13 +414,15 @@ 414 414 415 415 Derivation: 416 416 417 - *//com:AnnotableType// (extension)418 - **//ObsType//393 +//com:AnnotableType// (extension) 394 + //ObsType// 419 419 420 420 Attributes: 397 + 421 421 type?, TIME_PERIOD?, REPORTING_YEAR_START_DAY?, OBS_VALUE? 422 422 423 423 Content: 401 + 424 424 com:Annotations? 425 425 426 426 Attribute Documentation: ... ... @@ -440,14 +440,16 @@ 440 440 441 441 Derivation: 442 442 443 - *//com:AnnotableType// (extension)444 - **//DataSetType// (restriction)445 - ***//TimeSeriesDataSetType//421 +//com:AnnotableType// (extension) 422 + //DataSetType// (restriction) 423 + //TimeSeriesDataSetType// 446 446 447 447 Attributes: 426 + 448 448 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY? 449 449 450 450 Content: 430 + 451 451 com:Annotations?, DataProvider?, Group*, Series* 452 452 453 453 Attribute Documentation: ... ... @@ -477,14 +477,16 @@ 477 477 478 478 Derivation: 479 479 480 - *//com:AnnotableType// (extension)481 - **//SeriesType// (restriction)482 - ***TimeSeriesType460 +//com:AnnotableType// (extension) 461 + //SeriesType// (restriction) 462 + TimeSeriesType 483 483 484 484 Attributes: 465 + 485 485 REPORTING_YEAR_START_DAY? 486 486 487 487 Content: 469 + 488 488 com:Annotations?, Obs* 489 489 490 490 Attribute Documentation: ... ... @@ -502,14 +502,16 @@ 502 502 503 503 Derivation: 504 504 505 - *//com:AnnotableType// (extension)506 - **//ObsType// (restriction)507 - ***//TimeSeriesObsType//487 +//com:AnnotableType// (extension) 488 + //ObsType// (restriction) 489 + //TimeSeriesObsType// 508 508 509 509 Attributes: 492 + 510 510 TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE? 511 511 512 512 Content: 496 + 513 513 com:Annotations? 514 514 515 515 Attribute Documentation: ... ... @@ -524,7 +524,9 @@ 524 524 |**Name**|**Type**|**Documentation** 525 525 |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. 526 526 527 -=== Simple Types === 511 +1. 512 +11. 513 +111. Simple Types 528 528 529 529 **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. 530 530 ... ... @@ -538,11 +538,14 @@ 538 538 |Dataflow|The data set conforms to the known allowable content constraints applied to the dataflow. 539 539 |ProvisionAgreement|The data set conforms to the known allowable content constraints applied to the provision agreement. 540 540 541 -== Generic Metadata Namespace == 527 +1. 528 +11. Generic Metadata Namespace 542 542 543 543 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic** 544 544 545 -=== Summary === 532 +1. 533 +11. 534 +111. Summary 546 546 547 547 Referenced Namespaces: 548 548 ... ... @@ -551,21 +551,26 @@ 551 551 |http:~/~/www.w3.org/2001/XMLSchema|xs 552 552 553 553 Contents: 543 + 554 554 6 Complex Types 555 555 556 -=== Complex Types === 546 +1. 547 +11. 548 +111. Complex Types 557 557 558 558 **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. 559 559 560 560 Derivation: 561 561 562 - *//com:AnnotableType// (extension)563 - **MetadataSetType554 +//com:AnnotableType// (extension) 555 + MetadataSetType 564 564 565 565 Attributes: 558 + 566 566 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 567 567 568 568 Content: 562 + 569 569 com:Annotations?, com:Name*, DataProvider?, Report+ 570 570 571 571 Attribute Documentation: ... ... @@ -593,13 +593,15 @@ 593 593 594 594 Derivation: 595 595 596 - *//com:AnnotableType// (extension)597 - **ReportType590 +//com:AnnotableType// (extension) 591 + ReportType 598 598 599 599 Attributes: 594 + 600 600 id 601 601 602 602 Content: 598 + 603 603 com:Annotations?, Target, AttributeSet 604 604 605 605 Attribute Documentation: ... ... @@ -617,9 +617,11 @@ 617 617 **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. 618 618 619 619 Attributes: 616 + 620 620 id 621 621 622 622 Content: 620 + 623 623 ReferenceValue+ 624 624 625 625 Attribute Documentation: ... ... @@ -635,9 +635,11 @@ 635 635 **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. 636 636 637 637 Attributes: 636 + 638 638 id 639 639 640 640 Content: 640 + 641 641 (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod) 642 642 643 643 Attribute Documentation: ... ... @@ -657,6 +657,7 @@ 657 657 **AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata attributes. 658 658 659 659 Content: 660 + 660 660 ReportedAttribute+ 661 661 662 662 Element Documentation: ... ... @@ -668,13 +668,15 @@ 668 668 669 669 Derivation: 670 670 671 - *//com:AnnotableType// (extension)672 - **ReportedAttributeType672 +//com:AnnotableType// (extension) 673 + ReportedAttributeType 673 673 674 674 Attributes: 676 + 675 675 id, value? 676 676 677 677 Content: 680 + 678 678 com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet? 679 679 680 680 Attribute Documentation: ... ... @@ -691,11 +691,14 @@ 691 691 |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. 692 692 |AttributeSet|AttributeSetType|AttributeSet contains the reported metadata attribute values for the child metadata attributes. 693 693 694 -== Structure Specific Metadata Namespace == 697 +1. 698 +11. Structure Specific Metadata Namespace 695 695 696 696 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific** 697 697 698 -=== Summary === 702 +1. 703 +11. 704 +111. Summary 699 699 700 700 Referenced Namespaces: 701 701 ... ... @@ -705,21 +705,26 @@ 705 705 |http:~/~/www.w3.org/2001/XMLSchema|xs 706 706 707 707 Contents: 714 + 708 708 5 Complex Types 709 709 710 -=== Complex Types === 717 +1. 718 +11. 719 +111. Complex Types 711 711 712 712 **//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. 713 713 714 714 Derivation: 715 715 716 - *//com:AnnotableType// (extension)717 - **//MetadataSetType//725 +//com:AnnotableType// (extension) 726 + //MetadataSetType// 718 718 719 719 Attributes: 729 + 720 720 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 721 721 722 722 Content: 733 + 723 723 com:Annotations?, com:Name*, DataProvider?, Report+ 724 724 725 725 Attribute Documentation: ... ... @@ -747,13 +747,15 @@ 747 747 748 748 Derivation: 749 749 750 - *//com:AnnotableType// (extension)751 - **//ReportType//761 +//com:AnnotableType// (extension) 762 + //ReportType// 752 752 753 753 Attributes: 765 + 754 754 id? 755 755 756 756 Content: 769 + 757 757 com:Annotations?, Target, AttributeSet 758 758 759 759 Attribute Documentation: ... ... @@ -771,9 +771,11 @@ 771 771 **//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. 772 772 773 773 Attributes: 787 + 774 774 id? 775 775 776 776 Content: 791 + 777 777 ReferenceValue+ 778 778 779 779 Attribute Documentation: ... ... @@ -789,9 +789,11 @@ 789 789 **//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. 790 790 791 791 Attributes: 807 + 792 792 id? 793 793 794 794 Content: 811 + 795 795 (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod) 796 796 797 797 Attribute Documentation: ... ... @@ -812,13 +812,15 @@ 812 812 813 813 Derivation: 814 814 815 - *//com:AnnotableType// (extension)816 - **//ReportedAttributeType//832 +//com:AnnotableType// (extension) 833 + //ReportedAttributeType// 817 817 818 818 Attributes: 836 + 819 819 id?, value?, isMetadataAttribute? 820 820 821 821 Content: 840 + 822 822 com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet? 823 823 824 824 Attribute Documentation: ... ... @@ -836,10 +836,9 @@ 836 836 |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. 837 837 |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. 838 838 839 -= Mapping to Structure-Specific Schemas = 858 +1. Mapping to Structure-Specific Schemas 859 +11. General 840 840 841 -== General == 842 - 843 843 Data structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces; 844 844 845 845 Data - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific ... ... @@ -848,7 +848,9 @@ 848 848 849 849 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. 850 850 851 -=== Basic Terminology === 869 +1. 870 +11. 871 +111. Basic Terminology 852 852 853 853 In the subsequent sections, the following namespace prefixes are used: 854 854 ... ... @@ -894,7 +894,8 @@ 894 894 895 895 **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). 896 896 897 -== Namespace Rules == 917 +1. 918 +11. Namespace Rules 898 898 899 899 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. 900 900 ... ... @@ -902,17 +902,21 @@ 902 902 903 903 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". 904 904 905 -== General Rules == 926 +1. 927 +11. General Rules 906 906 907 907 The following section details the general rules which apply to all structure specific schema creation. 908 908 909 -=== Component Name Determination === 931 +1. 932 +11. 933 +111. Component Name Determination 910 910 911 911 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: 912 912 913 -If the component defines an identifier, the element or attribute name is the value of that identifier 914 -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). 915 -Representation Determination 937 +1. If the component defines an identifier, the element or attribute name is the value of that identifier 938 +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). 939 +11. 940 +111. Representation Determination 916 916 917 917 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). 918 918 ... ... @@ -926,27 +926,40 @@ 926 926 927 927 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. 928 928 929 -=== Simple / Primitive Type Determination === 954 +1. 955 +11. 956 +111. Simple / Primitive Type Determination 930 930 931 931 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:]]. 932 932 933 933 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. 934 934 935 -=== Representation with Enumeration === 962 +1. 963 +11. 964 +111. Representation with Enumeration 936 936 937 937 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: 938 938 939 -> <xs:simpleType name="ESTAT.CL_COUNTRY.1.0"> 940 -> <xs:restriction base="common:IDType"> 941 -> <xs:enumeration value="BE"> 942 -> <xs:annotation> 943 -> <xs:documentation xml:lang="en">Belgium</xs:documentation> 944 -> </xs:annotation> 945 -> </xs:enumeration> 946 946 969 +<xs:simpleType name="ESTAT.CL_COUNTRY.1.0"> 947 947 948 - === Representationwith Text Format ===971 +<xs:restriction base="common:IDType"> 949 949 973 +<xs:enumeration value="BE"> 974 + 975 +<xs:annotation> 976 + 977 +<xs:documentation xml:lang="en">Belgium</xs:documentation> 978 + 979 +</xs:annotation> 980 + 981 +</xs:enumeration> 982 + 983 + 984 +1. 985 +11. 986 +111. Representation with Text Format 987 + 950 950 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: 951 951 952 952 |**SDMX Data Type**|**XML Schema Data Type** ... ... @@ -989,7 +989,7 @@ 989 989 |Day|xs:gDay 990 990 |Time|xs:time 991 991 |Duration|xs:duration 992 -|XHTML|N/A {{footnote}}These typesare only used in complextypes and will be discussed within their appropriate context.{{/footnote}}1030 +|XHTML|N/A[[~[1~]>>path:#_ftn1]] 993 993 |KeyValues|N/A^^1^^ 994 994 |IdentifiableReference|N/A^^1^^ 995 995 |DataSetReference|N/A^^1^^ ... ... @@ -1000,7 +1000,7 @@ 1000 1000 |**SDMX Facet**|**XML Schema Facet** 1001 1001 |minLength|xs:minLength 1002 1002 |maxLength|xs:maxLength 1003 -|minValue {{footnote}}Note that these options onlyapplyto numeric representations and should be ignored ifthe data type isnon-numeric{{/footnote}}|if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive1041 +|minValue[[~[2~]>>path:#_ftn2]]|if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive 1004 1004 |maxValue^^2^^|if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive 1005 1005 |decimals^^2^^|xs:fractionDigits 1006 1006 |pattern|xs:pattern ... ... @@ -1007,7 +1007,9 @@ 1007 1007 1008 1008 Any other facets are informational only, and will not affect the determined type. 1009 1009 1010 -=== Type Names === 1048 +1. 1049 +11. 1050 +111. //Type Names// 1011 1011 1012 1012 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. 1013 1013 ... ... @@ -1034,13 +1034,16 @@ 1034 1034 1035 1035 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. 1036 1036 1037 -== Data Structure Specific Schema == 1077 +1. 1078 +11. Data Structure Specific Schema 1038 1038 1039 1039 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. 1040 1040 1041 1041 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. 1042 1042 1043 -=== DataSetType === 1084 +1. 1085 +11. 1086 +111. DataSetType 1044 1044 1045 1045 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: 1046 1046 ... ... @@ -1053,10 +1053,9 @@ 1053 1053 111. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows) 1054 1054 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 1055 1055 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 1056 -11. 1099 +11. 1100 +111. GroupType 1057 1057 1058 -=== GroupType === 1059 - 1060 1060 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: 1061 1061 1062 1062 1. A sequence consisting of: ... ... @@ -1083,9 +1083,9 @@ 1083 1083 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 1084 1084 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 1085 1085 1. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group 1128 +11. 1129 +111. SeriesType 1086 1086 1087 -=== SeriesType === 1088 - 1089 1089 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: 1090 1090 1091 1091 1. A sequence consisting of: ... ... @@ -1094,9 +1094,9 @@ 1094 1094 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 1095 1095 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 1096 1096 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 1139 +11. 1140 +111. ObsType 1097 1097 1098 -=== ObsType === 1099 - 1100 1100 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: 1101 1101 1102 1102 1. A sequence consisting of: ... ... @@ -1119,7 +1119,9 @@ 1119 1119 1120 1120 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. 1121 1121 1122 -=== MetadataSetType === 1164 +1. 1165 +11. 1166 +111. MetadataSetType 1123 1123 1124 1124 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: 1125 1125 ... ... @@ -1171,11 +1171,9 @@ 1171 1171 111. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref 1172 1172 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 1173 1173 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 1218 +111. 1219 +1111. Identifiable Object Target Type Determination 1174 1174 1175 - 1176 - 1177 -==== Identifiable Object Target Type Determination ==== 1178 - 1179 1179 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. 1180 1180 1181 1181 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. ... ... @@ -1192,9 +1192,9 @@ 1192 1192 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 1193 1193 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 1194 1194 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. 1237 +11. 1238 +111. ReportType 1195 1195 1196 -=== ReportType === 1197 - 1198 1198 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. 1199 1199 1200 1200 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: ... ... @@ -1242,28 +1242,34 @@ 1242 1242 1. 1243 1243 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 1244 1244 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] 1287 +11. 1288 +111. 1289 +1111. Attribute Set Complex Type Creation 1245 1245 1246 -=== Attribute Set Complex Type Creation === 1247 - 1248 1248 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: 1249 1249 1250 1250 1. A sequence consisting of: 1251 1251 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]. 1252 1252 1253 -= Special data functions = 1296 +1. Special data functions 1297 +11. Updates 1254 1254 1255 -== Updates == 1256 - 1257 1257 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. 1258 1258 1301 + 1259 1259 A dataset with an action of Append is assumed to be an incremental update. This means that one the information provided explicitly in the message should be altered. Any data attribute or observation value that is to be changed must be provided. However, the absence of an observation value or a data attribute at any level does not imply deletion; instead it is simply implied that the value is to remain unchanged. Therefore, it is valid and acceptable to send a data message with an action of Append which contains only a Series elements with attribute values. In this case, the values for the attributes will be updated. Note that it is not permissible to update data attributes using partial keys (outside of those associated with defined groups). In order to update an attribute, a full key must always be provided even if the message format does not require this. 1260 1260 1261 -== Deletes == 1304 +1. 1305 +11. Deletes 1262 1262 1263 1263 Both the generic and the structure-specific data messages allow for incremental deletion 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. 1264 1264 1309 + 1265 1265 A dataset with an action of Delete is assumed to be an incremental deletion. The deletion is assumed to take place of the lowest level of detail provided in the message. For example, if a delete message is sent with only a data set element, the entire data set will be deleted. On the other hand, if that data set contains a data attribute, only that data attribute value will be deleted. This same dynamic continues through the data set hierarchy. A data set containing only a series with no data attributes or observations will result in that entire series (all observations and data attributes) being deleted. If the series contains data attributes, only the supplied data attributes for that series will be deleted. Finally, if a series contains observations, then only the specified observations will be deleted. If an entire observation is to be deleted (value and data attributes), only the observation dimension should be provided. If only the observation value or particular data attributes are to be deleted, then these should be specified for the observation. Note that a group can only be used to delete the data attributes associated with it. Although the format might not require it, a full key must be provided to delete a series or observation. It is not permissible to wild card a key in order to delete more than one series or observation. Finally, to delete a data attribute or observation value it is recommended that the value to be deleted be supplied; however, it is only required that any valid value be provided. 1266 1266 1312 + 1267 1267 ---- 1268 1268 1269 -{{putFootnotes/}} 1315 +[[~[1~]>>path:#_ftnref1]] These types are only used in complex types and will be discussed within their appropriate context. 1316 + 1317 +[[~[2~]>>path:#_ftnref2]] Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric