Skip to Content

Changes for page 13 Structure Mapping

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

Summary

Details

Page properties
Content
... ... @@ -36,66 +36,62 @@
36 36  |(% style="width:173px" %)Andorra|(% style="width:180px" %)AD|(% style="width:229px" %)AND
37 37  |(% style="width:173px" %)etc…|(% style="width:180px" %) |(% style="width:229px" %)
38 38  
39 -Different source values can also map to the same target value, for example when deriving regions from country codes.
39 +Different source values can also (% style="color:#e74c3c" %)map(%%) to the same target value, for example when deriving regions from country [[codes>>doc:sdmx:Glossary.Code.WebHome]].
40 40  
41 -|Source Component: REF_AREA|Target Component: REGION
42 -|FR|EUR
43 -|DE|EUR
44 -|IT|EUR
45 -|ES|EUR
46 -|BE|EUR
41 +(% style="width:490.294px" %)
42 +|(% style="width:260px" %)Source Component: REF_AREA|(% style="width:227px" %)Target Component: REGION
43 +|(% style="width:260px" %)FR|(% style="width:227px" %)EUR
44 +|(% style="width:260px" %)DE|(% style="width:227px" %)EUR
45 +|(% style="width:260px" %)IT|(% style="width:227px" %)EUR
46 +|(% style="width:260px" %)ES|(% style="width:227px" %)EUR
47 +|(% style="width:260px" %)BE|(% style="width:227px" %)EUR
47 47  
48 48  == 13.3 N-n structure maps ==
49 49  
50 -N-n (pronounced 'N to N') mappings describe rules where a specified combination of values in multiple source Components map to specified values in one or more target Components. For example, when mapping a partial Series Key from a highly multidimensional cube (like Balance of Payments) to a single 'Indicator' Dimension in a target Data Structure.
51 +N-n (pronounced 'N to N') mappings describe rules where a specified combination of values in multiple source [[Components>>doc:sdmx:Glossary.Component.WebHome]] (% style="color:#e74c3c" %)map(%%) to specified values in one or more target [[Components>>doc:sdmx:Glossary.Component.WebHome]]. For example, when mapping a partial [[Series Key>>doc:sdmx:Glossary.Series key.WebHome]] from a highly multidimensional cube (like Balance of Payments) to a single 'Indicator' [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in a target Data Structure.
51 51  
52 52  Example:
53 53  
54 -|Rule|Source|Target
55 -|1|(((
55 +(% style="width:964.294px" %)
56 +|(% style="width:65px" %)Rule|(% style="width:519px" %)Source|(% style="width:378px" %)Target
57 +|(% style="width:65px" %)1|(% style="width:519px" %)(((
56 56  If
57 -
58 -FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
59 -)))|(((
59 +FREQUENCY=A; and
60 +ADJUSTMENT=N; and
61 +MATURITY=L.
62 +)))|(% style="width:378px" %)(((
60 60  Set
61 -
62 62  INDICATOR=A_N_L
63 63  )))
64 -|2|(((
66 +|(% style="width:65px" %)2|(% style="width:519px" %)(((
65 65  If
66 -
67 -FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
68 -)))|(((
68 +FREQUENCY=M; and
69 +ADJUSTMENT=S_A1; and
70 +MATURITY=TY12.
71 +)))|(% style="width:378px" %)(((
69 69  Set
70 -
71 71  INDICATOR=MON_SAX_12
72 72  )))
73 73  
74 74  N-n rules can also set values for multiple source Components.
75 75  
76 -|Rule|Source|Target
77 -|1|(((
78 +(% style="width:965.294px" %)
79 +|(% style="width:73px" %)Rule|(% style="width:506px" %)Source|(% style="width:383px" %)Target
80 +|(% style="width:73px" %)1|(% style="width:506px" %)(((
78 78  If
79 -
80 80  FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
81 -)))|(((
83 +)))|(% style="width:383px" %)(((
82 82  Set
83 -
84 84  INDICATOR=A_N_L, STATUS=QXR15,
85 -
86 86  NOTE="Unadjusted".
87 87  )))
88 -|2|(((
88 +|(% style="width:73px" %)2|(% style="width:506px" %)(((
89 89  If
90 -
91 91  FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
92 -)))|(((
91 +)))|(% style="width:383px" %)(((
93 93  Set
94 -
95 95  INDICATOR=MON_SAX_12,
96 -
97 97  STATUS=MPM12,
98 -
99 99  NOTE="Seasonally Adjusted"
100 100  )))
101 101  
... ... @@ -105,127 +105,125 @@
105 105  
106 106  A simple example mapping a source dataset with a single dimension to one with multiple dimensions is shown below:
107 107  
108 -|Source|Target|Output Series Key
109 -|SERIES_CODE=XMAN_Z_21|(((
104 +(% style="width:972.294px" %)
105 +|(% style="width:257px" %)Source|(% style="width:315px" %)Target|(% style="width:397px" %)Output Series Key
106 +|(% style="width:257px" %)SERIES_CODE=XMAN_Z_21|(% style="width:315px" %)(((
110 110  Dimensions
111 -
112 112  INDICATOR=XM
113 113  FREQ=A
114 114  ADJUSTMENT=N
115 115  Attributes
116 116  UNIT_MEASURE=_Z
117 -
118 118  COMP_ORG=21
119 -)))|XM:A:N
120 -|(((
114 +)))|(% style="width:397px" %)XM:A:N
115 +|(% style="width:257px" %)(((
121 121  SERIES_CODE=XMAN_Z_34
122 122  
123 123  
124 -)))|(((
119 +)))|(% style="width:315px" %)(((
125 125  Dimensions
126 -
127 127  INDICATOR=XM
128 -
129 129  FREQ=A
130 -
131 131  ADJUSTMENT=N
132 -
133 133  Attributes
134 -
135 135  UNIT_MEASURE=_Z
136 -
137 137  COMP_ORG=34
138 -)))|XM:A:N
127 +)))|(% style="width:397px" %)XM:A:N
139 139  
140 -The above behaviour can be okay if the series XMAN_Z_21 contains observations for different periods of time then the series XMAN_Z_34. If however both series contain observations for the same point in time, the output for this mapping will be two observations with the same series key, for the same period in time.
129 +The above behaviour can be okay if the series XMAN_Z_21 contains observations for different periods of time then the series XMAN_Z_34. If however both series contain observations for the same point in time, the output for this mapping will be two observations with the same [[series key>>doc:sdmx:Glossary.Series key.WebHome]], for the same period in time.
141 141  
142 142  == 13.5 Representation maps ==
143 143  
144 -Representation Maps replace the SDMX 2.1 Codelist Maps and are used describe explicit mappings between source and target Component values.
133 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%) replace the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 Codelist (% style="color:#e74c3c" %)Maps(%%) and are used describe explicit mappings between source and target [[Component>>doc:sdmx:Glossary.Component.WebHome]] values.
145 145  
146 -The source and target of a Representation Map can reference any of the following:
135 +The source and target of a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) can reference any of the following:
147 147  
148 148  1. Codelist
149 149  1. Free Text (restricted by type, e.g String, Integer, Boolean)
150 150  1. Valuelist
151 151  
152 -A Representation Map mapping ISO 2-character to ISO 3-character Codelists would take the following form:
141 +A [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) mapping ISO 2-character to ISO 3-character Codelists would take the following form:
153 153  
154 -|CL_ISO_ALPHA2|CL_ISO_ALPHA3
155 -|AF|AFG
156 -|AL|ALB
157 -|DZ|DZA
158 -|AS|ASM
159 -|AD|AND
160 -|etc…|
143 +(% style="width:356.294px" %)
144 +|(% style="width:167px" %)CL_ISO_ALPHA2|(% style="width:186px" %)CL_ISO_ALPHA3
145 +|(% style="width:167px" %)AF|(% style="width:186px" %)AFG
146 +|(% style="width:167px" %)AL|(% style="width:186px" %)ALB
147 +|(% style="width:167px" %)DZ|(% style="width:186px" %)DZA
148 +|(% style="width:167px" %)AS|(% style="width:186px" %)ASM
149 +|(% style="width:167px" %)AD|(% style="width:186px" %)AND
150 +|(% style="width:167px" %)etc…|(% style="width:186px" %)
161 161  
162 -A Representation Map mapping free text country names to an ISO 2-character Codelist could be similarly described:
152 +A [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) mapping free text country names to an ISO 2-character Codelist could be similarly described:
163 163  
164 -|Text|CL_ISO_ALPHA2
165 -|"Germany"|DE
166 -|"France"|FR
167 -|"United Kingdom"|GB
168 -|"Great Britain"|GB
169 -|"Ireland"|IE
170 -|"Eire"|IE
171 -|etc…|
154 +(% style="width:364.294px" %)
155 +|(% style="width:169px" %)Text|(% style="width:192px" %)CL_ISO_ALPHA2
156 +|(% style="width:169px" %)"Germany"|(% style="width:192px" %)DE
157 +|(% style="width:169px" %)"France"|(% style="width:192px" %)FR
158 +|(% style="width:169px" %)"United Kingdom"|(% style="width:192px" %)GB
159 +|(% style="width:169px" %)"Great Britain"|(% style="width:192px" %)GB
160 +|(% style="width:169px" %)"Ireland"|(% style="width:192px" %)IE
161 +|(% style="width:169px" %)"Eire"|(% style="width:192px" %)IE
162 +|(% style="width:169px" %)etc…|(% style="width:192px" %)
172 172  
173 -Valuelists, introduced in SDMX 3.0, are equivalent to Codelists but allow the maintenance of non-SDMX identifiers. Importantly, their IDs do not need to conform to IDType, but as a consequence are not Identifiable.
164 +Valuelists, introduced in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, are equivalent to Codelists but allow the maintenance of non-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] identifiers. Importantly, their IDs do not need to conform to IDType, but as a consequence are not Identifiable.
174 174  
175 -When used in Representation Maps, Valuelists allow Non-SDMX identifiers containing characters like £, $, % to be mapped to Code IDs, or Codes mapped to non-SDMX identifiers.
166 +When used in [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%), Valuelists allow Non-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] identifiers containing characters like £, $, % to be (% style="color:#e74c3c" %)mapped(%%) to [[Code>>doc:sdmx:Glossary.Code.WebHome]] IDs, or [[Codes>>doc:sdmx:Glossary.Code.WebHome]] (% style="color:#e74c3c" %)mapped(%%) to non-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] identifiers.
176 176  
177 177  In common with Codelists, each item in a Valuelist has a multilingual name giving it a human-readable label and an optional description. For example:
178 178  
179 -|Value|Locale|Name
180 -|$|en|United States Dollar
181 -|%|En|Percentage
182 -| |fr|Pourcentage
170 +(% style="width:435.294px" %)
171 +|(% style="width:126px" %)Value|(% style="width:133px" %)Locale|(% style="width:173px" %)Name
172 +|(% style="width:126px" %)$|(% style="width:133px" %)en|(% style="width:173px" %)United States Dollar
173 +|(% style="width:126px" %)%|(% style="width:133px" %)En|(% style="width:173px" %)Percentage
174 +|(% style="width:126px" %) |(% style="width:133px" %)fr|(% style="width:173px" %)Pourcentage
183 183  
184 -Other characteristics of Representation Maps:
176 +Other characteristics of [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%):
185 185  
186 -* Support the mapping of multiple source Component values to multiple Target Component values as described in section 13.3 on n-to-n mappings; this covers also the case of mapping an Attribute with an array representation to map combinations of values to a single target value;
187 -* Allow source or target mappings for an Item to be optional allowing rules such as 'A maps to nothing' or 'nothing maps to A'; and
188 -* Support for mapping rules where regular expressions or substrings are used to match source Component values. Refer to section 13.6 for more on this topic.
189 -*1. Regular expression and substring rules
178 +* Support the (% style="color:#e74c3c" %)mapping(%%) of multiple source [[Component>>doc:sdmx:Glossary.Component.WebHome]] values to multiple Target [[Component>>doc:sdmx:Glossary.Component.WebHome]] values as described in section 13.3 on n-to-n mappings; this covers also the case of (% style="color:#e74c3c" %)mapping(%%) an [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with an array [[representation>>doc:sdmx:Glossary.Representation.WebHome]] to (% style="color:#e74c3c" %)map(%%) combinations of values to a single target value;
179 +* Allow source or target mappings for an Item to be optional allowing rules such as 'A (% style="color:#e74c3c" %)maps(%%) to nothing' or 'nothing (% style="color:#e74c3c" %)maps(%%) to A'; and
180 +* Support for (% style="color:#e74c3c" %)mapping(%%) rules where regular expressions or substrings are used to match source [[Component>>doc:sdmx:Glossary.Component.WebHome]] values. Refer to section 13.6 for more on this topic.
190 190  
191 -It is common for classifications to contain meanings within the identifier, for example the code Id 'XULADS' may refer to a particular seasonality because it starts with the letters XU.
182 +== 13.6 Regular expression and substring rules ==
192 192  
193 -With SDMX 2.1 each code that starts with XU had to be individually mapped to the same seasonality, and additional mappings added when new Codes were added to the Codelists. This led to many hundreds or thousands of mappings which can be more efficiently summarised in a single conceptual rule:
184 +It is common for classifications to contain meanings within the identifier, for example the [[code>>doc:sdmx:Glossary.Code.WebHome]] Id 'XULADS' may refer to a particular seasonality because it starts with the letters XU.
194 194  
186 +With [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 each [[code>>doc:sdmx:Glossary.Code.WebHome]] that starts with XU had to be individually (% style="color:#e74c3c" %)mapped(%%) to the same seasonality, and additional mappings added when new [[Codes>>doc:sdmx:Glossary.Code.WebHome]] were added to the Codelists. This led to many hundreds or thousands of mappings which can be more efficiently summarised in a single conceptual rule:
187 +
195 195  //If starts with 'XU' map to 'Y'//
196 196  
197 197  These rules are described using either regular expressions, or substrings for simpler use cases.
198 198  
199 -=== 13.5.1 Regular expressions ===
192 +=== 13.6.1 Regular expressions ===
200 200  
201 -Regular expression mapping rules are defined in the Representation Map.
194 +Regular expression mapping rules are defined in the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Map.
202 202  
203 -Below is an example set of regular expression rules for a particular component.
196 +Below is an example set of regular expression rules for a particular [[component>>doc:sdmx:Glossary.Component.WebHome]].
204 204  
205 -|Regex|Description|Output
206 -|A|Rule match if input = 'A'|OUT_A
207 -|^[A-G]|Rule match if the input starts with letters A to G|OUT_B
208 -|A~|B|Rule match if input is either 'A' or 'B'|OUT_C
198 +(% style="width:664.294px" %)
199 +|(% style="width:141px" %)**Regex**|(% style="width:362px" %)**Description**|(% style="width:158px" %)**Output**
200 +|(% style="width:141px" %)A|(% style="width:362px" %)Rule match if input = 'A'|(% style="width:158px" %)OUT_A
201 +|(% style="width:141px" %)^[A-G]|(% style="width:362px" %)Rule match if the input starts with letters A to G|(% style="width:158px" %)OUT_B
202 +|(% style="width:141px" %)A~|B|(% style="width:362px" %)Rule match if input is either 'A' or 'B'|(% style="width:158px" %)OUT_C
209 209  
210 -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 +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]].
211 211  
212 212  If the regular expression contains capture groups, these can be used in the definition of the output value, by specifying \**//n//**// //as an output value where **//n//** is the number of the capture group starting from 1. For example
213 213  
214 -|Regex|Target output|Example Input|Example Output
215 -|(((
216 -([0-9]{4})[0-
208 +(% style="width:700.294px" %)
209 +|(% style="width:203px" %)Regex|(% style="width:148px" %)Target output|(% style="width:157px" %)Example Input|(% style="width:189px" %)Example Output
210 +|(% style="width:203px" %)(((
211 +([0-9]{4})[0-9]([0-9]{1})
212 +)))|(% style="width:148px" %)\1-Q\2|(% style="width:157px" %)200933|(% style="width:189px" %)2009-Q3
217 217  
218 -9]([0-9]{1})
219 -)))|\1-Q\2|200933|2009-Q3
220 -
221 221  As regular expression rules can be used as a general catch-all if nothing else matches, the ordering of the rules is important. Rules should be tested starting with the highest priority, moving down the list until a match is found.
222 222  
223 223  The following example shows this:
224 224  
225 -|Priority|Regex|Description|Output
226 -|1|A|Rule match if input = 'A'|OUT_A
227 -|2|B|Rule match if input = 'B'|OUT_B
228 -|3|[A-Z]|Any character A-Z|OUT_C
218 +(% style="width:704.294px" %)
219 +|(% style="width:130px" %)Priority|(% style="width:125px" %)Regex|(% style="width:241px" %)Description|(% style="width:205px" %)Output
220 +|(% style="width:130px" %)1|(% style="width:125px" %)A|(% style="width:241px" %)Rule match if input = 'A'|(% style="width:205px" %)OUT_A
221 +|(% style="width:130px" %)2|(% style="width:125px" %)B|(% style="width:241px" %)Rule match if input = 'B'|(% style="width:205px" %)OUT_B
222 +|(% style="width:130px" %)3|(% style="width:125px" %)[A-Z]|(% style="width:241px" %)Any character A-Z|(% style="width:205px" %)OUT_C
229 229  
230 230  The input 'A' matches both the first and the last rule, but the first takes precedence having the higher priority. The output is OUT_A.
231 231  
... ... @@ -237,24 +237,27 @@
237 237  
238 238  For instance:
239 239  
240 -|Input String|Start|Length|Output
241 -|ABC_DEF_XYZ|5|3|DEF
242 -|XULADS|1|2|XU
234 +(% style="width:623.294px" %)
235 +|(% style="width:169px" %)Input String|(% style="width:147px" %)Start|(% style="width:133px" %)Length|(% style="width:171px" %)Output
236 +|(% style="width:169px" %)ABC_DEF_XYZ|(% style="width:147px" %)5|(% style="width:133px" %)3|(% style="width:171px" %)DEF
237 +|(% style="width:169px" %)XULADS|(% style="width:147px" %)1|(% style="width:133px" %)2|(% style="width:171px" %)XU
243 243  
244 -Sub-strings can therefore be used for the conceptual rule //If starts with 'XU' map to Y// as shown in the following example:
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:
245 245  
246 -|Start|Length|Source|Target
247 -|1|2|XU|Y
241 +(% style="width:628.294px" %)
242 +|(% style="width:163px" %)Start|(% style="width:158px" %)Length|(% style="width:128px" %)Source|(% style="width:176px" %)Target
243 +|(% style="width:163px" %)1|(% style="width:158px" %)2|(% style="width:128px" %)XU|(% style="width:176px" %)Y
248 248  
249 -== 13.6 Mapping non-SDMX time formats to SDMX formats ==
245 +== 13.7 Mapping non-SDMX time formats to SDMX formats ==
250 250  
251 -Structure mapping allows non-SDMX compliant time values in source datasets to be mapped to an SDMX compliant time format.
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.
252 252  
253 253  Two types of time input are defined:
254 254  
255 -a. **Pattern based dates** – a string which can be described using a notation like dd/mm/yyyy or is represented as the number of periods since a point in time, for example: 2010M001 (first month in 2010), or 2014D123 (123^^rd^^ day in 2014); and b. **Numerical based datetime** – a number specifying the elapsed periods since a fixed point in time, for example Unix Time is measured by the number of milliseconds since 1970.
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.
256 256  
257 -The output of a time-based mapping is derived from the output Frequency, which is either explicitly stated in the mapping or defined as the value output by a specific Dimension or Attribute in the output mapping. If the output frequency is unknown or if the SDMX format is not desired, then additional rules can be provided to specify the output date format for the given frequency Id. The default rules are:
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:
258 258  
259 259  |Frequency|Format|Example
260 260  |A|YYYY|2010
... ... @@ -274,95 +274,95 @@
274 274  
275 275  There are two important points to note:
276 276  
277 -1. The output frequency determines the output date format, but the default output can be redefined using a Frequency Format mapping to force explicit rules on how the output time period is formatted.
278 -1. To support the use case of changing frequency the structure map can optionally provide a start of year attribute, which defines the year start date in MM-DD format. For example: YearStart=04-01.
279 -11.
280 -111. Pattern based dates
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.
281 281  
282 -Date and time formats are specified by date and time pattern strings based on Java's Simple Date Format. Within date and time pattern strings, unquoted letters from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the components of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "''" represents a single quote. All other characters are not interpreted; they're simply copied into the output string during formatting or matched against the input string during parsing.
277 +=== 13.7.1 Pattern based dates ===
283 283  
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 +
284 284  Due to the fact that dates may differ per locale, an optional property, defining the locale of the pattern, is provided. This would assist processing of source dates, according to the given locale{{footnote}} A list of commonly used locales can be found in the Java supported locales: https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html{{/footnote}}. An indicative list of examples is presented in the following table:
285 285  
286 -|English (en)|Australia (AU)|en-AU
287 -|English (en)|Canada (CA)|en-CA
288 -|English (en)|United Kingdom (GB)|en-GB
289 -|English (en)|United States (US)|en-US
290 -|Estonian (et)|Estonia (EE)|et-EE
291 -|Finnish (fi)|Finland (FI)|fi-FI
292 -|French (fr)|Belgium (BE)|fr-BE
293 -|French (fr)|Canada (CA)|fr-CA
294 -|French (fr)|France (FR)|fr-FR
295 -|French (fr)|Luxembourg (LU)|fr-LU
296 -|French (fr)|Switzerland (CH)|fr-CH
297 -|German (de)|Austria (AT)|de-AT
298 -|German (de)|Germany (DE)|de-DE
299 -|German (de)|Luxembourg (LU)|de-LU
300 -|German (de)|Switzerland (CH)|de-CH
301 -|Greek (el)|Cyprus (CY)|el-CY[[(*)>>url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]][[url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]]
302 -|Greek (el)|Greece (GR)|el-GR
303 -|Hebrew (iw)|Israel (IL)|iw-IL
304 -|Hindi (hi)|India (IN)|hi-IN
305 -|Hungarian (hu)|Hungary (HU)|hu-HU
306 -|Icelandic (is)|Iceland (IS)|is-IS
307 -|Indonesian (in)|Indonesia (ID)|in-ID[[(*)>>url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]][[url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]]
308 -|Irish (ga)|Ireland (IE)|ga-IE[[(*)>>url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]][[url:https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]]
309 -|Italian (it)|Italy (IT)|it-IT
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
310 310  
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 311  Examples
312 312  
313 313  22/06/1981 would be described as dd/MM/YYYY, with locale en-GB
314 -
315 315  2008-mars-12 would be described as YYYY-MMM-DD, with locale fr-FR
316 -
317 317  22 July 1981 would be described as dd MMMM YYYY, with locale en-US
318 -
319 319  22 Jul 1981 would be described as dd MMM YYYY
320 -
321 321  2010 D62 would be described as YYYYDnn (day 62 of the year 2010)
322 322  
323 323  The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):
324 324  
325 -|Letter|Date or Time Component|Presentation|Examples
326 -|G|Era designator|[[Text>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#text]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#text]]|AD
327 -|yy|Year short (upper case is Year of Week{{footnote}}yyyy represents the calendar year while YYYY represents the year of the week, which is only relevant for 53 week years{{/footnote}})|[[Year>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#year]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#year]]|96
328 -|yyyy|Year Full (upper case is Year of Week)|Year|1996
329 -|MM|Month number in year starting with 1|Month|07
330 -|MMM|Month name short|Month|Jul
331 -|MMMM|Month name full|Month|July
332 -|ww|Week in year|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|27
333 -|W|Week in month|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|2
334 -|DD|Day in year|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|189
335 -|dd|Day in month|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|10
336 -|F|Day of week in month|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|2
337 -|E|Day name in week|[[Text>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#text]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#text]]|Tuesday; Tue
338 -|U|Day number of week (1 = Monday, ..., 7 = Sunday)|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|1
339 -|HH|Hour in day (0-23)|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|0
340 -|kk|Hour in day (1-24)|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|24
341 -|KK|Hour in am/pm (0-11)|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|0
342 -|hh|Hour in am/pm (1-12)|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|12
343 -|mm|Minute in hour|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|30
344 -|ss|Second in minute|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|55
345 -|S|Millisecond|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|978
346 -|n|(((
321 +(% style="width:850.294px" %)
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" %)(((
347 347  Number of periods, used after a SDMX
348 -
349 349  Frequency Identifier such as M, Q, D (month, quarter, day)
350 -)))|[[Number>>url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]][[url:https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html#number]]|12
346 +)))|(% style="width:180px" %)Number|(% style="width:157px" %)12
351 351  
352 352  The model is illustrated below:
353 353  
350 +[[image:1750074822764-573.png]]
354 354  
355 -
356 356  **Figure 24 showing the component map mapping the SOURCE_DATE Dimension to the TIME_PERIOD dimension with the additional information on the component map to describe the time format?**
357 357  
354 +[[image:1750074865924-797.png]]
358 358  
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**
359 359  
360 -==== Figure 25 showing an input date format, whose output frequency is derived from the output value of the FREQ Dimension ====
359 +=== 13.7.2 Numerical based datetime ===
361 361  
362 -=== 13.3.6 Numerical based datetime ===
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:
363 363  
364 -Where the source datetime input is purely numerical, the mapping rules are defined by the **Base** as a valid SDMX Time Period, and the **Period** which must take one of the following enumerated values:
365 -
366 366  * day
367 367  * second
368 368  * millisecond
... ... @@ -369,23 +369,21 @@
369 369  * microsecond
370 370  * nanosecond
371 371  
372 -|Numerical datetime systems|Base|Period
373 -|(((
369 +(% style="width:545.294px" %)
370 +|(% style="width:268px" %)Numerical datetime systems|(% style="width:121px" %)Base|(% style="width:153px" %)Period
371 +|(% style="width:268px" %)(((
374 374  Epoch Time (UNIX)
375 -
376 376  Milliseconds since 01 Jan 1970
377 -)))|1970|millisecond
378 -|(((
374 +)))|(% style="width:121px" %)1970|(% style="width:153px" %)millisecond
375 +|(% style="width:268px" %)(((
379 379  Windows System Time
380 -
381 381  Milliseconds since 01 Jan 1601
382 -)))|1601|millisecond
378 +)))|(% style="width:121px" %)1601|(% style="width:153px" %)millisecond
383 383  
384 384  The example above illustrates numerical based datetime mapping rules for two commonly used time standards.
385 385  
386 386  The model is illustrated below:
387 387  
388 -[[image:1750072341491-790.jpeg]]
389 389  
390 390  **Figure 26 showing the component map mapping the SOURCE_DATE Dimension to the**
391 391  
1750074822764-573.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +25.1 KB
Content
1750074865924-797.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +46.8 KB
Content