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
-
... ... @@ -32,78 +32,47 @@ 32 32 33 33 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: 34 34 35 -• **AlphaNumeric** (**common:AlphaNumericType**, string which only allows A-z and 0-9) 35 +* AlphaNumeric (common:AlphaNumericType, string which only allows A-z and 0-9) 36 +* Alpha (common:AlphaType, string which only allows A-z) 37 +* Numeric (common:NumericType, string which only allows 0-9, but is not numeric so that is can having leading zeros) 38 +* Count (xs:integer, a sequence with an interval of "1") 39 +* InclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds) 40 +* ExclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds) 41 +* Incremental (xs:decimal with a specified interval; the interval is typically enforced outside of the XML validation) 42 +* TimeRange (common:TimeRangeType, startDateTime + Duration) 43 +* ObservationalTimePeriod (common:ObservationalTimePeriodType, a union of StandardTimePeriod and TimeRange). 44 +* StandardTimePeriod (common:StandardTimePeriodType, a union of BasicTimePeriod and ReportingTimePeriod). 45 +* BasicTimePeriod (common:BasicTimePeriodType, a union of GregorianTimePeriod and DateTime) 46 +* GregorianTimePeriod (common:GregorianTimePeriodType, a union of GregorianYear, GregorianMonth, and GregorianDay) 47 +* ReportingTimePeriod (common:ReportingTimePeriodType, a union of ReportingYear, ReportingSemester, ReportingTrimester, ReportingQuarter, ReportingMonth, ReportingWeek, and ReportingDay). 48 +* ReportingYear (common:ReportingYearType) 49 +* ReportingSemester (common:ReportingSemesterType) 50 +* ReportingTrimester (common:ReportingTrimesterType) 51 +* ReportingQuarter (common:ReportingQuarterType) 52 +* ReportingMonth (common:ReportingMonthType) 53 +* ReportingWeek (common:ReportingWeekType) 54 +* ReportingDay (common:ReportingDayType) 55 +* XHTML (common:StructuredText, allows for multi-lingual text content that has XHTML markup) 56 +* KeyValues (common:DataKeyType) 57 +* IdentifiableReference (types for each IdentifiableObject) 58 +* GeospatialInformation (a geo feature set, according to the pattern in section 7.2) 36 36 37 -• **Alpha** (**common:AlphaType**, string which only allows A-z) 38 - 39 -• ,,**Numeric**,, (,,**common:NumericType**,,, string which only allows 0-9, but is not numeric so that is can having leading zeros) 40 - 41 -• ,,**Count**,, (,,**xs:integer**,,, a sequence with an interval of "1") 42 - 43 -• **InclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds) 44 - 45 -• **ExclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds) 46 - 47 -• **Incremental** (**xs:decimal** with a specified **interval**; the interval is typically enforced outside of the XML validation) 48 - 49 -• **TimeRange** (**common:TimeRangeType**, **startDateTime** + **Duration**) 50 - 51 -• **ObservationalTimePeriod** (**common:ObservationalTimePeriodType**, a union of **StandardTimePeriod** and **TimeRange**). 52 - 53 -• **StandardTimePeriod** (**common:StandardTimePeriodType**, a union of **BasicTimePeriod** and **ReportingTimePeriod**). 54 - 55 -• **BasicTimePeriod** (**common:BasicTimePeriodType**, a union of **GregorianTimePeriod** and **DateTime**) 56 - 57 -• **GregorianTimePeriod** (**common:GregorianTimePeriodType**, a union of **GregorianYear**, **GregorianMonth**, and **GregorianDay**) 58 - 59 -• **ReportingTimePeriod** (**common:ReportingTimePeriodType**, a union of **ReportingYear**, **ReportingSemester**, **ReportingTrimester**, **ReportingQuarter**, **ReportingMonth**, **ReportingWeek**, and **ReportingDay**). 60 - 61 -• **ReportingYear** (**common:ReportingYearType**) 62 - 63 -• **ReportingSemester** (**common:ReportingSemesterType**) 64 - 65 -• **ReportingTrimester** (**common:ReportingTrimesterType**) 66 - 67 -• **ReportingQuarter** (**common:ReportingQuarterType**) 68 - 69 -• **ReportingMonth** (**common:ReportingMonthType**) 70 - 71 -• **ReportingWeek** (**common:ReportingWeekType**) 72 - 73 -• **ReportingDay** (**common:ReportingDayType**) 74 - 75 -• ,,**XHTML**,, (,,**common:StructuredText**,,, allows for multi-lingual text content that has ,,**XHTML**,, markup) 76 - 77 -• **KeyValues** (**common:DataKeyType**) 78 - 79 -• ,,**IdentifiableReference**,, (types for each IdentifiableObject) 80 - 81 -• ,,**GeospatialInformation**,, (a geo feature set, according to the pattern in section 7.2) 82 - 83 83 Data types also have a set of facets: 84 84 85 -• ,,**isSequence = true | false**,, (indicates a sequentially increasing value) 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) 68 +* timeInterval = duration 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) 86 86 87 -• ,,**minLength = positive integer**,, (# of characters/digits) 88 - 89 -• ,,**maxLength = positive integer**,, (# of characters/digits) 90 - 91 -• ,,**startValue = decimal**,, (for numeric sequence) 92 - 93 -• ,,**endValue = decimal**,, (for numeric sequence) 94 - 95 -• ,,**interval = decimal**,, (for numeric sequence) 96 - 97 -• **timeInterval = duration** 98 - 99 -• **startTime = BasicTimePer,,iod,,** (for time range) ,,**endTime = BasicTimePeriod**,, (for time range) 100 - 101 -* ,,**minValue = decimal**,, (for numeric range) 102 -* ,,**maxValue = decimal**,, (for numeric range) 103 -* ,,**decimal = Integer**,, (# of digits to right of decimal point) 104 -* ,,**pattern =**,, (a regular expression, as per W3C XML Schema) 105 -* ,,**isMultiLingual = boolean**,, (for specifying text can occur in more than one language) 106 - 107 107 Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes. 108 108 109 109 === {{id name="_Toc291505"/}}4.1.1 Data Types === ... ... @@ -114,76 +114,47 @@ 114 114 115 115 For example, for the id type, this is the XML schema definition: 116 116 117 -<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> 118 118 119 -<xs:restriction base="NestedIDType"> 120 - 121 -<xs:pattern value="[A-Za-z0-9_@$\-]+"/> 122 - 123 -</xs:restriction> 124 - 125 -</xs:simpleType> 126 - 127 127 Where the NestedIDType is also a restriction of string. 128 128 129 129 The above looks like this, in JSON schema: 130 130 131 -"idType": { 96 +> "idType": { 97 +> "type": "string", 98 +> "pattern": "^[A-Za-z0-9_@$-]+$" 99 +> } 132 132 133 -"type": "string", 134 - 135 -"pattern": "^[A-Za-z0-9_@$-]+$" 136 - 137 -} 138 - 139 139 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. 140 140 141 141 Further to the above, the mapping between the non-native data types is presented in the table below: 142 142 143 -|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ **for "string" type** 144 -|GregorianYear|xsd:gYear|((( 145 -"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0- 146 - 147 -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))?$" 148 148 ))) 149 -|GregorianMonth|xsd:gYearMonth|((( 150 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0- 151 - 152 -2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 153 - 154 -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))?$" 155 155 ))) 156 - 157 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape1" height="1" width="192"]] 158 - 159 -|GregorianDay|xsd:date|((( 160 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])- 161 - 162 -(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0- 163 - 164 -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))?$" 165 165 ))) 166 -|Day|xsd:gDay|((( 167 -"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|- 168 - 169 -)((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))?$" 170 170 ))) 171 -|MonthDay|xsd:gMonthDay|((( 172 -"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0- 173 - 174 -9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 175 - 176 -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))?$" 177 177 ))) 178 -|Month|xsd:Month|((( 179 -"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0- 180 - 181 -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))?$" 182 182 ))) 183 -|Duration|xsd:duration|((( 184 -"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0- 185 - 186 -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)?)?$" 187 187 ))) 188 188 189 189 == {{id name="_Toc291506"/}}4.2 Time and Time Format == ... ... @@ -241,7 +241,7 @@ 241 241 242 242 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. 243 243 244 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^ 184 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^ 245 245 246 246 === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period === 247 247 ... ... @@ -315,7 +315,7 @@ 315 315 316 316 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 317 317 318 -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. 258 +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" %)^^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. 319 319 320 320 **Reporting Day**: 321 321 ... ... @@ -349,19 +349,19 @@ 349 349 350 350 This is the [REPORTING_YEAR_START_DATE] 351 351 352 -1. 292 +1. 353 353 11. **If the [PERIOD_INDICATOR] is W:** 354 354 111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 355 355 356 -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]. 296 +Add^^[[(% class="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]. 357 357 358 -1. 359 -11. 298 +1. 299 +11. 360 360 111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** 361 361 362 362 Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 363 363 364 -1. 304 +1. 365 365 11. **Else:** 366 366 367 367 The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. ... ... @@ -645,3 +645,5 @@ 645 645 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. 646 646 647 647 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. 588 + 589 +{{putFootnotes/}}