Changes for page 4 General Notes for Implementers
Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -54,22 +54,24 @@ 54 54 * ReportingDay (common:ReportingDayType) 55 55 * XHTML (common:StructuredText, allows for multi-lingual text content that has XHTML markup) 56 56 * KeyValues (common:DataKeyType) 57 -* ,,IdentifiableReference,, (types for each IdentifiableObject) 58 -* ,,GeospatialInformation,, (a geo feature set, according to the pattern in section 7.2) 59 -* Data types also have a set of facets: 60 -* ,,isSequence = true | false,, (indicates a sequentially increasing value) 61 -* ,,minLength = positive integer,, (# of characters/digits) 62 -* ,,maxLength = positive integer,, (# of characters/digits) 63 -* ,,startValue = decimal,, (for numeric sequence) 64 -* ,,endValue = decimal,, (for numeric sequence) 65 -* ,,interval = decimal,, (for numeric sequence) 57 +* IdentifiableReference (types for each IdentifiableObject) 58 +* GeospatialInformation (a geo feature set, according to the pattern in section 7.2) 59 + 60 +Data types also have a set of facets: 61 + 62 +* isSequence = true | false (indicates a sequentially increasing value) 63 +* minLength = positive integer (# of characters/digits) 64 +* maxLength = positive integer (# of characters/digits) 65 +* startValue = decimal (for numeric sequence) 66 +* endValue = decimal (for numeric sequence) 67 +* interval = decimal (for numeric sequence) 66 66 * timeInterval = duration 67 -* startTime = BasicTimePer ,,iod,,(for time range),,**endTime = BasicTimePeriod**,,(for time range)68 -* ,,**minValue = decimal**,,(for numeric range)69 -* ,,**maxValue = decimal**,,(for numeric range)70 -* ,,**decimal = Integer**,,(# of digits to right of decimal point)71 -* ,,**pattern =**,,(a regular expression, as per W3C XML Schema)72 -* ,,**isMultiLingual = boolean**,,(for specifying text can occur in more than one language)69 +* startTime = BasicTimePeriod (for time range) endTime = BasicTimePeriod (for time range) 70 +* minValue = decimal (for numeric range) 71 +* maxValue = decimal (for numeric range) 72 +* decimal = Integer (# of digits to right of decimal point) 73 +* pattern = (a regular expression, as per W3C XML Schema) 74 +* isMultiLingual = boolean (for specifying text can occur in more than one language) 73 73 74 74 Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes. 75 75 ... ... @@ -81,76 +81,47 @@ 81 81 82 82 For example, for the id type, this is the XML schema definition: 83 83 84 -<xs:simpleType name="IDType"> 86 +> <xs:simpleType name="IDType"> 87 +> <xs:restriction base="NestedIDType"> 88 +> <xs:pattern value="[A-Za-z0-9_@$\-]+"/> 89 +> </xs:restriction> 90 +> </xs:simpleType> 85 85 86 -<xs:restriction base="NestedIDType"> 87 - 88 -<xs:pattern value="[A-Za-z0-9_@$\-]+"/> 89 - 90 -</xs:restriction> 91 - 92 -</xs:simpleType> 93 - 94 94 Where the NestedIDType is also a restriction of string. 95 95 96 96 The above looks like this, in JSON schema: 97 97 98 -"idType": { 96 +> "idType": { 97 +> "type": "string", 98 +> "pattern": "^[A-Za-z0-9_@$-]+$" 99 +> } 99 99 100 -"type": "string", 101 - 102 -"pattern": "^[A-Za-z0-9_@$-]+$" 103 - 104 -} 105 - 106 106 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. 107 107 108 108 Further to the above, the mapping between the non-native data types is presented in the table below: 109 109 110 -|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ **for "string" type** 111 -|GregorianYear|xsd:gYear|((( 112 -"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0- 113 - 114 -9]|1[0-3]):[0-5][0-9]|14:00))?$" 105 +(% style="width:1146.29px" %) 106 +|(% style="width:159px" %)**SDMX Facet**|(% style="width:179px" %)**XML Schema**|(% style="width:800px" %)**JSON schema **"**pattern**"{{footnote}}Regular expressions, as specified in W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes.{{/footnote}} **for "string" type** 107 +|(% style="width:159px" %)GregorianYear|(% style="width:179px" %)xsd:gYear|(% style="width:800px" %)((( 108 +"^-?( [1-9] [0-9] {3,}|0[0-9]{3}) (Z| (\ + | -) ((0 [0 - 9]| 1[0 - 3]):[0 - 5] [0 - 9] | 14:00))?$" 115 115 ))) 116 -|GregorianMonth|xsd:gYearMonth|((( 117 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0- 118 - 119 -2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 120 - 121 -9]|14:00))?$" 110 +|(% style="width:159px" %)GregorianMonth|(% style="width:179px" %)xsd:gYearMonth|(% style="width:800px" %)((( 111 +"^-?([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))?$" 122 122 ))) 123 - 124 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape1" height="1" width="192"]] 125 - 126 -|GregorianDay|xsd:date|((( 127 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])- 128 - 129 -(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0- 130 - 131 -3]):[0-5][0-9]|14:00))?$" 113 +|(% style="width:163px" %)GregorianDay|(% style="width:179px" %)xsd:date|(% style="width:800px" %)((( 114 +"^-?([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))?$" 132 132 ))) 133 -|Day|xsd:gDay|((( 134 -"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|- 135 - 136 -)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 116 +|(% style="width:163px" %)Day|(% style="width:179px" %)xsd:gDay|(% style="width:800px" %)((( 117 +"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|- )((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 137 137 ))) 138 -|MonthDay|xsd:gMonthDay|((( 139 -"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0- 140 - 141 -9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 142 - 143 -9]|14:00))?$" 119 +|(% style="width:163px" %)MonthDay|(% style="width:179px" %)xsd:gMonthDay|(% style="width:800px" %)((( 120 +"^~-~-(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))?$" 144 144 ))) 145 -|Month|xsd:Month|((( 146 -"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0- 147 - 148 -3]):[0-5][0-9]|14:00))?$" 122 +|(% style="width:163px" %)Month|(% style="width:179px" %)xsd:Month|(% style="width:800px" %)((( 123 +"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0- 3]):[0-5][0-9]|14:00))?$" 149 149 ))) 150 -|Duration|xsd:duration|((( 151 -"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0- 152 - 153 -9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$" 125 +|(% style="width:163px" %)Duration|(% style="width:179px" %)xsd:duration|(% style="width:800px" %)((( 126 +"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0- 9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$" 154 154 ))) 155 155 156 156 == {{id name="_Toc291506"/}}4.2 Time and Time Format == ... ... @@ -165,17 +165,14 @@ 165 165 166 166 The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format): 167 167 168 -* **Observational Time Period **o **Standard Time Period** 141 +* **Observational Time Period** 142 +** **Standard Time Period** 143 +*** **Basic Time Period** 144 +**** **Gregorian Time Period** 145 +**** //Date Time// 146 +*** **Reporting Time Period** 147 +** **//Time Range//** 169 169 170 -▪ **Basic Time Period** 171 - 172 -* **Gregorian Time Period** 173 -* //Date Time// 174 - 175 -▪ **Reporting Time Period** 176 - 177 -o //Time Range// 178 - 179 179 The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow. 180 180 181 181 === {{id name="_Toc291508"/}}4.2.2 Observational Time Period === ... ... @@ -208,7 +208,7 @@ 208 208 209 209 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. 210 210 211 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss) ^^[[(% class="wikiinternallink wikiinternallinkwikiinternallinkwikiinternallink"%)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^181 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}} 212 212 213 213 === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period === 214 214 ... ... @@ -242,8 +242,6 @@ 242 242 243 243 Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) 244 244 245 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape2" height="1" width="192"]] 246 - 247 247 **Reporting Trimester:** 248 248 249 249 Period Indicator: T ... ... @@ -282,7 +282,7 @@ 282 282 283 283 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 284 284 285 -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:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^ 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. 253 +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 wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^ 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. 286 286 287 287 **Reporting Day**: 288 288 ... ... @@ -316,19 +316,19 @@ 316 316 317 317 This is the [REPORTING_YEAR_START_DATE] 318 318 319 -1. 287 +1. 320 320 11. **If the [PERIOD_INDICATOR] is W:** 321 321 111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 322 322 323 -Add^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^4^^>>path:#sdfootnote4sym||name="sdfootnote4anc"]](%%)^^ (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 291 +Add^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^4^^>>path:#sdfootnote4sym||name="sdfootnote4anc"]](%%)^^ (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 324 324 325 -1. 326 -11. 293 +1. 294 +11. 327 327 111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** 328 328 329 329 Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 330 330 331 -1. 299 +1. 332 332 11. **Else:** 333 333 334 334 The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. ... ... @@ -612,3 +612,5 @@ 612 612 Any structural metadata object which contains a reference to an object can be queried based on that reference. For example, a categorisation references both a category and the object is it categorising. As this is the case, one can query for categorisations which categorise a particular object or which categorise against a particular category or category scheme. This mechanism should be used when the referenced object is known. 613 613 614 614 When the referenced object is not known, then the reference resolution mechanism could be used. For example, suppose one wanted to find all category schemes and the related categorisations for a given maintenance agency. In this case, one could query for the category scheme by the maintenance agency and specify that parent and sibling references should be resolved. This would result in the categorisations which reference the categories in the matched schemes to be returned, as well as the object which they categorise. 583 + 584 +{{putFootnotes/}}