Skip to Content

Wiki source code of 13 Structure Mapping

Version 4.10 by Helena on 2025/06/16 14:54
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.6.1 Regular expressions ===
193
194 Regular expression mapping rules are defined in the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Map.
195
196 Below is an example set of regular expression rules for a particular [[component>>doc:sdmx:Glossary.Component.WebHome]].
197
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
203
204 Like all mapping rules, the output is either a [[Code>>doc:sdmx:Glossary.Code.WebHome]], a Value or free text depending on the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[Component>>doc:sdmx:Glossary.Component.WebHome]] in the target [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
205
206 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
207
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
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 (% 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
223
224 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.
225
226 The input 'G' matches on the last rule which is used as a catch-all or default in this example.
227
228 === 13. Substrings ===
229
230 Substrings provide an alternative to regular expressions where the required section of an input value can be described using the number of the starting character, and the length of the substring in characters. The first character is at position 1.
231
232 For instance:
233
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
238
239 Sub-strings can therefore be used for the conceptual rule //If starts with 'XU' (% style="color:#e74c3c" %)map(%%) to Y// as shown in the following example:
240
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
244
245 == 13.7 Mapping non-SDMX time formats to SDMX formats ==
246
247 Structure mapping allows non-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] compliant time values in source [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] to be (% style="color:#e74c3c" %)mapped(%%) to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] compliant time format.
248
249 Two types of time input are defined:
250
251 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
252 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.
253
254 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>>doc:sdmx:Glossary.Dimension.WebHome]] or [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in the output mapping. If the output frequency is unknown or if the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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:
255
256 |Frequency|Format|Example
257 |A|YYYY|2010
258 |D|YYYY-MM-DD|2010-01-01
259 |I|(((
260 YYYY-MM-DD-
261
262 Thh:mm:ss
263 )))|2010-01T20:22:00
264 |M|YYYY-MM|2010-01
265 |Q|YYYY-Qn|2010-Q1
266 |S|YYYY-Sn|2010-S1
267 |T|YYYY-Tn|2010-T1
268 |W|YYYY-Wn|YYYY-W53
269
270 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.
271
272 There are two important points to note:
273
274 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>>doc:sdmx:Glossary.Time period.WebHome]] is formatted.
275 1. To support the use case of changing frequency the structure (% style="color:#e74c3c" %)map(%%) can optionally provide a start of year [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], which defines the year start date in MM-DD format. For example: YearStart=04-01.
276
277 === 13.7.1 Pattern based dates ===
278
279 Date and [[time formats>>doc:sdmx:Glossary.Time format.WebHome]] are specified by date and time pattern strings based on Java's Simple Date Format. Within date and time pattern strings, unquoted letters from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the [[components>>doc:sdmx:Glossary.Component.WebHome]] of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "''" represents a single quote. All other characters are not interpreted; they're simply copied into the output string during formatting or matched against the input string during parsing.
280
281 Due to the fact that dates may differ per locale, an optional property, defining the locale of the pattern, is provided. This would assist processing of source dates, according to the given locale{{footnote}} A list of commonly used locales can be found in the Java supported locales: https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html{{/footnote}}. An indicative list of examples is presented in the following table:
282
283 (% style="width:604.294px" %)
284 |(% style="width:172px" %)English (en)|(% style="width:216px" %)Australia (AU)|(% style="width:213px" %)en-AU
285 |(% style="width:172px" %)English (en)|(% style="width:216px" %)Canada (CA)|(% style="width:213px" %)en-CA
286 |(% style="width:172px" %)English (en)|(% style="width:216px" %)United Kingdom (GB)|(% style="width:213px" %)en-GB
287 |(% style="width:172px" %)English (en)|(% style="width:216px" %)United States (US)|(% style="width:213px" %)en-US
288 |(% style="width:172px" %)Estonian (et)|(% style="width:216px" %)Estonia (EE)|(% style="width:213px" %)et-EE
289 |(% style="width:172px" %)Finnish (fi)|(% style="width:216px" %)Finland (FI)|(% style="width:213px" %)fi-FI
290 |(% style="width:172px" %)French (fr)|(% style="width:216px" %)Belgium (BE)|(% style="width:213px" %)fr-BE
291 |(% style="width:172px" %)French (fr)|(% style="width:216px" %)Canada (CA)|(% style="width:213px" %)fr-CA
292 |(% style="width:172px" %)French (fr)|(% style="width:216px" %)France (FR)|(% style="width:213px" %)fr-FR
293 |(% style="width:172px" %)French (fr)|(% style="width:216px" %)Luxembourg (LU)|(% style="width:213px" %)fr-LU
294 |(% style="width:172px" %)French (fr)|(% style="width:216px" %)Switzerland (CH)|(% style="width:213px" %)fr-CH
295 |(% style="width:172px" %)German (de)|(% style="width:216px" %)Austria (AT)|(% style="width:213px" %)de-AT
296 |(% style="width:172px" %)German (de)|(% style="width:216px" %)Germany (DE)|(% style="width:213px" %)de-DE
297 |(% style="width:172px" %)German (de)|(% style="width:216px" %)Luxembourg (LU)|(% style="width:213px" %)de-LU
298 |(% style="width:172px" %)German (de)|(% style="width:216px" %)Switzerland (CH)|(% style="width:213px" %)de-CH
299 |(% style="width:172px" %)Greek (el)|(% style="width:216px" %)Cyprus (CY)|(% style="width:213px" %)el-CY(*)
300 |(% style="width:172px" %)Greek (el)|(% style="width:216px" %)Greece (GR)|(% style="width:213px" %)el-GR
301 |(% style="width:172px" %)Hebrew (iw)|(% style="width:216px" %)Israel (IL)|(% style="width:213px" %)iw-IL
302 |(% style="width:172px" %)Hindi (hi)|(% style="width:216px" %)India (IN)|(% style="width:213px" %)hi-IN
303 |(% style="width:172px" %)Hungarian (hu)|(% style="width:216px" %)Hungary (HU)|(% style="width:213px" %)hu-HU
304 |(% style="width:172px" %)Icelandic (is)|(% style="width:216px" %)Iceland (IS)|(% style="width:213px" %)is-IS
305 |(% style="width:172px" %)Indonesian (in)|(% style="width:216px" %)Indonesia (ID)|(% style="width:213px" %)in-ID(*)
306 |(% style="width:172px" %)Irish (ga)|(% style="width:216px" %)Ireland (IE)|(% style="width:213px" %)ga-IE(*)
307 |(% style="width:172px" %)Italian (it)|(% style="width:216px" %)Italy (IT)|(% style="width:213px" %)it-IT
308
309 ~* - [[https:~~/~~/www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale>>https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]]
310
311 Examples
312
313 22/06/1981 would be described as dd/MM/YYYY, with locale en-GB
314 2008-mars-12 would be described as YYYY-MMM-DD, with locale fr-FR
315 22 July 1981 would be described as dd MMMM YYYY, with locale en-US
316 22 Jul 1981 would be described as dd MMM YYYY
317 2010 D62 would be described as YYYYDnn (day 62 of the year 2010)
318
319 The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):
320
321 (% style="width:850.294px" %)
322 |(% style="width:182px" %)Letter|(% style="width:327px" %)Date or Time Component|(% style="width:180px" %)Presentation|(% style="width:157px" %)Examples
323 |(% style="width:182px" %)G|(% style="width:327px" %)Era designator|(% style="width:180px" %)Text|(% style="width:157px" %)AD
324 |(% style="width:182px" %)yy|(% style="width:327px" %)Year short (upper case is Year of Week{{footnote}}yyyy represents the calendar year while YYYY represents the year of the week, which is only relevant for 53 week years{{/footnote}})|(% style="width:180px" %)Year|(% style="width:157px" %)96
325 |(% style="width:182px" %)yyyy|(% style="width:327px" %)Year Full (upper case is Year of Week)|(% style="width:180px" %)Year|(% style="width:157px" %)1996
326 |(% style="width:182px" %)MM|(% style="width:327px" %)Month number in year starting with 1|(% style="width:180px" %)Month|(% style="width:157px" %)07
327 |(% style="width:182px" %)MMM|(% style="width:327px" %)Month name short|(% style="width:180px" %)Month|(% style="width:157px" %)Jul
328 |(% style="width:182px" %)MMMM|(% style="width:327px" %)Month name full|(% style="width:180px" %)Month|(% style="width:157px" %)July
329 |(% style="width:182px" %)ww|(% style="width:327px" %)Week in year|(% style="width:180px" %)Number|(% style="width:157px" %)27
330 |(% style="width:182px" %)W|(% style="width:327px" %)Week in month|(% style="width:180px" %)Number|(% style="width:157px" %)2
331 |(% style="width:182px" %)DD|(% style="width:327px" %)Day in year|(% style="width:180px" %)Number|(% style="width:157px" %)189
332 |(% style="width:182px" %)dd|(% style="width:327px" %)Day in month|(% style="width:180px" %)Number|(% style="width:157px" %)10
333 |(% style="width:182px" %)F|(% style="width:327px" %)Day of week in month|(% style="width:180px" %)Number|(% style="width:157px" %)2
334 |(% style="width:182px" %)E|(% style="width:327px" %)Day name in week|(% style="width:180px" %)Text|(% style="width:157px" %)Tuesday; Tue
335 |(% style="width:182px" %)U|(% style="width:327px" %)Day number of week (1 = Monday, ..., 7 = Sunday)|(% style="width:180px" %)Number|(% style="width:157px" %)1
336 |(% style="width:182px" %)HH|(% style="width:327px" %)Hour in day (0-23)|(% style="width:180px" %)Number|(% style="width:157px" %)0
337 |(% style="width:182px" %)kk|(% style="width:327px" %)Hour in day (1-24)|(% style="width:180px" %)Number|(% style="width:157px" %)24
338 |(% style="width:182px" %)KK|(% style="width:327px" %)Hour in am/pm (0-11)|(% style="width:180px" %)Number|(% style="width:157px" %)0
339 |(% style="width:182px" %)hh|(% style="width:327px" %)Hour in am/pm (1-12)|(% style="width:180px" %)Number|(% style="width:157px" %)12
340 |(% style="width:182px" %)mm|(% style="width:327px" %)Minute in hour|(% style="width:180px" %)Number|(% style="width:157px" %)30
341 |(% style="width:182px" %)ss|(% style="width:327px" %)Second in minute|(% style="width:180px" %)Number|(% style="width:157px" %)55
342 |(% style="width:182px" %)S|(% style="width:327px" %)Millisecond|(% style="width:180px" %)Number|(% style="width:157px" %)978
343 |(% style="width:182px" %)n|(% style="width:327px" %)(((
344 Number of periods, used after a SDMX
345
346 Frequency Identifier such as M, Q, D (month, quarter, day)
347 )))|(% style="width:180px" %)Number|(% style="width:157px" %)12
348
349 The model is illustrated below:
350
351 [[image:1750074822764-573.png]]
352
353 **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?**
354
355 [[image:1750074865924-797.png]]
356
357 (% class="wikigeneratedid" id="HFigure25showinganinputdateformat2CwhoseoutputfrequencyisderivedfromtheoutputvalueoftheFREQDimension" %)
358 **Figure 25 showing an input date format, whose output frequency is derived from the output value of the FREQ Dimension**
359
360 === 13.7.2 Numerical based datetime ===
361
362 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:
363
364 * day
365 * second
366 * millisecond
367 * microsecond
368 * nanosecond
369
370 |Numerical datetime systems|Base|Period
371 |(((
372 Epoch Time (UNIX)
373
374 Milliseconds since 01 Jan 1970
375 )))|1970|millisecond
376 |(((
377 Windows System Time
378
379 Milliseconds since 01 Jan 1601
380 )))|1601|millisecond
381
382 The example above illustrates numerical based datetime mapping rules for two commonly used time standards.
383
384 The model is illustrated below:
385
386 [[image:1750072341491-790.jpeg]]
387
388 **Figure 26 showing the component map mapping the SOURCE_DATE Dimension to the**
389
390 ==== TIME_PERIOD Dimension with the additional information on the component map to describe the numerical datetime system in use ====
391
392 === Mapping more complex time inputs ===
393
394 VTL should be used for more complex time inputs that cannot be interpreted using the pattern based on numerical methods.
395
396 == Using TIME_PERIOD in mapping rules ==
397
398 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.
399
400 The main use case is setting the value of Observation Attributes in the target dataset.
401
402 |Rule|Source|Target
403 |1|(((
404 If
405
406 INDICATOR=XULADS; and TIME_PERIOD=2007.
407 )))|(((
408 Set
409
410 OBS_CONF=F
411 )))
412 |2|(((
413 If
414
415 INDICATOR=XULADS; and TIME_PERIOD=2008.
416 )))|Set OBS_CONF=F
417 |3|(((
418 If
419
420 INDICATOR=XULADS; and TIME_PERIOD=2009.
421 )))|(((
422 Set
423
424 OBS_CONF=F
425 )))
426 |4|(((
427 If
428
429 INDICATOR=XULADS; and TIME_PERIOD=2010.
430 )))|(((
431 Set
432
433 OBS_CONF=**C**
434 )))
435
436 In the example above, OBS_CONF is an Observation Attribute.
437
438 == 13. Time span mapping rules using validity periods ==
439
440 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.
441
442 Instead, an optional validity period can be set for each mapping.
443
444 By specifying validity periods, the example from Section 13.8 can be re-written using two rules as follows:
445
446 |Rule|Source|Target
447 |1|(((
448 If
449
450 INDICATOR=XULADS.
451
452
453 Validity Period start period=2007 end period=2009
454 )))|Set OBS_CONF=F
455 |2|(((
456 If
457
458 INDICATOR=XULADS.
459
460
461 Validity Period start period=2010
462 )))|(((
463 Set
464
465 OBS_CONF=F
466 )))
467
468 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.
469
470 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.
471
472 == 13. Mapping examples ==
473
474 === 13. Many to one mapping (N-1) ===
475
476 |Source|Map To
477 |(((
478 **FREQ**="A"
479
480 ADJUSTMENT="N"
481
482 **REF_AREA**="PL"
483
484 **COUNTERPART_AREA**="W0"
485
486 REF_SECTOR="S1"
487
488 COUNTERPART_SECTOR="S1"
489
490 ACCOUNTING_ENTRY="B"
491
492 STO="B5G"
493 )))|(((
494 FREQ="A"
495
496 REF_AREA="PL"
497
498 COUNTERPART_AREA="W0"
499 INDICATOR="IND_ABC"
500
501 )))
502
503 The bold Dimensions map from source to target verbatim. The mapping simply specifies:
504
505 FREQ => FREQ
506
507 REF_AREA=> REF_AREA
508
509 COUNTERPART_AREA=> COUNTERPART _AREA
510
511 No Representation Mapping is required. The source value simply copies across unmodified.
512
513 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:
514
515 N:S1:S1:B:B5G => IND_ABC
516
517 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.
518
519 **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.
520
521 1.
522 11.
523 111. Mapping other data types to Code Id
524
525 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.
526
527 The following representation mapping can be used to explicitly map each age to an output code.
528
529 |Source Input Free Text|Desired Output Code Id
530 |0|A
531 |1|A
532 |2|A
533 |3|B
534 |4|B
535
536 If this mapping takes advantage of regular expressions it can be expressed in two rules:
537
538
539 Regular Expression Desired Output
540
541 |[0-2]|A
542 |[3-4]|B
543
544 === 13. Observation Attributes for Time Period ===
545
546 This use case is where a specific observation for a specific time period has an attribute value.
547
548 |Input INDICATOR|Input TIME_PERIOD|Output OBS_CONF
549 |XULADS|2008|C
550 |XULADS|2009|C
551 |XULADS|2010|C
552
553 Or using a validity period on the Representation Mapping:
554
555 Input INDICATOR Valid From/ Valid To Output OBS_CONF
556
557 XULADS 2008/2010 C
558
559 === 13. Time mapping ===
560
561 This use case is to create a time period from an input that does not respect SDMX Time Formats.
562
563 The Component Mapping from SYS_TIME to TIME_PERIOD specifies itself as a time mapping with the following details:
564
565 |Source Value|Source Mapping|Target Frequency|Output
566 |18/07/1981|dd/MM/yyyy|A|1981
567
568 When the target frequency is based on another target Dimension value, in this example the value of the FREQ Dimension in the target DSD.
569
570 Source Value Source Mapping Target Frequency Output
571
572 Dimension
573
574 |18/07/1981 dd/MM/yyyy FREQ| |1981-07-18 (when FREQ=D)
575 | When the source is a numerical format| |
576 |Source Value Start Period Interval|(((
577 Target
578
579 FREQ
580 )))|Output
581 |1589808220 1970 millisecond|M|2020-05
582
583 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:
584
585 Source Value Source Mapping Target Frequency Output
586
587 Dimension
588
589 1981 yyyy D – End of Period 1981-12-31
590
591
592 When the start of year is April 1^^st^^ the Structure Map has YearStart=04-01:
593
594 Source Value Source Mapping Target Frequency Output
595
596 Dimension
597
598 ----
599
600 {{putFootnotes/}}