Changes for page 13 Structure Mapping
Last modified by Artur on 2025/09/10 11:19
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Attachments (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Component|Data set|Dimension|Observation value|Series key|Statistical data and metadata exchange - Content
-
... ... @@ -4,97 +4,94 @@ 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:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structure mapping is to transform [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] from one dimensionality to another. In practice, this means that the input and output [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] conform to different Data Structure Definition. 8 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:sdmx: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:#e74c3c" %)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:sdmx:Glossary.Series key.WebHome]], but the same [[observation values>>doc:sdmx:Glossary.Observation value.WebHome]]; or 15 +1. Zero output series where no source rule matches the input [[Component>>doc:sdmx:Glossary.Component.WebHome]] values. 16 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:sdmx:Glossary.Data set.WebHome]]{{footnote}}Unidimensional datasets are those with a single 'indicator' or 'series code' dimension.{{/footnote}} to multi-dimensional; and 22 +* Transforming internal [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] with a complex structure to a simpler structure with fewer [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] suitable for dissemination. 23 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:sdmx:Glossary.Component.WebHome]] in the source structure is translated to a different value in the target, usually where different classification schemes are used for the same Concept. 27 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:sdmx:Glossary.Code.WebHome]] are (% style="color:#e74c3c" %)mapped(%%) to their ISO 3character equivalent. 29 29 30 -|Country|Alpha-2 code|Alpha-3 code 31 -|Afghanistan|AF|AFG 32 -|Albania|AL|ALB 33 -|Algeria|DZ|DZA 34 -|American Samoa|AS|ASM 35 -|Andorra|AD|AND 36 -|etc…| | 30 +(% style="width:585.294px" %) 31 +|(% style="width:173px" %)**Country**|(% style="width:180px" %)**Alpha-2 code**|(% style="width:229px" %)**Alpha-3 code** 32 +|(% style="width:173px" %)Afghanistan|(% style="width:180px" %)AF|(% style="width:229px" %)AFG 33 +|(% style="width:173px" %)Albania|(% style="width:180px" %)AL|(% style="width:229px" %)ALB 34 +|(% style="width:173px" %)Algeria|(% style="width:180px" %)DZ|(% style="width:229px" %)DZA 35 +|(% style="width:173px" %)American Samoa|(% style="width:180px" %)AS|(% style="width:229px" %)ASM 36 +|(% style="width:173px" %)Andorra|(% style="width:180px" %)AD|(% style="width:229px" %)AND 37 +|(% style="width:173px" %)etc…|(% style="width:180px" %) |(% style="width:229px" %) 37 37 38 -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]]. 39 39 40 -|Source Component: REF_AREA|Target Component: REGION 41 -|FR|EUR 42 -|DE|EUR 43 -|IT|EUR 44 -|ES|EUR 45 -|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 46 46 47 47 == 13.3 N-n structure maps == 48 48 49 -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. 50 50 51 51 Example: 52 52 53 -|Rule|Source|Target 54 -|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" %)((( 55 55 If 56 - 57 -FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L. 58 -)))|((( 59 +FREQUENCY=A; and 60 +ADJUSTMENT=N; and 61 +MATURITY=L. 62 +)))|(% style="width:378px" %)((( 59 59 Set 60 - 61 61 INDICATOR=A_N_L 62 62 ))) 63 -|2|((( 66 +|(% style="width:65px" %)2|(% style="width:519px" %)((( 64 64 If 65 - 66 -FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12. 67 -)))|((( 68 +FREQUENCY=M; and 69 +ADJUSTMENT=S_A1; and 70 +MATURITY=TY12. 71 +)))|(% style="width:378px" %)((( 68 68 Set 69 - 70 70 INDICATOR=MON_SAX_12 71 71 ))) 72 72 73 73 N-n rules can also set values for multiple source Components. 74 74 75 -|Rule|Source|Target 76 -|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" %)((( 77 77 If 78 - 79 79 FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L. 80 -)))|((( 83 +)))|(% style="width:383px" %)((( 81 81 Set 82 - 83 83 INDICATOR=A_N_L, STATUS=QXR15, 84 - 85 85 NOTE="Unadjusted". 86 86 ))) 87 -|2|((( 88 +|(% style="width:73px" %)2|(% style="width:506px" %)((( 88 88 If 89 - 90 90 FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12. 91 -)))|((( 91 +)))|(% style="width:383px" %)((( 92 92 Set 93 - 94 94 INDICATOR=MON_SAX_12, 95 - 96 96 STATUS=MPM12, 97 - 98 98 NOTE="Seasonally Adjusted" 99 99 ))) 100 100 ... ... @@ -104,127 +104,125 @@ 104 104 105 105 A simple example mapping a source dataset with a single dimension to one with multiple dimensions is shown below: 106 106 107 -|Source|Target|Output Series Key 108 -|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" %)((( 109 109 Dimensions 110 - 111 111 INDICATOR=XM 112 112 FREQ=A 113 113 ADJUSTMENT=N 114 114 Attributes 115 115 UNIT_MEASURE=_Z 116 - 117 117 COMP_ORG=21 118 -)))|XM:A:N 119 -|((( 114 +)))|(% style="width:397px" %)XM:A:N 115 +|(% style="width:257px" %)((( 120 120 SERIES_CODE=XMAN_Z_34 121 121 122 122 123 -)))|((( 119 +)))|(% style="width:315px" %)((( 124 124 Dimensions 125 - 126 126 INDICATOR=XM 127 - 128 128 FREQ=A 129 - 130 130 ADJUSTMENT=N 131 - 132 132 Attributes 133 - 134 134 UNIT_MEASURE=_Z 135 - 136 136 COMP_ORG=34 137 -)))|XM:A:N 127 +)))|(% style="width:397px" %)XM:A:N 138 138 139 -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. 140 140 141 141 == 13.5 Representation maps == 142 142 143 -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. 144 144 145 -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: 146 146 147 147 1. Codelist 148 148 1. Free Text (restricted by type, e.g String, Integer, Boolean) 149 149 1. Valuelist 150 150 151 -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: 152 152 153 -|CL_ISO_ALPHA2|CL_ISO_ALPHA3 154 -|AF|AFG 155 -|AL|ALB 156 -|DZ|DZA 157 -|AS|ASM 158 -|AD|AND 159 -|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" %) 160 160 161 -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: 162 162 163 -|Text|CL_ISO_ALPHA2 164 -|"Germany"|DE 165 -|"France"|FR 166 -|"United Kingdom"|GB 167 -|"Great Britain"|GB 168 -|"Ireland"|IE 169 -|"Eire"|IE 170 -|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" %) 171 171 172 -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. 173 173 174 -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. 175 175 176 176 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: 177 177 178 -|Value|Locale|Name 179 -|$|en|United States Dollar 180 -|%|En|Percentage 181 -| |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 182 182 183 -Other characteristics of Representation Maps: 176 +Other characteristics of [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%): 184 184 185 -* 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; 186 -* 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 187 -* 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. 188 -*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. 189 189 190 - Itiscommon for classifications to contain meanings within the identifier,forexample the code Id 'XULADS' mayrefer to a particularseasonalitybecause itstarts withthelettersXU.182 +== 13.6 Regular expression and substring rules == 191 191 192 - WithSDMX2.1 eachcodethatstartswith XU hadto beindividuallymappedtothe same seasonality,and additionalmappingsaddedwhennewCodes wereaddedto theCodelists.This ledtomanyhundreds or thousandsof mappings whichcan bemoreefficientlysummarisedinasingleconceptual 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. 193 193 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 + 194 194 //If starts with 'XU' map to 'Y'// 195 195 196 196 These rules are described using either regular expressions, or substrings for simpler use cases. 197 197 198 -=== 13. 5.1 Regular expressions ===192 +=== 13.6.1 Regular expressions === 199 199 200 -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. 201 201 202 -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]]. 203 203 204 -|Regex|Description|Output 205 -|A|Rule match if input = 'A'|OUT_A 206 -|^[A-G]|Rule match if the input starts with letters A to G|OUT_B 207 -|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 208 208 209 -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]]. 210 210 211 211 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 212 212 213 -|Regex|Target output|Example Input|Example Output 214 -|((( 215 -([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 216 216 217 -9]([0-9]{1}) 218 -)))|\1-Q\2|200933|2009-Q3 219 - 220 220 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. 221 221 222 222 The following example shows this: 223 223 224 -|Priority|Regex|Description|Output 225 -|1|A|Rule match if input = 'A'|OUT_A 226 -|2|B|Rule match if input = 'B'|OUT_B 227 -|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 228 228 229 229 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. 230 230 ... ... @@ -236,24 +236,27 @@ 236 236 237 237 For instance: 238 238 239 -|Input String|Start|Length|Output 240 -|ABC_DEF_XYZ|5|3|DEF 241 -|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 242 242 243 -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: 244 244 245 -|Start|Length|Source|Target 246 -|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 247 247 248 -== 13. 6Mapping non-SDMX time formats to SDMX formats ==245 +== 13.7 Mapping non-SDMX time formats to SDMX formats == 249 249 250 -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. 251 251 252 252 Two types of time input are defined: 253 253 254 -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. 255 255 256 -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: 257 257 258 258 |Frequency|Format|Example 259 259 |A|YYYY|2010 ... ... @@ -273,95 +273,95 @@ 273 273 274 274 There are two important points to note: 275 275 276 -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. 277 -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. 278 -11. 279 -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. 280 280 281 - Dateand time formats are specified by date and time pattern strings based on Java's Simple Date Format.Within date andtimepatternstrings, 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 canbe quoted using single quotes (') toavoid interpretation. "''" represents a single quote. All other characters are not interpreted;they're simply copiedinto the output string during formatting or matched againstthe input string during parsing.277 +=== 13.7.1 Pattern based dates === 282 282 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 + 283 283 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: 284 284 285 -|English (en)|Australia (AU)|en-AU 286 -|English (en)|Canada (CA)|en-CA 287 -|English (en)|United Kingdom (GB)|en-GB 288 -|English (en)|United States (US)|en-US 289 -|Estonian (et)|Estonia (EE)|et-EE 290 -|Finnish (fi)|Finland (FI)|fi-FI 291 -|French (fr)|Belgium (BE)|fr-BE 292 -|French (fr)|Canada (CA)|fr-CA 293 -|French (fr)|France (FR)|fr-FR 294 -|French (fr)|Luxembourg (LU)|fr-LU 295 -|French (fr)|Switzerland (CH)|fr-CH 296 -|German (de)|Austria (AT)|de-AT 297 -|German (de)|Germany (DE)|de-DE 298 -|German (de)|Luxembourg (LU)|de-LU 299 -|German (de)|Switzerland (CH)|de-CH 300 -|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]] 301 -|Greek (el)|Greece (GR)|el-GR 302 -|Hebrew (iw)|Israel (IL)|iw-IL 303 -|Hindi (hi)|India (IN)|hi-IN 304 -|Hungarian (hu)|Hungary (HU)|hu-HU 305 -|Icelandic (is)|Iceland (IS)|is-IS 306 -|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]] 307 -|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]] 308 -|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 309 309 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 + 310 310 Examples 311 311 312 312 22/06/1981 would be described as dd/MM/YYYY, with locale en-GB 313 - 314 314 2008-mars-12 would be described as YYYY-MMM-DD, with locale fr-FR 315 - 316 316 22 July 1981 would be described as dd MMMM YYYY, with locale en-US 317 - 318 318 22 Jul 1981 would be described as dd MMM YYYY 319 - 320 320 2010 D62 would be described as YYYYDnn (day 62 of the year 2010) 321 321 322 322 The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved): 323 323 324 -|Letter|Date or Time Component|Presentation|Examples 325 -|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 326 -|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 327 -|yyyy|Year Full (upper case is Year of Week)|Year|1996 328 -|MM|Month number in year starting with 1|Month|07 329 -|MMM|Month name short|Month|Jul 330 -|MMMM|Month name full|Month|July 331 -|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 332 -|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 333 -|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 334 -|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 335 -|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 336 -|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 337 -|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 338 -|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 339 -|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 340 -|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 341 -|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 342 -|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 343 -|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 344 -|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 345 -|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" %)((( 346 346 Number of periods, used after a SDMX 347 - 348 348 Frequency Identifier such as M, Q, D (month, quarter, day) 349 -)))| [[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]]|12346 +)))|(% style="width:180px" %)Number|(% style="width:157px" %)12 350 350 351 351 The model is illustrated below: 352 352 350 +[[image:1750074822764-573.png]] 353 353 354 - 355 355 **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?** 356 356 354 +[[image:1750074865924-797.png]] 357 357 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** 358 358 359 -=== =Figure25showing an input date format, whoseoutput frequencyisderivedfrom the output value oftheFREQ Dimension====359 +=== 13.7.2 Numerical based datetime === 360 360 361 - ===13.3.6Numerical 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: 362 362 363 -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: 364 - 365 365 * day 366 366 * second 367 367 * millisecond ... ... @@ -368,23 +368,21 @@ 368 368 * microsecond 369 369 * nanosecond 370 370 371 -|Numerical datetime systems|Base|Period 372 -|((( 369 +(% style="width:545.294px" %) 370 +|(% style="width:268px" %)Numerical datetime systems|(% style="width:121px" %)Base|(% style="width:153px" %)Period 371 +|(% style="width:268px" %)((( 373 373 Epoch Time (UNIX) 374 - 375 375 Milliseconds since 01 Jan 1970 376 -)))|1970|millisecond 377 -|((( 374 +)))|(% style="width:121px" %)1970|(% style="width:153px" %)millisecond 375 +|(% style="width:268px" %)((( 378 378 Windows System Time 379 - 380 380 Milliseconds since 01 Jan 1601 381 -)))|1601|millisecond 378 +)))|(% style="width:121px" %)1601|(% style="width:153px" %)millisecond 382 382 383 383 The example above illustrates numerical based datetime mapping rules for two commonly used time standards. 384 384 385 385 The model is illustrated below: 386 386 387 -[[image:1750072341491-790.jpeg]] 388 388 389 389 **Figure 26 showing the component map mapping the SOURCE_DATE Dimension to the** 390 390
- 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