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
-
... ... @@ -471,21 +471,17 @@ 471 471 **//TimeSeriesObsType//: **TimeSeriesObsType defines the abstract structure of a time series observation. The observation must be provided a value for the time dimension. This time value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same time value). The observation can contain an observed value and/or attribute values. The same rules for derivation as the base observation type apply to this specialized observation. 472 472 473 473 Derivation: 474 +* //com:AnnotableType// (extension) 475 +** //ObsType// (restriction) 476 +*** //TimeSeriesObsType// 474 474 475 -//com:AnnotableType// (extension) 476 - //ObsType// (restriction) 477 - //TimeSeriesObsType// 478 - 479 479 Attributes: 480 - 481 481 TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE? 482 482 483 483 Content: 484 - 485 485 com:Annotations? 486 486 487 487 Attribute Documentation: 488 - 489 489 |**Name**|**Type**|**Documentation** 490 490 |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. 491 491 |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. ... ... @@ -492,13 +492,10 @@ 492 492 |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. 493 493 494 494 Element Documentation: 495 - 496 496 |**Name**|**Type**|**Documentation** 497 497 |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. 498 498 499 -1. 500 -11. 501 -111. Simple Types 494 +=== Simple Types === 502 502 503 503 **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. 504 504 ... ... @@ -505,7 +505,6 @@ 505 505 Derived by restriction of xs:string . 506 506 507 507 Enumerations: 508 - 509 509 |**Value**|**Documentation** 510 510 |DataStructure|The data set conforms simply to the data structure definition as it is defined, without regard to any constraints. 511 511 |ConstrainedDataStructure|The data set conforms to the known allowable content constraints applied to the data structure definition. ... ... @@ -512,46 +512,35 @@ 512 512 |Dataflow|The data set conforms to the known allowable content constraints applied to the dataflow. 513 513 |ProvisionAgreement|The data set conforms to the known allowable content constraints applied to the provision agreement. 514 514 515 -1. 516 -11. Generic Metadata Namespace 507 +== Generic Metadata Namespace == 517 517 518 518 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic** 519 519 520 -1. 521 -11. 522 -111. Summary 511 +=== Summary === 523 523 524 524 Referenced Namespaces: 525 - 526 526 |**Namespace**|**Prefix** 527 527 |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com 528 528 |http:~/~/www.w3.org/2001/XMLSchema|xs 529 529 530 530 Contents: 531 - 532 532 6 Complex Types 533 533 534 -1. 535 -11. 536 -111. Complex Types 521 +=== Complex Types === 537 537 538 538 **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. 539 539 540 540 Derivation: 526 +* //com:AnnotableType// (extension) 527 +** MetadataSetType 541 541 542 -//com:AnnotableType// (extension) 543 - MetadataSetType 544 - 545 545 Attributes: 546 - 547 547 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 548 548 549 549 Content: 550 - 551 551 com:Annotations?, com:Name*, DataProvider?, Report+ 552 552 553 553 Attribute Documentation: 554 - 555 555 |**Name**|**Type**|**Documentation** 556 556 |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). 557 557 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -574,20 +574,16 @@ 574 574 **ReportType: **ReportType contains a set of report attributes and identifies a target objects] to which they apply. 575 575 576 576 Derivation: 558 +* //com:AnnotableType// (extension) 559 +** ReportType 577 577 578 -//com:AnnotableType// (extension) 579 - ReportType 580 - 581 581 Attributes: 582 - 583 583 id 584 584 585 585 Content: 586 - 587 587 com:Annotations?, Target, AttributeSet 588 588 589 589 Attribute Documentation: 590 - 591 591 |**Name**|**Type**|**Documentation** 592 592 |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. 593 593 ... ... @@ -601,20 +601,16 @@ 601 601 **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. 602 602 603 603 Attributes: 604 - 605 605 id 606 606 607 607 Content: 608 - 609 609 ReferenceValue+ 610 610 611 611 Attribute Documentation: 612 - 613 613 |**Name**|**Type**|**Documentation** 614 614 |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. 615 615 616 616 Element Documentation: 617 - 618 618 |**Name**|**Type**|**Documentation** 619 619 |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. 620 620 ... ... @@ -621,20 +621,16 @@ 621 621 **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. 622 622 623 623 Attributes: 624 - 625 625 id 626 626 627 627 Content: 628 - 629 629 (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod) 630 630 631 631 Attribute Documentation: 632 - 633 633 |**Name**|**Type**|**Documentation** 634 634 |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. 635 635 636 636 Element Documentation: 637 - 638 638 |**Name**|**Type**|**Documentation** 639 639 |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. 640 640 |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. ... ... @@ -645,11 +645,9 @@ 645 645 **AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata attributes. 646 646 647 647 Content: 648 - 649 649 ReportedAttribute+ 650 650 651 651 Element Documentation: 652 - 653 653 |**Name**|**Type**|**Documentation** 654 654 |ReportedAttribute|ReportedAttributeTyp e|ReportedAttribute provides the details of a reported attribute, including a value and/or child reported attributes. 655 655 ... ... @@ -656,26 +656,21 @@ 656 656 **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. 657 657 658 658 Derivation: 626 +* //com:AnnotableType// (extension) 627 +** ReportedAttributeType 659 659 660 -//com:AnnotableType// (extension) 661 - ReportedAttributeType 662 - 663 663 Attributes: 664 - 665 665 id, value? 666 666 667 667 Content: 668 - 669 669 com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet? 670 670 671 671 Attribute Documentation: 672 - 673 673 |**Name**|**Type**|**Documentation** 674 674 |id|com:IDType|The id attribute identifies the metadata attribute that the value is being reported for. 675 675 |value|xs:string|The value attribute holds any simple value for the metadata attribute. 676 676 677 677 Element Documentation: 678 - 679 679 |**Name**|**Type**|**Documentation** 680 680 |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. 681 681 |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. ... ... @@ -682,14 +682,11 @@ 682 682 |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. 683 683 |AttributeSet|AttributeSetType|AttributeSet contains the reported metadata attribute values for the child metadata attributes. 684 684 685 -1. 686 -11. Structure Specific Metadata Namespace 647 +== Structure Specific Metadata Namespace == 687 687 688 688 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific** 689 689 690 -1. 691 -11. 692 -111. Summary 651 +=== Summary === 693 693 694 694 Referenced Namespaces: 695 695 ... ... @@ -699,30 +699,23 @@ 699 699 |http:~/~/www.w3.org/2001/XMLSchema|xs 700 700 701 701 Contents: 702 - 703 703 5 Complex Types 704 704 705 -1. 706 -11. 707 -111. Complex Types 663 +=== Complex Types === 708 708 709 709 **//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. 710 710 711 711 Derivation: 668 +* //com:AnnotableType// (extension) 669 +** //MetadataSetType// 712 712 713 -//com:AnnotableType// (extension) 714 - //MetadataSetType// 715 - 716 716 Attributes: 717 - 718 718 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 719 719 720 720 Content: 721 - 722 722 com:Annotations?, com:Name*, DataProvider?, Report+ 723 723 724 724 Attribute Documentation: 725 - 726 726 |**Name**|**Type**|**Documentation** 727 727 |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). 728 728 |setID|com:IDType|The setID provides an identification of the data or metadata set. ... ... @@ -735,7 +735,6 @@ 735 735 |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). 736 736 737 737 Element Documentation: 738 - 739 739 |**Name**|**Type**|**Documentation** 740 740 |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. 741 741 |com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object. ... ... @@ -745,25 +745,20 @@ 745 745 **//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. 746 746 747 747 Derivation: 699 +* //com:AnnotableType// (extension) 700 +** //ReportType// 748 748 749 -//com:AnnotableType// (extension) 750 - //ReportType// 751 - 752 752 Attributes: 753 - 754 754 id? 755 755 756 756 Content: 757 - 758 758 com:Annotations?, Target, AttributeSet 759 759 760 760 Attribute Documentation: 761 - 762 762 |**Name**|**Type**|**Documentation** 763 763 |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. 764 764 765 765 Element Documentation: 766 - 767 767 |**Name**|**Type**|**Documentation** 768 768 |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. 769 769 |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. ... ... @@ -772,20 +772,16 @@ 772 772 **//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. 773 773 774 774 Attributes: 775 - 776 776 id? 777 777 778 778 Content: 779 - 780 780 ReferenceValue+ 781 781 782 782 Attribute Documentation: 783 - 784 784 |**Name**|**Type**|**Documentation** 785 785 |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. 786 786 787 787 Element Documentation: 788 - 789 789 |**Name**|**Type**|**Documentation** 790 790 |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. 791 791 ... ... @@ -792,20 +792,16 @@ 792 792 **//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. 793 793 794 794 Attributes: 795 - 796 796 id? 797 797 798 798 Content: 799 - 800 800 (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod) 801 801 802 802 Attribute Documentation: 803 - 804 804 |**Name**|**Type**|**Documentation** 805 805 |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. 806 806 807 807 Element Documentation: 808 - 809 809 |**Name**|**Type**|**Documentation** 810 810 |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. 811 811 |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. ... ... @@ -816,20 +816,16 @@ 816 816 **//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. 817 817 818 818 Derivation: 757 +* //com:AnnotableType// (extension) 758 +** //ReportedAttributeType// 819 819 820 -//com:AnnotableType// (extension) 821 - //ReportedAttributeType// 822 - 823 823 Attributes: 824 - 825 825 id?, value?, isMetadataAttribute? 826 826 827 827 Content: 828 - 829 829 com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet? 830 830 831 831 Attribute Documentation: 832 - 833 833 |**Name**|**Type**|**Documentation** 834 834 |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. 835 835 |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. ... ... @@ -836,7 +836,6 @@ 836 836 |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. 837 837 838 838 Element Documentation: 839 - 840 840 |**Name**|**Type**|**Documentation** 841 841 |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. 842 842 |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. ... ... @@ -843,9 +843,10 @@ 843 843 |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. 844 844 |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. 845 845 846 -1. Mapping to Structure-Specific Schemas 847 -11. General 779 += Mapping to Structure-Specific Schemas = 848 848 781 +== General == 782 + 849 849 Data structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces; 850 850 851 851 Data - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific ... ... @@ -854,9 +854,7 @@ 854 854 855 855 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. 856 856 857 -1. 858 -11. 859 -111. Basic Terminology 791 +=== Basic Terminology === 860 860 861 861 In the subsequent sections, the following namespace prefixes are used: 862 862 ... ... @@ -902,8 +902,7 @@ 902 902 903 903 **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). 904 904 905 -1. 906 -11. Namespace Rules 837 +== Namespace Rules == 907 907 908 908 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. 909 909 ... ... @@ -911,21 +911,17 @@ 911 911 912 912 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". 913 913 914 -1. 915 -11. General Rules 845 +== General Rules == 916 916 917 917 The following section details the general rules which apply to all structure specific schema creation. 918 918 919 -1. 920 -11. 921 -111. Component Name Determination 849 +=== Component Name Determination === 922 922 923 923 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: 924 924 925 -1. If the component defines an identifier, the element or attribute name is the value of that identifier 926 -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). 927 -11. 928 -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 929 929 930 930 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). 931 931 ... ... @@ -939,40 +939,27 @@ 939 939 940 940 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. 941 941 942 -1. 943 -11. 944 -111. Simple / Primitive Type Determination 869 +=== Simple / Primitive Type Determination === 945 945 946 946 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:]]. 947 947 948 948 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. 949 949 950 -1. 951 -11. 952 -111. Representation with Enumeration 875 +=== Representation with Enumeration === 953 953 954 954 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: 955 955 956 956 957 -<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> 958 958 959 - <xs:restrictionbase="common:IDType">888 +=== Representation with Text Format === 960 960 961 -<xs:enumeration value="BE"> 962 - 963 -<xs:annotation> 964 - 965 -<xs:documentation xml:lang="en">Belgium</xs:documentation> 966 - 967 -</xs:annotation> 968 - 969 -</xs:enumeration> 970 - 971 - 972 -1. 973 -11. 974 -111. Representation with Text Format 975 - 976 976 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: 977 977 978 978 |**SDMX Data Type**|**XML Schema Data Type** ... ... @@ -1033,9 +1033,7 @@ 1033 1033 1034 1034 Any other facets are informational only, and will not affect the determined type. 1035 1035 1036 -1. 1037 -11. 1038 -111. //Type Names// 950 +=== Type Names === 1039 1039 1040 1040 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. 1041 1041 ... ... @@ -1062,16 +1062,13 @@ 1062 1062 1063 1063 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. 1064 1064 1065 -1. 1066 -11. Data Structure Specific Schema 977 +== Data Structure Specific Schema == 1067 1067 1068 1068 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. 1069 1069 1070 1070 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. 1071 1071 1072 -1. 1073 -11. 1074 -111. DataSetType 983 +=== DataSetType === 1075 1075 1076 1076 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: 1077 1077 ... ... @@ -1085,8 +1085,9 @@ 1085 1085 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 1086 1086 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 1087 1087 11. 1088 -111. GroupType 1089 1089 998 +=== GroupType === 999 + 1090 1090 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: 1091 1091 1092 1092 1. A sequence consisting of: ... ... @@ -1113,9 +1113,9 @@ 1113 1113 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 1114 1114 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 1115 1115 1. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group 1116 -11. 1117 -111. SeriesType 1118 1118 1027 +=== SeriesType === 1028 + 1119 1119 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: 1120 1120 1121 1121 1. A sequence consisting of: ... ... @@ -1124,9 +1124,9 @@ 1124 1124 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 1125 1125 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 1126 1126 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 1127 -11. 1128 -111. ObsType 1129 1129 1038 +=== ObsType === 1039 + 1130 1130 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: 1131 1131 1132 1132 1. A sequence consisting of: ... ... @@ -1149,9 +1149,7 @@ 1149 1149 1150 1150 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. 1151 1151 1152 -1. 1153 -11. 1154 -111. MetadataSetType 1062 +=== MetadataSetType === 1155 1155 1156 1156 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: 1157 1157 ... ... @@ -1203,9 +1203,10 @@ 1203 1203 111. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref 1204 1204 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 1205 1205 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 1206 -111. 1207 -1111. Identifiable Object Target Type Determination 1208 1208 1115 + 1116 +==== Identifiable Object Target Type Determination ==== 1117 + 1209 1209 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. 1210 1210 1211 1211 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. ... ... @@ -1222,9 +1222,9 @@ 1222 1222 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 1223 1223 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 1224 1224 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. 1225 -11. 1226 -111. ReportType 1227 1227 1135 +=== ReportType === 1136 + 1228 1228 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. 1229 1229 1230 1230 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: ... ... @@ -1272,17 +1272,16 @@ 1272 1272 1. 1273 1273 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 1274 1274 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] 1275 -11. 1276 -111. 1277 -1111. Attribute Set Complex Type Creation 1278 1278 1185 +=== Attribute Set Complex Type Creation === 1186 + 1279 1279 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: 1280 1280 1281 1281 1. A sequence consisting of: 1282 1282 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]. 1283 1283 1284 - 1.Special data functions1285 - 11.Updates1192 += Special data functions = 1193 +== Updates == 1286 1286 1287 1287 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. 1288 1288