Skip to Content

Changes for page 13 Structure Mapping

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

Summary

Details

Page properties
Content
... ... @@ -36,66 +36,62 @@
36 36  |(% style="width:173px" %)Andorra|(% style="width:180px" %)AD|(% style="width:229px" %)AND
37 37  |(% style="width:173px" %)etc…|(% style="width:180px" %) |(% style="width:229px" %)
38 38  
39 -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]].
40 40  
41 -|Source Component: REF_AREA|Target Component: REGION
42 -|FR|EUR
43 -|DE|EUR
44 -|IT|EUR
45 -|ES|EUR
46 -|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
47 47  
48 48  == 13.3 N-n structure maps ==
49 49  
50 -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.
51 51  
52 52  Example:
53 53  
54 -|Rule|Source|Target
55 -|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" %)(((
56 56  If
57 -
58 -FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
59 -)))|(((
59 +FREQUENCY=A; and
60 +ADJUSTMENT=N; and
61 +MATURITY=L.
62 +)))|(% style="width:378px" %)(((
60 60  Set
61 -
62 62  INDICATOR=A_N_L
63 63  )))
64 -|2|(((
66 +|(% style="width:65px" %)2|(% style="width:519px" %)(((
65 65  If
66 -
67 -FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
68 -)))|(((
68 +FREQUENCY=M; and
69 +ADJUSTMENT=S_A1; and
70 +MATURITY=TY12.
71 +)))|(% style="width:378px" %)(((
69 69  Set
70 -
71 71  INDICATOR=MON_SAX_12
72 72  )))
73 73  
74 74  N-n rules can also set values for multiple source Components.
75 75  
76 -|Rule|Source|Target
77 -|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" %)(((
78 78  If
79 -
80 80  FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
81 -)))|(((
83 +)))|(% style="width:383px" %)(((
82 82  Set
83 -
84 84  INDICATOR=A_N_L, STATUS=QXR15,
85 -
86 86  NOTE="Unadjusted".
87 87  )))
88 -|2|(((
88 +|(% style="width:73px" %)2|(% style="width:506px" %)(((
89 89  If
90 -
91 91  FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
92 -)))|(((
91 +)))|(% style="width:383px" %)(((
93 93  Set
94 -
95 95  INDICATOR=MON_SAX_12,
96 -
97 97  STATUS=MPM12,
98 -
99 99  NOTE="Seasonally Adjusted"
100 100  )))
101 101  
... ... @@ -105,93 +105,90 @@
105 105  
106 106  A simple example mapping a source dataset with a single dimension to one with multiple dimensions is shown below:
107 107  
108 -|Source|Target|Output Series Key
109 -|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" %)(((
110 110  Dimensions
111 -
112 112  INDICATOR=XM
113 113  FREQ=A
114 114  ADJUSTMENT=N
115 115  Attributes
116 116  UNIT_MEASURE=_Z
117 -
118 118  COMP_ORG=21
119 -)))|XM:A:N
120 -|(((
114 +)))|(% style="width:397px" %)XM:A:N
115 +|(% style="width:257px" %)(((
121 121  SERIES_CODE=XMAN_Z_34
122 122  
123 123  
124 -)))|(((
119 +)))|(% style="width:315px" %)(((
125 125  Dimensions
126 -
127 127  INDICATOR=XM
128 -
129 129  FREQ=A
130 -
131 131  ADJUSTMENT=N
132 -
133 133  Attributes
134 -
135 135  UNIT_MEASURE=_Z
136 -
137 137  COMP_ORG=34
138 -)))|XM:A:N
127 +)))|(% style="width:397px" %)XM:A:N
139 139  
140 -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.
141 141  
142 142  == 13.5 Representation maps ==
143 143  
144 -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.
145 145  
146 -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:
147 147  
148 148  1. Codelist
149 149  1. Free Text (restricted by type, e.g String, Integer, Boolean)
150 150  1. Valuelist
151 151  
152 -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:
153 153  
154 -|CL_ISO_ALPHA2|CL_ISO_ALPHA3
155 -|AF|AFG
156 -|AL|ALB
157 -|DZ|DZA
158 -|AS|ASM
159 -|AD|AND
160 -|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" %)
161 161  
162 -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:
163 163  
164 -|Text|CL_ISO_ALPHA2
165 -|"Germany"|DE
166 -|"France"|FR
167 -|"United Kingdom"|GB
168 -|"Great Britain"|GB
169 -|"Ireland"|IE
170 -|"Eire"|IE
171 -|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" %)
172 172  
173 -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.
174 174  
175 -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.
176 176  
177 177  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:
178 178  
179 -|Value|Locale|Name
180 -|$|en|United States Dollar
181 -|%|En|Percentage
182 -| |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
183 183  
184 -Other characteristics of Representation Maps:
176 +Other characteristics of [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%):
185 185  
186 -* 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;
187 -* 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
188 -* 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.
189 -*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.
190 190  
191 -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 ==
192 192  
193 -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.
194 194  
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 +
195 195  //If starts with 'XU' map to 'Y'//
196 196  
197 197  These rules are described using either regular expressions, or substrings for simpler use cases.
... ... @@ -202,30 +202,31 @@
202 202  
203 203  Below is an example set of regular expression rules for a particular component.
204 204  
205 -|Regex|Description|Output
206 -|A|Rule match if input = 'A'|OUT_A
207 -|^[A-G]|Rule match if the input starts with letters A to G|OUT_B
208 -|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
209 209  
210 210  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.
211 211  
212 212  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
213 213  
214 -|Regex|Target output|Example Input|Example Output
215 -|(((
216 -([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
217 217  
218 -9]([0-9]{1})
219 -)))|\1-Q\2|200933|2009-Q3
220 -
221 221  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.
222 222  
223 223  The following example shows this:
224 224  
225 -|Priority|Regex|Description|Output
226 -|1|A|Rule match if input = 'A'|OUT_A
227 -|2|B|Rule match if input = 'B'|OUT_B
228 -|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
229 229  
230 230  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.
231 231  
... ... @@ -237,14 +237,16 @@
237 237  
238 238  For instance:
239 239  
240 -|Input String|Start|Length|Output
241 -|ABC_DEF_XYZ|5|3|DEF
242 -|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
243 243  
244 244  Sub-strings can therefore be used for the conceptual rule //If starts with 'XU' map to Y// as shown in the following example:
245 245  
246 -|Start|Length|Source|Target
247 -|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
248 248  
249 249  == 13.6 Mapping non-SDMX time formats to SDMX formats ==
250 250  
... ... @@ -276,7 +276,7 @@
276 276  
277 277  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.
278 278  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.
279 -11.
275 +11.
280 280  111. Pattern based dates
281 281  
282 282  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.
... ... @@ -520,8 +520,8 @@
520 520  
521 521  **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.
522 522  
523 -1.
524 -11.
519 +1.
520 +11.
525 525  111. Mapping other data types to Code Id
526 526  
527 527  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.