Changes for page 4 General Notes for Implementers
Last modified by Artur on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -10,26 +10,26 @@ 10 10 11 11 There are several different representations in SDMX-ML, taken from XML Schemas and common programming languages. The table below describes the various representations, which are found in SDMX-ML, and their equivalents. 12 12 13 -|SDMX-ML Data Type|XML Schema Data Type|.NET Framework Type|((( 14 -Java Data Type 13 +|(% style="width:191px" %)**SDMX-ML Data Type**|(% style="width:232px" %)**XML Schema Data Type**|(% style="width:212px" %)**.NET Framework Type**|(% style="width:980px" %)((( 14 +**Java Data Type** 15 15 ))) 16 -| **String**|**xsd:string**|**System.String**|**java.lang.String**17 -| **Big Integer**|**xsd:integer**|**System.Decimal**|**java.math.BigInteger**18 -| **Integer**|**xsd:int**|**System.Int32**|**int**19 -| **Long**|**xsd.long**|**System.Int64**|**long**20 -| **Short**|**xsd:short**|**System.Int16**|**short**21 -| **Decimal**|**xsd:decimal**|**System.Decimal**|**java.math.BigDecimal**22 -| **Float**|**xsd:float**|**System.Single**|**float**23 -| **Double**|**xsd:double**|**System.Double**|**double**24 -| **Boolean**|**xsd:boolean**|**System.Boolean**|**boolean**25 -| **URI**|**xsd:anyURI**|**System.Uri**|**Java.net.URI or java.lang.String**26 -| **DateTime**|**xsd:dateTime**|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**27 -| **Time**|**xsd:time**|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**28 -| **GregorianYear**|**xsd:gYear**|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**29 -| **GregorianMonth**|**xsd:gYearMonth**|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**30 -| **GregorianDay**|**xsd:date**|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**31 -| **Day, MonthDay, Month**|**xsd:g***|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**32 -| **Duration**|**xsd:duration**|**System.TimeSpan**|**javax.xml.datatype.Duration**16 +|(% style="width:191px" %)String|(% style="width:232px" %)xsd:string|(% style="width:212px" %)System.String|(% style="width:980px" %)java.lang.String 17 +|(% style="width:191px" %)Big Integer|(% style="width:232px" %)xsd:integer|(% style="width:212px" %)System.Decimal|(% style="width:980px" %)java.math.BigInteger 18 +|(% style="width:191px" %)Integer|(% style="width:232px" %)xsd:int|(% style="width:212px" %)System.Int32|(% style="width:980px" %)int 19 +|(% style="width:191px" %)Long|(% style="width:232px" %)xsd.long|(% style="width:212px" %)System.Int64|(% style="width:980px" %)long 20 +|(% style="width:191px" %)Short|(% style="width:232px" %)xsd:short|(% style="width:212px" %)System.Int16|(% style="width:980px" %)short 21 +|(% style="width:191px" %)Decimal|(% style="width:232px" %)xsd:decimal|(% style="width:212px" %)System.Decimal|(% style="width:980px" %)java.math.BigDecimal 22 +|(% style="width:191px" %)Float|(% style="width:232px" %)xsd:float|(% style="width:212px" %)System.Single|(% style="width:980px" %)float 23 +|(% style="width:191px" %)Double|(% style="width:232px" %)xsd:double|(% style="width:212px" %)System.Double|(% style="width:980px" %)double 24 +|(% style="width:191px" %)Boolean|(% style="width:232px" %)xsd:boolean|(% style="width:212px" %)System.Boolean|(% style="width:980px" %)boolean 25 +|(% style="width:191px" %)URI|(% style="width:232px" %)xsd:anyURI|(% style="width:212px" %)System.Uri|(% style="width:980px" %)Java.net.URI or java.lang.String 26 +|(% style="width:191px" %)DateTime|(% style="width:232px" %)xsd:dateTime|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar 27 +|(% style="width:191px" %)Time|(% style="width:232px" %)xsd:time|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar 28 +|(% style="width:191px" %)GregorianYear|(% style="width:232px" %)xsd:gYear|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar 29 +|(% style="width:191px" %)GregorianMonth|(% style="width:232px" %)xsd:gYearMonth|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar 30 +|(% style="width:191px" %)GregorianDay|(% style="width:232px" %)xsd:date|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar 31 +|(% style="width:191px" %)Day, MonthDay, Month|(% style="width:232px" %)xsd:g*|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar 32 +|(% style="width:191px" %)Duration|(% style="width:232px" %)xsd:duration|(% style="width:212px" %)System.TimeSpan|(% style="width:980px" %)javax.xml.datatype.Duration 33 33 34 34 There are also a number of SDMX-ML data types which do not have these direct correspondences, often because they are composite representations or restrictions of a broader data type. For most of these, there are simple types which can be referenced from the SDMX schemas, for others a derived simple type will be necessary: 35 35 ... ... @@ -76,7 +76,7 @@ 76 76 77 77 Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes. 78 78 79 -4.1.1 Data Types 79 +=== 4.1.1 Data Types === 80 80 81 81 XML and JSON schemas support a variety of data types that, although rich, are not mapped one-to-one in all cases. This section provides an explanation of the mapping performed in SDMX 3.0, between such cases. 82 82 ... ... @@ -95,8 +95,8 @@ 95 95 The above looks like this, in JSON schema: 96 96 97 97 > "idType": { 98 -> "type": "string", 99 -> "pattern": "^[A-Za-z0-9_@$-]+$" 98 +> "type": "string", 99 +> "pattern": "^[A-Za-z0-9_@$-]+$" 100 100 > } 101 101 102 102 There are also cases, though, that data types cannot be mapped like above. One such case is the array data type, which was introduced in SDMX 3.0 as a new representation. In JSON schema an array is already natively foreseen, while in the XML schema, this has to be defined as a complex type, with an SDMX specific definition (i.e., specific element/attribute names for SDMX). Beyond that, the minimum and/or maximum number of items within an array is possible in both cases. ... ... @@ -103,47 +103,28 @@ 103 103 104 104 Further to the above, the mapping between the non-native data types is presented in the table below: 105 105 106 -|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"[[(% class="wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]](%%) **for "string" type** 107 -|GregorianYear|xsd:gYear|((( 108 -"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0- 109 - 110 -9]|1[0-3]):[0-5][0-9]|14:00))?$" 106 +(% style="width:1005.83px" %) 107 +|(% style="width:198px" %)**SDMX Facet**|(% style="width:241px" %)**XML Schema**|(% style="width:563px" %)**JSON schema **"**pattern**"{{footnote}}Regular expressions, as specified in W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes.{{/footnote}} **for "string" type** 108 +|(% style="width:198px" %)GregorianYear|(% style="width:241px" %)xsd:gYear|(% style="width:563px" %)((( 109 +"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 111 111 ))) 112 -|GregorianMonth|xsd:gYearMonth|((( 113 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0- 114 - 115 -2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 116 - 117 -9]|14:00))?$" 111 +|(% style="width:198px" %)GregorianMonth|(% style="width:241px" %)xsd:gYearMonth|(% style="width:563px" %)((( 112 +"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 118 118 ))) 119 -|GregorianDay|xsd:date|((( 120 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])- 121 - 122 -(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0- 123 - 124 -3]):[0-5][0-9]|14:00))?$" 114 +|(% style="width:198px" %)GregorianDay|(% style="width:241px" %)xsd:date|(% style="width:563px" %)((( 115 +"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 125 125 ))) 126 -|Day|xsd:gDay|((( 127 -"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|- 128 - 129 -)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 117 +|(% style="width:198px" %)Day|(% style="width:241px" %)xsd:gDay|(% style="width:563px" %)((( 118 +"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 130 130 ))) 131 -|MonthDay|xsd:gMonthDay|((( 132 -"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0- 133 - 134 -9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 135 - 136 -9]|14:00))?$" 120 +|(% style="width:198px" %)MonthDay|(% style="width:241px" %)xsd:gMonthDay|(% style="width:563px" %)((( 121 +"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 137 137 ))) 138 -|Month|xsd:Month|((( 139 -"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0- 140 - 141 -3]):[0-5][0-9]|14:00))?$" 123 +|(% style="width:198px" %)Month|(% style="width:241px" %)xsd:Month|(% style="width:563px" %)((( 124 +"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 142 142 ))) 143 -|Duration|xsd:duration|((( 144 -"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0- 145 - 146 -9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$" 126 +|(% style="width:198px" %)Duration|(% style="width:241px" %)xsd:duration|(% style="width:563px" %)((( 127 +"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$" 147 147 ))) 148 148 149 149 == 4.2 Time and Time Format == ... ... @@ -158,15 +158,14 @@ 158 158 159 159 The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format): 160 160 161 -* **Observational Time Period **o **Standard Time Period** 142 +* **Observational Time Period** 143 +** **Standard Time Period** 144 +*** **Basic Time Period** 145 +**** **Gregorian Time Period** 146 +**** //Date Time// 147 +*** **Reporting Time Period** 148 +** //Time Range// 162 162 163 - § **Basic Time Period** 164 - 165 -* **Gregorian Time Period** 166 -* //Date Time// 167 - 168 -§ **Reporting Time Period **o //Time Range// 169 - 170 170 The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow. 171 171 172 172 === 4.2.2 Observational Time Period === ... ... @@ -194,7 +194,7 @@ 194 194 195 195 This is used to unambiguously state that a date-time represents an observation at a single point in time. Therefore, if one wants to use SDMX for data which is measured at a distinct point in time rather than being reported over a period, the date-time representation can be used. 196 196 197 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)[[(% class="wikiinternallink" %)^^~[2~]^^>>path:#_ftn2]] 177 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[2~]^^>>path:#_ftn2]] 198 198 199 199 === 4.2.6 Standard Reporting Period === 200 200 ... ... @@ -263,7 +263,7 @@ 263 263 264 264 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 265 265 266 -Notes: There are either 52 or 53 weeks in a reporting year. This is based on the ISO 8601 definition of a week (Monday - Saturday), where the first week of a reporting year is defined as the week with the first Thursday on or after the reporting year start day.[[(% class="wikiinternallink" %)^^~[3~]^^>>path:#_ftn3]](%%) The reporting week is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods. 246 +Notes: There are either 52 or 53 weeks in a reporting year. This is based on the ISO 8601 definition of a week (Monday - Saturday), where the first week of a reporting year is defined as the week with the first Thursday on or after the reporting year start day.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[3~]^^>>path:#_ftn3]](%%) The reporting week is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods. 267 267 268 268 **Reporting Day**: 269 269 ... ... @@ -291,19 +291,19 @@ 291 291 292 292 This is the [REPORTING_YEAR_START_DATE] 293 293 294 -1. 274 +1. 295 295 11. **If the [PERIOD_INDICATOR] is W:** 296 296 111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 297 297 298 -Add[[(% class="wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 278 +Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 299 299 300 -1. 301 -11. 280 +1. 281 +11. 302 302 111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** 303 303 304 304 Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 305 305 306 -1. 286 +1. 307 307 11. **Else:** 308 308 309 309 The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. ... ... @@ -384,27 +384,25 @@ 384 384 385 385 In version 2.0 of SDMX there is a recommendation to use the time format attribute to gives additional information on the way time is represented in the message. Following an appraisal of its usefulness this is no longer required. However, it is still possible, if required , to include the time format attribute in SDMX-ML. 386 386 387 -|Code|Format 388 -|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 389 -|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods 390 -|GTP|Superset of all Gregorian Time Periods and date-time 391 -|RTP|Superset of all Reporting Time Periods 392 -|TR|((( 393 -Time Range: Start time and duration (YYYY-MM- 394 - 395 -DD(Thh:mm:ss)?/<duration>) 367 +|(% style="width:95px" %)Code|(% style="width:1520px" %)Format 368 +|(% style="width:95px" %)OTP|(% style="width:1520px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 369 +|(% style="width:95px" %)STP|(% style="width:1520px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods 370 +|(% style="width:95px" %)GTP|(% style="width:1520px" %)Superset of all Gregorian Time Periods and date-time 371 +|(% style="width:95px" %)RTP|(% style="width:1520px" %)Superset of all Reporting Time Periods 372 +|(% style="width:95px" %)TR|(% style="width:1520px" %)((( 373 +Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>) 396 396 ))) 397 -|GY|Gregorian Year (YYYY) 398 -|GTM|Gregorian Year Month (YYYY-MM) 399 -|GD|Gregorian Day (YYYY-MM-DD) 400 -|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 401 -|RY|Reporting Year (YYYY-A1) 402 -|RS|Reporting Semester (YYYY-Ss) 403 -|RT|Reporting Trimester (YYYY-Tt) 404 -|RQ|Reporting Quarter (YYYY-Qq) 405 -|RM|Reporting Month (YYYY-Mmm) 406 -|RW|Reporting Week (YYYY-Www) 407 -|RD|Reporting Day (YYYY-Dddd) 375 +|(% style="width:95px" %)GY|(% style="width:1520px" %)Gregorian Year (YYYY) 376 +|(% style="width:95px" %)GTM|(% style="width:1520px" %)Gregorian Year Month (YYYY-MM) 377 +|(% style="width:95px" %)GD|(% style="width:1520px" %)Gregorian Day (YYYY-MM-DD) 378 +|(% style="width:95px" %)DT|(% style="width:1520px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 379 +|(% style="width:95px" %)RY|(% style="width:1520px" %)Reporting Year (YYYY-A1) 380 +|(% style="width:95px" %)RS|(% style="width:1520px" %)Reporting Semester (YYYY-Ss) 381 +|(% style="width:95px" %)RT|(% style="width:1520px" %)Reporting Trimester (YYYY-Tt) 382 +|(% style="width:95px" %)RQ|(% style="width:1520px" %)Reporting Quarter (YYYY-Qq) 383 +|(% style="width:95px" %)RM|(% style="width:1520px" %)Reporting Month (YYYY-Mmm) 384 +|(% style="width:95px" %)RW|(% style="width:1520px" %)Reporting Week (YYYY-Www) 385 +|(% style="width:95px" %)RD|(% style="width:1520px" %)Reporting Day (YYYY-Dddd) 408 408 409 409 (% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 410 410 **Table 1: SDMX-ML Time Format Codes** ... ... @@ -434,11 +434,11 @@ 434 434 435 435 It has been possible since SDMX 2.0 for a Component to specify a representation of a time span. Depending on the format of the data message, this resulted in either an element with 2 XML attributes for holding the start time and the duration or two separate XML attributes based on the underlying Component identifier. For example, if REF_PERIOD were given a representation of time span, then in the Compact data format, it would be represented by two XML attributes; REF_PERIODStartTime (holding the start) and REF_PERIOD (holding the duration). If a new simple type is introduced in the SDMX schemas that can hold ISO 8601 time intervals, then this will no longer be necessary. What was represented as this: 436 436 437 -<Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 415 +>(% style="font-size:18px" %) <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 438 438 439 439 can now be represented with this: 440 440 441 -<Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 419 +>(% style="font-size:18px" %) <Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 442 442 443 443 === 4.2.11 Notes on Formats === 444 444 ... ... @@ -505,7 +505,7 @@ 505 505 * 2010-W28 or later (reporting year start day ~-~-07-01)^^6^^ 506 506 * 2010-D185 or later (reporting year start day ~-~-07-01) 507 507 508 -= 4.3 Versioning = 486 +== 4.3 Versioning == 509 509 510 510 Versioning operates at the level of versionable and maintainable objects in the SDMX information model. Within the SDMX Structure and MetadataSet messages, there is a well-defined pattern for artefact versioning and referencing. The artefact identifiers are qualified by their version numbers – that is, an object with an Agency of "A", and ID of "X" and a version of "1.0.0" is a different object than one with an Agency of "A", an ID of "X", and a version of "1.1.0". 511 511 ... ... @@ -598,4 +598,5 @@ 598 598 599 599 [[~[4~]>>path:#_ftnref4]] The rules for adding durations to a date time are described in the W3C XML Schema specification. See [[http:~~/~~/www.w3.org/TR/xmlschema>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[2/#adding>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[durations>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[to>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[dateTimes>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[ >>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]]for further details. 600 600 601 - 579 + 580 +{{putFootnotes/}}