Changes for page 13 Structure Mapping

Last modified by Helena on 2025/09/10 11:19

From version 10.6
edited by Helena
on 2025/05/16 09:14
Change comment: There is no comment for this version
To version 14.3
edited by Helena
on 2025/05/19 13:56
Change comment: Update document after refactoring.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +Methodology.SDMX STANDARDS 3\.0\: SECTION 6\. TECHNICAL NOTES.WebHome
Content
... ... @@ -4,28 +4,28 @@
4 4  
5 5  == 13.1 Introduction ==
6 6  
7 -The purpose of SDMX structure mapping is to transform datasets from one dimensionality to another. In practice, this means that the input and output datasets conform to different Data Structure Definition.
7 +The purpose of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] structure mapping is to transform [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] from one dimensionality to another. In practice, this means that the input and output [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] conform to different Data Structure Definition.
8 8  
9 -Structure mapping does not alter the observation values and is not intended to perform any aggregations or calculations.
9 +Structure mapping does not alter the [[observation values>>doc:xwiki:Glossary.Observation value.WebHome]] and is not intended to perform any aggregations or calculations.
10 10  
11 -An input series maps to:
11 +An input series (% style="color:#2ecc71" %)maps(%%) to:
12 12  
13 13  1. Exactly one output series; or
14 -1. Multiple output series with different Series Keys, but the same observation values; or
15 -1. Zero output series where no source rule matches the input Component values.
14 +1. Multiple output series with different [[Series Keys>>doc:xwiki:Glossary.Series key.WebHome]], but the same [[observation values>>doc:xwiki:Glossary.Observation value.WebHome]]; or
15 +1. Zero output series where no source rule matches the input [[Component>>doc:xwiki:Glossary.Component.WebHome]] values.
16 16  
17 17  Typical use cases include:
18 18  
19 19  * Transforming received data into a common internal structure;
20 20  * Transforming reported data into the data collector's preferred structure;
21 -* Transforming unidimensional datasets{{footnote}}Unidimensional datasets are those with a single 'indicator' or 'series code' dimension.{{/footnote}} to multi-dimensional; and
22 -* Transforming internal datasets with a complex structure to a simpler structure with fewer dimensions suitable for dissemination.
21 +* Transforming unidimensional [[datasets>>doc:xwiki: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:xwiki:Glossary.Data set.WebHome]] with a complex structure to a simpler structure with fewer [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] suitable for dissemination.
23 23  
24 24  == 13.2 1-1 structure maps ==
25 25  
26 -1-1 (pronounced 'one to one') mappings support the simple use case where the value of a Component in the source structure is translated to a different value in the target, usually where different classification schemes are used for the same Concept.
26 +1-1 (pronounced 'one to one') mappings support the simple use case where the value of a [[Component>>doc:xwiki: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 27  
28 -In the example below, ISO 2-character country codes are mapped to their ISO 3character equivalent.
28 +In the example below, ISO 2-character country [[codes>>doc:xwiki:Glossary.Code.WebHome]] are (% style="color:#2ecc71" %)mapped(%%) to their ISO 3character equivalent.
29 29  
30 30  (% style="width:666.294px" %)
31 31  |(% style="width:217px" %)**Country**|(% style="width:251px" %)**Alpha-2 code**|(% style="width:195px" %)**Alpha-3 code**
... ... @@ -36,10 +36,12 @@
36 36  |(% style="width:217px" %)Andorra|(% style="width:251px" %)AD|(% style="width:195px" %)AND
37 37  |(% style="width:217px" %)etc…|(% style="width:251px" %) |(% style="width:195px" %)
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:#2ecc71" %)map(%%) to the same target value, for example when deriving regions from country [[codes>>doc:xwiki:Glossary.Code.WebHome]].
40 40  
41 41  (% style="width:674.294px" %)
42 -|(% style="width:284px" %)**Source Component: REF_AREA**|(% style="width:387px" %)**Target Component: REGION**
42 +|(% style="width:284px" %)**Source Component:
43 +REF_AREA**|(% style="width:387px" %)**Target Component:
44 +REGION**
43 43  |(% style="width:284px" %)FR|(% style="width:387px" %)EUR
44 44  |(% style="width:284px" %)DE|(% style="width:387px" %)EUR
45 45  |(% style="width:284px" %)IT|(% style="width:387px" %)EUR
... ... @@ -48,7 +48,7 @@
48 48  
49 49  == 13.3 N-n structure maps ==
50 50  
51 -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.
53 +N-n (pronounced 'N to N') mappings describe rules where a specified combination of values in multiple source [[Components>>doc:xwiki:Glossary.Component.WebHome]] (% style="color:#2ecc71" %)map(%%) to specified values in one or more target [[Components>>doc:xwiki:Glossary.Component.WebHome]]. For example, when mapping a partial [[Series Key>>doc:xwiki:Glossary.Series key.WebHome]] from a highly multidimensional cube (like Balance of Payments) to a single 'Indicator' [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] in a target Data Structure.
52 52  
53 53  Example:
54 54  
... ... @@ -69,7 +69,7 @@
69 69  INDICATOR=MON_SAX_12
70 70  )))
71 71  
72 -N-n rules can also set values for multiple source Components.
74 +N-n rules can also set values for multiple source [[Components>>doc:xwiki:Glossary.Component.WebHome]].
73 73  
74 74  (% style="width:757.294px" %)
75 75  |(% style="width:62px" %)**Rule**|(% style="width:378px" %)**Source**|(% style="width:312px" %)**Target**
... ... @@ -93,132 +93,125 @@
93 93  
94 94  == 13.4 Ambiguous mapping rules ==
95 95  
96 -A structure map is ambiguous if the rules result in a dataset containing multiple series with the same Series Key.
98 +A structure (% style="color:#2ecc71" %)map(%%) is ambiguous if the rules result in a [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] containing multiple series with the same Series Key.
97 97  
98 -A simple example mapping a source dataset with a single dimension to one with multiple dimensions is shown below:
100 +A simple example (% style="color:#2ecc71" %)mapping(%%) a source [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] with a single [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] to one with multiple [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] is shown below:
99 99  
100 -|Source|Target|Output Series Key
101 -|SERIES_CODE=XMAN_Z_21|(((
102 +(% style="width:819.294px" %)
103 +|(% style="width:240px" %)**Source**|(% style="width:246px" %)**Target**|(% style="width:329px" %)**Output Series Key**
104 +|(% style="width:240px" %)SERIES_CODE=XMAN_Z_21|(% style="width:246px" %)(((
102 102  Dimensions
103 -
104 104  INDICATOR=XM
105 -
106 106  FREQ=A
107 -
108 108  ADJUSTMENT=N
109 -
110 110  Attributes
111 -
112 112  UNIT_MEASURE=_Z
113 -
114 114  COMP_ORG=21
115 -)))|XM:A:N
116 -|SERIES_CODE=XMAN_Z_34|(((
112 +)))|(% style="width:329px" %)XM:A:N
113 +|(% style="width:240px" %)SERIES_CODE=XMAN_Z_34|(% style="width:246px" %)(((
117 117  Dimensions
118 -
119 119  INDICATOR=XM
120 -
121 121  FREQ=A
122 -
123 123  ADJUSTMENT=N
124 -
125 125  Attributes
126 -
127 127  UNIT_MEASURE=_Z
128 -
129 129  COMP_ORG=34
130 -)))|XM:A:N
121 +)))|(% style="width:329px" %)XM:A:N
131 131  
132 -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.
123 +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:xwiki:Glossary.Series key.WebHome]], for the same period in time.
133 133  
134 134  == 13.5 Representation maps ==
135 135  
136 -Representation Maps replace the SDMX 2.1 Codelist Maps and are used describe explicit mappings between source and target Component values.
127 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Maps(%%) replace the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 Codelist (% style="color:#2ecc71" %)Maps(%%) and are used describe explicit mappings between source and target [[Component>>doc:xwiki:Glossary.Component.WebHome]] values.
137 137  
138 -The source and target of a Representation Map can reference any of the following:
129 +The source and target of a [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Map(%%) can reference any of the following:
139 139  
140 140  1. Codelist
141 141  1. Free Text (restricted by type, e.g String, Integer, Boolean)
142 142  1. Valuelist
143 143  
144 -A Representation Map mapping ISO 2-character to ISO 3-character Codelists would take the following form:
135 +A [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Map(%%) mapping ISO 2-character to ISO 3-character Codelists would take the following form:
145 145  
146 -|CL_ISO_ALPHA2|CL_ISO_ALPHA3
147 -|AF|AFG
148 -|AL|ALB
149 -|DZ|DZA
150 -|AS|ASM
151 -|AD|AND
152 -|etc…|
137 +(% style="width:763.294px" %)
138 +|(% style="width:252px" %)**CL_ISO_ALPHA2**|(% style="width:508px" %)**CL_ISO_ALPHA3**
139 +|(% style="width:252px" %)AF|(% style="width:508px" %)AFG
140 +|(% style="width:252px" %)AL|(% style="width:508px" %)ALB
141 +|(% style="width:252px" %)DZ|(% style="width:508px" %)DZA
142 +|(% style="width:252px" %)AS|(% style="width:508px" %)ASM
143 +|(% style="width:252px" %)AD|(% style="width:508px" %)AND
144 +|(% style="width:252px" %)etc…|(% style="width:508px" %)
153 153  
154 -A Representation Map mapping free text country names to an ISO 2-character Codelist could be similarly described:
146 +A [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Map(%%) mapping free text country names to an ISO 2-character Codelist could be similarly described:
155 155  
156 -|Text|CL_ISO_ALPHA2
157 -|"Germany"|DE
158 -|"France"|FR
159 -|"United Kingdom"|GB
160 -|"Great Britain"|GB
161 -|"Ireland"|IE
162 -|"Eire"|IE
163 -|etc…|
148 +(% style="width:770.294px" %)
149 +|(% style="width:247px" %)**Text**|(% style="width:520px" %)**CL_ISO_ALPHA2**
150 +|(% style="width:247px" %)"Germany"|(% style="width:520px" %)DE
151 +|(% style="width:247px" %)"France"|(% style="width:520px" %)FR
152 +|(% style="width:247px" %)"United Kingdom"|(% style="width:520px" %)GB
153 +|(% style="width:247px" %)"Great Britain"|(% style="width:520px" %)GB
154 +|(% style="width:247px" %)"Ireland"|(% style="width:520px" %)IE
155 +|(% style="width:247px" %)"Eire"|(% style="width:520px" %)IE
156 +|(% style="width:247px" %)etc…|(% style="width:520px" %)
164 164  
165 -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.
158 +Valuelists, introduced in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, are equivalent to Codelists but allow the maintenance of non-[[SDMX>>doc:xwiki: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.
166 166  
167 -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.
160 +When used in [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Maps(%%), Valuelists allow Non-[[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] identifiers containing characters like £, $, % to be (% style="color:#2ecc71" %)mapped(%%) to [[Code>>doc:xwiki:Glossary.Code.WebHome]] IDs, or [[Codes>>doc:xwiki:Glossary.Code.WebHome]] (% style="color:#2ecc71" %)mapped(%%) to non-[[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] identifiers.
168 168  
169 169  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:
170 170  
171 -|Value|Locale|Name
172 -|$|en|United States Dollar
173 -|%|En|Percentage
174 -| |fr|Pourcentage
164 +(% style="width:780.294px" %)
165 +|(% style="width:126px" %)**Value**|(% style="width:153px" %)**Locale**|(% style="width:498px" %)**Name**
166 +|(% style="width:126px" %)$|(% style="width:153px" %)en|(% style="width:498px" %)United States Dollar
167 +|(% style="width:126px" %)%|(% style="width:153px" %)En|(% style="width:498px" %)Percentage
168 +|(% style="width:126px" %) |(% style="width:153px" %)fr|(% style="width:498px" %)Pourcentage
175 175  
176 -Other characteristics of Representation Maps:
170 +Other characteristics of [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Maps(%%):
177 177  
178 -* 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;
179 -* 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
180 -* 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.
172 +* Support the (% style="color:#2ecc71" %)mapping(%%) of multiple source [[Component>>doc:xwiki:Glossary.Component.WebHome]] values to multiple Target [[Component>>doc:xwiki:Glossary.Component.WebHome]] values as described in section 13.3 on n-to-n mappings; this covers also the case of (% style="color:#2ecc71" %)mapping(%%) an [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] with an array [[representation>>doc:xwiki:Glossary.Representation.WebHome]] to (% style="color:#2ecc71" %)map(%%) combinations of values to a single target value;
173 +* Allow source or target mappings for an Item to be optional allowing rules such as 'A (% style="color:#2ecc71" %)maps(%%) to nothing' or 'nothing (% style="color:#2ecc71" %)maps(%%) to A'; and
174 +* Support for (% style="color:#2ecc71" %)mapping(%%) rules where regular expressions or substrings are used to match source [[Component>>doc:xwiki:Glossary.Component.WebHome]] values. Refer to section 13.6 for more on this topic.
181 181  
182 182  == 13.6 Regular expression and substring rules ==
183 183  
184 -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.
178 +It is common for classifications to contain meanings within the identifier, for example the [[code>>doc:xwiki:Glossary.Code.WebHome]] Id 'XULADS' may refer to a particular seasonality because it starts with the letters XU.
185 185  
186 -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:
180 +With [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 each [[code>>doc:xwiki:Glossary.Code.WebHome]] that starts with XU had to be individually (% style="color:#2ecc71" %)mapped(%%) to the same seasonality, and additional mappings added when new [[Codes>>doc:xwiki: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 187  
188 -//If starts with 'XU' map to 'Y'//
182 +//If starts with 'XU' (% style="color:#2ecc71" %)map(%%) to 'Y'//
189 189  
190 190  These rules are described using either regular expressions, or substrings for simpler use cases.
191 191  
192 192  === 13.6.1 Regular expressions ===
193 193  
194 -Regular expression mapping rules are defined in the Representation Map.
188 +Regular expression (% style="color:#2ecc71" %)mapping(%%) rules are defined in the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Map(%%).
195 195  
196 -Below is an example set of regular expression rules for a particular component.
190 +Below is an example set of regular expression rules for a particular [[component>>doc:xwiki:Glossary.Component.WebHome]].
197 197  
198 -|Regex|Description|Output
199 -|A|Rule match if input = 'A'|OUT_A
200 -|^[A-G]|Rule match if the input starts with letters A to G|OUT_B
201 -|A~|B|Rule match if input is either 'A' or 'B'|OUT_C
192 +(% style="width:708.294px" %)
193 +|(% style="width:133px" %)**Regex**|(% style="width:377px" %)**Description**|(% style="width:194px" %)**Output**
194 +|(% style="width:133px" %)A|(% style="width:377px" %)Rule match if input = 'A'|(% style="width:194px" %)OUT_A
195 +|(% style="width:133px" %)^[A-G]|(% style="width:377px" %)Rule match if the input starts with letters A to G|(% style="width:194px" %)OUT_B
196 +|(% style="width:133px" %)A~|B|(% style="width:377px" %)Rule match if input is either 'A' or 'B'|(% style="width:194px" %)OUT_C
202 202  
203 -Like all mapping rules, the output is either a Code, a Value or free text depending on the representation of the Component in the target Data Structure Definition.
198 +Like all mapping rules, the output is either a [[Code>>doc:xwiki:Glossary.Code.WebHome]], a Value or free text depending on the [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of the [[Component>>doc:xwiki:Glossary.Component.WebHome]] in the target [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].
204 204  
205 205  If the regular expression contains capture groups, these can be used in the definition of the output value, by specifying \//**n** //as an output value where //**n**// is the number of the capture group starting from 1. For example
206 206  
207 -|Regex|Target output|Example Input|Example Output
208 -|(((
209 -([0-9]{4})[0-
202 +(% style="width:720.294px" %)
203 +|(% style="width:199px" %)**Regex**|(% style="width:126px" %)**Target output**|(% style="width:192px" %)**Example Input**|(% style="width:200px" %)**Example Output**
204 +|(% style="width:199px" %)(((
205 +([0-9]{4})[0-9]([0-9]{1})
206 +)))|(% style="width:126px" %)\1-Q\2|(% style="width:192px" %)200933|(% style="width:200px" %)2009-Q3
210 210  
211 -9]([0-9]{1})
212 -)))|\1-Q\2|200933|2009-Q3
213 -
214 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 215  
216 216  The following example shows this:
217 217  
218 -|Priority|Regex|Description|Output
219 -|1|A|Rule match if input = 'A'|OUT_A
220 -|2|B|Rule match if input = 'B'|OUT_B
221 -|3|[A-Z]|Any character A-Z|OUT_C
212 +(% style="width:725.294px" %)
213 +|(% style="width:198px" %)**Priority**|(% style="width:148px" %)**Regex**|(% style="width:212px" %)**Description**|(% style="width:164px" %)**Output**
214 +|(% style="width:198px" %)1|(% style="width:148px" %)A|(% style="width:212px" %)Rule match if input = 'A'|(% style="width:164px" %)OUT_A
215 +|(% style="width:198px" %)2|(% style="width:148px" %)B|(% style="width:212px" %)Rule match if input = 'B'|(% style="width:164px" %)OUT_B
216 +|(% style="width:198px" %)3|(% style="width:148px" %)[A-Z]|(% style="width:212px" %)Any character A-Z|(% style="width:164px" %)OUT_C
222 222  
223 223  The input 'A' matches both the first and the last rule, but the first takes precedence having the higher priority. The output is OUT_A.
224 224  
... ... @@ -230,129 +230,128 @@
230 230  
231 231  For instance:
232 232  
233 -|Input String|Start|Length|Output
234 -|ABC_DEF_XYZ|5|3|DEF
235 -|XULADS|1|2|XU
228 +(% style="width:742.294px" %)
229 +|(% style="width:191px" %)**Input String**|(% style="width:154px" %)**Start**|(% style="width:211px" %)**Length**|(% style="width:182px" %)**Output**
230 +|(% style="width:191px" %)ABC_DEF_XYZ|(% style="width:154px" %)5|(% style="width:211px" %)3|(% style="width:182px" %)DEF
231 +|(% style="width:191px" %)XULADS|(% style="width:154px" %)1|(% style="width:211px" %)2|(% style="width:182px" %)XU
236 236  
237 -Sub-strings can therefore be used for the conceptual rule //If starts with 'XU' map to Y// as shown in the following example:
233 +Sub-strings can therefore be used for the conceptual rule //If starts with 'XU' (% style="color:#2ecc71" %)map(%%) to Y// as shown in the following example:
238 238  
239 -|Start|Length|Source|Target
240 -|1|2|XU|Y
235 +(% style="width:740.294px" %)
236 +|(% style="width:194px" %)**Start**|(% style="width:151px" %)**Length**|(% style="width:208px" %)**Source**|(% style="width:183px" %)**Target**
237 +|(% style="width:194px" %)1|(% style="width:151px" %)2|(% style="width:208px" %)XU|(% style="width:183px" %)Y
241 241  
242 242  == 13.7 Mapping non-SDMX time formats to SDMX formats ==
243 243  
244 -Structure mapping allows non-SDMX compliant time values in source datasets to be mapped to an SDMX compliant time format.
241 +Structure mapping allows non-[[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] compliant time values in source [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] to be (% style="color:#2ecc71" %)mapped(%%) to an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] compliant time format.
245 245  
246 246  Two types of time input are defined:
247 247  
248 248  a. **Pattern based dates** – a string which can be described using a notation like dd/mm/yyyy or is represented as the number of periods since a point in time, for example: 2010M001 (first month in 2010), or 2014D123 (123^^rd^^ day in 2014); and b. **Numerical based datetime** – a number specifying the elapsed periods since a fixed point in time, for example Unix Time is measured by the number of milliseconds since 1970.
249 249  
250 -The output of a time-based mapping is derived from the output Frequency, which is either explicitly stated in the mapping or defined as the value output by a specific Dimension or Attribute in the output mapping. If the output frequency is unknown or if the SDMX format is not desired, then additional rules can be provided to specify the output date format for the given frequency Id. The default rules are:
247 +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:xwiki:Glossary.Dimension.WebHome]] or [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] in the output mapping. If the output frequency is unknown or if the [[SDMX>>doc:xwiki: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:
251 251  
252 -|Frequency|Format|Example
253 -|A|YYYY|2010
254 -|D|YYYY-MM-DD|2010-01-01
255 -|I|YYYY-MM-DDThh:mm:ss|2010-01T20:22:00
256 -|M|YYYY-MM|2010-01
257 -|Q|YYYY-Qn|2010-Q1
258 -|S|YYYY-Sn|2010-S1
259 -|T|YYYY-Tn|2010-T1
260 -|W|YYYY-Wn|YYYY-W53
249 +(% style="width:771.294px" %)
250 +|(% style="width:187px" %)**Frequency**|(% style="width:159px" %)**Format**|(% style="width:422px" %)**Example**
251 +|(% style="width:187px" %)A|(% style="width:159px" %)YYYY|(% style="width:422px" %)2010
252 +|(% style="width:187px" %)D|(% style="width:159px" %)YYYY-MM-DD|(% style="width:422px" %)2010-01-01
253 +|(% style="width:187px" %)I|(% style="width:159px" %)YYYY-MM-DDThh:mm:ss|(% style="width:422px" %)2010-01T20:22:00
254 +|(% style="width:187px" %)M|(% style="width:159px" %)YYYY-MM|(% style="width:422px" %)2010-01
255 +|(% style="width:187px" %)Q|(% style="width:159px" %)YYYY-Qn|(% style="width:422px" %)2010-Q1
256 +|(% style="width:187px" %)S|(% style="width:159px" %)YYYY-Sn|(% style="width:422px" %)2010-S1
257 +|(% style="width:187px" %)T|(% style="width:159px" %)YYYY-Tn|(% style="width:422px" %)2010-T1
258 +|(% style="width:187px" %)W|(% style="width:159px" %)YYYY-Wn|(% style="width:422px" %)YYYY-W53
261 261  
262 262  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.
263 263  
264 264  There are two important points to note:
265 265  
266 -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.
267 -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.
264 +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:xwiki:Glossary.Time period.WebHome]] is formatted.
265 +1. To support the use case of changing frequency the structure (% style="color:#2ecc71" %)map(%%) can optionally provide a start of year [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]], which defines the year start date in MM-DD format. For example: YearStart=04-01.
268 268  
269 269  === 13.7.1 Pattern based dates ===
270 270  
271 -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.
269 +Date and [[time formats>>doc:xwiki: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:xwiki: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.
272 272  
273 -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^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^44^^>>path:#sdfootnote44sym||name="sdfootnote44anc"]](%%)^^. An indicative list of examples is presented in the following table:
271 +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}}Unidimensional datasets are those with a single 'indicator' or 'series code' dimension.{{/footnote}}. An indicative list of examples is presented in the following table:
274 274  
275 -|English (en)|Australia (AU)|en-AU
276 -|English (en)|Canada (CA)|en-CA
277 -|English (en)|United Kingdom (GB)|en-GB
278 -|English (en)|United States (US)|en-US
279 -|Estonian (et)|Estonia (EE)|et-EE
280 -|Finnish (fi)|Finland (FI)|fi-FI
281 -|French (fr)|Belgium (BE)|fr-BE
282 -|French (fr)|Canada (CA)|fr-CA
283 -|French (fr)|France (FR)|fr-FR
284 -|French (fr)|Luxembourg (LU)|fr-LU
285 -|French (fr)|Switzerland (CH)|fr-CH
286 -|German (de)|Austria (AT)|de-AT
287 -|German (de)|Germany (DE)|de-DE
273 +(% style="width:772.294px" %)
274 +|(% style="width:190px" %)English (en)|(% style="width:230px" %)Australia (AU)|(% style="width:348px" %)en-AU
275 +|(% style="width:190px" %)English (en)|(% style="width:230px" %)Canada (CA)|(% style="width:348px" %)en-CA
276 +|(% style="width:190px" %)English (en)|(% style="width:230px" %)United Kingdom (GB)|(% style="width:348px" %)en-GB
277 +|(% style="width:190px" %)English (en)|(% style="width:230px" %)United States (US)|(% style="width:348px" %)en-US
278 +|(% style="width:190px" %)Estonian (et)|(% style="width:230px" %)Estonia (EE)|(% style="width:348px" %)et-EE
279 +|(% style="width:190px" %)Finnish (fi)|(% style="width:230px" %)Finland (FI)|(% style="width:348px" %)fi-FI
280 +|(% style="width:190px" %)French (fr)|(% style="width:230px" %)Belgium (BE)|(% style="width:348px" %)fr-BE
281 +|(% style="width:190px" %)French (fr)|(% style="width:230px" %)Canada (CA)|(% style="width:348px" %)fr-CA
282 +|(% style="width:190px" %)French (fr)|(% style="width:230px" %)France (FR)|(% style="width:348px" %)fr-FR
283 +|(% style="width:190px" %)French (fr)|(% style="width:230px" %)Luxembourg (LU)|(% style="width:348px" %)fr-LU
284 +|(% style="width:190px" %)French (fr)|(% style="width:230px" %)Switzerland (CH)|(% style="width:348px" %)fr-CH
285 +|(% style="width:190px" %)German (de)|(% style="width:230px" %)Austria (AT)|(% style="width:348px" %)de-AT
286 +|(% style="width:190px" %)German (de)|(% style="width:230px" %)Germany (DE)|(% style="width:348px" %)de-DE
288 288  
289 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape8" height="1" width="192"]]
288 +(% style="width:773.294px" %)
289 +|(% style="width:190px" %)German (de)|(% style="width:234px" %)Luxembourg (LU)|(% style="width:345px" %)de-LU
290 +|(% style="width:190px" %)German (de)|(% style="width:234px" %)Switzerland (CH)|(% style="width:345px" %)de-CH
291 +|(% style="width:190px" %)Greek (el)|(% style="width:234px" %)Cyprus (CY)|(% style="width:345px" %)el-CY__([[*>>https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]])__
292 +|(% style="width:190px" %)Greek (el)|(% style="width:234px" %)Greece (GR)|(% style="width:345px" %)el-GR
293 +|(% style="width:190px" %)Hebrew (iw)|(% style="width:234px" %)Israel (IL)|(% style="width:345px" %)iw-IL
294 +|(% style="width:190px" %)Hindi (hi)|(% style="width:234px" %)India (IN)|(% style="width:345px" %)hi-IN
295 +|(% style="width:190px" %)Hungarian (hu)|(% style="width:234px" %)Hungary (HU)|(% style="width:345px" %)hu-HU
296 +|(% style="width:190px" %)Icelandic (is)|(% style="width:234px" %)Iceland (IS)|(% style="width:345px" %)is-IS
297 +|(% style="width:190px" %)Indonesian (in)|(% style="width:234px" %)Indonesia (ID)|(% style="width:345px" %)in-ID__([[*>>https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]])__
298 +|(% style="width:190px" %)Irish (ga)|(% style="width:234px" %)Ireland (IE)|(% style="width:345px" %)ga-IE__([[*>>https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#cldrlocale]])__
299 +|(% style="width:190px" %)Italian (it)|(% style="width:234px" %)Italy (IT)|(% style="width:345px" %)it-IT
290 290  
291 -|German (de)|Luxembourg (LU)|de-LU
292 -|German (de)|Switzerland (CH)|de-CH
293 -|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]]
294 -|Greek (el)|Greece (GR)|el-GR
295 -|Hebrew (iw)|Israel (IL)|iw-IL
296 -|Hindi (hi)|India (IN)|hi-IN
297 -|Hungarian (hu)|Hungary (HU)|hu-HU
298 -|Icelandic (is)|Iceland (IS)|is-IS
299 -|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]]
300 -|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]]
301 -|Italian (it)|Italy (IT)|it-IT
302 -
303 303  Examples
304 304  
305 305  22/06/1981 would be described as dd/MM/YYYY, with locale en-GB
306 -
307 307  2008-mars-12 would be described as YYYY-MMM-DD, with locale fr-FR
308 -
309 309  22 July 1981 would be described as dd MMMM YYYY, with locale en-US
310 -
311 311  22 Jul 1981 would be described as dd MMM YYYY
312 -
313 313  2010 D62 would be described as YYYYDnn (day 62 of the year 2010)
314 314  
315 315  The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):
316 316  
317 -|Letter|Date or Time Component|Presentation|Examples
318 -|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
319 -|yy|Year short (upper case is Year of Week^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^45^^>>path:#sdfootnote45sym||name="sdfootnote45anc"]](%%)^^)|[[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
320 -|yyyy|Year Full (upper case is Year of Week)|Year|1996
321 -|MM|Month number in year starting with 1|Month|07
322 -|MMM|Month name short|Month|Jul
323 -|MMMM|Month name full|Month|July
324 -|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
325 -|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
326 -|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
327 -|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
328 -|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
329 -|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
311 +(% style="width:896.294px" %)
312 +|(% style="width:133px" %)**Letter**|(% style="width:414px" %)**Date or Time Component**|(% style="width:157px" %)**Presentation**|(% style="width:172px" %)**Examples**
313 +|(% style="width:133px" %)G|(% style="width:414px" %)Era designator|(% style="width:157px" %)Text|(% style="width:172px" %)AD
314 +|(% style="width:133px" %)yy|(% style="width:414px" %)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:157px" %)Year|(% style="width:172px" %)96
315 +|(% style="width:133px" %)yyyy|(% style="width:414px" %)Year Full (upper case is Year of Week)|(% style="width:157px" %)Year|(% style="width:172px" %)1996
316 +|(% style="width:133px" %)MM|(% style="width:414px" %)Month number in year starting with 1|(% style="width:157px" %)Month|(% style="width:172px" %)07
317 +|(% style="width:133px" %)MMM|(% style="width:414px" %)Month name short|(% style="width:157px" %)Month|(% style="width:172px" %)Jul
318 +|(% style="width:133px" %)MMMM|(% style="width:414px" %)Month name full|(% style="width:157px" %)Month|(% style="width:172px" %)July
319 +|(% style="width:133px" %)ww|(% style="width:414px" %)Week in year|(% style="width:157px" %)Number|(% style="width:172px" %)27
320 +|(% style="width:133px" %)W|(% style="width:414px" %)Week in month|(% style="width:157px" %)Number|(% style="width:172px" %)2
321 +|(% style="width:133px" %)DD|(% style="width:414px" %)Day in year|(% style="width:157px" %)Number|(% style="width:172px" %)189
322 +|(% style="width:133px" %)dd|(% style="width:414px" %)Day in month|(% style="width:157px" %)Number|(% style="width:172px" %)10
323 +|(% style="width:133px" %)F|(% style="width:414px" %)Day of week in month|(% style="width:157px" %)Number|(% style="width:172px" %)2
324 +|(% style="width:133px" %)E|(% style="width:414px" %)Day name in week|(% style="width:157px" %)Text|(% style="width:172px" %)Tuesday; Tue
325 +|(% style="width:132px" %)U|(% style="width:414px" %)Day number of week (1 = Monday, ..., 7 = Sunday)|(% style="width:157px" %)Number|(% style="width:217px" %)1
326 +|(% style="width:132px" %)HH|(% style="width:414px" %)Hour in day (0-23)|(% style="width:157px" %)Number|(% style="width:217px" %)0
327 +|(% style="width:132px" %)kk|(% style="width:414px" %)Hour in day (1-24)|(% style="width:157px" %)Number|(% style="width:217px" %)24
328 +|(% style="width:132px" %)KK|(% style="width:414px" %)Hour in am/pm (0-11)|(% style="width:157px" %)Number|(% style="width:217px" %)0
329 +|(% style="width:132px" %)hh|(% style="width:414px" %)Hour in am/pm (1-12)|(% style="width:157px" %)Number|(% style="width:217px" %)12
330 +|(% style="width:132px" %)mm|(% style="width:414px" %)Minute in hour|(% style="width:157px" %)Number|(% style="width:217px" %)30
331 +|(% style="width:132px" %)ss|(% style="width:414px" %)Second in minute|(% style="width:157px" %)Number|(% style="width:217px" %)55
332 +|(% style="width:132px" %)S|(% style="width:414px" %)Millisecond|(% style="width:157px" %)Number|(% style="width:217px" %)978
333 +|(% style="width:132px" %)n|(% style="width:414px" %)Number of periods, used after a SDMX Frequency Identifier such as M, Q, D (month, quarter, day)|(% style="width:157px" %)Number|(% style="width:217px" %)12
330 330  
331 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape9" height="1" width="192"]]
332 -
333 -|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
334 -|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
335 -|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
336 -|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
337 -|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
338 -|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
339 -|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
340 -|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
341 -|n|Number of periods, used after a SDMX Frequency Identifier such as M, Q, D (month, quarter, day)|[[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
342 -
343 343  The model is illustrated below:
344 344  
345 345  [[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_295af259.jpg||height="265" width="477"]]
346 346  
347 -==== 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 ====
339 +(% class="wikigeneratedid" id="HFigure24showingthecomponentmapmappingtheSOURCE_DATEDimensiontotheTIME_PERIODdimensionwiththeadditionalinformationonthecomponentmaptodescribethetimeformat" %)
340 +**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**
348 348  
349 349  [[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_a3215c79.jpg||height="265" width="480"]]
350 350  
351 -==== Figure 25 showing an input date format, whose output frequency is derived from the output value of the FREQ Dimension ====
344 +(% class="wikigeneratedid" id="HFigure25showinganinputdateformat2CwhoseoutputfrequencyisderivedfromtheoutputvalueoftheFREQDimension" %)
345 +**Figure 25 showing an input date format, whose output frequency is derived from the output value of the FREQ Dimension**
352 352  
353 353  === 13.7.2 Numerical based datetime ===
354 354  
355 -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:
349 +Where the source datetime input is purely numerical, the mapping rules are defined by the **Base** as a valid [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[Time Period>>doc:xwiki:Glossary.Time period.WebHome]], and the **Period** which must take one of the following enumerated values:
356 356  
357 357  * day
358 358  * second
... ... @@ -360,17 +360,16 @@
360 360  * microsecond
361 361  * nanosecond
362 362  
363 -|Numerical datetime systems|Base|Period
364 -|(((
357 +(% style="width:573.294px" %)
358 +|(% style="width:276px" %)**Numerical datetime systems**|(% style="width:117px" %)**Base**|(% style="width:177px" %)**Period**
359 +|(% style="width:276px" %)(((
365 365  Epoch Time (UNIX)
366 -
367 367  Milliseconds since 01 Jan 1970
368 -)))|1970|millisecond
369 -|(((
362 +)))|(% style="width:117px" %)1970|(% style="width:177px" %)millisecond
363 +|(% style="width:276px" %)(((
370 370  Windows System Time
371 -
372 372  Milliseconds since 01 Jan 1601
373 -)))|1601|millisecond
366 +)))|(% style="width:117px" %)1601|(% style="width:177px" %)millisecond
374 374  
375 375  The example above illustrates numerical based datetime mapping rules for two commonly used time standards.
376 376  
... ... @@ -384,53 +384,46 @@
384 384  
385 385  === 13.7.3 Mapping more complex time inputs ===
386 386  
387 -VTL should be used for more complex time inputs that cannot be interpreted using the pattern based on numerical methods.
380 +[[VTL>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] should be used for more complex time inputs that cannot be interpreted using the pattern based on numerical methods.
388 388  
389 389  == 13.8 Using TIME_PERIOD in mapping rules ==
390 390  
391 -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.
384 +The source TIME_PERIOD [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] can be used in conjunction with other input [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] to create discrete mapping rules where the output is conditional on the [[time period>>doc:xwiki:Glossary.Time period.WebHome]] value.
392 392  
393 -The main use case is setting the value of Observation Attributes in the target dataset.
386 +The main use case is setting the value of Observation [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] in the target [[dataset>>doc:xwiki:Glossary.Data set.WebHome]].
394 394  
395 -|Rule|Source|Target
396 -|1|(((
388 +(% style="width:786.294px" %)
389 +|(% style="width:92px" %)**Rule**|(% style="width:377px" %)**Source**|(% style="width:315px" %)**Target**
390 +|(% style="width:92px" %)1|(% style="width:377px" %)(((
397 397  If
398 -
399 399  INDICATOR=XULADS; and TIME_PERIOD=2007.
400 -)))|(((
393 +)))|(% style="width:315px" %)(((
401 401  Set
402 -
403 403  OBS_CONF=F
404 404  )))
405 -|2|(((
397 +|(% style="width:92px" %)2|(% style="width:377px" %)(((
406 406  If
407 -
408 408  INDICATOR=XULADS; and TIME_PERIOD=2008.
409 -)))|(((
400 +)))|(% style="width:315px" %)(((
410 410  Set
411 -
412 412  OBS_CONF=F
413 413  )))
414 -|3|(((
404 +|(% style="width:92px" %)3|(% style="width:377px" %)(((
415 415  If
416 -
417 417  INDICATOR=XULADS; and TIME_PERIOD=2009.
418 -)))|(((
407 +)))|(% style="width:315px" %)(((
419 419  Set
420 -
421 421  OBS_CONF=F
422 422  )))
423 -|4|(((
411 +|(% style="width:92px" %)4|(% style="width:377px" %)(((
424 424  If
425 -
426 426  INDICATOR=XULADS; and TIME_PERIOD=2010.
427 -)))|(((
414 +)))|(% style="width:315px" %)(((
428 428  Set
429 -
430 430  OBS_CONF=**C**
431 431  )))
432 432  
433 -In the example above, OBS_CONF is an Observation Attribute.
419 +In the example above, OBS_CONF is an Observation [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]].
434 434  
435 435  == 13.9 Time span mapping rules using validity periods ==
436 436  
... ... @@ -440,28 +440,23 @@
440 440  
441 441  By specifying validity periods, the example from Section 13.8 can be re-written using two rules as follows:
442 442  
443 -|Rule|Source|Target
444 -|1|(((
429 +(% style="width:808.294px" %)
430 +|(% style="width:93px" %)**Rule**|(% style="width:385px" %)**Source**|(% style="width:328px" %)**Target**
431 +|(% style="width:93px" %)1|(% style="width:385px" %)(((
445 445  If
446 -
447 447  INDICATOR=XULADS.
448 -
449 449  Validity Period start period=2007 end period=2009
450 -)))|(((
435 +)))|(% style="width:328px" %)(((
451 451  Set
452 -
453 453  OBS_CONF=F
454 454  )))
455 -|2|(((
439 +|(% style="width:93px" %)2|(% style="width:385px" %)(((
456 456  If
457 -
458 458  INDICATOR=XULADS.
459 -
460 460  Validity Period start period=2010
461 -)))|(((
443 +)))|(% style="width:328px" %)(((
462 462  Set
463 -
464 -OBS_CONF=F** **
445 +OBS_CONF=F
465 465  )))
466 466  
467 467  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.
... ... @@ -472,149 +472,107 @@
472 472  
473 473  === 13.10.1 Many to one mapping (N-1) ===
474 474  
475 -|Source|Map To
476 -|(((
477 -**FREQ**="A"
456 +[[image:1747377208446-496.png]]
478 478  
479 -ADJUSTMENT="N"
458 +The bold [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] (% style="color:#2ecc71" %)map(%%) from source to target verbatim. The mapping simply specifies:
480 480  
481 -**REF_AREA**="PL"
482 -
483 -**COUNTERPART_AREA**="W0"
484 -
485 -REF_SECTOR="S1"
486 -
487 -COUNTERPART_SECTOR="S1" ACCOUNTING_ENTRY="B"
488 -
489 -STO="B5G"
490 -)))|(((
491 -FREQ="A"
492 -
493 -REF_AREA="PL"
494 -
495 -COUNTERPART_AREA="W0"
496 -
497 -INDICATOR="IND_ABC"
498 -)))
499 -
500 -The bold Dimensions map from source to target verbatim. The mapping simply specifies:
501 -
502 502  FREQ => FREQ
503 -
504 504  REF_AREA=> REF_AREA
505 -
506 506  COUNTERPART_AREA=> COUNTERPART _AREA
507 507  
508 -No Representation Mapping is required. The source value simply copies across unmodified.
464 +No [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] Mapping is required. The source value simply copies across unmodified.
509 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:
466 +The remaining [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] all (% style="color:#2ecc71" %)map(%%) to the Indicator [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]]. This is an example of many [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] mapping to one [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]]. In this case a [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] Mapping is required, and the mapping first describes the input 'partial key' and how this (% style="color:#2ecc71" %)maps(%%) to the target indicator:
511 511  
512 512  N:S1:S1:B:B5G => IND_ABC
513 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.
470 +Where the key sequence is based on the order specified in the mapping (i.e [[ADJUSTMENT>>doc:xwiki:Glossary.Adjustment.WebHome]], REF_SECTOR, etc will result in the first value N being taken from [[ADJUSTMENT>>doc:xwiki:Glossary.Adjustment.WebHome]] as this was the first item in the source [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] list.
515 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.
472 +**Note**: The key order is NOT based on the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] order of the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]], as the mapping needs to be resilient to the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]] changing.
517 517  
518 518  === 13.10.2 Mapping other data types to Code Id ===
519 519  
520 -In the case where the incoming data type is not a string and not a code identifier i.e. the source Dimension is of type Integer and the target is Codelist. This is supported by the RepresentationMap. The RepresentationMap source can reference a Codelist, Valuelist, or be free text, the free text can include regular expressions.
476 +In the case where the incoming data type is not a string and not a [[code>>doc:xwiki:Glossary.Code.WebHome]] identifier i.e. the source [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] is of type Integer and the target is Codelist. This is supported by the RepresentationMap. The RepresentationMap source can reference a Codelist, Valuelist, or be free text, the free text can include regular expressions.
521 521  
522 -The following representation mapping can be used to explicitly map each age to an output code.
478 +The following [[representation>>doc:xwiki:Glossary.Representation.WebHome]] mapping can be used to explicitly (% style="color:#2ecc71" %)map(%%) each [[age>>doc:xwiki:Glossary.Age.WebHome]] to an output [[code>>doc:xwiki:Glossary.Code.WebHome]].
523 523  
524 -:
525 -
526 526  (((
527 -|Source Input Free Text|Desired Output Code Id
528 -|0|A
529 -|1|A
530 -|2|A
531 -|3|B
532 -|4|B
481 +(% style="width:669.294px" %)
482 +|(% style="width:218px" %)**Source Input Free Text**|(% style="width:448px" %)**Desired Output Code Id**
483 +|(% style="width:218px" %)0|(% style="width:448px" %)A
484 +|(% style="width:218px" %)1|(% style="width:448px" %)A
485 +|(% style="width:218px" %)2|(% style="width:448px" %)A
486 +|(% style="width:218px" %)3|(% style="width:448px" %)B
487 +|(% style="width:218px" %)4|(% style="width:448px" %)B
533 533  )))
534 534  
535 -If this mapping takes advantage of regular expressions it can be expressed in two 3464 rules:
490 +If this mapping takes advantage of regular expressions it can be expressed in two rules:
536 536  
537 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_8c1afe2b.gif||alt="Shape10" height="1" width="302"]]
538 -
539 -__Regular Expression __Desired Output
540 -
541 -:
542 -
543 543  (((
544 -|[0-2]|A
545 -|[3-4]|B
493 +(% style="width:675.294px" %)
494 +|(% style="width:219px" %)(((
495 +**Regular Expression**
496 +)))|(% style="width:453px" %)**Desired Output**
497 +|(% style="width:219px" %)[0-2]|(% style="width:453px" %)A
498 +|(% style="width:219px" %)[3-4]|(% style="width:453px" %)B
499 +
500 +(% style="color:inherit; font-family:inherit; font-size:max(21px, min(23px, 17.4444px + 0.462963vw))" %)13.10.3 Observation Attributes for Time Period
546 546  )))
547 547  
548 -=== 13.10.3 Observation Attributes for Time Period ===
503 +This use case is where a specific observation for a specific [[time period>>doc:xwiki:Glossary.Time period.WebHome]] has an [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] value.
549 549  
550 -This use case is where a specific observation for a specific time period has an attribute 3468 value.
551 -
552 -:
553 -
554 554  (((
555 -|Input INDICATOR|Input TIME_PERIOD|Output OBS_CONF
556 -|XULADS|2008|C
557 -|XULADS|2009|C
558 -|XULADS|2010|C
506 +(% style="width:689.294px" %)
507 +|(% style="width:220px" %)**Input INDICATOR**|(% style="width:223px" %)**Input TIME_PERIOD**|(% style="width:243px" %)**Output OBS_CONF**
508 +|(% style="width:220px" %)XULADS|(% style="width:223px" %)2008|(% style="width:243px" %)C
509 +|(% style="width:220px" %)XULADS|(% style="width:223px" %)2009|(% style="width:243px" %)C
510 +|(% style="width:220px" %)XULADS|(% style="width:223px" %)2010|(% style="width:243px" %)C
559 559  )))
560 560  
561 -__Or using a validity period on the Representation Mapping__:
513 +Or using a validity period on the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] Mapping:
562 562  
563 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_6dbf7f.gif||alt="Shape11" height="36" width="555"]] Input INDICATOR Valid From/ Valid To Output OBS_CONF
515 +(% style="width:693.294px" %)
516 +|(% style="width:221px" %)**Input INDICATOR**|(% style="width:222px" %)**Valid From/ Valid To**|(% style="width:246px" %)**Output OBS_CONF**
517 +|(% style="width:221px" %)XULADS|(% style="width:222px" %)2008/2010|(% style="width:246px" %)C
564 564  
565 -XULADS 2008/2010 C
566 -
567 567  === 13.10.4 Time mapping ===
568 568  
569 -This use case is to create a time period from an input that does not respect SDMXTime Formats.
521 +This use case is to create a [[time period>>doc:xwiki:Glossary.Time period.WebHome]] from an input that does not respect SDMXTime Formats.
570 570  
571 -The Component Mapping from SYS_TIME to TIME_PERIOD specifies itself as a time mapping with the following details:
523 +The [[Component>>doc:xwiki:Glossary.Component.WebHome]] Mapping from SYS_TIME to TIME_PERIOD specifies itself as a time mapping with the following details:
572 572  
573 -:
574 -
575 575  (((
576 -|Source Value|Source Mapping|Target Frequency|Output
577 -|18/07/1981|dd/MM/yyyy|A|1981
526 +(% style="width:763.294px" %)
527 +|(% style="width:163px" %)**Source Value**|(% style="width:219px" %)**Source Mapping**|(% style="width:198px" %)**Target Frequency**|(% style="width:180px" %)**Output**
528 +|(% style="width:163px" %)18/07/1981|(% style="width:219px" %)dd/MM/yyyy|(% style="width:198px" %)A|(% style="width:180px" %)1981
578 578  )))
579 579  
580 -When the target frequency is based on another target Dimension value, in this example __the value of the FREQ Dimension in the tar__get DSD.
531 +When the target frequency is based on another target [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] value, in this example the value of the FREQ [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] in the target [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]].
581 581  
582 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_dbe68698.gif||alt="Shape12" height="1" width="273"]]
583 -
584 -:
585 -::
586 -
587 587  (((
588 -|Source Value|Source Mapping|Target Frequency Output Dimension
534 +(% style="width:734.294px" %)
535 +|(% style="width:165px" %)**Source Value**|(% style="width:220px" %)**Source Mapping**|(% style="width:161px" %)**Target Frequency**|(% style="width:251px" %)**Output Dimension**
536 +|(% style="width:165px" %)18/07/1981|(% style="width:220px" %)dd/MM/yyyy|(% style="width:161px" %)FREQ|(% style="width:251px" %)1981-07-18 (when FREQ=D)
589 589  
590 -|18/07/1981 dd/MM/yyyy|FREQ| |1981-07-18 (when FREQ=D)
591 -|(% rowspan="2" %)(((
592 -__When the source is a numerical form__at
538 +When the source is a numerical format
593 593  
594 -Source Value Start Period Interv
595 -)))| | |
596 -|al|(((
597 -Target
540 +(% style="width:892.294px" %)
541 +|(% style="width:165px" %)**Source Value**|(% style="width:133px" %)**Start Period**|(% style="width:191px" %)**Interv**|(% style="width:264px" %)**Target FREQ**|(% style="width:167px" %)**Output**
542 +|(% style="width:165px" %)1589808220|(% style="width:133px" %)1970|(% style="width:191px" %)millisecond|(% style="width:264px" %)1981-07-18 (when FREQ=D)|(% style="width:167px" %)2020-05
598 598  
599 -FREQ
600 -)))|Output
601 -|(% colspan="2" %)1589808220 1970 millisecond|M|2020-05
544 +When the source frequency is lower than the target frequency additional information 3485 can be provided for resolve to start of period, end of period, or mid period, as shown 3486 in the following example:
602 602  )))
603 603  
604 -When the source frequency is lower than the target frequency additional information 3485 can be provided for resolve to start of period, end of period, or mid period, as shown 3486 in the following example:
547 +(% style="width:892.294px" %)
548 +|(% style="width:165px" %)**Source Value**|(% style="width:133px" %)**Source Mapping**|(% style="width:191px" %)**Target Dimension**|(% style="width:264px" %)**Frequency**|(% style="width:167px" %)**Output**
549 +|(% style="width:165px" %)1981|(% style="width:133px" %)yyyy|(% style="width:191px" %)D – End of Period|(% style="width:264px" %) |(% style="width:167px" %)1981-12-31
605 605  
606 -Source Value Source Mapping Target Frequency Output
551 +When the start of year is April 1^^st^^ the Structure (% style="color:#2ecc71" %)Map(%%) has YearStart=04-01:
607 607  
608 -Dimension
553 +(% style="width:892.294px" %)
554 +|(% style="width:165px" %)**Source Value**|(% style="width:133px" %)**Source Mapping**|(% style="width:191px" %)**Target Dimension**|(% style="width:264px" %)**Frequency**|(% style="width:167px" %)**Output**
555 +|(% style="width:165px" %)1981|(% style="width:133px" %)yyyy|(% style="width:191px" %)D – End of Period|(% style="width:264px" %) |(% style="width:167px" %)1982-03-31
609 609  
610 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_4ec4bb31.gif||alt="Shape13" height="173" width="555"]] 1981 yyyy D – End of Period 1981-12-31
557 +----
611 611  
612 -When the start of year is April 1^^st^^ the Structure Map has YearStart=04-01:
613 -
614 -Source Value Source Mapping Target Frequency Output
615 -
616 -Dimension
617 -
618 -1981 yyyy D – End of Period 1982-03-31
619 -
620 620  {{putFootnotes/}}
1747377208446-496.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +28.0 KB
Content