Skip to Content

Wiki source code of 13 Structure Mapping

Version 4.4 by Helena on 2025/06/16 14:22
Hide last authors
Helena 1.1 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 == 13.1 Introduction ==
6
Helena 4.3 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.
Helena 1.1 8
Helena 4.3 9 Structure mapping does not alter the [[observation values>>doc:sdmx:Glossary.Observation value.WebHome]] and is not intended to perform any aggregations or calculations.
Helena 1.1 10
Helena 4.3 11 An input series (% style="color:#e74c3c" %)maps(%%) to:
Helena 1.1 12
13 1. Exactly one output series; or
Helena 4.3 14 1. Multiple output series with different [[Series Keys>>doc:sdmx:Glossary.Series key.WebHome]], but the same [[observation values>>doc:sdmx:Glossary.Observation value.WebHome]]; or
15 1. Zero output series where no source rule matches the input [[Component>>doc:sdmx:Glossary.Component.WebHome]] values.
Helena 1.1 16
17 Typical use cases include:
18
19 * Transforming received data into a common internal structure;
20 * Transforming reported data into the data collector's preferred structure;
Helena 4.3 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
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.
Helena 1.1 23
24 == 13.2 1-1 structure maps ==
25
Helena 4.4 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.
Helena 1.1 27
Helena 4.4 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.
Helena 1.1 29
Helena 4.4 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" %)
Helena 1.1 38
39 Different source values can also map to the same target value, for example when deriving regions from country codes.
40
41 |Source Component: REF_AREA|Target Component: REGION
42 |FR|EUR
43 |DE|EUR
44 |IT|EUR
45 |ES|EUR
46 |BE|EUR
47
48 == 13.3 N-n structure maps ==
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
52 Example:
53
54 |Rule|Source|Target
55 |1|(((
56 If
57
58 FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
59 )))|(((
60 Set
61
62 INDICATOR=A_N_L
63 )))
64 |2|(((
65 If
66
67 FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
68 )))|(((
69 Set
70
71 INDICATOR=MON_SAX_12
72 )))
73
74 N-n rules can also set values for multiple source Components.
75
76 |Rule|Source|Target
77 |1|(((
78 If
79
80 FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
81 )))|(((
82 Set
83
84 INDICATOR=A_N_L, STATUS=QXR15,
85
86 NOTE="Unadjusted".
87 )))
88 |2|(((
89 If
90
91 FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
92 )))|(((
93 Set
94
95 INDICATOR=MON_SAX_12,
96
97 STATUS=MPM12,
98
99 NOTE="Seasonally Adjusted"
100 )))
101
102 == 13.4 Ambiguous mapping rules ==
103
104 A structure map is ambiguous if the rules result in a dataset containing multiple series with the same Series Key.
105
106 A simple example mapping a source dataset with a single dimension to one with multiple dimensions is shown below:
107
108 |Source|Target|Output Series Key
109 |SERIES_CODE=XMAN_Z_21|(((
110 Dimensions
111
112 INDICATOR=XM
113 FREQ=A
114 ADJUSTMENT=N
115 Attributes
116 UNIT_MEASURE=_Z
117
118 COMP_ORG=21
119 )))|XM:A:N
120 |(((
121 SERIES_CODE=XMAN_Z_34
122
123
124 )))|(((
125 Dimensions
126
127 INDICATOR=XM
128
129 FREQ=A
130
131 ADJUSTMENT=N
132
133 Attributes
134
135 UNIT_MEASURE=_Z
136
137 COMP_ORG=34
138 )))|XM:A:N
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.
141
142 == 13.5 Representation maps ==
143
144 Representation Maps replace the SDMX 2.1 Codelist Maps and are used describe explicit mappings between source and target Component values.
145
146 The source and target of a Representation Map can reference any of the following:
147
148 1. Codelist
149 1. Free Text (restricted by type, e.g String, Integer, Boolean)
150 1. Valuelist
151
152 A Representation Map mapping ISO 2-character to ISO 3-character Codelists would take the following form:
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…|
161
162 A Representation Map mapping free text country names to an ISO 2-character Codelist could be similarly described:
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…|
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.
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.
176
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
179 |Value|Locale|Name
180 |$|en|United States Dollar
181 |%|En|Percentage
182 | |fr|Pourcentage
183
184 Other characteristics of Representation Maps:
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
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.
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:
194
195 //If starts with 'XU' map to 'Y'//
196
197 These rules are described using either regular expressions, or substrings for simpler use cases.
198
199 === 13.5.1 Regular expressions ===
200
201 Regular expression mapping rules are defined in the Representation Map.
202
203 Below is an example set of regular expression rules for a particular component.
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
209
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
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
214 |Regex|Target output|Example Input|Example Output
215 |(((
216 ([0-9]{4})[0-
217
218 9]([0-9]{1})
219 )))|\1-Q\2|200933|2009-Q3
220
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
223 The following example shows this:
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
229
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
232 The input 'G' matches on the last rule which is used as a catch-all or default in this example.
233
234 === 13. Substrings ===
235
236 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.
237
238 For instance:
239
240 |Input String|Start|Length|Output
241 |ABC_DEF_XYZ|5|3|DEF
242 |XULADS|1|2|XU
243
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
246 |Start|Length|Source|Target
247 |1|2|XU|Y
248
249 == 13.6 Mapping non-SDMX time formats to SDMX formats ==
250
251 Structure mapping allows non-SDMX compliant time values in source datasets to be mapped to an SDMX compliant time format.
252
253 Two types of time input are defined:
254
255 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.
256
257 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:
258
259 |Frequency|Format|Example
260 |A|YYYY|2010
261 |D|YYYY-MM-DD|2010-01-01
262 |I|(((
263 YYYY-MM-DD-
264
265 Thh:mm:ss
266 )))|2010-01T20:22:00
267 |M|YYYY-MM|2010-01
268 |Q|YYYY-Qn|2010-Q1
269 |S|YYYY-Sn|2010-S1
270 |T|YYYY-Tn|2010-T1
271 |W|YYYY-Wn|YYYY-W53
272
273 In the case where the input frequency is lower than the output frequency, the mapping defaults to end of period, but can be explicitly set to start, end or mid-period.
274
275 There are two important points to note:
276
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 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.
Helena 4.2 279 11.
Helena 1.1 280 111. Pattern based dates
281
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.
283
Helena 4.2 284 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:
Helena 1.1 285
286 |English (en)|Australia (AU)|en-AU
287 |English (en)|Canada (CA)|en-CA
288 |English (en)|United Kingdom (GB)|en-GB
289 |English (en)|United States (US)|en-US
290 |Estonian (et)|Estonia (EE)|et-EE
291 |Finnish (fi)|Finland (FI)|fi-FI
292 |French (fr)|Belgium (BE)|fr-BE
293 |French (fr)|Canada (CA)|fr-CA
294 |French (fr)|France (FR)|fr-FR
295 |French (fr)|Luxembourg (LU)|fr-LU
296 |French (fr)|Switzerland (CH)|fr-CH
297 |German (de)|Austria (AT)|de-AT
298 |German (de)|Germany (DE)|de-DE
299 |German (de)|Luxembourg (LU)|de-LU
300 |German (de)|Switzerland (CH)|de-CH
301 |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]]
302 |Greek (el)|Greece (GR)|el-GR
303 |Hebrew (iw)|Israel (IL)|iw-IL
304 |Hindi (hi)|India (IN)|hi-IN
305 |Hungarian (hu)|Hungary (HU)|hu-HU
306 |Icelandic (is)|Iceland (IS)|is-IS
307 |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]]
308 |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]]
309 |Italian (it)|Italy (IT)|it-IT
310
311 Examples
312
313 22/06/1981 would be described as dd/MM/YYYY, with locale en-GB
314
315 2008-mars-12 would be described as YYYY-MMM-DD, with locale fr-FR
316
317 22 July 1981 would be described as dd MMMM YYYY, with locale en-US
318
319 22 Jul 1981 would be described as dd MMM YYYY
320
321 2010 D62 would be described as YYYYDnn (day 62 of the year 2010)
322
323 The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):
324
325 |Letter|Date or Time Component|Presentation|Examples
326 |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
Helena 4.2 327 |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
Helena 1.1 328 |yyyy|Year Full (upper case is Year of Week)|Year|1996
329 |MM|Month number in year starting with 1|Month|07
330 |MMM|Month name short|Month|Jul
331 |MMMM|Month name full|Month|July
332 |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
333 |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
334 |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
335 |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
336 |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
337 |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
338 |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
339 |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
340 |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
341 |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
342 |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
343 |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
344 |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
345 |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
346 |n|(((
347 Number of periods, used after a SDMX
348
349 Frequency Identifier such as M, Q, D (month, quarter, day)
350 )))|[[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
351
352 The model is illustrated below:
353
354
355
356 **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?**
357
358
359
360 ==== Figure 25 showing an input date format, whose output frequency is derived from the output value of the FREQ Dimension ====
361
362 === 13.3.6 Numerical based datetime ===
363
364 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:
365
366 * day
367 * second
368 * millisecond
369 * microsecond
370 * nanosecond
371
372 |Numerical datetime systems|Base|Period
373 |(((
374 Epoch Time (UNIX)
375
376 Milliseconds since 01 Jan 1970
377 )))|1970|millisecond
378 |(((
379 Windows System Time
380
381 Milliseconds since 01 Jan 1601
382 )))|1601|millisecond
383
384 The example above illustrates numerical based datetime mapping rules for two commonly used time standards.
385
386 The model is illustrated below:
387
388 [[image:1750072341491-790.jpeg]]
389
390 **Figure 26 showing the component map mapping the SOURCE_DATE Dimension to the**
391
392 ==== TIME_PERIOD Dimension with the additional information on the component map to describe the numerical datetime system in use ====
393
394 === Mapping more complex time inputs ===
395
396 VTL should be used for more complex time inputs that cannot be interpreted using the pattern based on numerical methods.
397
398 == Using TIME_PERIOD in mapping rules ==
399
400 The source TIME_PERIOD Dimension can be used in conjunction with other input Dimensions to create discrete mapping rules where the output is conditional on the time period value.
401
402 The main use case is setting the value of Observation Attributes in the target dataset.
403
404 |Rule|Source|Target
405 |1|(((
406 If
407
408 INDICATOR=XULADS; and TIME_PERIOD=2007.
409 )))|(((
410 Set
411
412 OBS_CONF=F
413 )))
414 |2|(((
415 If
416
417 INDICATOR=XULADS; and TIME_PERIOD=2008.
418 )))|Set OBS_CONF=F
419 |3|(((
420 If
421
422 INDICATOR=XULADS; and TIME_PERIOD=2009.
423 )))|(((
424 Set
425
426 OBS_CONF=F
427 )))
428 |4|(((
429 If
430
431 INDICATOR=XULADS; and TIME_PERIOD=2010.
432 )))|(((
433 Set
434
435 OBS_CONF=**C**
436 )))
437
438 In the example above, OBS_CONF is an Observation Attribute.
439
440 == 13. Time span mapping rules using validity periods ==
441
442 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.
443
444 Instead, an optional validity period can be set for each mapping.
445
446 By specifying validity periods, the example from Section 13.8 can be re-written using two rules as follows:
447
448 |Rule|Source|Target
449 |1|(((
450 If
451
452 INDICATOR=XULADS.
453
454
455 Validity Period start period=2007 end period=2009
456 )))|Set OBS_CONF=F
457 |2|(((
458 If
459
460 INDICATOR=XULADS.
461
462
463 Validity Period start period=2010
464 )))|(((
465 Set
466
467 OBS_CONF=F
468 )))
469
470 In Rule 1, start period resolves to the start of the 2007 period (2007-01-01T00:00:00), and the end period resolves to the very end of 2009 (2009-12-31T23:59:59). The rule will hold true regardless of the input data frequency. Any observations reporting data for the Indicator XULADS that fall into that time range will have an OBS_CONF value of F.
471
472 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.
473
474 == 13. Mapping examples ==
475
476 === 13. Many to one mapping (N-1) ===
477
478 |Source|Map To
479 |(((
480 **FREQ**="A"
481
482 ADJUSTMENT="N"
483
484 **REF_AREA**="PL"
485
486 **COUNTERPART_AREA**="W0"
487
488 REF_SECTOR="S1"
489
490 COUNTERPART_SECTOR="S1"
491
492 ACCOUNTING_ENTRY="B"
493
494 STO="B5G"
495 )))|(((
496 FREQ="A"
497
498 REF_AREA="PL"
499
500 COUNTERPART_AREA="W0"
501 INDICATOR="IND_ABC"
502
503 )))
504
505 The bold Dimensions map from source to target verbatim. The mapping simply specifies:
506
507 FREQ => FREQ
508
509 REF_AREA=> REF_AREA
510
511 COUNTERPART_AREA=> COUNTERPART _AREA
512
513 No Representation Mapping is required. The source value simply copies across unmodified.
514
515 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:
516
517 N:S1:S1:B:B5G => IND_ABC
518
519 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.
520
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
Helena 4.2 523 1.
524 11.
Helena 1.1 525 111. Mapping other data types to Code Id
526
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.
528
529 The following representation mapping can be used to explicitly map each age to an output code.
530
531 |Source Input Free Text|Desired Output Code Id
532 |0|A
533 |1|A
534 |2|A
535 |3|B
536 |4|B
537
538 If this mapping takes advantage of regular expressions it can be expressed in two rules:
539
540
541 Regular Expression Desired Output
542
543 |[0-2]|A
544 |[3-4]|B
545
546 === 13. Observation Attributes for Time Period ===
547
548 This use case is where a specific observation for a specific time period has an attribute value.
549
550 |Input INDICATOR|Input TIME_PERIOD|Output OBS_CONF
551 |XULADS|2008|C
552 |XULADS|2009|C
553 |XULADS|2010|C
554
555 Or using a validity period on the Representation Mapping:
556
557 Input INDICATOR Valid From/ Valid To Output OBS_CONF
558
559 XULADS 2008/2010 C
560
561 === 13. Time mapping ===
562
563 This use case is to create a time period from an input that does not respect SDMX Time Formats.
564
565 The Component Mapping from SYS_TIME to TIME_PERIOD specifies itself as a time mapping with the following details:
566
567 |Source Value|Source Mapping|Target Frequency|Output
568 |18/07/1981|dd/MM/yyyy|A|1981
569
570 When the target frequency is based on another target Dimension value, in this example the value of the FREQ Dimension in the target DSD.
571
572 Source Value Source Mapping Target Frequency Output
573
574 Dimension
575
576 |18/07/1981 dd/MM/yyyy FREQ| |1981-07-18 (when FREQ=D)
577 | When the source is a numerical format| |
578 |Source Value Start Period Interval|(((
579 Target
580
581 FREQ
582 )))|Output
583 |1589808220 1970 millisecond|M|2020-05
584
585 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:
586
587 Source Value Source Mapping Target Frequency Output
588
589 Dimension
590
591 1981 yyyy D – End of Period 1981-12-31
592
593
594 When the start of year is April 1^^st^^ the Structure Map has YearStart=04-01:
595
596 Source Value Source Mapping Target Frequency Output
597
598 Dimension
599
600 ----
601
Helena 4.2 602 {{putFootnotes/}}