Wiki source code of 13 Structure Mapping

Version 4.6 by Helena on 2025/06/16 14:44

version	line-number	content
1.1	1	{{box title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
	4
	5	== 13.1 Introduction ==
	6
4.3	7	The purpose of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structure mapping is to transform [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] from one dimensionality to another. In practice, this means that the input and output [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] conform to different Data Structure Definition.
1.1	8
4.3	9	Structure mapping does not alter the [[observation values>>doc:sdmx:Glossary.Observation value.WebHome]] and is not intended to perform any aggregations or calculations.
1.1	10
4.3	11	An input series (% style="color:#e74c3c" %)maps(%%) to:
1.1	12
	13	1. Exactly one output series; or
4.3	14	1. Multiple output series with different [[Series Keys>>doc:sdmx:Glossary.Series key.WebHome]], but the same [[observation values>>doc:sdmx:Glossary.Observation value.WebHome]]; or
	15	1. Zero output series where no source rule matches the input [[Component>>doc:sdmx:Glossary.Component.WebHome]] values.
1.1	16
	17	Typical use cases include:
	18
	19	* Transforming received data into a common internal structure;
	20	* Transforming reported data into the data collector's preferred structure;
4.3	21	* Transforming unidimensional [[datasets>>doc:sdmx:Glossary.Data set.WebHome]]{{footnote}}Unidimensional datasets are those with a single 'indicator' or 'series code' dimension.{{/footnote}} to multi-dimensional; and
	22	* Transforming internal [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] with a complex structure to a simpler structure with fewer [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] suitable for dissemination.
1.1	23
	24	== 13.2 1-1 structure maps ==
	25
4.4	26	1-1 (pronounced 'one to one') mappings support the simple use case where the value of a [[Component>>doc:sdmx:Glossary.Component.WebHome]] in the source structure is translated to a different value in the target, usually where different classification schemes are used for the same Concept.
1.1	27
4.4	28	In the example below, ISO 2-character country [[codes>>doc:sdmx:Glossary.Code.WebHome]] are (% style="color:#e74c3c" %)mapped(%%) to their ISO 3character equivalent.
1.1	29
4.4	30	(% style="width:585.294px" %)
	31	\|(% style="width:173px" %)Country\|(% style="width:180px" %)Alpha-2 code\|(% style="width:229px" %)Alpha-3 code
	32	\|(% style="width:173px" %)Afghanistan\|(% style="width:180px" %)AF\|(% style="width:229px" %)AFG
	33	\|(% style="width:173px" %)Albania\|(% style="width:180px" %)AL\|(% style="width:229px" %)ALB
	34	\|(% style="width:173px" %)Algeria\|(% style="width:180px" %)DZ\|(% style="width:229px" %)DZA
	35	\|(% style="width:173px" %)American Samoa\|(% style="width:180px" %)AS\|(% style="width:229px" %)ASM
	36	\|(% style="width:173px" %)Andorra\|(% style="width:180px" %)AD\|(% style="width:229px" %)AND
	37	\|(% style="width:173px" %)etc…\|(% style="width:180px" %) \|(% style="width:229px" %)
1.1	38
4.5	39	Different source values can also (% style="color:#e74c3c" %)map(%%) to the same target value, for example when deriving regions from country [[codes>>doc:sdmx:Glossary.Code.WebHome]].
1.1	40
4.5	41	(% style="width:490.294px" %)
	42	\|(% style="width:260px" %)Source Component: REF_AREA\|(% style="width:227px" %)Target Component: REGION
	43	\|(% style="width:260px" %)FR\|(% style="width:227px" %)EUR
	44	\|(% style="width:260px" %)DE\|(% style="width:227px" %)EUR
	45	\|(% style="width:260px" %)IT\|(% style="width:227px" %)EUR
	46	\|(% style="width:260px" %)ES\|(% style="width:227px" %)EUR
	47	\|(% style="width:260px" %)BE\|(% style="width:227px" %)EUR
1.1	48
	49	== 13.3 N-n structure maps ==
	50
4.5	51	N-n (pronounced 'N to N') mappings describe rules where a specified combination of values in multiple source [[Components>>doc:sdmx:Glossary.Component.WebHome]] (% style="color:#e74c3c" %)map(%%) to specified values in one or more target [[Components>>doc:sdmx:Glossary.Component.WebHome]]. For example, when mapping a partial [[Series Key>>doc:sdmx:Glossary.Series key.WebHome]] from a highly multidimensional cube (like Balance of Payments) to a single 'Indicator' [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in a target Data Structure.
1.1	52
	53	Example:
	54
4.5	55	(% style="width:964.294px" %)
	56	\|(% style="width:65px" %)Rule\|(% style="width:519px" %)Source\|(% style="width:378px" %)Target
	57	\|(% style="width:65px" %)1\|(% style="width:519px" %)(((
1.1	58	If
4.5	59	FREQUENCY=A; and
	60	ADJUSTMENT=N; and
	61	MATURITY=L.
	62	)))\|(% style="width:378px" %)(((
1.1	63	Set
	64	INDICATOR=A_N_L
	65	)))
4.5	66	\|(% style="width:65px" %)2\|(% style="width:519px" %)(((
1.1	67	If
4.5	68	FREQUENCY=M; and
	69	ADJUSTMENT=S_A1; and
	70	MATURITY=TY12.
	71	)))\|(% style="width:378px" %)(((
1.1	72	Set
	73	INDICATOR=MON_SAX_12
	74	)))
	75
	76	N-n rules can also set values for multiple source Components.
	77
4.5	78	(% style="width:965.294px" %)
	79	\|(% style="width:73px" %)Rule\|(% style="width:506px" %)Source\|(% style="width:383px" %)Target
	80	\|(% style="width:73px" %)1\|(% style="width:506px" %)(((
1.1	81	If
	82	FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
4.5	83	)))\|(% style="width:383px" %)(((
1.1	84	Set
	85	INDICATOR=A_N_L, STATUS=QXR15,
	86	NOTE="Unadjusted".
	87	)))
4.5	88	\|(% style="width:73px" %)2\|(% style="width:506px" %)(((
1.1	89	If
	90	FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
4.5	91	)))\|(% style="width:383px" %)(((
1.1	92	Set
	93	INDICATOR=MON_SAX_12,
	94	STATUS=MPM12,
	95	NOTE="Seasonally Adjusted"
	96	)))
	97
	98	== 13.4 Ambiguous mapping rules ==
	99
	100	A structure map is ambiguous if the rules result in a dataset containing multiple series with the same Series Key.
	101
	102	A simple example mapping a source dataset with a single dimension to one with multiple dimensions is shown below:
	103
4.5	104	(% style="width:972.294px" %)
	105	\|(% style="width:257px" %)Source\|(% style="width:315px" %)Target\|(% style="width:397px" %)Output Series Key
	106	\|(% style="width:257px" %)SERIES_CODE=XMAN_Z_21\|(% style="width:315px" %)(((
1.1	107	Dimensions
	108	INDICATOR=XM
	109	FREQ=A
	110	ADJUSTMENT=N
	111	Attributes
	112	UNIT_MEASURE=_Z
	113	COMP_ORG=21
4.5	114	)))\|(% style="width:397px" %)XM:A:N
	115	\|(% style="width:257px" %)(((
1.1	116	SERIES_CODE=XMAN_Z_34
	117
	118
4.5	119	)))\|(% style="width:315px" %)(((
1.1	120	Dimensions
	121	INDICATOR=XM
	122	FREQ=A
	123	ADJUSTMENT=N
	124	Attributes
	125	UNIT_MEASURE=_Z
	126	COMP_ORG=34
4.5	127	)))\|(% style="width:397px" %)XM:A:N
1.1	128
4.5	129	The above behaviour can be okay if the series XMAN_Z_21 contains observations for different periods of time then the series XMAN_Z_34. If however both series contain observations for the same point in time, the output for this mapping will be two observations with the same [[series key>>doc:sdmx:Glossary.Series key.WebHome]], for the same period in time.
1.1	130
	131	== 13.5 Representation maps ==
	132
4.5	133	[[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%) replace the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 Codelist (% style="color:#e74c3c" %)Maps(%%) and are used describe explicit mappings between source and target [[Component>>doc:sdmx:Glossary.Component.WebHome]] values.
1.1	134
4.5	135	The source and target of a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) can reference any of the following:
1.1	136
	137	1. Codelist
	138	1. Free Text (restricted by type, e.g String, Integer, Boolean)
	139	1. Valuelist
	140
4.5	141	A [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) mapping ISO 2-character to ISO 3-character Codelists would take the following form:
1.1	142
4.5	143	(% style="width:356.294px" %)
	144	\|(% style="width:167px" %)CL_ISO_ALPHA2\|(% style="width:186px" %)CL_ISO_ALPHA3
	145	\|(% style="width:167px" %)AF\|(% style="width:186px" %)AFG
	146	\|(% style="width:167px" %)AL\|(% style="width:186px" %)ALB
	147	\|(% style="width:167px" %)DZ\|(% style="width:186px" %)DZA
	148	\|(% style="width:167px" %)AS\|(% style="width:186px" %)ASM
	149	\|(% style="width:167px" %)AD\|(% style="width:186px" %)AND
	150	\|(% style="width:167px" %)etc…\|(% style="width:186px" %)
1.1	151
4.5	152	A [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) mapping free text country names to an ISO 2-character Codelist could be similarly described:
1.1	153
4.5	154	(% style="width:364.294px" %)
	155	\|(% style="width:169px" %)Text\|(% style="width:192px" %)CL_ISO_ALPHA2
	156	\|(% style="width:169px" %)"Germany"\|(% style="width:192px" %)DE
	157	\|(% style="width:169px" %)"France"\|(% style="width:192px" %)FR
	158	\|(% style="width:169px" %)"United Kingdom"\|(% style="width:192px" %)GB
	159	\|(% style="width:169px" %)"Great Britain"\|(% style="width:192px" %)GB
	160	\|(% style="width:169px" %)"Ireland"\|(% style="width:192px" %)IE
	161	\|(% style="width:169px" %)"Eire"\|(% style="width:192px" %)IE
	162	\|(% style="width:169px" %)etc…\|(% style="width:192px" %)
1.1	163
4.5	164	Valuelists, introduced in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, are equivalent to Codelists but allow the maintenance of non-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] identifiers. Importantly, their IDs do not need to conform to IDType, but as a consequence are not Identifiable.
1.1	165
4.5	166	When used in [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%), Valuelists allow Non-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] identifiers containing characters like £, $, % to be (% style="color:#e74c3c" %)mapped(%%) to [[Code>>doc:sdmx:Glossary.Code.WebHome]] IDs, or [[Codes>>doc:sdmx:Glossary.Code.WebHome]] (% style="color:#e74c3c" %)mapped(%%) to non-[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] identifiers.
1.1	167
	168	In common with Codelists, each item in a Valuelist has a multilingual name giving it a human-readable label and an optional description. For example:
	169
4.5	170	(% style="width:435.294px" %)
	171	\|(% style="width:126px" %)Value\|(% style="width:133px" %)Locale\|(% style="width:173px" %)Name
	172	\|(% style="width:126px" %)$\|(% style="width:133px" %)en\|(% style="width:173px" %)United States Dollar
	173	\|(% style="width:126px" %)%\|(% style="width:133px" %)En\|(% style="width:173px" %)Percentage
	174	\|(% style="width:126px" %) \|(% style="width:133px" %)fr\|(% style="width:173px" %)Pourcentage
1.1	175
4.5	176	Other characteristics of [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%):
1.1	177
4.5	178	* Support the (% style="color:#e74c3c" %)mapping(%%) of multiple source [[Component>>doc:sdmx:Glossary.Component.WebHome]] values to multiple Target [[Component>>doc:sdmx:Glossary.Component.WebHome]] values as described in section 13.3 on n-to-n mappings; this covers also the case of (% style="color:#e74c3c" %)mapping(%%) an [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with an array [[representation>>doc:sdmx:Glossary.Representation.WebHome]] to (% style="color:#e74c3c" %)map(%%) combinations of values to a single target value;
	179	* Allow source or target mappings for an Item to be optional allowing rules such as 'A (% style="color:#e74c3c" %)maps(%%) to nothing' or 'nothing (% style="color:#e74c3c" %)maps(%%) to A'; and
	180	* Support for (% style="color:#e74c3c" %)mapping(%%) rules where regular expressions or substrings are used to match source [[Component>>doc:sdmx:Glossary.Component.WebHome]] values. Refer to section 13.6 for more on this topic.
1.1	181
4.5	182	== 13.6 Regular expression and substring rules ==
1.1	183
4.5	184	It is common for classifications to contain meanings within the identifier, for example the [[code>>doc:sdmx:Glossary.Code.WebHome]] Id 'XULADS' may refer to a particular seasonality because it starts with the letters XU.
1.1	185
4.5	186	With [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 each [[code>>doc:sdmx:Glossary.Code.WebHome]] that starts with XU had to be individually (% style="color:#e74c3c" %)mapped(%%) to the same seasonality, and additional mappings added when new [[Codes>>doc:sdmx:Glossary.Code.WebHome]] were added to the Codelists. This led to many hundreds or thousands of mappings which can be more efficiently summarised in a single conceptual rule:
	187
1.1	188	//If starts with 'XU' map to 'Y'//
	189
	190	These rules are described using either regular expressions, or substrings for simpler use cases.
	191
	192	=== 13.5.1 Regular expressions ===
	193
	194	Regular expression mapping rules are defined in the Representation Map.
	195
	196	Below is an example set of regular expression rules for a particular component.
	197
4.6	198	(% style="width:664.294px" %)
	199	\|(% style="width:141px" %)Regex\|(% style="width:362px" %)Description\|(% style="width:158px" %)Output
	200	\|(% style="width:141px" %)A\|(% style="width:362px" %)Rule match if input = 'A'\|(% style="width:158px" %)OUT_A
	201	\|(% style="width:141px" %)^[A-G]\|(% style="width:362px" %)Rule match if the input starts with letters A to G\|(% style="width:158px" %)OUT_B
	202	\|(% style="width:141px" %)A~\|B\|(% style="width:362px" %)Rule match if input is either 'A' or 'B'\|(% style="width:158px" %)OUT_C
1.1	203
	204	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.
	205
	206	If the regular expression contains capture groups, these can be used in the definition of the output value, by specifying \//n//// //as an output value where //n// is the number of the capture group starting from 1. For example
	207
4.6	208	(% style="width:700.294px" %)
	209	\|(% style="width:203px" %)Regex\|(% style="width:148px" %)Target output\|(% style="width:157px" %)Example Input\|(% style="width:189px" %)Example Output
	210	\|(% style="width:203px" %)(((
	211	([0-9]{4})[0-9]([0-9]{1})
	212	)))\|(% style="width:148px" %)\1-Q\2\|(% style="width:157px" %)200933\|(% style="width:189px" %)2009-Q3
1.1	213
	214	As regular expression rules can be used as a general catch-all if nothing else matches, the ordering of the rules is important. Rules should be tested starting with the highest priority, moving down the list until a match is found.
	215
	216	The following example shows this:
	217
4.6	218	(% style="width:704.294px" %)
	219	\|(% style="width:130px" %)Priority\|(% style="width:125px" %)Regex\|(% style="width:241px" %)Description\|(% style="width:205px" %)Output
	220	\|(% style="width:130px" %)1\|(% style="width:125px" %)A\|(% style="width:241px" %)Rule match if input = 'A'\|(% style="width:205px" %)OUT_A
	221	\|(% style="width:130px" %)2\|(% style="width:125px" %)B\|(% style="width:241px" %)Rule match if input = 'B'\|(% style="width:205px" %)OUT_B
	222	\|(% style="width:130px" %)3\|(% style="width:125px" %)[A-Z]\|(% style="width:241px" %)Any character A-Z\|(% style="width:205px" %)OUT_C
1.1	223
	224	The input 'A' matches both the first and the last rule, but the first takes precedence having the higher priority. The output is OUT_A.
	225
	226	The input 'G' matches on the last rule which is used as a catch-all or default in this example.
	227
	228	=== 13. Substrings ===
	229
	230	Substrings provide an alternative to regular expressions where the required section of an input value can be described using the number of the starting character, and the length of the substring in characters. The first character is at position 1.
	231
	232	For instance:
	233
4.6	234	(% style="width:623.294px" %)
	235	\|(% style="width:169px" %)Input String\|(% style="width:147px" %)Start\|(% style="width:133px" %)Length\|(% style="width:171px" %)Output
	236	\|(% style="width:169px" %)ABC_DEF_XYZ\|(% style="width:147px" %)5\|(% style="width:133px" %)3\|(% style="width:171px" %)DEF
	237	\|(% style="width:169px" %)XULADS\|(% style="width:147px" %)1\|(% style="width:133px" %)2\|(% style="width:171px" %)XU
1.1	238
	239	Sub-strings can therefore be used for the conceptual rule //If starts with 'XU' map to Y// as shown in the following example:
	240
4.6	241	(% style="width:628.294px" %)
	242	\|(% style="width:163px" %)Start\|(% style="width:158px" %)Length\|(% style="width:128px" %)Source\|(% style="width:176px" %)Target
	243	\|(% style="width:163px" %)1\|(% style="width:158px" %)2\|(% style="width:128px" %)XU\|(% style="width:176px" %)Y
1.1	244
	245	== 13.6 Mapping non-SDMX time formats to SDMX formats ==
	246
	247	Structure mapping allows non-SDMX compliant time values in source datasets to be mapped to an SDMX compliant time format.
	248
	249	Two types of time input are defined:
	250
	251	a. Pattern based dates – a string which can be described using a notation like dd/mm/yyyy or is represented as the number of periods since a point in time, for example: 2010M001 (first month in 2010), or 2014D123 (123^^rd^^ day in 2014); and 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.
	252
	253	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
	255	\|Frequency\|Format\|Example
	256	\|A\|YYYY\|2010
	257	\|D\|YYYY-MM-DD\|2010-01-01
	258	\|I\|(((
	259	YYYY-MM-DD-
	260
	261	Thh:mm:ss
	262	)))\|2010-01T20:22:00
	263	\|M\|YYYY-MM\|2010-01
	264	\|Q\|YYYY-Qn\|2010-Q1
	265	\|S\|YYYY-Sn\|2010-S1
	266	\|T\|YYYY-Tn\|2010-T1
	267	\|W\|YYYY-Wn\|YYYY-W53
	268
	269	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.
	270
	271	There are two important points to note:
	272
	273	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.
	274	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.
4.5	275	11.
1.1	276	111. Pattern based dates
	277
	278	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.
	279
4.2	280	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:
1.1	281
	282	\|English (en)\|Australia (AU)\|en-AU
	283	\|English (en)\|Canada (CA)\|en-CA
	284	\|English (en)\|United Kingdom (GB)\|en-GB
	285	\|English (en)\|United States (US)\|en-US
	286	\|Estonian (et)\|Estonia (EE)\|et-EE
	287	\|Finnish (fi)\|Finland (FI)\|fi-FI
	288	\|French (fr)\|Belgium (BE)\|fr-BE
	289	\|French (fr)\|Canada (CA)\|fr-CA
	290	\|French (fr)\|France (FR)\|fr-FR
	291	\|French (fr)\|Luxembourg (LU)\|fr-LU
	292	\|French (fr)\|Switzerland (CH)\|fr-CH
	293	\|German (de)\|Austria (AT)\|de-AT
	294	\|German (de)\|Germany (DE)\|de-DE
	295	\|German (de)\|Luxembourg (LU)\|de-LU
	296	\|German (de)\|Switzerland (CH)\|de-CH
	297	\|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]]
	298	\|Greek (el)\|Greece (GR)\|el-GR
	299	\|Hebrew (iw)\|Israel (IL)\|iw-IL
	300	\|Hindi (hi)\|India (IN)\|hi-IN
	301	\|Hungarian (hu)\|Hungary (HU)\|hu-HU
	302	\|Icelandic (is)\|Iceland (IS)\|is-IS
	303	\|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]]
	304	\|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]]
	305	\|Italian (it)\|Italy (IT)\|it-IT
	306
	307	Examples
	308
	309	22/06/1981 would be described as dd/MM/YYYY, with locale en-GB
	310
	311	2008-mars-12 would be described as YYYY-MMM-DD, with locale fr-FR
	312
	313	22 July 1981 would be described as dd MMMM YYYY, with locale en-US
	314
	315	22 Jul 1981 would be described as dd MMM YYYY
	316
	317	2010 D62 would be described as YYYYDnn (day 62 of the year 2010)
	318
	319	The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):
	320
	321	\|Letter\|Date or Time Component\|Presentation\|Examples
	322	\|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
4.2	323	\|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
1.1	324	\|yyyy\|Year Full (upper case is Year of Week)\|Year\|1996
	325	\|MM\|Month number in year starting with 1\|Month\|07
	326	\|MMM\|Month name short\|Month\|Jul
	327	\|MMMM\|Month name full\|Month\|July
	328	\|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
	329	\|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
	330	\|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
	331	\|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
	332	\|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
	333	\|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
	334	\|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
	335	\|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
	336	\|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
	337	\|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
	338	\|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
	339	\|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
	340	\|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
	341	\|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
	342	\|n\|(((
	343	Number of periods, used after a SDMX
	344
	345	Frequency Identifier such as M, Q, D (month, quarter, day)
	346	)))\|[[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
	347
	348	The model is illustrated below:
	349
	350
	351
	352	Figure 24 showing the component map mapping the SOURCE_DATE Dimension to the TIME_PERIOD dimension with the additional information on the component map to describe the time format?
	353
	354
	355
	356	==== Figure 25 showing an input date format, whose output frequency is derived from the output value of the FREQ Dimension ====
	357
	358	=== 13.3.6 Numerical based datetime ===
	359
	360	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:
	361
	362	* day
	363	* second
	364	* millisecond
	365	* microsecond
	366	* nanosecond
	367
	368	\|Numerical datetime systems\|Base\|Period
	369	\|(((
	370	Epoch Time (UNIX)
	371
	372	Milliseconds since 01 Jan 1970
	373	)))\|1970\|millisecond
	374	\|(((
	375	Windows System Time
	376
	377	Milliseconds since 01 Jan 1601
	378	)))\|1601\|millisecond
	379
	380	The example above illustrates numerical based datetime mapping rules for two commonly used time standards.
	381
	382	The model is illustrated below:
	383
	384	[[image:1750072341491-790.jpeg]]
	385
	386	Figure 26 showing the component map mapping the SOURCE_DATE Dimension to the
	387
	388	==== TIME_PERIOD Dimension with the additional information on the component map to describe the numerical datetime system in use ====
	389
	390	=== Mapping more complex time inputs ===
	391
	392	VTL should be used for more complex time inputs that cannot be interpreted using the pattern based on numerical methods.
	393
	394	== Using TIME_PERIOD in mapping rules ==
	395
	396	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.
	397
	398	The main use case is setting the value of Observation Attributes in the target dataset.
	399
	400	\|Rule\|Source\|Target
	401	\|1\|(((
	402	If
	403
	404	INDICATOR=XULADS; and TIME_PERIOD=2007.
	405	)))\|(((
	406	Set
	407
	408	OBS_CONF=F
	409	)))
	410	\|2\|(((
	411	If
	412
	413	INDICATOR=XULADS; and TIME_PERIOD=2008.
	414	)))\|Set OBS_CONF=F
	415	\|3\|(((
	416	If
	417
	418	INDICATOR=XULADS; and TIME_PERIOD=2009.
	419	)))\|(((
	420	Set
	421
	422	OBS_CONF=F
	423	)))
	424	\|4\|(((
	425	If
	426
	427	INDICATOR=XULADS; and TIME_PERIOD=2010.
	428	)))\|(((
	429	Set
	430
	431	OBS_CONF=C
	432	)))
	433
	434	In the example above, OBS_CONF is an Observation Attribute.
	435
	436	== 13. Time span mapping rules using validity periods ==
	437
	438	Creating discrete mapping rules for each TIME_PERIOD is impractical where rules need to cover a specific span of time regardless of frequency, and for high-frequency data.
	439
	440	Instead, an optional validity period can be set for each mapping.
	441
	442	By specifying validity periods, the example from Section 13.8 can be re-written using two rules as follows:
	443
	444	\|Rule\|Source\|Target
	445	\|1\|(((
	446	If
	447
	448	INDICATOR=XULADS.
	449
	450
	451	Validity Period start period=2007 end period=2009
	452	)))\|Set OBS_CONF=F
	453	\|2\|(((
	454	If
	455
	456	INDICATOR=XULADS.
	457
	458
	459	Validity Period start period=2010
	460	)))\|(((
	461	Set
	462
	463	OBS_CONF=F
	464	)))
	465
	466	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.
	467
	468	In Rule 2, no end period is specified so remains in effect from the start of the period (2010-01-01T00:00:00) until the end of time. Any observations reporting data for the Indicator XULADS that fall into that time range will have an OBS_CONF value of C.
	469
	470	== 13. Mapping examples ==
	471
	472	=== 13. Many to one mapping (N-1) ===
	473
	474	\|Source\|Map To
	475	\|(((
	476	FREQ="A"
	477
	478	ADJUSTMENT="N"
	479
	480	REF_AREA="PL"
	481
	482	COUNTERPART_AREA="W0"
	483
	484	REF_SECTOR="S1"
	485
	486	COUNTERPART_SECTOR="S1"
	487
	488	ACCOUNTING_ENTRY="B"
	489
	490	STO="B5G"
	491	)))\|(((
	492	FREQ="A"
	493
	494	REF_AREA="PL"
	495
	496	COUNTERPART_AREA="W0"
	497	INDICATOR="IND_ABC"
	498
	499	)))
	500
	501	The bold Dimensions map from source to target verbatim. The mapping simply specifies:
	502
	503	FREQ => FREQ
	504
	505	REF_AREA=> REF_AREA
	506
	507	COUNTERPART_AREA=> COUNTERPART _AREA
	508
	509	No Representation Mapping is required. The source value simply copies across unmodified.
	510
	511	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:
	512
	513	N:S1:S1:B:B5G => IND_ABC
	514
	515	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.
	516
	517	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.
	518
4.5	519	1.
	520	11.
1.1	521	111. Mapping other data types to Code Id
	522
	523	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.
	524
	525	The following representation mapping can be used to explicitly map each age to an output code.
	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
	533
	534	If this mapping takes advantage of regular expressions it can be expressed in two rules:
	535
	536
	537	Regular Expression Desired Output
	538
	539	\|[0-2]\|A
	540	\|[3-4]\|B
	541
	542	=== 13. Observation Attributes for Time Period ===
	543
	544	This use case is where a specific observation for a specific time period has an attribute value.
	545
	546	\|Input INDICATOR\|Input TIME_PERIOD\|Output OBS_CONF
	547	\|XULADS\|2008\|C
	548	\|XULADS\|2009\|C
	549	\|XULADS\|2010\|C
	550
	551	Or using a validity period on the Representation Mapping:
	552
	553	Input INDICATOR Valid From/ Valid To Output OBS_CONF
	554
	555	XULADS 2008/2010 C
	556
	557	=== 13. Time mapping ===
	558
	559	This use case is to create a time period from an input that does not respect SDMX Time Formats.
	560
	561	The Component Mapping from SYS_TIME to TIME_PERIOD specifies itself as a time mapping with the following details:
	562
	563	\|Source Value\|Source Mapping\|Target Frequency\|Output
	564	\|18/07/1981\|dd/MM/yyyy\|A\|1981
	565
	566	When the target frequency is based on another target Dimension value, in this example the value of the FREQ Dimension in the target DSD.
	567
	568	Source Value Source Mapping Target Frequency Output
	569
	570	Dimension
	571
	572	\|18/07/1981 dd/MM/yyyy FREQ\| \|1981-07-18 (when FREQ=D)
	573	\| When the source is a numerical format\| \|
	574	\|Source Value Start Period Interval\|(((
	575	Target
	576
	577	FREQ
	578	)))\|Output
	579	\|1589808220 1970 millisecond\|M\|2020-05
	580
	581	When the source frequency is lower than the target frequency additional information 3568 can be provided for resolve to start of period, end of period, or mid period, as shown 3569 in the following example:
	582
	583	Source Value Source Mapping Target Frequency Output
	584
	585	Dimension
	586
	587	1981 yyyy D – End of Period 1981-12-31
	588
	589
	590	When the start of year is April 1^^st^^ the Structure Map has YearStart=04-01:
	591
	592	Source Value Source Mapping Target Frequency Output
	593
	594	Dimension
	595
	596	----
	597
4.2	598	{{putFootnotes/}}