Skip to Content

Changes for page 13 Structure Mapping

Last modified by Artur on 2025/09/10 11:19
From version 4.3
edited by Helena
on 2025/06/16 14:22
Change comment: There is no comment for this version
To version 4.5
edited by Helena
on 2025/06/16 14:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -23,78 +23,75 @@
23 23  
24 24  == 13.2 1-1 structure maps ==
25 25  
26 -1-1 (pronounced 'one to one') mappings support the simple use case where the value of a Component in the source structure is translated to a different value in the target, usually where different classification schemes are used for the same Concept.
26 +1-1 (pronounced 'one to one') mappings support the simple use case where the value of a [[Component>>doc:sdmx:Glossary.Component.WebHome]] in the source structure is translated to a different value in the target, usually where different classification schemes are used for the same Concept.
27 27  
28 -In the example below, ISO 2-character country codes are mapped to their ISO 3character equivalent.
28 +In the example below, ISO 2-character country [[codes>>doc:sdmx:Glossary.Code.WebHome]] are (% style="color:#e74c3c" %)mapped(%%) to their ISO 3character equivalent.
29 29  
30 -|Country|Alpha-2 code|Alpha-3 code
31 -|Afghanistan|AF|AFG
32 -|Albania|AL|ALB
33 -|Algeria|DZ|DZA
34 -|American Samoa|AS|ASM
35 -|Andorra|AD|AND
36 -|etc…| |
30 +(% style="width:585.294px" %)
31 +|(% style="width:173px" %)**Country**|(% style="width:180px" %)**Alpha-2 code**|(% style="width:229px" %)**Alpha-3 code**
32 +|(% style="width:173px" %)Afghanistan|(% style="width:180px" %)AF|(% style="width:229px" %)AFG
33 +|(% style="width:173px" %)Albania|(% style="width:180px" %)AL|(% style="width:229px" %)ALB
34 +|(% style="width:173px" %)Algeria|(% style="width:180px" %)DZ|(% style="width:229px" %)DZA
35 +|(% style="width:173px" %)American Samoa|(% style="width:180px" %)AS|(% style="width:229px" %)ASM
36 +|(% style="width:173px" %)Andorra|(% style="width:180px" %)AD|(% style="width:229px" %)AND
37 +|(% style="width:173px" %)etc…|(% style="width:180px" %) |(% style="width:229px" %)
37 37  
38 -Different source values can also map to the same target value, for example when deriving regions from country codes.
39 +Different source values can also (% style="color:#e74c3c" %)map(%%) to the same target value, for example when deriving regions from country [[codes>>doc:sdmx:Glossary.Code.WebHome]].
39 39  
40 -|Source Component: REF_AREA|Target Component: REGION
41 -|FR|EUR
42 -|DE|EUR
43 -|IT|EUR
44 -|ES|EUR
45 -|BE|EUR
41 +(% style="width:490.294px" %)
42 +|(% style="width:260px" %)Source Component: REF_AREA|(% style="width:227px" %)Target Component: REGION
43 +|(% style="width:260px" %)FR|(% style="width:227px" %)EUR
44 +|(% style="width:260px" %)DE|(% style="width:227px" %)EUR
45 +|(% style="width:260px" %)IT|(% style="width:227px" %)EUR
46 +|(% style="width:260px" %)ES|(% style="width:227px" %)EUR
47 +|(% style="width:260px" %)BE|(% style="width:227px" %)EUR
46 46  
47 47  == 13.3 N-n structure maps ==
48 48  
49 -N-n (pronounced 'N to N') mappings describe rules where a specified combination of values in multiple source Components map to specified values in one or more target Components. For example, when mapping a partial Series Key from a highly multidimensional cube (like Balance of Payments) to a single 'Indicator' Dimension in a target Data Structure.
51 +N-n (pronounced 'N to N') mappings describe rules where a specified combination of values in multiple source [[Components>>doc:sdmx:Glossary.Component.WebHome]] (% style="color:#e74c3c" %)map(%%) to specified values in one or more target [[Components>>doc:sdmx:Glossary.Component.WebHome]]. For example, when mapping a partial [[Series Key>>doc:sdmx:Glossary.Series key.WebHome]] from a highly multidimensional cube (like Balance of Payments) to a single 'Indicator' [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in a target Data Structure.
50 50  
51 51  Example:
52 52  
53 -|Rule|Source|Target
54 -|1|(((
55 +(% style="width:964.294px" %)
56 +|(% style="width:65px" %)Rule|(% style="width:519px" %)Source|(% style="width:378px" %)Target
57 +|(% style="width:65px" %)1|(% style="width:519px" %)(((
55 55  If
56 -
57 -FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
58 -)))|(((
59 +FREQUENCY=A; and
60 +ADJUSTMENT=N; and
61 +MATURITY=L.
62 +)))|(% style="width:378px" %)(((
59 59  Set
60 -
61 61  INDICATOR=A_N_L
62 62  )))
63 -|2|(((
66 +|(% style="width:65px" %)2|(% style="width:519px" %)(((
64 64  If
65 -
66 -FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
67 -)))|(((
68 +FREQUENCY=M; and
69 +ADJUSTMENT=S_A1; and
70 +MATURITY=TY12.
71 +)))|(% style="width:378px" %)(((
68 68  Set
69 -
70 70  INDICATOR=MON_SAX_12
71 71  )))
72 72  
73 73  N-n rules can also set values for multiple source Components.
74 74  
75 -|Rule|Source|Target
76 -|1|(((
78 +(% style="width:965.294px" %)
79 +|(% style="width:73px" %)Rule|(% style="width:506px" %)Source|(% style="width:383px" %)Target
80 +|(% style="width:73px" %)1|(% style="width:506px" %)(((
77 77  If
78 -
79 79  FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
80 -)))|(((
83 +)))|(% style="width:383px" %)(((
81 81  Set
82 -
83 83  INDICATOR=A_N_L, STATUS=QXR15,
84 -
85 85  NOTE="Unadjusted".
86 86  )))
87 -|2|(((
88 +|(% style="width:73px" %)2|(% style="width:506px" %)(((
88 88  If
89 -
90 90  FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
91 -)))|(((
91 +)))|(% style="width:383px" %)(((
92 92  Set
93 -
94 94  INDICATOR=MON_SAX_12,
95 -
96 96  STATUS=MPM12,
97 -
98 98  NOTE="Seasonally Adjusted"
99 99  )))
100 100  
... ... @@ -104,93 +104,90 @@
104 104  
105 105  A simple example mapping a source dataset with a single dimension to one with multiple dimensions is shown below:
106 106  
107 -|Source|Target|Output Series Key
108 -|SERIES_CODE=XMAN_Z_21|(((
104 +(% style="width:972.294px" %)
105 +|(% style="width:257px" %)Source|(% style="width:315px" %)Target|(% style="width:397px" %)Output Series Key
106 +|(% style="width:257px" %)SERIES_CODE=XMAN_Z_21|(% style="width:315px" %)(((
109 109  Dimensions
110 -
111 111  INDICATOR=XM
112 112  FREQ=A
113 113  ADJUSTMENT=N
114 114  Attributes
115 115  UNIT_MEASURE=_Z
116 -
117 117  COMP_ORG=21
118 -)))|XM:A:N
119 -|(((
114 +)))|(% style="width:397px" %)XM:A:N
115 +|(% style="width:257px" %)(((
120 120  SERIES_CODE=XMAN_Z_34
121 121  
122 122  
123 -)))|(((
119 +)))|(% style="width:315px" %)(((
124 124  Dimensions
125 -
126 126  INDICATOR=XM
127 -
128 128  FREQ=A
129 -
130 130  ADJUSTMENT=N
131 -
132 132  Attributes
133 -
134 134  UNIT_MEASURE=_Z
135 -
136 136  COMP_ORG=34
137 -)))|XM:A:N
127 +)))|(% style="width:397px" %)XM:A:N
138 138  
139 -The above behaviour can be okay if the series XMAN_Z_21 contains observations for different periods of time then the series XMAN_Z_34. If however both series contain observations for the same point in time, the output for this mapping will be two observations with the same series key, for the same period in time.
129 +The above behaviour can be okay if the series XMAN_Z_21 contains observations for different periods of time then the series XMAN_Z_34. If however both series contain observations for the same point in time, the output for this mapping will be two observations with the same [[series key>>doc:sdmx:Glossary.Series key.WebHome]], for the same period in time.
140 140  
141 141  == 13.5 Representation maps ==
142 142  
143 -Representation Maps replace the SDMX 2.1 Codelist Maps and are used describe explicit mappings between source and target Component values.
133 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%) replace the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 Codelist (% style="color:#e74c3c" %)Maps(%%) and are used describe explicit mappings between source and target [[Component>>doc:sdmx:Glossary.Component.WebHome]] values.
144 144  
145 -The source and target of a Representation Map can reference any of the following:
135 +The source and target of a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) can reference any of the following:
146 146  
147 147  1. Codelist
148 148  1. Free Text (restricted by type, e.g String, Integer, Boolean)
149 149  1. Valuelist
150 150  
151 -A Representation Map mapping ISO 2-character to ISO 3-character Codelists would take the following form:
141 +A [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) mapping ISO 2-character to ISO 3-character Codelists would take the following form:
152 152  
153 -|CL_ISO_ALPHA2|CL_ISO_ALPHA3
154 -|AF|AFG
155 -|AL|ALB
156 -|DZ|DZA
157 -|AS|ASM
158 -|AD|AND
159 -|etc…|
143 +(% style="width:356.294px" %)
144 +|(% style="width:167px" %)CL_ISO_ALPHA2|(% style="width:186px" %)CL_ISO_ALPHA3
145 +|(% style="width:167px" %)AF|(% style="width:186px" %)AFG
146 +|(% style="width:167px" %)AL|(% style="width:186px" %)ALB
147 +|(% style="width:167px" %)DZ|(% style="width:186px" %)DZA
148 +|(% style="width:167px" %)AS|(% style="width:186px" %)ASM
149 +|(% style="width:167px" %)AD|(% style="width:186px" %)AND
150 +|(% style="width:167px" %)etc…|(% style="width:186px" %)
160 160  
161 -A Representation Map mapping free text country names to an ISO 2-character Codelist could be similarly described:
152 +A [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) mapping free text country names to an ISO 2-character Codelist could be similarly described:
162 162  
163 -|Text|CL_ISO_ALPHA2
164 -|"Germany"|DE
165 -|"France"|FR
166 -|"United Kingdom"|GB
167 -|"Great Britain"|GB
168 -|"Ireland"|IE
169 -|"Eire"|IE
170 -|etc…|
154 +(% style="width:364.294px" %)
155 +|(% style="width:169px" %)Text|(% style="width:192px" %)CL_ISO_ALPHA2
156 +|(% style="width:169px" %)"Germany"|(% style="width:192px" %)DE
157 +|(% style="width:169px" %)"France"|(% style="width:192px" %)FR
158 +|(% style="width:169px" %)"United Kingdom"|(% style="width:192px" %)GB
159 +|(% style="width:169px" %)"Great Britain"|(% style="width:192px" %)GB
160 +|(% style="width:169px" %)"Ireland"|(% style="width:192px" %)IE
161 +|(% style="width:169px" %)"Eire"|(% style="width:192px" %)IE
162 +|(% style="width:169px" %)etc…|(% style="width:192px" %)
171 171  
172 -Valuelists, introduced in SDMX 3.0, are equivalent to Codelists but allow the maintenance of non-SDMX identifiers. Importantly, their IDs do not need to conform to IDType, but as a consequence are not Identifiable.
164 +Valuelists, introduced in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, are equivalent to Codelists but allow the maintenance of non-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] identifiers. Importantly, their IDs do not need to conform to IDType, but as a consequence are not Identifiable.
173 173  
174 -When used in Representation Maps, Valuelists allow Non-SDMX identifiers containing characters like £, $, % to be mapped to Code IDs, or Codes mapped to non-SDMX identifiers.
166 +When used in [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%), Valuelists allow Non-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] identifiers containing characters like £, $, % to be (% style="color:#e74c3c" %)mapped(%%) to [[Code>>doc:sdmx:Glossary.Code.WebHome]] IDs, or [[Codes>>doc:sdmx:Glossary.Code.WebHome]] (% style="color:#e74c3c" %)mapped(%%) to non-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] identifiers.
175 175  
176 176  In common with Codelists, each item in a Valuelist has a multilingual name giving it a human-readable label and an optional description. For example:
177 177  
178 -|Value|Locale|Name
179 -|$|en|United States Dollar
180 -|%|En|Percentage
181 -| |fr|Pourcentage
170 +(% style="width:435.294px" %)
171 +|(% style="width:126px" %)Value|(% style="width:133px" %)Locale|(% style="width:173px" %)Name
172 +|(% style="width:126px" %)$|(% style="width:133px" %)en|(% style="width:173px" %)United States Dollar
173 +|(% style="width:126px" %)%|(% style="width:133px" %)En|(% style="width:173px" %)Percentage
174 +|(% style="width:126px" %) |(% style="width:133px" %)fr|(% style="width:173px" %)Pourcentage
182 182  
183 -Other characteristics of Representation Maps:
176 +Other characteristics of [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%):
184 184  
185 -* Support the mapping of multiple source Component values to multiple Target Component values as described in section 13.3 on n-to-n mappings; this covers also the case of mapping an Attribute with an array representation to map combinations of values to a single target value;
186 -* Allow source or target mappings for an Item to be optional allowing rules such as 'A maps to nothing' or 'nothing maps to A'; and
187 -* Support for mapping rules where regular expressions or substrings are used to match source Component values. Refer to section 13.6 for more on this topic.
188 -*1. Regular expression and substring rules
178 +* Support the (% style="color:#e74c3c" %)mapping(%%) of multiple source [[Component>>doc:sdmx:Glossary.Component.WebHome]] values to multiple Target [[Component>>doc:sdmx:Glossary.Component.WebHome]] values as described in section 13.3 on n-to-n mappings; this covers also the case of (% style="color:#e74c3c" %)mapping(%%) an [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with an array [[representation>>doc:sdmx:Glossary.Representation.WebHome]] to (% style="color:#e74c3c" %)map(%%) combinations of values to a single target value;
179 +* Allow source or target mappings for an Item to be optional allowing rules such as 'A (% style="color:#e74c3c" %)maps(%%) to nothing' or 'nothing (% style="color:#e74c3c" %)maps(%%) to A'; and
180 +* Support for (% style="color:#e74c3c" %)mapping(%%) rules where regular expressions or substrings are used to match source [[Component>>doc:sdmx:Glossary.Component.WebHome]] values. Refer to section 13.6 for more on this topic.
189 189  
190 -It is common for classifications to contain meanings within the identifier, for example the code Id 'XULADS' may refer to a particular seasonality because it starts with the letters XU.
182 +== 13.6 Regular expression and substring rules ==
191 191  
192 -With SDMX 2.1 each code that starts with XU had to be individually mapped to the same seasonality, and additional mappings added when new Codes were added to the Codelists. This led to many hundreds or thousands of mappings which can be more efficiently summarised in a single conceptual rule:
184 +It is common for classifications to contain meanings within the identifier, for example the [[code>>doc:sdmx:Glossary.Code.WebHome]] Id 'XULADS' may refer to a particular seasonality because it starts with the letters XU.
193 193  
186 +With [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 each [[code>>doc:sdmx:Glossary.Code.WebHome]] that starts with XU had to be individually (% style="color:#e74c3c" %)mapped(%%) to the same seasonality, and additional mappings added when new [[Codes>>doc:sdmx:Glossary.Code.WebHome]] were added to the Codelists. This led to many hundreds or thousands of mappings which can be more efficiently summarised in a single conceptual rule:
187 +
194 194  //If starts with 'XU' map to 'Y'//
195 195  
196 196  These rules are described using either regular expressions, or substrings for simpler use cases.
... ... @@ -275,7 +275,7 @@
275 275  
276 276  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.
277 277  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.
278 -11.
272 +11.
279 279  111. Pattern based dates
280 280  
281 281  Date and time formats 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 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.
... ... @@ -519,8 +519,8 @@
519 519  
520 520  **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.
521 521  
522 -1.
523 -11.
516 +1.
517 +11.
524 524  111. Mapping other data types to Code Id
525 525  
526 526  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.