Changes for page 13 Structure Mapping
Last modified by Artur on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 3 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -189,36 +189,37 @@ 189 189 190 190 These rules are described using either regular expressions, or substrings for simpler use cases. 191 191 192 -=== 13. 5.1 Regular expressions ===192 +=== 13.6.1 Regular expressions === 193 193 194 -Regular expression mapping rules are defined in the Representation Map. 194 +Regular expression mapping rules are defined in the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Map. 195 195 196 -Below is an example set of regular expression rules for a particular component. 196 +Below is an example set of regular expression rules for a particular [[component>>doc:sdmx:Glossary.Component.WebHome]]. 197 197 198 -|Regex|Description|Output 199 -|A|Rule match if input = 'A'|OUT_A 200 -|^[A-G]|Rule match if the input starts with letters A to G|OUT_B 201 -|A~|B|Rule match if input is either 'A' or 'B'|OUT_C 198 +(% style="width:664.294px" %) 199 +|(% style="width:141px" %)**Regex**|(% style="width:362px" %)**Description**|(% style="width:158px" %)**Output** 200 +|(% style="width:141px" %)A|(% style="width:362px" %)Rule match if input = 'A'|(% style="width:158px" %)OUT_A 201 +|(% style="width:141px" %)^[A-G]|(% style="width:362px" %)Rule match if the input starts with letters A to G|(% style="width:158px" %)OUT_B 202 +|(% style="width:141px" %)A~|B|(% style="width:362px" %)Rule match if input is either 'A' or 'B'|(% style="width:158px" %)OUT_C 202 202 203 -Like all mapping rules, the output is either a Code, a Value or free text depending on the representation of the Component in the target Data Structure Definition. 204 +Like all mapping rules, the output is either a [[Code>>doc:sdmx:Glossary.Code.WebHome]], a Value or free text depending on the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[Component>>doc:sdmx:Glossary.Component.WebHome]] in the target [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. 204 204 205 205 If the regular expression contains capture groups, these can be used in the definition of the output value, by specifying \**//n//**// //as an output value where **//n//** is the number of the capture group starting from 1. For example 206 206 207 -|Regex|Target output|Example Input|Example Output 208 -|((( 209 -([0-9]{4})[0- 208 +(% style="width:700.294px" %) 209 +|(% style="width:203px" %)Regex|(% style="width:148px" %)Target output|(% style="width:157px" %)Example Input|(% style="width:189px" %)Example Output 210 +|(% style="width:203px" %)((( 211 +([0-9]{4})[0-9]([0-9]{1}) 212 +)))|(% style="width:148px" %)\1-Q\2|(% style="width:157px" %)200933|(% style="width:189px" %)2009-Q3 210 210 211 -9]([0-9]{1}) 212 -)))|\1-Q\2|200933|2009-Q3 213 - 214 214 As regular expression rules can be used as a general catch-all if nothing else matches, the ordering of the rules is important. Rules should be tested starting with the highest priority, moving down the list until a match is found. 215 215 216 216 The following example shows this: 217 217 218 -|Priority|Regex|Description|Output 219 -|1|A|Rule match if input = 'A'|OUT_A 220 -|2|B|Rule match if input = 'B'|OUT_B 221 -|3|[A-Z]|Any character A-Z|OUT_C 218 +(% style="width:704.294px" %) 219 +|(% style="width:130px" %)Priority|(% style="width:125px" %)Regex|(% style="width:241px" %)Description|(% style="width:205px" %)Output 220 +|(% style="width:130px" %)1|(% style="width:125px" %)A|(% style="width:241px" %)Rule match if input = 'A'|(% style="width:205px" %)OUT_A 221 +|(% style="width:130px" %)2|(% style="width:125px" %)B|(% style="width:241px" %)Rule match if input = 'B'|(% style="width:205px" %)OUT_B 222 +|(% style="width:130px" %)3|(% style="width:125px" %)[A-Z]|(% style="width:241px" %)Any character A-Z|(% style="width:205px" %)OUT_C 222 222 223 223 The input 'A' matches both the first and the last rule, but the first takes precedence having the higher priority. The output is OUT_A. 224 224 ... ... @@ -230,24 +230,27 @@ 230 230 231 231 For instance: 232 232 233 -|Input String|Start|Length|Output 234 -|ABC_DEF_XYZ|5|3|DEF 235 -|XULADS|1|2|XU 234 +(% style="width:623.294px" %) 235 +|(% style="width:169px" %)Input String|(% style="width:147px" %)Start|(% style="width:133px" %)Length|(% style="width:171px" %)Output 236 +|(% style="width:169px" %)ABC_DEF_XYZ|(% style="width:147px" %)5|(% style="width:133px" %)3|(% style="width:171px" %)DEF 237 +|(% style="width:169px" %)XULADS|(% style="width:147px" %)1|(% style="width:133px" %)2|(% style="width:171px" %)XU 236 236 237 -Sub-strings can therefore be used for the conceptual rule //If starts with 'XU' map to Y// as shown in the following example: 239 +Sub-strings can therefore be used for the conceptual rule //If starts with 'XU' (% style="color:#e74c3c" %)map(%%) to Y// as shown in the following example: 238 238 239 -|Start|Length|Source|Target 240 -|1|2|XU|Y 241 +(% style="width:628.294px" %) 242 +|(% style="width:163px" %)Start|(% style="width:158px" %)Length|(% style="width:128px" %)Source|(% style="width:176px" %)Target 243 +|(% style="width:163px" %)1|(% style="width:158px" %)2|(% style="width:128px" %)XU|(% style="width:176px" %)Y 241 241 242 -== 13. 6Mapping non-SDMX time formats to SDMX formats ==245 +== 13.7 Mapping non-SDMX time formats to SDMX formats == 243 243 244 -Structure mapping allows non-SDMX compliant time values in source datasets to be mapped to an SDMX compliant time format. 247 +Structure mapping allows non-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] compliant time values in source [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] to be (% style="color:#e74c3c" %)mapped(%%) to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] compliant time format. 245 245 246 246 Two types of time input are defined: 247 247 248 -a. **Pattern based dates** – a string which can be described using a notation like dd/mm/yyyy or is represented as the number of periods since a point in time, for example: 2010M001 (first month in 2010), or 2014D123 (123^^rd^^ day in 2014); and b. **Numerical based datetime** – a number specifying the elapsed periods since a fixed point in time, for example Unix Time is measured by the number of milliseconds since 1970. 251 +a. **Pattern based dates** – a string which can be described using a notation like dd/mm/yyyy or is represented as the number of periods since a point in time, for example: 2010M001 (first month in 2010), or 2014D123 (123^^rd^^ day in 2014); and 252 +b. **Numerical based datetime** – a number specifying the elapsed periods since a fixed point in time, for example Unix Time is measured by the number of milliseconds since 1970. 249 249 250 -The output of a time-based mapping is derived from the output Frequency, which is either explicitly stated in the mapping or defined as the value output by a specific Dimension or Attribute in the output mapping. If the output frequency is unknown or if the SDMX format is not desired, then additional rules can be provided to specify the output date format for the given frequency Id. The default rules are: 254 +The output of a time-based mapping is derived from the output Frequency, which is either explicitly stated in the mapping or defined as the value output by a specific [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in the output mapping. If the output frequency is unknown or if the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] format is not desired, then additional rules can be provided to specify the output date format for the given frequency Id. The default rules are: 251 251 252 252 |Frequency|Format|Example 253 253 |A|YYYY|2010 ... ... @@ -267,95 +267,95 @@ 267 267 268 268 There are two important points to note: 269 269 270 -1. The output frequency determines the output date format, but the default output can be redefined using a Frequency Format mapping to force explicit rules on how the output time period is formatted. 271 -1. To support the use case of changing frequency the structure map can optionally provide a start of year attribute, which defines the year start date in MM-DD format. For example: YearStart=04-01. 272 -11. 273 -111. Pattern based dates 274 +1. The output frequency determines the output date format, but the default output can be redefined using a Frequency Format mapping to force explicit rules on how the output [[time period>>doc:sdmx:Glossary.Time period.WebHome]] is formatted. 275 +1. To support the use case of changing frequency the structure (% style="color:#e74c3c" %)map(%%) can optionally provide a start of year [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], which defines the year start date in MM-DD format. For example: YearStart=04-01. 274 274 275 - Dateand time formats are specified by date and time pattern strings based on Java's Simple Date Format.Within date andtimepatternstrings, unquoted letters from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the components of a date or time string. Text canbe quoted using single quotes (') toavoid interpretation. "''" represents a single quote. All other characters are not interpreted;they're simply copiedinto the output string during formatting or matched againstthe input string during parsing.277 +=== 13.7.1 Pattern based dates === 276 276 279 +Date and [[time formats>>doc:sdmx:Glossary.Time format.WebHome]] are specified by date and time pattern strings based on Java's Simple Date Format. Within date and time pattern strings, unquoted letters from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the [[components>>doc:sdmx:Glossary.Component.WebHome]] of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "''" represents a single quote. All other characters are not interpreted; they're simply copied into the output string during formatting or matched against the input string during parsing. 280 + 277 277 Due to the fact that dates may differ per locale, an optional property, defining the locale of the pattern, is provided. This would assist processing of source dates, according to the given locale{{footnote}} A list of commonly used locales can be found in the Java supported locales: https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html{{/footnote}}. An indicative list of examples is presented in the following table: 278 278 279 -|English (en)|Australia (AU)|en-AU 280 -|English (en)|Canada (CA)|en-CA 281 -|English (en)|United Kingdom (GB)|en-GB 282 -|English (en)|United States (US)|en-US 283 -|Estonian (et)|Estonia (EE)|et-EE 284 -|Finnish (fi)|Finland (FI)|fi-FI 285 -|French (fr)|Belgium (BE)|fr-BE 286 -|French (fr)|Canada (CA)|fr-CA 287 -|French (fr)|France (FR)|fr-FR 288 -|French (fr)|Luxembourg (LU)|fr-LU 289 -|French (fr)|Switzerland (CH)|fr-CH 290 -|German (de)|Austria (AT)|de-AT 291 -|German (de)|Germany (DE)|de-DE 292 -|German (de)|Luxembourg (LU)|de-LU 293 -|German (de)|Switzerland (CH)|de-CH 294 -|Greek (el)|Cyprus (CY)|el-CY[[(*)>>url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]][[url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]] 295 -|Greek (el)|Greece (GR)|el-GR 296 -|Hebrew (iw)|Israel (IL)|iw-IL 297 -|Hindi (hi)|India (IN)|hi-IN 298 -|Hungarian (hu)|Hungary (HU)|hu-HU 299 -|Icelandic (is)|Iceland (IS)|is-IS 300 -|Indonesian (in)|Indonesia (ID)|in-ID[[(*)>>url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]][[url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]] 301 -|Irish (ga)|Ireland (IE)|ga-IE[[(*)>>url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]][[url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]] 302 -|Italian (it)|Italy (IT)|it-IT 283 +(% style="width:604.294px" %) 284 +|(% style="width:172px" %)English (en)|(% style="width:216px" %)Australia (AU)|(% style="width:213px" %)en-AU 285 +|(% style="width:172px" %)English (en)|(% style="width:216px" %)Canada (CA)|(% style="width:213px" %)en-CA 286 +|(% style="width:172px" %)English (en)|(% style="width:216px" %)United Kingdom (GB)|(% style="width:213px" %)en-GB 287 +|(% style="width:172px" %)English (en)|(% style="width:216px" %)United States (US)|(% style="width:213px" %)en-US 288 +|(% style="width:172px" %)Estonian (et)|(% style="width:216px" %)Estonia (EE)|(% style="width:213px" %)et-EE 289 +|(% style="width:172px" %)Finnish (fi)|(% style="width:216px" %)Finland (FI)|(% style="width:213px" %)fi-FI 290 +|(% style="width:172px" %)French (fr)|(% style="width:216px" %)Belgium (BE)|(% style="width:213px" %)fr-BE 291 +|(% style="width:172px" %)French (fr)|(% style="width:216px" %)Canada (CA)|(% style="width:213px" %)fr-CA 292 +|(% style="width:172px" %)French (fr)|(% style="width:216px" %)France (FR)|(% style="width:213px" %)fr-FR 293 +|(% style="width:172px" %)French (fr)|(% style="width:216px" %)Luxembourg (LU)|(% style="width:213px" %)fr-LU 294 +|(% style="width:172px" %)French (fr)|(% style="width:216px" %)Switzerland (CH)|(% style="width:213px" %)fr-CH 295 +|(% style="width:172px" %)German (de)|(% style="width:216px" %)Austria (AT)|(% style="width:213px" %)de-AT 296 +|(% style="width:172px" %)German (de)|(% style="width:216px" %)Germany (DE)|(% style="width:213px" %)de-DE 297 +|(% style="width:172px" %)German (de)|(% style="width:216px" %)Luxembourg (LU)|(% style="width:213px" %)de-LU 298 +|(% style="width:172px" %)German (de)|(% style="width:216px" %)Switzerland (CH)|(% style="width:213px" %)de-CH 299 +|(% style="width:172px" %)Greek (el)|(% style="width:216px" %)Cyprus (CY)|(% style="width:213px" %)el-CY(*) 300 +|(% style="width:172px" %)Greek (el)|(% style="width:216px" %)Greece (GR)|(% style="width:213px" %)el-GR 301 +|(% style="width:172px" %)Hebrew (iw)|(% style="width:216px" %)Israel (IL)|(% style="width:213px" %)iw-IL 302 +|(% style="width:172px" %)Hindi (hi)|(% style="width:216px" %)India (IN)|(% style="width:213px" %)hi-IN 303 +|(% style="width:172px" %)Hungarian (hu)|(% style="width:216px" %)Hungary (HU)|(% style="width:213px" %)hu-HU 304 +|(% style="width:172px" %)Icelandic (is)|(% style="width:216px" %)Iceland (IS)|(% style="width:213px" %)is-IS 305 +|(% style="width:172px" %)Indonesian (in)|(% style="width:216px" %)Indonesia (ID)|(% style="width:213px" %)in-ID(*) 306 +|(% style="width:172px" %)Irish (ga)|(% style="width:216px" %)Ireland (IE)|(% style="width:213px" %)ga-IE(*) 307 +|(% style="width:172px" %)Italian (it)|(% style="width:216px" %)Italy (IT)|(% style="width:213px" %)it-IT 303 303 309 +~* - [[https:~~/~~/www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale>>https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]] 310 + 304 304 Examples 305 305 306 306 22/06/1981 would be described as dd/MM/YYYY, with locale en-GB 307 - 308 308 2008-mars-12 would be described as YYYY-MMM-DD, with locale fr-FR 309 - 310 310 22 July 1981 would be described as dd MMMM YYYY, with locale en-US 311 - 312 312 22 Jul 1981 would be described as dd MMM YYYY 313 - 314 314 2010 D62 would be described as YYYYDnn (day 62 of the year 2010) 315 315 316 316 The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved): 317 317 318 -|Letter|Date or Time Component|Presentation|Examples 319 -|G|Era designator|[[Text>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#text]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#text]]|AD 320 -|yy|Year short (upper case is Year of Week{{footnote}}yyyy represents the calendar year while YYYY represents the year of the week, which is only relevant for 53 week years{{/footnote}})|[[Year>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#year]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#year]]|96 321 -|yyyy|Year Full (upper case is Year of Week)|Year|1996 322 -|MM|Month number in year starting with 1|Month|07 323 -|MMM|Month name short|Month|Jul 324 -|MMMM|Month name full|Month|July 325 -|ww|Week in year|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|27 326 -|W|Week in month|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|2 327 -|DD|Day in year|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|189 328 -|dd|Day in month|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|10 329 -|F|Day of week in month|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|2 330 -|E|Day name in week|[[Text>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#text]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#text]]|Tuesday; Tue 331 -|U|Day number of week (1 = Monday, ..., 7 = Sunday)|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|1 332 -|HH|Hour in day (0-23)|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|0 333 -|kk|Hour in day (1-24)|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|24 334 -|KK|Hour in am/pm (0-11)|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|0 335 -|hh|Hour in am/pm (1-12)|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|12 336 -|mm|Minute in hour|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|30 337 -|ss|Second in minute|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|55 338 -|S|Millisecond|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|978 339 -|n|((( 321 +(% style="width:850.294px" %) 322 +|(% style="width:125px" %)**Letter**|(% style="width:385px" %)**Date or Time Component**|(% style="width:180px" %)**Presentation**|(% style="width:157px" %)**Examples** 323 +|(% style="width:125px" %)G|(% style="width:385px" %)Era designator|(% style="width:180px" %)Text|(% style="width:157px" %)AD 324 +|(% style="width:125px" %)yy|(% style="width:385px" %)Year short (upper case is Year of Week{{footnote}}yyyy represents the calendar year while YYYY represents the year of the week, which is only relevant for 53 week years{{/footnote}})|(% style="width:180px" %)Year|(% style="width:157px" %)96 325 +|(% style="width:125px" %)yyyy|(% style="width:385px" %)Year Full (upper case is Year of Week)|(% style="width:180px" %)Year|(% style="width:157px" %)1996 326 +|(% style="width:125px" %)MM|(% style="width:385px" %)Month number in year starting with 1|(% style="width:180px" %)Month|(% style="width:157px" %)07 327 +|(% style="width:125px" %)MMM|(% style="width:385px" %)Month name short|(% style="width:180px" %)Month|(% style="width:157px" %)Jul 328 +|(% style="width:125px" %)MMMM|(% style="width:385px" %)Month name full|(% style="width:180px" %)Month|(% style="width:157px" %)July 329 +|(% style="width:125px" %)ww|(% style="width:385px" %)Week in year|(% style="width:180px" %)Number|(% style="width:157px" %)27 330 +|(% style="width:125px" %)W|(% style="width:385px" %)Week in month|(% style="width:180px" %)Number|(% style="width:157px" %)2 331 +|(% style="width:125px" %)DD|(% style="width:385px" %)Day in year|(% style="width:180px" %)Number|(% style="width:157px" %)189 332 +|(% style="width:125px" %)dd|(% style="width:385px" %)Day in month|(% style="width:180px" %)Number|(% style="width:157px" %)10 333 +|(% style="width:125px" %)F|(% style="width:385px" %)Day of week in month|(% style="width:180px" %)Number|(% style="width:157px" %)2 334 +|(% style="width:125px" %)E|(% style="width:385px" %)Day name in week|(% style="width:180px" %)Text|(% style="width:157px" %)Tuesday; Tue 335 +|(% style="width:125px" %)U|(% style="width:385px" %)Day number of week (1 = Monday, ..., 7 = Sunday)|(% style="width:180px" %)Number|(% style="width:157px" %)1 336 +|(% style="width:125px" %)HH|(% style="width:385px" %)Hour in day (0-23)|(% style="width:180px" %)Number|(% style="width:157px" %)0 337 +|(% style="width:125px" %)kk|(% style="width:385px" %)Hour in day (1-24)|(% style="width:180px" %)Number|(% style="width:157px" %)24 338 +|(% style="width:125px" %)KK|(% style="width:385px" %)Hour in am/pm (0-11)|(% style="width:180px" %)Number|(% style="width:157px" %)0 339 +|(% style="width:125px" %)hh|(% style="width:385px" %)Hour in am/pm (1-12)|(% style="width:180px" %)Number|(% style="width:157px" %)12 340 +|(% style="width:125px" %)mm|(% style="width:385px" %)Minute in hour|(% style="width:180px" %)Number|(% style="width:157px" %)30 341 +|(% style="width:125px" %)ss|(% style="width:385px" %)Second in minute|(% style="width:180px" %)Number|(% style="width:157px" %)55 342 +|(% style="width:125px" %)S|(% style="width:385px" %)Millisecond|(% style="width:180px" %)Number|(% style="width:157px" %)978 343 +|(% style="width:125px" %)n|(% style="width:385px" %)((( 340 340 Number of periods, used after a SDMX 341 - 342 342 Frequency Identifier such as M, Q, D (month, quarter, day) 343 -)))| [[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|12346 +)))|(% style="width:180px" %)Number|(% style="width:157px" %)12 344 344 345 345 The model is illustrated below: 346 346 350 +[[image:1750074822764-573.png]] 347 347 348 - 349 349 **Figure 24 showing the component map mapping the SOURCE_DATE Dimension to the TIME_PERIOD dimension with the additional information on the component map to describe the time format?** 350 350 354 +[[image:1750074865924-797.png]] 351 351 356 +(% class="wikigeneratedid" id="HFigure25showinganinputdateformat2CwhoseoutputfrequencyisderivedfromtheoutputvalueoftheFREQDimension" %) 357 +**Figure 25 showing an input date format, whose output frequency is derived from the output value of the FREQ Dimension** 352 352 353 -=== =Figure25showing an input date format, whoseoutput frequencyisderivedfrom the output value oftheFREQ Dimension====359 +=== 13.7.2 Numerical based datetime === 354 354 355 - ===13.3.6Numerical based datetime===361 +Where the source datetime input is purely numerical, the mapping rules are defined by the **Base** as a valid [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]], and the **Period** which must take one of the following enumerated values: 356 356 357 -Where the source datetime input is purely numerical, the mapping rules are defined by the **Base** as a valid SDMX Time Period, and the **Period** which must take one of the following enumerated values: 358 - 359 359 * day 360 360 * second 361 361 * millisecond ... ... @@ -362,75 +362,63 @@ 362 362 * microsecond 363 363 * nanosecond 364 364 365 -|Numerical datetime systems|Base|Period 366 -|((( 369 +(% style="width:545.294px" %) 370 +|(% style="width:268px" %)Numerical datetime systems|(% style="width:121px" %)Base|(% style="width:153px" %)Period 371 +|(% style="width:268px" %)((( 367 367 Epoch Time (UNIX) 368 - 369 369 Milliseconds since 01 Jan 1970 370 -)))|1970|millisecond 371 -|((( 374 +)))|(% style="width:121px" %)1970|(% style="width:153px" %)millisecond 375 +|(% style="width:268px" %)((( 372 372 Windows System Time 373 - 374 374 Milliseconds since 01 Jan 1601 375 -)))|1601|millisecond 378 +)))|(% style="width:121px" %)1601|(% style="width:153px" %)millisecond 376 376 377 377 The example above illustrates numerical based datetime mapping rules for two commonly used time standards. 378 378 379 379 The model is illustrated below: 380 380 381 -[[image:175007 2341491-790.jpeg]]384 +[[image:1750074994887-415.png]] 382 382 383 -**Figure 26 showing the component map mapping the SOURCE_DATE Dimension to the** 386 +**Figure 26 showing the component map mapping the SOURCE_DATE Dimension to the TIME_PERIOD Dimension with the additional information on the component map to describe the numerical datetime system in use ** 384 384 385 -=== =TIME_PERIODDimension with theadditionalinformation on the componentmapto describe the numericaldatetime system ine====388 +=== 13.7.3 Mapping more complex time inputs === 386 386 387 - ===Mapping more complex time inputs===390 +[[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] should be used for more complex time inputs that cannot be interpreted using the pattern based on numerical methods. 388 388 389 - VTLshouldbe used for more complex time inputsthatcannot beinterpretedusingthe pattern based on numericalmethods.392 +== 13.8 Using TIME_PERIOD in mapping rules == 390 390 391 - ==UsingTIME_PERIOD in mapping rules==394 +The source TIME_PERIOD [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be used in conjunction with other input [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] to create discrete mapping rules where the output is conditional on the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] value. 392 392 393 -The sourceTIME_PERIOD Dimensioncan be usedin conjunctionwith othernputDimensionstocreate discreteappingrules wheretheoutputis conditionalnthetimeperiod value.396 +The main use case is setting the value of Observation [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the target [[dataset>>doc:sdmx:Glossary.Data set.WebHome]]. 394 394 395 -The main use case is setting the value of Observation Attributes in the target dataset. 396 - 397 -|Rule|Source|Target 398 -|1|((( 398 +(% style="width:709.294px" %) 399 +|(% style="width:103px" %)**Rule**|(% style="width:405px" %)**Source**|(% style="width:198px" %)**Target** 400 +|(% style="width:103px" %)1|(% style="width:405px" %)((( 399 399 If 400 - 401 401 INDICATOR=XULADS; and TIME_PERIOD=2007. 402 -)))|((( 403 -Set 404 - 405 -OBS_CONF=F 403 +)))|(% style="width:198px" %)((( 404 +Set OBS_CONF=F 406 406 ))) 407 -|2|((( 406 +|(% style="width:103px" %)2|(% style="width:405px" %)((( 408 408 If 409 - 410 410 INDICATOR=XULADS; and TIME_PERIOD=2008. 411 -)))|Set OBS_CONF=F 412 -|3|((( 409 +)))|(% style="width:198px" %)Set OBS_CONF=F 410 +|(% style="width:103px" %)3|(% style="width:405px" %)((( 413 413 If 414 - 415 415 INDICATOR=XULADS; and TIME_PERIOD=2009. 416 -)))|((( 417 -Set 418 - 419 -OBS_CONF=F 413 +)))|(% style="width:198px" %)((( 414 +Set OBS_CONF=F 420 420 ))) 421 -|4|((( 416 +|(% style="width:103px" %)4|(% style="width:405px" %)((( 422 422 If 423 - 424 424 INDICATOR=XULADS; and TIME_PERIOD=2010. 425 -)))|((( 426 -Set 427 - 428 -OBS_CONF=**C** 419 +)))|(% style="width:198px" %)((( 420 +Set OBS_CONF=**C** 429 429 ))) 430 430 431 -In the example above, OBS_CONF is an Observation Attribute. 423 +In the example above, OBS_CONF is an Observation [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. 432 432 433 -== 13. Time span mapping rules using validity periods == 425 +== 13.9 Time span mapping rules using validity periods == 434 434 435 435 Creating discrete mapping rules for each TIME_PERIOD is impractical where rules need to cover a specific span of time regardless of frequency, and for high-frequency data. 436 436 ... ... @@ -438,25 +438,22 @@ 438 438 439 439 By specifying validity periods, the example from Section 13.8 can be re-written using two rules as follows: 440 440 441 -|Rule|Source|Target 442 -|1|((( 433 +(% style="width:516.294px" %) 434 +|(% style="width:74px" %)Rule|(% style="width:215px" %)Source|(% style="width:223px" %)Target 435 +|(% style="width:74px" %)1|(% style="width:215px" %)((( 443 443 If 444 - 445 445 INDICATOR=XULADS. 446 - 447 - 448 - Validity Period start period=2007 end period=2009449 -)))|Set OBS_CONF=F 450 -|2|((( 438 +Validity Period 439 +start period=2007 440 +end period=2009 441 +)))|(% style="width:223px" %)Set OBS_CONF=F 442 +|(% style="width:74px" %)2|(% style="width:215px" %)((( 451 451 If 452 - 453 453 INDICATOR=XULADS. 454 - 455 - 456 -Validity Period start period=2010 457 -)))|((( 445 +Validity Period 446 +start period=2010 447 +)))|(% style="width:223px" %)((( 458 458 Set 459 - 460 460 OBS_CONF=F 461 461 ))) 462 462 ... ... @@ -464,95 +464,86 @@ 464 464 465 465 In Rule 2, no end period is specified so remains in effect from the start of the period (2010-01-01T00:00:00) until the end of time. Any observations reporting data for the Indicator XULADS that fall into that time range will have an OBS_CONF value of C. 466 466 467 - ==13.Mapping examples==456 +In Rule 2, no end period is specified so remains in effect from the start of the period (2010-01-01T00:00:00) until the end of time. Any observations reporting data for the Indicator XULADS that fall into that time range will have an OBS_CONF value of C. 468 468 469 -== =13. Many to one mapping(N-1)===458 +== 13.10 Mapping examples == 470 470 471 -|Source|Map To 472 -|((( 473 -**FREQ**="A" 460 +=== 13.10.1 Many to one mapping (N3513 -1) === 474 474 462 +(% style="width:542.294px" %) 463 +|(% style="width:274px" %)**Source**|(% style="width:265px" %)**Map To** 464 +|(% style="width:274px" %)((( 465 +(% style="color:#8e44ad" %)**FREQ**="A" 475 475 ADJUSTMENT="N" 476 - 477 477 **REF_AREA**="PL" 478 - 479 479 **COUNTERPART_AREA**="W0" 480 - 481 481 REF_SECTOR="S1" 482 - 483 483 COUNTERPART_SECTOR="S1" 484 - 485 485 ACCOUNTING_ENTRY="B" 486 - 487 487 STO="B5G" 488 -)))|((( 489 -FREQ="A" 490 - 473 +)))|(% style="width:265px" %)((( 474 +(% style="color:#8e44ad" %)FREQ="A" 491 491 REF_AREA="PL" 492 - 493 493 COUNTERPART_AREA="W0" 494 -INDICATOR="IND_ABC" 477 +INDICATOR="IND_ABC"(%%) 495 495 496 496 ))) 497 497 498 -The bold Dimensions map from source to target verbatim. The mapping simply specifies: 481 +The bold [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)map(%%) from source to target verbatim. The mapping simply specifies: 499 499 500 -FREQ => FREQ 483 +> FREQ => FREQ 484 +> REF_AREA=> REF_AREA 485 +> COUNTERPART_AREA=> COUNTERPART _AREA 501 501 502 -R EF_AREA=>EF_AREA487 +No [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Mapping is required. The source value simply copies across unmodified. 503 503 504 - COUNTERPART_AREA=>COUNTERPART_AREA489 +The remaining [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] all (% style="color:#e74c3c" %)map(%%) to the Indicator [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This is an example of many [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] mapping to one [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. In this case a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Mapping is required, and the mapping first describes the input 'partial key' and how this (% style="color:#e74c3c" %)maps(%%) to the target indicator: 505 505 506 -N oRepresentationMapping is required. The source value simply copies across unmodified.491 +> N:S1:S1:B:B5G => IND_ABC 507 507 508 - ThemainingDimensions allmap to theIndicatorDimension. Thisis an exampleofmanyDimensionsmappingto one Dimension. In thiscaseaRepresentationMappingisrequired,andthemappingfirstdescribestheinput'partial key'andhow this mapstothetargetindicator:493 +Where the key sequence is based on the order specified in the (% style="color:#e74c3c" %)mapping(%%) (i.e [[ADJUSTMENT>>doc:sdmx:Glossary.Adjustment.WebHome]], REF_SECTOR, etc will result in the first value N being taken from [[ADJUSTMENT>>doc:sdmx:Glossary.Adjustment.WebHome]] as this was the first item in the source [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] list. 509 509 510 -N: S1:S1:B:B5G =>IND_ABC495 +**Note**: The key order is NOT based on the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] order of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]], as the (% style="color:#e74c3c" %)mapping(%%) needs to be resilient to the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] changing. 511 511 512 - Wherethekey sequence is based on the order specified in the mapping(i.e ADJUSTMENT, REF_SECTOR, etc will result in thefirstvalue N beingtakenfrom ADJUSTMENT asthis was thefirstitemin the sourceDimensionlist.497 +=== 13.10.2 Mapping other data types to Code Id === 513 513 514 - **Note**:ThekeyorderisNOTbased on the Dimensionrder of theDSD,as themappingneeds to be resilienttotheDSDchanging.499 +In the case where the incoming data type is not a string and not a [[code>>doc:sdmx:Glossary.Code.WebHome]] identifier i.e. the source [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is of type Integer and the target is Codelist. This is supported by the RepresentationMap. The RepresentationMap source can reference a Codelist, Valuelist, or be free text, the free text can include regular expressions. 515 515 516 -1. 517 -11. 518 -111. Mapping other data types to Code Id 501 +The following [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)mapping(%%) can be used to explicitly (% style="color:#e74c3c" %)map(%%) each [[age>>doc:sdmx:Glossary.Age.WebHome]] to an output [[code>>doc:sdmx:Glossary.Code.WebHome]]. 519 519 520 -In the case where the incoming data type is not a string and not a code identifier i.e. the source Dimension is of type Integer and the target is Codelist. This is supported by the RepresentationMap. The RepresentationMap source can reference a Codelist, Valuelist, or be free text, the free text can include regular expressions. 503 +(% style="width:402.294px" %) 504 +|(% style="width:197px" %)**Source Input Free Text**|(% style="width:204px" %)**Desired Output Code Id** 505 +|(% style="width:197px" %)0|(% style="width:204px" %)A 506 +|(% style="width:197px" %)1|(% style="width:204px" %)A 507 +|(% style="width:197px" %)2|(% style="width:204px" %)A 508 +|(% style="width:197px" %)3|(% style="width:204px" %)B 509 +|(% style="width:197px" %)4|(% style="width:204px" %)B 521 521 522 -The following representation mapping can be used to explicitly map each age to an output code. 523 - 524 -|Source Input Free Text|Desired Output Code Id 525 -|0|A 526 -|1|A 527 -|2|A 528 -|3|B 529 -|4|B 530 - 531 531 If this mapping takes advantage of regular expressions it can be expressed in two rules: 532 532 513 +(% style="width:336.294px" %) 514 +|(% style="width:182px" %)**Regular Expression**|(% style="width:151px" %)**Desired Output** 515 +|(% style="width:182px" %)[0-2]|(% style="width:151px" %)A 516 +|(% style="width:182px" %)[3-4]|(% style="width:151px" %)B 533 533 534 - RegularExpressionDesiredOutput518 +=== 13.10.3 Observation Attributes for Time Period === 535 535 536 -|[0-2]|A 537 -|[3-4]|B 520 +This use case is where a specific observation for a specific [[time period>>doc:sdmx:Glossary.Time period.WebHome]] has an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] value. 538 538 539 -=== 13. Observation Attributes for Time Period === 522 +(% style="width:621.294px" %) 523 +|(% style="width:201px" %)Input INDICATOR|(% style="width:192px" %)Input TIME_PERIOD|(% style="width:225px" %)Output OBS_CONF 524 +|(% style="width:201px" %)XULADS|(% style="width:192px" %)2008|(% style="width:225px" %)C 525 +|(% style="width:201px" %)XULADS|(% style="width:192px" %)2009|(% style="width:225px" %)C 526 +|(% style="width:201px" %)XULADS|(% style="width:192px" %)2010|(% style="width:225px" %)C 540 540 541 - Thisusecaseiswhereaspecificobservationfor a specific timeeriod hasantributevalue.528 +Or using a validity period on the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Mapping: 542 542 543 -|Input INDICATOR|Input TIME_PERIOD|Output OBS_CONF 544 -|XULADS|2008|C 545 -|XULADS|2009|C 546 -|XULADS|2010|C 530 +(% style="width:629.294px" %) 531 +|(% style="width:202px" %)Input INDICATOR|(% style="width:197px" %)Valid From/ Valid To|(% style="width:227px" %) Output OBS_CONF 532 +|(% style="width:202px" %)XULADS|(% style="width:197px" %) 2008/2010|(% style="width:227px" %)С 547 547 548 - Orusinga validity periodon the Representation Mapping:534 +=== 13.10.4 Time mapping === 549 549 550 -Input INDICATOR Valid From/ Valid To Output OBS_CONF 551 - 552 -XULADS 2008/2010 C 553 - 554 -=== 13. Time mapping === 555 - 556 556 This use case is to create a time period from an input that does not respect SDMX Time Formats. 557 557 558 558 The Component Mapping from SYS_TIME to TIME_PERIOD specifies itself as a time mapping with the following details:
- 1750074822764-573.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +25.1 KB - Content
- 1750074865924-797.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +46.8 KB - Content
- 1750074994887-415.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +12.4 KB - Content