Skip to Content

Wiki source code of 13 Structure Mapping

Version 4.12 by Helena on 2025/06/16 14:56
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
Helena 4.5 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]].
Helena 1.1 40
Helena 4.5 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
Helena 1.1 48
49 == 13.3 N-n structure maps ==
50
Helena 4.5 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.
Helena 1.1 52
53 Example:
54
Helena 4.5 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" %)(((
Helena 1.1 58 If
Helena 4.5 59 FREQUENCY=A; and
60 ADJUSTMENT=N; and
61 MATURITY=L.
62 )))|(% style="width:378px" %)(((
Helena 1.1 63 Set
64 INDICATOR=A_N_L
65 )))
Helena 4.5 66 |(% style="width:65px" %)2|(% style="width:519px" %)(((
Helena 1.1 67 If
Helena 4.5 68 FREQUENCY=M; and
69 ADJUSTMENT=S_A1; and
70 MATURITY=TY12.
71 )))|(% style="width:378px" %)(((
Helena 1.1 72 Set
73 INDICATOR=MON_SAX_12
74 )))
75
76 N-n rules can also set values for multiple source Components.
77
Helena 4.5 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" %)(((
Helena 1.1 81 If
82 FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
Helena 4.5 83 )))|(% style="width:383px" %)(((
Helena 1.1 84 Set
85 INDICATOR=A_N_L, STATUS=QXR15,
86 NOTE="Unadjusted".
87 )))
Helena 4.5 88 |(% style="width:73px" %)2|(% style="width:506px" %)(((
Helena 1.1 89 If
90 FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
Helena 4.5 91 )))|(% style="width:383px" %)(((
Helena 1.1 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
Helena 4.5 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" %)(((
Helena 1.1 107 Dimensions
108 INDICATOR=XM
109 FREQ=A
110 ADJUSTMENT=N
111 Attributes
112 UNIT_MEASURE=_Z
113 COMP_ORG=21
Helena 4.5 114 )))|(% style="width:397px" %)XM:A:N
115 |(% style="width:257px" %)(((
Helena 1.1 116 SERIES_CODE=XMAN_Z_34
117
118
Helena 4.5 119 )))|(% style="width:315px" %)(((
Helena 1.1 120 Dimensions
121 INDICATOR=XM
122 FREQ=A
123 ADJUSTMENT=N
124 Attributes
125 UNIT_MEASURE=_Z
126 COMP_ORG=34
Helena 4.5 127 )))|(% style="width:397px" %)XM:A:N
Helena 1.1 128
Helena 4.5 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.
Helena 1.1 130
131 == 13.5 Representation maps ==
132
Helena 4.5 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.
Helena 1.1 134
Helena 4.5 135 The source and target of a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) can reference any of the following:
Helena 1.1 136
137 1. Codelist
138 1. Free Text (restricted by type, e.g String, Integer, Boolean)
139 1. Valuelist
140
Helena 4.5 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:
Helena 1.1 142
Helena 4.5 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" %)
Helena 1.1 151
Helena 4.5 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:
Helena 1.1 153
Helena 4.5 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" %)
Helena 1.1 163
Helena 4.5 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.
Helena 1.1 165
Helena 4.5 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.
Helena 1.1 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
Helena 4.5 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
Helena 1.1 175
Helena 4.5 176 Other characteristics of [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%):
Helena 1.1 177
Helena 4.5 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.
Helena 1.1 181
Helena 4.5 182 == 13.6 Regular expression and substring rules ==
Helena 1.1 183
Helena 4.5 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.
Helena 1.1 185
Helena 4.5 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
Helena 1.1 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
Helena 4.7 192 === 13.6.1 Regular expressions ===
Helena 1.1 193
Helena 4.7 194 Regular expression mapping rules are defined in the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Map.
Helena 1.1 195
Helena 4.7 196 Below is an example set of regular expression rules for a particular [[component>>doc:sdmx:Glossary.Component.WebHome]].
Helena 1.1 197
Helena 4.6 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
Helena 1.1 203
Helena 4.7 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]].
Helena 1.1 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
Helena 4.6 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
Helena 1.1 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
Helena 4.6 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
Helena 1.1 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
Helena 4.6 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
Helena 1.1 238
Helena 4.8 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:
Helena 1.1 240
Helena 4.6 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
Helena 1.1 244
Helena 4.8 245 == 13.7 Mapping non-SDMX time formats to SDMX formats ==
Helena 1.1 246
Helena 4.8 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.
Helena 1.1 248
249 Two types of time input are defined:
250
Helena 4.8 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.
Helena 1.1 253
Helena 4.8 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:
Helena 1.1 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
Helena 4.8 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.
Helena 1.1 276
Helena 4.8 277 === 13.7.1 Pattern based dates ===
Helena 1.1 278
Helena 4.8 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
Helena 4.2 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:
Helena 1.1 282
Helena 4.9 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
Helena 1.1 308
Helena 4.9 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
Helena 1.1 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
Helena 4.10 321 (% style="width:850.294px" %)
Helena 4.11 322 |(% style="width:125px" %)**Letter**|(% style="width:385px" %)**Date or Time Component**|(% style="width:180px" %)**Presentation**|(% style="width:157px" %)**Examples**
323 |(% style="width:125px" %)G|(% style="width:385px" %)Era designator|(% style="width:180px" %)Text|(% style="width:157px" %)AD
324 |(% style="width:125px" %)yy|(% style="width:385px" %)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:125px" %)yyyy|(% style="width:385px" %)Year Full (upper case is Year of Week)|(% style="width:180px" %)Year|(% style="width:157px" %)1996
326 |(% style="width:125px" %)MM|(% style="width:385px" %)Month number in year starting with 1|(% style="width:180px" %)Month|(% style="width:157px" %)07
327 |(% style="width:125px" %)MMM|(% style="width:385px" %)Month name short|(% style="width:180px" %)Month|(% style="width:157px" %)Jul
328 |(% style="width:125px" %)MMMM|(% style="width:385px" %)Month name full|(% style="width:180px" %)Month|(% style="width:157px" %)July
329 |(% style="width:125px" %)ww|(% style="width:385px" %)Week in year|(% style="width:180px" %)Number|(% style="width:157px" %)27
330 |(% style="width:125px" %)W|(% style="width:385px" %)Week in month|(% style="width:180px" %)Number|(% style="width:157px" %)2
331 |(% style="width:125px" %)DD|(% style="width:385px" %)Day in year|(% style="width:180px" %)Number|(% style="width:157px" %)189
332 |(% style="width:125px" %)dd|(% style="width:385px" %)Day in month|(% style="width:180px" %)Number|(% style="width:157px" %)10
333 |(% style="width:125px" %)F|(% style="width:385px" %)Day of week in month|(% style="width:180px" %)Number|(% style="width:157px" %)2
334 |(% style="width:125px" %)E|(% style="width:385px" %)Day name in week|(% style="width:180px" %)Text|(% style="width:157px" %)Tuesday; Tue
335 |(% style="width:125px" %)U|(% style="width:385px" %)Day number of week (1 = Monday, ..., 7 = Sunday)|(% style="width:180px" %)Number|(% style="width:157px" %)1
336 |(% style="width:125px" %)HH|(% style="width:385px" %)Hour in day (0-23)|(% style="width:180px" %)Number|(% style="width:157px" %)0
337 |(% style="width:125px" %)kk|(% style="width:385px" %)Hour in day (1-24)|(% style="width:180px" %)Number|(% style="width:157px" %)24
338 |(% style="width:125px" %)KK|(% style="width:385px" %)Hour in am/pm (0-11)|(% style="width:180px" %)Number|(% style="width:157px" %)0
339 |(% style="width:125px" %)hh|(% style="width:385px" %)Hour in am/pm (1-12)|(% style="width:180px" %)Number|(% style="width:157px" %)12
340 |(% style="width:125px" %)mm|(% style="width:385px" %)Minute in hour|(% style="width:180px" %)Number|(% style="width:157px" %)30
341 |(% style="width:125px" %)ss|(% style="width:385px" %)Second in minute|(% style="width:180px" %)Number|(% style="width:157px" %)55
342 |(% style="width:125px" %)S|(% style="width:385px" %)Millisecond|(% style="width:180px" %)Number|(% style="width:157px" %)978
343 |(% style="width:125px" %)n|(% style="width:385px" %)(((
Helena 1.1 344 Number of periods, used after a SDMX
345 Frequency Identifier such as M, Q, D (month, quarter, day)
Helena 4.10 346 )))|(% style="width:180px" %)Number|(% style="width:157px" %)12
Helena 1.1 347
348 The model is illustrated below:
349
Helena 4.10 350 [[image:1750074822764-573.png]]
Helena 1.1 351
352 **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?**
353
Helena 4.10 354 [[image:1750074865924-797.png]]
Helena 1.1 355
Helena 4.10 356 (% class="wikigeneratedid" id="HFigure25showinganinputdateformat2CwhoseoutputfrequencyisderivedfromtheoutputvalueoftheFREQDimension" %)
357 **Figure 25 showing an input date format, whose output frequency is derived from the output value of the FREQ Dimension**
Helena 1.1 358
Helena 4.10 359 === 13.7.2 Numerical based datetime ===
Helena 1.1 360
Helena 4.12 361 Where the source datetime input is purely numerical, the mapping rules are defined by the **Base** as a valid [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]], and the **Period** which must take one of the following enumerated values:
Helena 1.1 362
363 * day
364 * second
365 * millisecond
366 * microsecond
367 * nanosecond
368
Helena 4.12 369 (% style="width:545.294px" %)
370 |(% style="width:268px" %)Numerical datetime systems|(% style="width:121px" %)Base|(% style="width:153px" %)Period
371 |(% style="width:268px" %)(((
Helena 1.1 372 Epoch Time (UNIX)
373 Milliseconds since 01 Jan 1970
Helena 4.12 374 )))|(% style="width:121px" %)1970|(% style="width:153px" %)millisecond
375 |(% style="width:268px" %)(((
Helena 1.1 376 Windows System Time
377 Milliseconds since 01 Jan 1601
Helena 4.12 378 )))|(% style="width:121px" %)1601|(% style="width:153px" %)millisecond
Helena 1.1 379
380 The example above illustrates numerical based datetime mapping rules for two commonly used time standards.
381
382 The model is illustrated below:
383
384
385 **Figure 26 showing the component map mapping the SOURCE_DATE Dimension to the**
386
387 ==== TIME_PERIOD Dimension with the additional information on the component map to describe the numerical datetime system in use ====
388
389 === Mapping more complex time inputs ===
390
391 VTL should be used for more complex time inputs that cannot be interpreted using the pattern based on numerical methods.
392
393 == Using TIME_PERIOD in mapping rules ==
394
395 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.
396
397 The main use case is setting the value of Observation Attributes in the target dataset.
398
399 |Rule|Source|Target
400 |1|(((
401 If
402
403 INDICATOR=XULADS; and TIME_PERIOD=2007.
404 )))|(((
405 Set
406
407 OBS_CONF=F
408 )))
409 |2|(((
410 If
411
412 INDICATOR=XULADS; and TIME_PERIOD=2008.
413 )))|Set OBS_CONF=F
414 |3|(((
415 If
416
417 INDICATOR=XULADS; and TIME_PERIOD=2009.
418 )))|(((
419 Set
420
421 OBS_CONF=F
422 )))
423 |4|(((
424 If
425
426 INDICATOR=XULADS; and TIME_PERIOD=2010.
427 )))|(((
428 Set
429
430 OBS_CONF=**C**
431 )))
432
433 In the example above, OBS_CONF is an Observation Attribute.
434
435 == 13. Time span mapping rules using validity periods ==
436
437 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.
438
439 Instead, an optional validity period can be set for each mapping.
440
441 By specifying validity periods, the example from Section 13.8 can be re-written using two rules as follows:
442
443 |Rule|Source|Target
444 |1|(((
445 If
446
447 INDICATOR=XULADS.
448
449
450 Validity Period start period=2007 end period=2009
451 )))|Set OBS_CONF=F
452 |2|(((
453 If
454
455 INDICATOR=XULADS.
456
457
458 Validity Period start period=2010
459 )))|(((
460 Set
461
462 OBS_CONF=F
463 )))
464
465 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.
466
467 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.
468
469 == 13. Mapping examples ==
470
471 === 13. Many to one mapping (N-1) ===
472
473 |Source|Map To
474 |(((
475 **FREQ**="A"
476
477 ADJUSTMENT="N"
478
479 **REF_AREA**="PL"
480
481 **COUNTERPART_AREA**="W0"
482
483 REF_SECTOR="S1"
484
485 COUNTERPART_SECTOR="S1"
486
487 ACCOUNTING_ENTRY="B"
488
489 STO="B5G"
490 )))|(((
491 FREQ="A"
492
493 REF_AREA="PL"
494
495 COUNTERPART_AREA="W0"
496 INDICATOR="IND_ABC"
497
498 )))
499
500 The bold Dimensions map from source to target verbatim. The mapping simply specifies:
501
502 FREQ => FREQ
503
504 REF_AREA=> REF_AREA
505
506 COUNTERPART_AREA=> COUNTERPART _AREA
507
508 No Representation Mapping is required. The source value simply copies across unmodified.
509
510 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:
511
512 N:S1:S1:B:B5G => IND_ABC
513
514 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.
515
516 **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.
517
Helena 4.8 518 1.
519 11.
Helena 1.1 520 111. Mapping other data types to Code Id
521
522 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.
523
524 The following representation mapping can be used to explicitly map each age to an output code.
525
526 |Source Input Free Text|Desired Output Code Id
527 |0|A
528 |1|A
529 |2|A
530 |3|B
531 |4|B
532
533 If this mapping takes advantage of regular expressions it can be expressed in two rules:
534
535
536 Regular Expression Desired Output
537
538 |[0-2]|A
539 |[3-4]|B
540
541 === 13. Observation Attributes for Time Period ===
542
543 This use case is where a specific observation for a specific time period has an attribute value.
544
545 |Input INDICATOR|Input TIME_PERIOD|Output OBS_CONF
546 |XULADS|2008|C
547 |XULADS|2009|C
548 |XULADS|2010|C
549
550 Or using a validity period on the Representation Mapping:
551
552 Input INDICATOR Valid From/ Valid To Output OBS_CONF
553
554 XULADS 2008/2010 C
555
556 === 13. Time mapping ===
557
558 This use case is to create a time period from an input that does not respect SDMX Time Formats.
559
560 The Component Mapping from SYS_TIME to TIME_PERIOD specifies itself as a time mapping with the following details:
561
562 |Source Value|Source Mapping|Target Frequency|Output
563 |18/07/1981|dd/MM/yyyy|A|1981
564
565 When the target frequency is based on another target Dimension value, in this example the value of the FREQ Dimension in the target DSD.
566
567 Source Value Source Mapping Target Frequency Output
568
569 Dimension
570
571 |18/07/1981 dd/MM/yyyy FREQ| |1981-07-18 (when FREQ=D)
572 | When the source is a numerical format| |
573 |Source Value Start Period Interval|(((
574 Target
575
576 FREQ
577 )))|Output
578 |1589808220 1970 millisecond|M|2020-05
579
580 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:
581
582 Source Value Source Mapping Target Frequency Output
583
584 Dimension
585
586 1981 yyyy D – End of Period 1981-12-31
587
588
589 When the start of year is April 1^^st^^ the Structure Map has YearStart=04-01:
590
591 Source Value Source Mapping Target Frequency Output
592
593 Dimension
594
595 ----
596
Helena 4.2 597 {{putFootnotes/}}