Skip to Content

Changes for page 13 Structure Mapping

Last modified by Artur on 2025/09/10 11:19
From version 4.13
edited by Helena
on 2025/06/16 15:02
Change comment: There is no comment for this version
To version 7.1
edited by Helena
on 2025/06/16 15:31
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,52 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
1 +(% contenteditable="false" tabindex="-1" %)
2 +(((
3 +(% class="macro" data-macro="startmacro:box|-|title=~"**Contents**~"|-|\{\{toc/}}" data-widget="xwiki-macro" %)
4 +(((
5 +(% class="macro-placeholder hidden" %)
6 +(((
7 +macro:box
8 +)))
4 4  
10 +(% class="box" %)
11 +(((
12 +(% class="box-title" %)
13 +(((
14 +**Contents**
15 +)))
16 +
17 +(% class="macro" data-macro="startmacro:toc|-|" %)
18 +(((
19 +(% class="macro-placeholder hidden" %)
20 +(((
21 +macro:toc
22 +)))
23 +
24 +(% class="wikitoc" %)
25 +*
26 +** [[13.1 Introduction>>doc:null||anchor="H13.1Introduction"]]
27 +** [[13.2 1-1 structure maps>>doc:null||anchor="H13.21-1structuremaps"]]
28 +** [[13.3 N-n structure maps>>doc:null||anchor="H13.3N-nstructuremaps"]]
29 +** [[13.4 Ambiguous mapping rules>>doc:null||anchor="H13.4Ambiguousmappingrules"]]
30 +** [[13.5 Representation maps>>doc:null||anchor="H13.5Representationmaps"]]
31 +** [[13.6 Regular expression and substring rules>>doc:null||anchor="H13.6Regularexpressionandsubstringrules"]]
32 +*** [[13.6.1 Regular expressions>>doc:null||anchor="H13.6.1Regularexpressions"]]
33 +*** [[13.6.2 Substrings>>doc:null||anchor="H13.6.2Substrings"]]
34 +** [[13.7 Mapping non-SDMX time formats to SDMX formats>>doc:null||anchor="H13.7Mappingnon-SDMXtimeformatstoSDMXformats"]]
35 +*** [[13.7.1 Pattern based dates>>doc:null||anchor="H13.7.1Patternbaseddates"]]
36 +*** [[13.7.2 Numerical based datetime>>doc:null||anchor="H13.7.2Numericalbaseddatetime"]]
37 +*** [[13.7.3 Mapping more complex time inputs>>doc:null||anchor="H13.7.3Mappingmorecomplextimeinputs"]]
38 +** [[13.8 Using TIME_PERIOD in mapping rules>>doc:null||anchor="H13.8UsingTIME_PERIODinmappingrules"]]
39 +** [[13.9 Time span mapping rules using validity periods>>doc:null||anchor="H13.9Timespanmappingrulesusingvalidityperiods"]]
40 +** [[13.10 Mapping examples>>doc:null||anchor="H13.10Mappingexamples"]]
41 +*** [[13.10.1 Many to one mapping (N3513 -1)>>doc:null||anchor="H13.10.1A0Manytoonemapping28N3513-129"]]
42 +*** [[13.10.2 Mapping other data types to Code Id>>doc:null||anchor="H13.10.2MappingotherdatatypestoCodeId"]]
43 +*** [[13.10.3 Observation Attributes for Time Period>>doc:null||anchor="H13.10.3ObservationAttributesforTimePeriod"]]
44 +*** [[13.10.4 Time mapping>>doc:null||anchor="H13.10.4Timemapping"]]
45 +)))
46 +)))
47 +)))
48 +)))
49 +
5 5  == 13.1 Introduction ==
6 6  
7 7  The purpose of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structure mapping is to transform [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] from one dimensionality to another. In practice, this means that the input and output [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] conform to different Data Structure Definition.
... ... @@ -18,7 +18,7 @@
18 18  
19 19  * Transforming received data into a common internal structure;
20 20  * Transforming reported data into the data collector's preferred structure;
21 -* Transforming unidimensional [[datasets>>doc:sdmx:Glossary.Data set.WebHome]]{{footnote}}Unidimensional datasets are those with a single 'indicator' or 'series code' dimension.{{/footnote}} to multi-dimensional; and
66 +* Transforming unidimensional [[datasets>>doc:sdmx:Glossary.Data set.WebHome]](% contenteditable="false" tabindex="-1" data-macro="startmacro:footnote|-||-|Unidimensional datasets are those with a single 'indicator' or 'series code' dimension." data-widget="xwiki-macro" class="macro hidden macro-placeholder" %)macro:footnote(% contenteditable="false" tabindex="-1" data-macro="startmacro:footnote|-||-|Unidimensional datasets are those with a single 'indicator' or 'series code' dimension." data-widget="xwiki-macro" class="macro footnoteRef" id="x_footnote_ref_1" %)^^[[1>>doc:null||anchor="x_footnote_1"]]^^(%%) to multi-dimensional; and
22 22  * Transforming internal [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] with a complex structure to a simpler structure with fewer [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] suitable for dissemination.
23 23  
24 24  == 13.2 1-1 structure maps ==
... ... @@ -225,7 +225,7 @@
225 225  
226 226  The input 'G' matches on the last rule which is used as a catch-all or default in this example.
227 227  
228 -=== 13. Substrings ===
273 +=== 13.6.2 Substrings ===
229 229  
230 230  Substrings provide an alternative to regular expressions where the required section of an input value can be described using the number of the starting character, and the length of the substring in characters. The first character is at position 1.
231 231  
... ... @@ -278,7 +278,7 @@
278 278  
279 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 280  
281 -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:
326 +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(% contenteditable="false" tabindex="-1" data-macro="startmacro: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" data-widget="xwiki-macro" class="macro hidden macro-placeholder" %)macro:footnote(% contenteditable="false" tabindex="-1" data-macro="startmacro: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" data-widget="xwiki-macro" class="macro footnoteRef" id="x_footnote_ref_2" %)^^[[2>>doc:null||anchor="x_footnote_2"]]^^(%%). An indicative list of examples is presented in the following table:
282 282  
283 283  (% style="width:604.294px" %)
284 284  |(% style="width:172px" %)English (en)|(% style="width:216px" %)Australia (AU)|(% style="width:213px" %)en-AU
... ... @@ -321,7 +321,7 @@
321 321  (% style="width:850.294px" %)
322 322  |(% style="width:125px" %)**Letter**|(% style="width:385px" %)**Date or Time Component**|(% style="width:180px" %)**Presentation**|(% style="width:157px" %)**Examples**
323 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
369 +|(% style="width:125px" %)yy|(% style="width:385px" %)Year short (upper case is Year of Week(% contenteditable="false" tabindex="-1" data-macro="startmacro:footnote|-||-|yyyy represents the calendar year while YYYY represents the year of the week, which is only relevant for 53 week years" data-widget="xwiki-macro" class="macro hidden macro-placeholder" %)macro:footnote(% contenteditable="false" tabindex="-1" data-macro="startmacro:footnote|-||-|yyyy represents the calendar year while YYYY represents the year of the week, which is only relevant for 53 week years" data-widget="xwiki-macro" class="macro footnoteRef" id="x_footnote_ref_3" %)^^[[3>>doc:null||anchor="x_footnote_3"]]^^(%%))|(% style="width:180px" %)Year|(% style="width:157px" %)96
325 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 326  |(% style="width:125px" %)MM|(% style="width:385px" %)Month number in year starting with 1|(% style="width:180px" %)Month|(% style="width:157px" %)07
327 327  |(% style="width:125px" %)MMM|(% style="width:385px" %)Month name short|(% style="width:180px" %)Month|(% style="width:157px" %)Jul
... ... @@ -347,11 +347,11 @@
347 347  
348 348  The model is illustrated below:
349 349  
350 -[[image:1750074822764-573.png]]
395 +(% contenteditable="false" tabindex="-1" %)[[image:1750074822764-573.png||data-widget="image"]]
351 351  
352 352  **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?**
353 353  
354 -[[image:1750074865924-797.png]]
399 +(% contenteditable="false" tabindex="-1" %)[[image:1750074865924-797.png||data-widget="image"]]
355 355  
356 356  (% class="wikigeneratedid" id="HFigure25showinganinputdateformat2CwhoseoutputfrequencyisderivedfromtheoutputvalueoftheFREQDimension" %)
357 357  **Figure 25 showing an input date format, whose output frequency is derived from the output value of the FREQ Dimension**
... ... @@ -381,7 +381,7 @@
381 381  
382 382  The model is illustrated below:
383 383  
384 -[[image:1750074994887-415.png]]
429 +(% contenteditable="false" tabindex="-1" %)[[image:1750074994887-415.png||data-widget="image"]]
385 385  
386 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 **
387 387  
... ... @@ -478,101 +478,107 @@
478 478  
479 479  )))
480 480  
481 -The bold Dimensions map from source to target verbatim. The mapping simply specifies:
526 +The bold [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)map(%%) from source to target verbatim. The mapping simply specifies:
482 482  
483 -FREQ => FREQ
528 +> FREQ => FREQ
529 +> REF_AREA=> REF_AREA
530 +> COUNTERPART_AREA=> COUNTERPART _AREA
484 484  
485 -REF_AREA=> REF_AREA
532 +No [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Mapping is required. The source value simply copies across unmodified.
486 486  
487 -COUNTERPART_AREA=> COUNTERPART _AREA
534 +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:
488 488  
489 -No Representation Mapping is required. The source value simply copies across unmodified.
536 +> N:S1:S1:B:B5G => IND_ABC
490 490  
491 -The remaining Dimensions all map to the Indicator Dimension. This is an example of many Dimensions mapping to one Dimension. In this case a Representation Mapping is required, and the mapping first describes the input 'partial key' and how this maps to the target indicator:
538 +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.
492 492  
493 -N:S1:S1:B:B5G => IND_ABC
540 +**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.
494 494  
495 -Where the key sequence is based on the order specified in the mapping (i.e ADJUSTMENT, REF_SECTOR, etc will result in the first value N being taken from ADJUSTMENT as this was the first item in the source Dimension list.
542 +=== 13.10.2 Mapping other data types to Code Id ===
496 496  
497 -**Note**: The key order is NOT based on the Dimension order of the DSD, as the mapping needs to be resilient to the DSD changing.
544 +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.
498 498  
499 -1.
500 -11.
501 -111. Mapping other data types to Code Id
546 +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]].
502 502  
503 -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.
548 +(% style="width:402.294px" %)
549 +|(% style="width:197px" %)**Source Input Free Text**|(% style="width:204px" %)**Desired Output Code Id**
550 +|(% style="width:197px" %)0|(% style="width:204px" %)A
551 +|(% style="width:197px" %)1|(% style="width:204px" %)A
552 +|(% style="width:197px" %)2|(% style="width:204px" %)A
553 +|(% style="width:197px" %)3|(% style="width:204px" %)B
554 +|(% style="width:197px" %)4|(% style="width:204px" %)B
504 504  
505 -The following representation mapping can be used to explicitly map each age to an output code.
506 -
507 -|Source Input Free Text|Desired Output Code Id
508 -|0|A
509 -|1|A
510 -|2|A
511 -|3|B
512 -|4|B
513 -
514 514  If this mapping takes advantage of regular expressions it can be expressed in two rules:
515 515  
558 +(% style="width:336.294px" %)
559 +|(% style="width:182px" %)**Regular Expression**|(% style="width:151px" %)**Desired Output**
560 +|(% style="width:182px" %)[0-2]|(% style="width:151px" %)A
561 +|(% style="width:182px" %)[3-4]|(% style="width:151px" %)B
516 516  
517 -Regular Expression Desired Output
563 +=== 13.10.3 Observation Attributes for Time Period ===
518 518  
519 -|[0-2]|A
520 -|[3-4]|B
565 +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.
521 521  
522 -=== 13. Observation Attributes for Time Period ===
567 +(% style="width:621.294px" %)
568 +|(% style="width:201px" %)Input INDICATOR|(% style="width:192px" %)Input TIME_PERIOD|(% style="width:225px" %)Output OBS_CONF
569 +|(% style="width:201px" %)XULADS|(% style="width:192px" %)2008|(% style="width:225px" %)C
570 +|(% style="width:201px" %)XULADS|(% style="width:192px" %)2009|(% style="width:225px" %)C
571 +|(% style="width:201px" %)XULADS|(% style="width:192px" %)2010|(% style="width:225px" %)C
523 523  
524 -This use case is where a specific observation for a specific time period has an attribute value.
573 +Or using a validity period on the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Mapping:
525 525  
526 -|Input INDICATOR|Input TIME_PERIOD|Output OBS_CONF
527 -|XULADS|2008|C
528 -|XULADS|2009|C
529 -|XULADS|2010|C
575 +(% style="width:629.294px" %)
576 +|(% style="width:202px" %)Input INDICATOR|(% style="width:197px" %)Valid From/ Valid To|(% style="width:227px" %) Output OBS_CONF
577 +|(% style="width:202px" %)XULADS|(% style="width:197px" %) 2008/2010|(% style="width:227px" %)С
530 530  
531 -Or using a validity period on the Representation Mapping:
579 +=== 13.10.4 Time mapping ===
532 532  
533 -Input INDICATOR Valid From/ Valid To Output OBS_CONF
581 +This use case is to create a [[time period>>doc:sdmx:Glossary.Time period.WebHome]] from an input that does not respect [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Time Formats.
534 534  
535 -XULADS 2008/2010 C
583 +The [[Component>>doc:sdmx:Glossary.Component.WebHome]] Mapping from SYS_TIME to TIME_PERIOD specifies itself as a time mapping with the following details:
536 536  
537 -=== 13. Time mapping ===
585 +(% style="width:652.294px" %)
586 +|(% style="width:139px" %)Source Value|(% style="width:165px" %)Source Mapping|(% style="width:182px" %)Target Frequency|(% style="width:163px" %)Output
587 +|(% style="width:139px" %)18/07/1981|(% style="width:165px" %)dd/MM/yyyy|(% style="width:182px" %)A|(% style="width:163px" %)1981
538 538  
539 -This use case is to create a time period from an input that does not respect SDMX Time Formats.
589 +When the target frequency is based on another target [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] value, in this example the value of the FREQ [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the target [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]].
540 540  
541 -The Component Mapping from SYS_TIME to TIME_PERIOD specifies itself as a time mapping with the following details:
591 +(% style="width:658.294px" %)
592 +|(% style="width:143px" %)Source Value|(% style="width:163px" %) Source Mapping|(% style="width:176px" %)Target Dimension|(% style="width:173px" %)Frequency Output
593 +|(% style="width:143px" %)18/07/1981|(% style="width:163px" %)dd/MM/yyyy|(% style="width:176px" %)FREQ|(% style="width:173px" %)1981-07-18 (when FREQ=D)
542 542  
543 -|Source Value|Source Mapping|Target Frequency|Output
544 -|18/07/1981|dd/MM/yyyy|A|1981
595 + When the source is a numerical format.
545 545  
546 -When the target frequency is based on another target Dimension value, in this example the value of the FREQ Dimension in the target DSD.
597 +(% style="width:658.294px" %)
598 +|(% style="width:143px" %)Source Value|(% style="width:163px" %) Start Period|(% style="width:176px" %)Interval|(% style="width:176px" %)Target FREQ|(% style="width:173px" %) Output
599 +|(% style="width:143px" %)1589808220|(% style="width:163px" %)1970|(% style="width:176px" %) millisecond|(% style="width:176px" %)M|(% style="width:173px" %)2020-05
547 547  
548 -Source Value Source Mapping Target Frequency Output
549 -
550 -Dimension
551 -
552 -|18/07/1981 dd/MM/yyyy FREQ| |1981-07-18 (when FREQ=D)
553 -| When the source is a numerical format| |
554 -|Source Value Start Period Interval|(((
555 -Target
556 -
557 -FREQ
558 -)))|Output
559 -|1589808220 1970 millisecond|M|2020-05
560 -
561 561  When the source frequency is lower than the target frequency additional information 3568 can be provided for resolve to start of period, end of period, or mid period, as shown 3569 in the following example:
562 562  
563 - Source Value Source Mapping Target Frequency Output
603 +(% style="width:666.294px" %)
604 +|(% style="width:131px" %) Source Value|(% style="width:143px" %)Source Mapping|(% style="width:149px" %)Target Dimension|(% style="width:114px" %)Frequency|(% style="width:126px" %)Output
605 +|(% style="width:131px" %)1981|(% style="width:143px" %)yyyy|(% style="width:149px" %)D – End of Period|(% style="width:114px" %) |(% style="width:126px" %)1981-12-31
564 564  
565 -Dimension
607 +When the start of year is April 1^^st^^ the Structure (% style="color:#e74c3c" %)Map(%%) has YearStart=04-01:
566 566  
567 - 1981 yyyy D – End of Period 1981-12-31
609 +(% style="width:666.294px" %)
610 +|(% style="width:131px" %) Source Value|(% style="width:143px" %)Source Mapping|(% style="width:149px" %)Target Dimension|(% style="width:114px" %)Frequency|(% style="width:126px" %)Output
611 +|(% style="width:131px" %)1981|(% style="width:143px" %)yyyy|(% style="width:149px" %)D – End of Period|(% style="width:114px" %) |(% style="width:126px" %)1982-03-31
568 568  
569 -
570 -When the start of year is April 1^^st^^ the Structure Map has YearStart=04-01:
571 -
572 - Source Value Source Mapping Target Frequency Output
573 -
574 -Dimension
575 -
576 576  ----
577 577  
578 -{{putFootnotes/}}
615 +(% contenteditable="false" tabindex="-1" %)
616 +(((
617 +(% class="macro" data-macro="startmacro:putFootnotes|-|" data-widget="xwiki-macro" %)
618 +(((
619 +(% class="macro-placeholder hidden" %)
620 +(((
621 +macro:putFootnotes
622 +)))
623 +
624 +(% class="footnotes" %)
625 +1. [[^>>doc:null||anchor="x_footnote_ref_1" id="x_footnote_1" class="footnoteBackRef"]] Unidimensional datasets are those with a single 'indicator' or 'series code' dimension.
626 +1. [[^>>doc:null||anchor="x_footnote_ref_2" id="x_footnote_2" class="footnoteBackRef"]] 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//
627 +1. [[^>>doc:null||anchor="x_footnote_ref_3" id="x_footnote_3" class="footnoteBackRef"]] yyyy represents the calendar year while YYYY represents the year of the week, which is only relevant for 53 week years
628 +)))
629 +)))