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

From version 4.4
edited by Helena
on 2025/06/24 14:50
Change comment: There is no comment for this version
To version 4.7
edited by Helena
on 2025/06/24 14:59
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -389,20 +389,16 @@
389 389  **//ObsType//: **ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values. Data structure definition schemas will drive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attribute(s) will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived observation type be for the observation dimension(s) and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute. If the data structure definition specific schema requires that explicit measures be used (only possible when the measure dimension is specified at the observation), then there will be types derived for each measure defined by the measure dimension. In this case, the types will be specific to each measure, which is to say that the representation of the primary measure (i.e. the observed value) will be restricted to that which is specified by the specific measure.
390 390  
391 391  Derivation:
392 +* //com:AnnotableType// (extension) 
393 +** //ObsType//
392 392  
393 -//com:AnnotableType// (extension) 
394 - //ObsType//
395 -
396 396  Attributes:
397 -
398 398  type?, TIME_PERIOD?, REPORTING_YEAR_START_DAY?, OBS_VALUE?
399 399  
400 400  Content:
401 -
402 402  com:Annotations?
403 403  
404 404  Attribute Documentation:
405 -
406 406  |**Name**|**Type**|**Documentation**
407 407  |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.
408 408  |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.
... ... @@ -417,21 +417,17 @@
417 417  **//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.
418 418  
419 419  Derivation:
416 +* //com:AnnotableType// (extension) 
417 +** //DataSetType// (restriction) 
418 +*** //TimeSeriesDataSetType//
420 420  
421 -//com:AnnotableType// (extension) 
422 - //DataSetType// (restriction) 
423 - //TimeSeriesDataSetType//
424 -
425 425  Attributes:
426 -
427 427  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?
428 428  
429 429  Content:
430 -
431 431  com:Annotations?, DataProvider?, Group*, Series*
432 432  
433 433  Attribute Documentation:
434 -
435 435  |**Name**|**Type**|**Documentation**
436 436  |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).
437 437  |setID|com:IDType|The setID provides an identification of the data or metadata set.
... ... @@ -456,21 +456,17 @@
456 456  **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.
457 457  
458 458  Derivation:
451 +* //com:AnnotableType// (extension) 
452 +** //SeriesType// (restriction) 
453 +*** TimeSeriesType
459 459  
460 -//com:AnnotableType// (extension) 
461 - //SeriesType// (restriction) 
462 - TimeSeriesType
463 -
464 464  Attributes:
465 -
466 466  REPORTING_YEAR_START_DAY?
467 467  
468 468  Content:
469 -
470 470  com:Annotations?, Obs*
471 471  
472 472  Attribute Documentation:
473 -
474 474  |**Name**|**Type**|**Documentation**
475 475  |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.
476 476  
... ... @@ -483,21 +483,17 @@
483 483  **//TimeSeriesObsType//: **TimeSeriesObsType defines the abstract structure of a time series observation. The observation must be provided a value for the time dimension. This time value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same time value). The observation can contain an observed value and/or attribute values. The same rules for derivation as the base observation type apply to this specialized observation.
484 484  
485 485  Derivation:
474 +* //com:AnnotableType// (extension) 
475 +** //ObsType// (restriction) 
476 +*** //TimeSeriesObsType//
486 486  
487 -//com:AnnotableType// (extension) 
488 - //ObsType// (restriction) 
489 - //TimeSeriesObsType//
490 -
491 491  Attributes:
492 -
493 493  TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE?
494 494  
495 495  Content:
496 -
497 497  com:Annotations?
498 498  
499 499  Attribute Documentation:
500 -
501 501  |**Name**|**Type**|**Documentation**
502 502  |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.
503 503  |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.
... ... @@ -504,13 +504,10 @@
504 504  |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.
505 505  
506 506  Element Documentation:
507 -
508 508  |**Name**|**Type**|**Documentation**
509 509  |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.
510 510  
511 -1.
512 -11.
513 -111. Simple Types
494 +=== Simple Types ===
514 514  
515 515  **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.
516 516  
... ... @@ -517,7 +517,6 @@
517 517  Derived by restriction of xs:string .
518 518  
519 519  Enumerations:
520 -
521 521  |**Value**|**Documentation**
522 522  |DataStructure|The data set conforms simply to the data structure definition as it is defined, without regard to any constraints.
523 523  |ConstrainedDataStructure|The data set conforms to the known allowable content constraints applied to the data structure definition.
... ... @@ -524,46 +524,35 @@
524 524  |Dataflow|The data set conforms to the known allowable content constraints applied to the dataflow.
525 525  |ProvisionAgreement|The data set conforms to the known allowable content constraints applied to the provision agreement.
526 526  
527 -1.
528 -11. Generic Metadata Namespace
507 +== Generic Metadata Namespace ==
529 529  
530 530  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic**
531 531  
532 -1.
533 -11.
534 -111. Summary
511 +=== Summary ===
535 535  
536 536  Referenced Namespaces:
537 -
538 538  |**Namespace**|**Prefix**
539 539  |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
540 540  |http:~/~/www.w3.org/2001/XMLSchema|xs
541 541  
542 542  Contents:
543 -
544 544  6 Complex Types
545 545  
546 -1.
547 -11.
548 -111. Complex Types
521 +=== Complex Types ===
549 549  
550 550  **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.
551 551  
552 552  Derivation:
526 +* //com:AnnotableType// (extension) 
527 +** MetadataSetType
553 553  
554 -//com:AnnotableType// (extension) 
555 - MetadataSetType
556 -
557 557  Attributes:
558 -
559 559  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
560 560  
561 561  Content:
562 -
563 563  com:Annotations?, com:Name*, DataProvider?, Report+
564 564  
565 565  Attribute Documentation:
566 -
567 567  |**Name**|**Type**|**Documentation**
568 568  |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).
569 569  |setID|com:IDType|The setID provides an identification of the data or metadata set.
... ... @@ -586,20 +586,16 @@
586 586  **ReportType: **ReportType contains a set of report attributes and identifies a target objects] to which they apply.
587 587  
588 588  Derivation:
558 +* //com:AnnotableType// (extension) 
559 +** ReportType
589 589  
590 -//com:AnnotableType// (extension) 
591 - ReportType
592 -
593 593  Attributes:
594 -
595 595  id
596 596  
597 597  Content:
598 -
599 599  com:Annotations?, Target, AttributeSet
600 600  
601 601  Attribute Documentation:
602 -
603 603  |**Name**|**Type**|**Documentation**
604 604  |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.
605 605  
... ... @@ -613,20 +613,16 @@
613 613  **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.
614 614  
615 615  Attributes:
616 -
617 617  id
618 618  
619 619  Content:
620 -
621 621  ReferenceValue+
622 622  
623 623  Attribute Documentation:
624 -
625 625  |**Name**|**Type**|**Documentation**
626 626  |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.
627 627  
628 628  Element Documentation:
629 -
630 630  |**Name**|**Type**|**Documentation**
631 631  |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.
632 632  
... ... @@ -633,20 +633,16 @@
633 633  **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.
634 634  
635 635  Attributes:
636 -
637 637  id
638 638  
639 639  Content:
640 -
641 641  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
642 642  
643 643  Attribute Documentation:
644 -
645 645  |**Name**|**Type**|**Documentation**
646 646  |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.
647 647  
648 648  Element Documentation:
649 -
650 650  |**Name**|**Type**|**Documentation**
651 651  |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.
652 652  |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.
... ... @@ -657,11 +657,9 @@
657 657  **AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata attributes.
658 658  
659 659  Content:
660 -
661 661  ReportedAttribute+
662 662  
663 663  Element Documentation:
664 -
665 665  |**Name**|**Type**|**Documentation**
666 666  |ReportedAttribute|ReportedAttributeTyp e|ReportedAttribute provides the details of a reported attribute, including a value and/or child reported attributes.
667 667  
... ... @@ -668,26 +668,21 @@
668 668  **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.
669 669  
670 670  Derivation:
626 +* //com:AnnotableType// (extension) 
627 +** ReportedAttributeType
671 671  
672 -//com:AnnotableType// (extension) 
673 - ReportedAttributeType
674 -
675 675  Attributes:
676 -
677 677  id, value?
678 678  
679 679  Content:
680 -
681 681  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
682 682  
683 683  Attribute Documentation:
684 -
685 685  |**Name**|**Type**|**Documentation**
686 686  |id|com:IDType|The id attribute identifies the metadata attribute that the value is being reported for.
687 687  |value|xs:string|The value attribute holds any simple value for the metadata attribute.
688 688  
689 689  Element Documentation:
690 -
691 691  |**Name**|**Type**|**Documentation**
692 692  |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.
693 693  |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.
... ... @@ -694,14 +694,11 @@
694 694  |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.
695 695  |AttributeSet|AttributeSetType|AttributeSet contains the reported metadata attribute values for the child metadata attributes.
696 696  
697 -1.
698 -11. Structure Specific Metadata Namespace
647 +== Structure Specific Metadata Namespace ==
699 699  
700 700  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific**
701 701  
702 -1.
703 -11.
704 -111. Summary
651 +=== Summary ===
705 705  
706 706  Referenced Namespaces:
707 707  
... ... @@ -711,30 +711,23 @@
711 711  |http:~/~/www.w3.org/2001/XMLSchema|xs
712 712  
713 713  Contents:
714 -
715 715  5 Complex Types
716 716  
717 -1.
718 -11.
719 -111. Complex Types
663 +=== Complex Types ===
720 720  
721 721  **//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.
722 722  
723 723  Derivation:
668 +* //com:AnnotableType// (extension) 
669 +** //MetadataSetType//
724 724  
725 -//com:AnnotableType// (extension) 
726 - //MetadataSetType//
727 -
728 728  Attributes:
729 -
730 730  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
731 731  
732 732  Content:
733 -
734 734  com:Annotations?, com:Name*, DataProvider?, Report+
735 735  
736 736  Attribute Documentation:
737 -
738 738  |**Name**|**Type**|**Documentation**
739 739  |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).
740 740  |setID|com:IDType|The setID provides an identification of the data or metadata set.
... ... @@ -747,7 +747,6 @@
747 747  |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).
748 748  
749 749  Element Documentation:
750 -
751 751  |**Name**|**Type**|**Documentation**
752 752  |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.
753 753  |com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object.
... ... @@ -757,25 +757,20 @@
757 757  **//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.
758 758  
759 759  Derivation:
699 +* //com:AnnotableType// (extension) 
700 +** //ReportType//
760 760  
761 -//com:AnnotableType// (extension) 
762 - //ReportType//
763 -
764 764  Attributes:
765 -
766 766  id?
767 767  
768 768  Content:
769 -
770 770  com:Annotations?, Target, AttributeSet
771 771  
772 772  Attribute Documentation:
773 -
774 774  |**Name**|**Type**|**Documentation**
775 775  |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.
776 776  
777 777  Element Documentation:
778 -
779 779  |**Name**|**Type**|**Documentation**
780 780  |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.
781 781  |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.
... ... @@ -784,20 +784,16 @@
784 784  **//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.
785 785  
786 786  Attributes:
787 -
788 788  id?
789 789  
790 790  Content:
791 -
792 792  ReferenceValue+
793 793  
794 794  Attribute Documentation:
795 -
796 796  |**Name**|**Type**|**Documentation**
797 797  |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.
798 798  
799 799  Element Documentation:
800 -
801 801  |**Name**|**Type**|**Documentation**
802 802  |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.
803 803  
... ... @@ -804,20 +804,16 @@
804 804  **//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.
805 805  
806 806  Attributes:
807 -
808 808  id?
809 809  
810 810  Content:
811 -
812 812  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
813 813  
814 814  Attribute Documentation:
815 -
816 816  |**Name**|**Type**|**Documentation**
817 817  |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.
818 818  
819 819  Element Documentation:
820 -
821 821  |**Name**|**Type**|**Documentation**
822 822  |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.
823 823  |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.
... ... @@ -828,20 +828,16 @@
828 828  **//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.
829 829  
830 830  Derivation:
757 +* //com:AnnotableType// (extension) 
758 +** //ReportedAttributeType//
831 831  
832 -//com:AnnotableType// (extension) 
833 - //ReportedAttributeType//
834 -
835 835  Attributes:
836 -
837 837  id?, value?, isMetadataAttribute?
838 838  
839 839  Content:
840 -
841 841  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
842 842  
843 843  Attribute Documentation:
844 -
845 845  |**Name**|**Type**|**Documentation**
846 846  |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.
847 847  |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.
... ... @@ -848,7 +848,6 @@
848 848  |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.
849 849  
850 850  Element Documentation:
851 -
852 852  |**Name**|**Type**|**Documentation**
853 853  |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.
854 854  |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.
... ... @@ -855,9 +855,10 @@
855 855  |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.
856 856  |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.
857 857  
858 -1. Mapping to Structure-Specific Schemas
859 -11. General
779 += Mapping to Structure-Specific Schemas =
860 860  
781 +== General ==
782 +
861 861  Data structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces;
862 862  
863 863  Data  - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific
... ... @@ -866,9 +866,7 @@
866 866  
867 867  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.
868 868  
869 -1.
870 -11.
871 -111. Basic Terminology
791 +=== Basic Terminology ===
872 872  
873 873  In the subsequent sections, the following namespace prefixes are used:
874 874  
... ... @@ -914,8 +914,7 @@
914 914  
915 915  **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).
916 916  
917 -1.
918 -11. Namespace Rules
837 +== Namespace Rules ==
919 919  
920 920  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.
921 921  
... ... @@ -923,21 +923,17 @@
923 923  
924 924  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".
925 925  
926 -1.
927 -11. General Rules
845 +== General Rules ==
928 928  
929 929  The following section details the general rules which apply to all structure specific schema creation.
930 930  
931 -1.
932 -11.
933 -111. Component Name Determination
849 +=== Component Name Determination ===
934 934  
935 935  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:
936 936  
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
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
941 941  
942 942  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).
943 943  
... ... @@ -951,40 +951,27 @@
951 951  
952 952  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.
953 953  
954 -1.
955 -11.
956 -111. Simple / Primitive Type Determination
869 +=== Simple / Primitive Type Determination ===
957 957  
958 958  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:]].
959 959  
960 960  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.
961 961  
962 -1.
963 -11.
964 -111. Representation with Enumeration
875 +=== Representation with Enumeration ===
965 965  
966 966  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:
967 967  
968 968  
969 -<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>
970 970  
971 -<xs:restriction base="common:IDType">
888 +=== Representation with Text Format ===
972 972  
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 -
988 988  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:
989 989  
990 990  |**SDMX Data Type**|**XML Schema Data Type**
... ... @@ -1045,9 +1045,7 @@
1045 1045  
1046 1046  Any other facets are informational only, and will not affect the determined type.
1047 1047  
1048 -1.
1049 -11.
1050 -111. //Type Names//
950 +=== Type Names ===
1051 1051  
1052 1052  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.
1053 1053  
... ... @@ -1074,16 +1074,13 @@
1074 1074  
1075 1075  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.
1076 1076  
1077 -1.
1078 -11. Data Structure Specific Schema
977 +== Data Structure Specific Schema ==
1079 1079  
1080 1080  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.
1081 1081  
1082 1082  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.
1083 1083  
1084 -1.
1085 -11.
1086 -111. DataSetType
983 +=== DataSetType ===
1087 1087  
1088 1088  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:
1089 1089  
... ... @@ -1097,8 +1097,9 @@
1097 1097  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
1098 1098  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
1099 1099  11.
1100 -111. GroupType
1101 1101  
998 +=== GroupType ===
999 +
1102 1102  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:
1103 1103  
1104 1104  1. A sequence consisting of:
... ... @@ -1125,9 +1125,9 @@
1125 1125  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
1126 1126  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
1127 1127  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
1130 1130  
1027 +=== SeriesType ===
1028 +
1131 1131  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:
1132 1132  
1133 1133  1. A sequence consisting of:
... ... @@ -1136,9 +1136,9 @@
1136 1136  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
1137 1137  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
1138 1138  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
1141 1141  
1038 +=== ObsType ===
1039 +
1142 1142  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:
1143 1143  
1144 1144  1. A sequence consisting of:
... ... @@ -1161,9 +1161,7 @@
1161 1161  
1162 1162  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.
1163 1163  
1164 -1.
1165 -11.
1166 -111. MetadataSetType
1062 +=== MetadataSetType ===
1167 1167  
1168 1168  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:
1169 1169  
... ... @@ -1215,9 +1215,10 @@
1215 1215  111. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref
1216 1216  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
1217 1217  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
1220 1220  
1115 +
1116 +==== Identifiable Object Target Type Determination ====
1117 +
1221 1221  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.
1222 1222  
1223 1223  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.
... ... @@ -1234,9 +1234,9 @@
1234 1234  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
1235 1235  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
1236 1236  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
1239 1239  
1135 +=== ReportType ===
1136 +
1240 1240  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.
1241 1241  
1242 1242  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:
... ... @@ -1284,17 +1284,16 @@
1284 1284  1.
1285 1285  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
1286 1286  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
1290 1290  
1185 +=== Attribute Set Complex Type Creation ===
1186 +
1291 1291  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:
1292 1292  
1293 1293  1. A sequence consisting of:
1294 1294  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].
1295 1295  
1296 -1. Special data functions
1297 -11. Updates
1192 += Special data functions =
1193 +== Updates ==
1298 1298  
1299 1299  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.
1300 1300