Skip to Content

Wiki source code of 13 Structure Mapping

Version 4.5 by Helena on 2025/06/16 14:41
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 == 13.1 Introduction ==
6
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.
8
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.
10
11 An input series (% style="color:#e74c3c" %)maps(%%) to:
12
13 1. Exactly one output series; or
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.
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;
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.
23
24 == 13.2 1-1 structure maps ==
25
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
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
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" %)
38
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
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
48
49 == 13.3 N-n structure maps ==
50
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.
52
53 Example:
54
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" %)(((
58 If
59 FREQUENCY=A; and
60 ADJUSTMENT=N; and
61 MATURITY=L.
62 )))|(% style="width:378px" %)(((
63 Set
64 INDICATOR=A_N_L
65 )))
66 |(% style="width:65px" %)2|(% style="width:519px" %)(((
67 If
68 FREQUENCY=M; and
69 ADJUSTMENT=S_A1; and
70 MATURITY=TY12.
71 )))|(% style="width:378px" %)(((
72 Set
73 INDICATOR=MON_SAX_12
74 )))
75
76 N-n rules can also set values for multiple source Components.
77
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" %)(((
81 If
82 FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
83 )))|(% style="width:383px" %)(((
84 Set
85 INDICATOR=A_N_L, STATUS=QXR15,
86 NOTE="Unadjusted".
87 )))
88 |(% style="width:73px" %)2|(% style="width:506px" %)(((
89 If
90 FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
91 )))|(% style="width:383px" %)(((
92 Set
93 INDICATOR=MON_SAX_12,
94 STATUS=MPM12,
95 NOTE="Seasonally Adjusted"
96 )))
97
98 == 13.4 Ambiguous mapping rules ==
99
100 A structure map is ambiguous if the rules result in a dataset containing multiple series with the same Series Key.
101
102 A simple example mapping a source dataset with a single dimension to one with multiple dimensions is shown below:
103
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" %)(((
107 Dimensions
108 INDICATOR=XM
109 FREQ=A
110 ADJUSTMENT=N
111 Attributes
112 UNIT_MEASURE=_Z
113 COMP_ORG=21
114 )))|(% style="width:397px" %)XM:A:N
115 |(% style="width:257px" %)(((
116 SERIES_CODE=XMAN_Z_34
117
118
119 )))|(% style="width:315px" %)(((
120 Dimensions
121 INDICATOR=XM
122 FREQ=A
123 ADJUSTMENT=N
124 Attributes
125 UNIT_MEASURE=_Z
126 COMP_ORG=34
127 )))|(% style="width:397px" %)XM:A:N
128
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.
130
131 == 13.5 Representation maps ==
132
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.
134
135 The source and target of a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) can reference any of the following:
136
137 1. Codelist
138 1. Free Text (restricted by type, e.g String, Integer, Boolean)
139 1. Valuelist
140
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:
142
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" %)
151
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:
153
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" %)
163
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.
165
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.
167
168 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:
169
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
175
176 Other characteristics of [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%):
177
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.
181
182 == 13.6 Regular expression and substring rules ==
183
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.
185
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
188 //If starts with 'XU' map to 'Y'//
189
190 These rules are described using either regular expressions, or substrings for simpler use cases.
191
192 === 13.5.1 Regular expressions ===
193
194 Regular expression mapping rules are defined in the Representation Map.
195
196 Below is an example set of regular expression rules for a particular component.
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
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
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
207 |Regex|Target output|Example Input|Example Output
208 |(((
209 ([0-9]{4})[0-
210
211 9]([0-9]{1})
212 )))|\1-Q\2|200933|2009-Q3
213
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
216 The following example shows this:
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
222
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
225 The input 'G' matches on the last rule which is used as a catch-all or default in this example.
226
227 === 13. Substrings ===
228
229 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.
230
231 For instance:
232
233 |Input String|Start|Length|Output
234 |ABC_DEF_XYZ|5|3|DEF
235 |XULADS|1|2|XU
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:
238
239 |Start|Length|Source|Target
240 |1|2|XU|Y
241
242 == 13.6 Mapping non-SDMX time formats to SDMX formats ==
243
244 Structure mapping allows non-SDMX compliant time values in source datasets to be mapped to an SDMX compliant time format.
245
246 Two types of time input are defined:
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.
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:
251
252 |Frequency|Format|Example
253 |A|YYYY|2010
254 |D|YYYY-MM-DD|2010-01-01
255 |I|(((
256 YYYY-MM-DD-
257
258 Thh:mm:ss
259 )))|2010-01T20:22:00
260 |M|YYYY-MM|2010-01
261 |Q|YYYY-Qn|2010-Q1
262 |S|YYYY-Sn|2010-S1
263 |T|YYYY-Tn|2010-T1
264 |W|YYYY-Wn|YYYY-W53
265
266 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.
267
268 There are two important points to note:
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
275 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.
276
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
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
303
304 Examples
305
306 22/06/1981 would be described as dd/MM/YYYY, with locale en-GB
307
308 2008-mars-12 would be described as YYYY-MMM-DD, with locale fr-FR
309
310 22 July 1981 would be described as dd MMMM YYYY, with locale en-US
311
312 22 Jul 1981 would be described as dd MMM YYYY
313
314 2010 D62 would be described as YYYYDnn (day 62 of the year 2010)
315
316 The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):
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|(((
340 Number of periods, used after a SDMX
341
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]]|12
344
345 The model is illustrated below:
346
347
348
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
351
352
353 ==== Figure 25 showing an input date format, whose output frequency is derived from the output value of the FREQ Dimension ====
354
355 === 13.3.6 Numerical based datetime ===
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 * day
360 * second
361 * millisecond
362 * microsecond
363 * nanosecond
364
365 |Numerical datetime systems|Base|Period
366 |(((
367 Epoch Time (UNIX)
368
369 Milliseconds since 01 Jan 1970
370 )))|1970|millisecond
371 |(((
372 Windows System Time
373
374 Milliseconds since 01 Jan 1601
375 )))|1601|millisecond
376
377 The example above illustrates numerical based datetime mapping rules for two commonly used time standards.
378
379 The model is illustrated below:
380
381 [[image:1750072341491-790.jpeg]]
382
383 **Figure 26 showing the component map mapping the SOURCE_DATE Dimension to the**
384
385 ==== TIME_PERIOD Dimension with the additional information on the component map to describe the numerical datetime system in use ====
386
387 === Mapping more complex time inputs ===
388
389 VTL should be used for more complex time inputs that cannot be interpreted using the pattern based on numerical methods.
390
391 == Using TIME_PERIOD in mapping rules ==
392
393 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.
394
395 The main use case is setting the value of Observation Attributes in the target dataset.
396
397 |Rule|Source|Target
398 |1|(((
399 If
400
401 INDICATOR=XULADS; and TIME_PERIOD=2007.
402 )))|(((
403 Set
404
405 OBS_CONF=F
406 )))
407 |2|(((
408 If
409
410 INDICATOR=XULADS; and TIME_PERIOD=2008.
411 )))|Set OBS_CONF=F
412 |3|(((
413 If
414
415 INDICATOR=XULADS; and TIME_PERIOD=2009.
416 )))|(((
417 Set
418
419 OBS_CONF=F
420 )))
421 |4|(((
422 If
423
424 INDICATOR=XULADS; and TIME_PERIOD=2010.
425 )))|(((
426 Set
427
428 OBS_CONF=**C**
429 )))
430
431 In the example above, OBS_CONF is an Observation Attribute.
432
433 == 13. Time span mapping rules using validity periods ==
434
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
437 Instead, an optional validity period can be set for each mapping.
438
439 By specifying validity periods, the example from Section 13.8 can be re-written using two rules as follows:
440
441 |Rule|Source|Target
442 |1|(((
443 If
444
445 INDICATOR=XULADS.
446
447
448 Validity Period start period=2007 end period=2009
449 )))|Set OBS_CONF=F
450 |2|(((
451 If
452
453 INDICATOR=XULADS.
454
455
456 Validity Period start period=2010
457 )))|(((
458 Set
459
460 OBS_CONF=F
461 )))
462
463 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.
464
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
467 == 13. Mapping examples ==
468
469 === 13. Many to one mapping (N-1) ===
470
471 |Source|Map To
472 |(((
473 **FREQ**="A"
474
475 ADJUSTMENT="N"
476
477 **REF_AREA**="PL"
478
479 **COUNTERPART_AREA**="W0"
480
481 REF_SECTOR="S1"
482
483 COUNTERPART_SECTOR="S1"
484
485 ACCOUNTING_ENTRY="B"
486
487 STO="B5G"
488 )))|(((
489 FREQ="A"
490
491 REF_AREA="PL"
492
493 COUNTERPART_AREA="W0"
494 INDICATOR="IND_ABC"
495
496 )))
497
498 The bold Dimensions map from source to target verbatim. The mapping simply specifies:
499
500 FREQ => FREQ
501
502 REF_AREA=> REF_AREA
503
504 COUNTERPART_AREA=> COUNTERPART _AREA
505
506 No Representation Mapping is required. The source value simply copies across unmodified.
507
508 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:
509
510 N:S1:S1:B:B5G => IND_ABC
511
512 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.
513
514 **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.
515
516 1.
517 11.
518 111. Mapping other data types to Code Id
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.
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 If this mapping takes advantage of regular expressions it can be expressed in two rules:
532
533
534 Regular Expression Desired Output
535
536 |[0-2]|A
537 |[3-4]|B
538
539 === 13. Observation Attributes for Time Period ===
540
541 This use case is where a specific observation for a specific time period has an attribute value.
542
543 |Input INDICATOR|Input TIME_PERIOD|Output OBS_CONF
544 |XULADS|2008|C
545 |XULADS|2009|C
546 |XULADS|2010|C
547
548 Or using a validity period on the Representation Mapping:
549
550 Input INDICATOR Valid From/ Valid To Output OBS_CONF
551
552 XULADS 2008/2010 C
553
554 === 13. Time mapping ===
555
556 This use case is to create a time period from an input that does not respect SDMX Time Formats.
557
558 The Component Mapping from SYS_TIME to TIME_PERIOD specifies itself as a time mapping with the following details:
559
560 |Source Value|Source Mapping|Target Frequency|Output
561 |18/07/1981|dd/MM/yyyy|A|1981
562
563 When the target frequency is based on another target Dimension value, in this example the value of the FREQ Dimension in the target DSD.
564
565 Source Value Source Mapping Target Frequency Output
566
567 Dimension
568
569 |18/07/1981 dd/MM/yyyy FREQ| |1981-07-18 (when FREQ=D)
570 | When the source is a numerical format| |
571 |Source Value Start Period Interval|(((
572 Target
573
574 FREQ
575 )))|Output
576 |1589808220 1970 millisecond|M|2020-05
577
578 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:
579
580 Source Value Source Mapping Target Frequency Output
581
582 Dimension
583
584 1981 yyyy D – End of Period 1981-12-31
585
586
587 When the start of year is April 1^^st^^ the Structure Map has YearStart=04-01:
588
589 Source Value Source Mapping Target Frequency Output
590
591 Dimension
592
593 ----
594
595 {{putFootnotes/}}