Changes for page Part IV. Data and Reference Metadata Namespaces

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

From 3.4 to 3.3 From 3.9 to 3.8

From version 3.8

edited by Helena
on 2025/07/02 16:08

Change comment: There is no comment for this version

To version 3.4

edited by Helena
on 2025/07/02 15:55

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -425,56 +425,57 @@
  === 3.3.1 Component Name Determination ===
--When required to create an XML element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], the name for a [[component>>doc:sdmx:Glossary.Component.WebHome]] is always its identifier. However, the identifier may be inherited. Therefore, the general rules are as follows:
++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 are as follows:
--1. If the [[component>>doc:sdmx:Glossary.Component.WebHome]] defines an identifier, the element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name is the value of that identifier
--2. Otherwise, the element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name is the identifier of the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic (Note that this is technically the [[component>>doc:sdmx:Glossary.Component.WebHome]] identifier).
++1. If the component defines an identifier, the element or attribute name is the value of that identifier
++2. 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 identifier).
  === 3.3.2 Representation Determination ===
--Every [[component>>doc:sdmx:Glossary.Component.WebHome]] has a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] associated with it, whether it is defined as a local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] in the [[component>>doc:sdmx:Glossary.Component.WebHome]] definition, or it is inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes it semantic (as defined in the (% style="color:#e74c3c" %)concept(%%) identity of the [[component>>doc:sdmx:Glossary.Component.WebHome]]).
++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).
--The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]] is determined by the following precedence:
++The representation of a component is determined by the following precedence:
--1. The local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]]
--1. The core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic
--1. A default [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of an un-faceted text format with a data type of String.
++1. The local representation defined by the component
++1. The core representation defined in the concept from which the component takes its semantic
++1. A default representation of an un-faceted text format with a data type of String.
--The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] will either define a text format, an enumeration with an enumeration format, or a union of the former with the value of a irrelevant [[representation>>doc:sdmx:Glossary.Representation.WebHome]] ‘’ (tilde).
++The representation will either define a text format, an enumeration with an enumeration format, or a union of the former with the value of a irrelevant representation ‘’ (tilde).
--A text format consists of a data type and an optional collection of [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. It is the combination of these which determine the exact nature of the [[component>>doc:sdmx:Glossary.Component.WebHome]] [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. An enumeration consists of a reference to a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], or value list, for which an enumerated list of possible values can be created.
++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 a codelist, hierarchy, or value list, for which an enumerated list of possible values can be created.
  === 3.3.3 Simple / Primitive Type Determination ===
--For any given [[representation>>doc:sdmx:Glossary.Representation.WebHome]], 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>>doc:sdmx:Glossary.Component.WebHome]] based on its [determined [[representation>>doc:sdmx:Glossary.Representation.WebHome]]](#332-[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]-Determination).
++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](#332-Representation-Determination).
--For example, a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] may inherit its [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for a (% style="color:#e74c3c" %)concept(%%), and the data type of a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] 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 (% style="color:#e74c3c" %)concepts(%%) to avoid having to look up the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for very [[component>>doc:sdmx:Glossary.Component.WebHome]]. In this case, the type may be given a name based on the (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Dimension.WebHome]], although named after the (% style="color:#e74c3c" %)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.
++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.
  === 3.3.4 Representation with Codelist Enumeration ===
--A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines an enumeration from a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] or [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each [[code>>doc:sdmx:Glossary.Code.WebHome]] in the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] or [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], accounting for extensions. 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:
++A representation which defines an enumeration from a codelist or hierarchy will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each code in the codelist or hierarchy, accounting for extensions. 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:
-->  <xs:simpleType name="ESTAT.CL\_COUNTRY.1.0">
-->     <xs:restriction base="common:IDType">
-->        <xs:enumeration value="BE">
-->           <xs:annotation>
-->              <xs:documentation xml:lang="en">Belgium</xs:documentation>
-->           </xs:annotation>
-->        </xs:enumeration>
++xml
++   <xs:simpleType name="ESTAT.CL\_COUNTRY.1.0">
++      <xs:restriction base="common:IDType">
++         <xs:enumeration value="BE">
++            <xs:annotation>
++               <xs:documentation xml:lang="en">Belgium</xs:documentation>
++            </xs:annotation>
++         </xs:enumeration>
  === 3.3.5 Representation with Value List Enumeration ===
--A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines an enumeration from a value list will result in a simple type that is a restriction of the xs:string data type. The simple type will define enumerations for each value item in the value list. 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.
++A representation which defines an enumeration from a value list will result in a simple type that is a restriction of the xs:string data type. The simple type will define enumerations for each value item in the value list. 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.
  === 3.3.6 Representation with Simple Text Format ===
--A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines a simple text format will result in a simple type or primitive type. The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is simple if none of the following conditions are true:
++A representation which defines a simple text format will result in a simple type or primitive type. The representation is simple if none of the following conditions are true:
--* [[representation>>doc:sdmx:Glossary.Representation.WebHome]] max occurs is greater than 1
++* representation max occurs is greater than 1
  * text format data type is XHMTL
  * text format is multi-lingual
--If the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is not simple, see the rules in the following section for complex text formats. If the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is simple, the first step is to determine the base type from the text format data type:
++If the representation is not simple, see the rules in the following section for complex text formats. If the representation is simple, the first step is to determine the base type from the text format data type:
  (% style="width:679.294px" %)
  |(% style="width:286px" %)**SDMX Data Type**|(% style="width:390px" %)**XML Schema Data Type**
@@ -520,7 +520,7 @@
  |(% style="width:286px" %)GeospatialInformation|(% style="width:390px" %)xs:string
  |(% style="width:286px" %)XHTML|(% style="width:390px" %)See the following section for complex representations
--If the text format does not specify any further [[facets>>doc:sdmx:Glossary.Facet.WebHome]], then the determined type is the listed type or a type which derives from the listed type without placing any addition restrictions on it. However, if one or more [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are specified, then a simple type based on the listed type is necessary. The simple type derives via restriction from the listed type and adds [[facets>>doc:sdmx:Glossary.Facet.WebHome]] according to the following table (the values are (% style="color:#e74c3c" %)mapped(%%) as is):
++If the text format does not specify any further facets, then the determined type is the listed type or a type which derives from the listed type without placing any addition restrictions on it. However, if one or more facets are specified, then a simple type based on the listed type is necessary. The simple type derives via restriction from the listed type and adds facets according to the following table (the values are mapped as is):
  (% style="width:1007.29px" %)
  |(% style="width:267px" %)**SDMX Facet**|(% style="width:729px" %)**XML Schema Facet**
@@ -531,34 +531,37 @@
  |(% style="width:267px" %)decimals^^1^^|(% style="width:729px" %)xs:fractionDigits
  |(% style="width:267px" %)pattern|(% style="width:729px" %)xs:pattern
--Any other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are informational only and will not affect the determined type.
++Any other facets are informational only and will not affect the determined type.
  === 3.3.7 Representation for Not Applicable Dimensions ===
--Not applicable [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], i.e., when reported [[measures>>doc:sdmx:Glossary.Measure.WebHome]] or [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are not attached to those [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], take as value the tilde ‘’ character. This is required for [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] defined by a [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] that has the ‘evolving structure’ property set to true and that includes data from [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]], which only use a subset of [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] as defined by a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)constraint(%%). This is also required for data-related higher-(% style="color:#e74c3c" %)level(%%) (i.e., attached to [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or partial list of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that don’t have a fixed pre-defined attachment.
++Not applicable dimensions, i.e., when reported measures or attributes are not attached to those dimensions, take as value the tilde ‘’ character. This is required for datasets defined by a DSD that has the ‘evolving structure’ property set to true and that includes data from dataflows, which only use a subset of dimensions as defined by a dimension constraint. This is also required for data-related higher-level (i.e., attached to dataflow or partial list of Dimensions) reference metadata attributes that don’t have a fixed pre-defined attachment.
--To support a specific type and allow for a not applicable [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] value, the structure-specific schema must union the type with the common:NotApplicableType, which enumerates the tilde ‘’ character. This is as shown in the following example:
++To support a specific type and allow for a not applicable dimension value, the structure-specific schema must union the type with the common:NotApplicableType, which enumerates the tilde ‘’ character. This is as shown in the following example:
-->  <xs:simpleType name="DecimalOrNotApplicableType">
-->     <xs:union memberTypes="xs:decimal common:NotApplicableType"/>
-->  </xs:simpleType>
++xml
++   <xs:simpleType name="DecimalOrNotApplicableType">
++      <xs:union memberTypes="xs:decimal common:NotApplicableType"/>
++   </xs:simpleType>
  For enumerated types, the generated structure-specific schema can include the special value in the enumeration or create a union between the enumerated type and the common:NotApplicableType.
  Option 1: Augmenting the enumeration with the special value
-->  <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
-->     <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/>
-->  </xs:simpleType>
++xml
++   <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
++      <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/>
++   </xs:simpleType>
  Option 2: Extending the enumeration with the special value
-->  <xs:simpleType name="CL\_ SUBINDICATOR ">
-->     <xs:restriction base="xs:string">
-->        <xs:enumeration value="A"/>
-->        <xs:enumeration value=""/>
-->     <xs:restriction>
-->  </xs:simpleType>
++xml
++   <xs:simpleType name="CL\_ SUBINDICATOR ">
++      <xs:restriction base="xs:string">
++         <xs:enumeration value="A"/>
++         <xs:enumeration value=""/>
++      <xs:restriction>
++   </xs:simpleType>
  For convenience the common schema provides the union types for the following data types.
@@ -595,35 +595,38 @@
  === 3.3.8 Representation for Intentionally Missing Measure and Attribute Values ===
--For intentionally missing [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values, even if mandatory, the following special values can be used:
++For intentionally missing measure and attribute values, even if mandatory, the following special values can be used:
  * NaN for all numeric types (float, double)
  * #N/A for all other types
--To support a specific type and allow for an intentionally missing [[measure>>doc:sdmx:Glossary.Measure.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] value, the structure-specific schema must union the type with the common:MissingType, which enumerates the #N/A string. Note that XML natively already supports NaN for float and double values.
++To support a specific type and allow for an intentionally missing measure or attribute value, the structure-specific schema must union the type with the common:MissingType, which enumerates the #N/A string. Note that XML natively already supports NaN for float and double values.
  This union is as shown in the following example:
-->   <xs:simpleType name="DecimalOrMissingType">
-->      <xs:union memberTypes="xs:decimal common:MissingType"/>
-->   </xs:simpleType>
++xml
++   <xs:simpleType name="DecimalOrMissingType">
++      <xs:union memberTypes="xs:decimal common:MissingType"/>
++   </xs:simpleType>
  For enumerated types, the generated structure-specific schema can include the special value in the enumeration or create a union between the enumerated type and the common:MissingType.
  Option 1: Augmenting the enumeration with the special value
-- >  <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
-- >     <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/>
-- >  </xs:simpleType>
++xml
++   <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
++      <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/>
++   </xs:simpleType>
  Option 2: Extending the enumeration with the special value
-->   <xs:simpleType name="CL\_ SUBINDICATOR ">
-->      <xs:restriction base="xs:string">
-->         <xs:enumeration value="A"/>
-->         <xs:enumeration value="#N/A"/>
-->      <xs:restriction>
-->   </xs:simpleType>
++xml
++   <xs:simpleType name="CL\_ SUBINDICATOR ">
++      <xs:restriction base="xs:string">
++         <xs:enumeration value="A"/>
++         <xs:enumeration value="#N/A"/>
++      <xs:restriction>
++   </xs:simpleType>
  For convenience the common schema provides the union types for the following data types.
@@ -660,24 +660,24 @@
  === 3.3.9 Representation with Complex Text Format ===
--A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines a complex text format will result in a complex type. The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is complex if any of the following conditions are true:
++A representation which defines a complex text format will result in a complex type. The representation is complex if any of the following conditions are true:
--* [[representation>>doc:sdmx:Glossary.Representation.WebHome]] max occurs is greater than 1
++* representation max occurs is greater than 1
  * text format data type is XHMTL
  * text format is multi-lingual
  The resulting complex type will be derived via restriction of the common:ValueType. In simple cases, there are pre-defined types that can be used:
--* if the text format data type is XHTML, common:StructuredTextValueType can be used; note that this type cannot be further restricted – all other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are ignored
--* if the text format is multi-lingual, common:TextValueType can be used; note that this type cannot be further restricted – all other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are ignored
--* if the text format has no additional [[facets>>doc:sdmx:Glossary.Facet.WebHome]] and the data type is:
--**   Boolean, common:BooleanValueType can be used
--**   String, common:StringValueType can be used
--**   Integer, common:IntValueType can be used
--**   Double, common:DoubleValueType can be used
--**   ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used
++* if the text format data type is XHTML, common:StructuredTextValueType can be used; note that this type cannot be further restricted – all other facets are ignored
++* if the text format is multi-lingual, common:TextValueType can be used; note that this type cannot be further restricted – all other facets are ignored
++* if the text format has no additional facets and the data type is:
++  + Boolean, common:BooleanValueType can be used
++  + String, common:StringValueType can be used
++  + Integer, common:IntValueType can be used
++  + Double, common:DoubleValueType can be used
++  + ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used
--If a pre-defined type cannot be used, one will have to be created. The complex type must define a simple content restriction of the common:ValueType. The restriction should define an anonymous simple type based on the text format data type and [[facets>>doc:sdmx:Glossary.Facet.WebHome]] as described in the previous section.
++If a pre-defined type cannot be used, one will have to be created. The complex type must define a simple content restriction of the common:ValueType. The restriction should define an anonymous simple type based on the text format data type and facets as described in the previous section.
  === 3.3.10 Type Names ===