Changes for page 13 Structure Mapping

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

From 4.4 to 4.3 From 4.9 to 4.8

From version 4.8

edited by Helena
on 2025/06/16 14:49

Change comment: There is no comment for this version

To version 4.4

edited by Helena
on 2025/06/16 14:22

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -36,62 +36,66 @@
  |(% style="width:173px" %)Andorra|(% style="width:180px" %)AD|(% style="width:229px" %)AND
  |(% style="width:173px" %)etc…|(% style="width:180px" %) |(% style="width:229px" %)
--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]].
++Different source values can also map to the same target value, for example when deriving regions from country codes.
--(% style="width:490.294px" %)
--|(% style="width:260px" %)Source Component: REF_AREA|(% style="width:227px" %)Target Component: REGION
--|(% style="width:260px" %)FR|(% style="width:227px" %)EUR
--|(% style="width:260px" %)DE|(% style="width:227px" %)EUR
--|(% style="width:260px" %)IT|(% style="width:227px" %)EUR
--|(% style="width:260px" %)ES|(% style="width:227px" %)EUR
--|(% style="width:260px" %)BE|(% style="width:227px" %)EUR
++|Source Component: REF_AREA|Target Component: REGION
++|FR|EUR
++|DE|EUR
++|IT|EUR
++|ES|EUR
++|BE|EUR
  == 13.3 N-n structure maps ==
--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.
++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.
  Example:
--(% style="width:964.294px" %)
--|(% style="width:65px" %)Rule|(% style="width:519px" %)Source|(% style="width:378px" %)Target
--|(% style="width:65px" %)1|(% style="width:519px" %)(((
++|Rule|Source|Target
++|1|(((
  If
--FREQUENCY=A; and
--ADJUSTMENT=N; and
--MATURITY=L.
--)))|(% style="width:378px" %)(((
++
++FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
++)))|(((
  Set
++
  INDICATOR=A_N_L
  )))
--|(% style="width:65px" %)2|(% style="width:519px" %)(((
++|2|(((
  If
--FREQUENCY=M; and
--ADJUSTMENT=S_A1; and
--MATURITY=TY12.
--)))|(% style="width:378px" %)(((
++
++FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
++)))|(((
  Set
++
  INDICATOR=MON_SAX_12
  )))
  N-n rules can also set values for multiple source Components.
--(% style="width:965.294px" %)
--|(% style="width:73px" %)Rule|(% style="width:506px" %)Source|(% style="width:383px" %)Target
--|(% style="width:73px" %)1|(% style="width:506px" %)(((
++|Rule|Source|Target
++|1|(((
  If
++
  FREQUENCY=A; and ADJUSTMENT=N; and MATURITY=L.
--)))|(% style="width:383px" %)(((
++)))|(((
  Set
++
  INDICATOR=A_N_L, STATUS=QXR15,
++
  NOTE="Unadjusted".
  )))
--|(% style="width:73px" %)2|(% style="width:506px" %)(((
++|2|(((
  If
++
  FREQUENCY=M; and ADJUSTMENT=S_A1; and MATURITY=TY12.
--)))|(% style="width:383px" %)(((
++)))|(((
  Set
++
  INDICATOR=MON_SAX_12,
++
  STATUS=MPM12,
++
  NOTE="Seasonally Adjusted"
  )))
@@ -101,125 +101,127 @@
  A simple example mapping a source dataset with a single dimension to one with multiple dimensions is shown below:
--(% style="width:972.294px" %)
--|(% style="width:257px" %)Source|(% style="width:315px" %)Target|(% style="width:397px" %)Output Series Key
--|(% style="width:257px" %)SERIES_CODE=XMAN_Z_21|(% style="width:315px" %)(((
++|Source|Target|Output Series Key
++|SERIES_CODE=XMAN_Z_21|(((
  Dimensions
++
  INDICATOR=XM
  FREQ=A
  ADJUSTMENT=N
  Attributes
  UNIT_MEASURE=_Z
++
  COMP_ORG=21
--)))|(% style="width:397px" %)XM:A:N
--|(% style="width:257px" %)(((
++)))|XM:A:N
++|(((
  SERIES_CODE=XMAN_Z_34
--)))|(% style="width:315px" %)(((
++)))|(((
  Dimensions
++
  INDICATOR=XM
++
  FREQ=A
++
  ADJUSTMENT=N
++
  Attributes
++
  UNIT_MEASURE=_Z
++
  COMP_ORG=34
--)))|(% style="width:397px" %)XM:A:N
++)))|XM:A:N
--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.
++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.
  == 13.5 Representation maps ==
--[[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.
++Representation Maps replace the SDMX 2.1 Codelist Maps and are used describe explicit mappings between source and target Component values.
--The source and target of a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map(%%) can reference any of the following:
++The source and target of a Representation Map can reference any of the following:
 . Codelist
 . Free Text (restricted by type, e.g String, Integer, Boolean)
 . Valuelist
--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:
++A Representation Map mapping ISO 2-character to ISO 3-character Codelists would take the following form:
--(% style="width:356.294px" %)
--|(% style="width:167px" %)CL_ISO_ALPHA2|(% style="width:186px" %)CL_ISO_ALPHA3
--|(% style="width:167px" %)AF|(% style="width:186px" %)AFG
--|(% style="width:167px" %)AL|(% style="width:186px" %)ALB
--|(% style="width:167px" %)DZ|(% style="width:186px" %)DZA
--|(% style="width:167px" %)AS|(% style="width:186px" %)ASM
--|(% style="width:167px" %)AD|(% style="width:186px" %)AND
--|(% style="width:167px" %)etc…|(% style="width:186px" %)
++|CL_ISO_ALPHA2|CL_ISO_ALPHA3
++|AF|AFG
++|AL|ALB
++|DZ|DZA
++|AS|ASM
++|AD|AND
++|etc…|
--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:
++A Representation Map mapping free text country names to an ISO 2-character Codelist could be similarly described:
--(% style="width:364.294px" %)
--|(% style="width:169px" %)Text|(% style="width:192px" %)CL_ISO_ALPHA2
--|(% style="width:169px" %)"Germany"|(% style="width:192px" %)DE
--|(% style="width:169px" %)"France"|(% style="width:192px" %)FR
--|(% style="width:169px" %)"United Kingdom"|(% style="width:192px" %)GB
--|(% style="width:169px" %)"Great Britain"|(% style="width:192px" %)GB
--|(% style="width:169px" %)"Ireland"|(% style="width:192px" %)IE
--|(% style="width:169px" %)"Eire"|(% style="width:192px" %)IE
--|(% style="width:169px" %)etc…|(% style="width:192px" %)
++|Text|CL_ISO_ALPHA2
++|"Germany"|DE
++|"France"|FR
++|"United Kingdom"|GB
++|"Great Britain"|GB
++|"Ireland"|IE
++|"Eire"|IE
++|etc…|
--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.
++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.
--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.
++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.
  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:
--(% style="width:435.294px" %)
--|(% style="width:126px" %)Value|(% style="width:133px" %)Locale|(% style="width:173px" %)Name
--|(% style="width:126px" %)$|(% style="width:133px" %)en|(% style="width:173px" %)United States Dollar
--|(% style="width:126px" %)%|(% style="width:133px" %)En|(% style="width:173px" %)Percentage
--|(% style="width:126px" %) |(% style="width:133px" %)fr|(% style="width:173px" %)Pourcentage
++|Value|Locale|Name
++|$|en|United States Dollar
++|%|En|Percentage
++| |fr|Pourcentage
--Other characteristics of [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Maps(%%):
++Other characteristics of Representation Maps:
--* 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;
--* 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
--* 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.
++* 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;
++* 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
++* 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.
++*1. Regular expression and substring rules
--== 13.6 Regular expression and substring rules ==
++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.
--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.
++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:
--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:
--
  //If starts with 'XU' map to 'Y'//
  These rules are described using either regular expressions, or substrings for simpler use cases.
--=== 13.6.1 Regular expressions ===
++=== 13.5.1 Regular expressions ===
--Regular expression mapping rules are defined in the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Map.
++Regular expression mapping rules are defined in the Representation Map.
--Below is an example set of regular expression rules for a particular [[component>>doc:sdmx:Glossary.Component.WebHome]].
++Below is an example set of regular expression rules for a particular component.
--(% style="width:664.294px" %)
--|(% style="width:141px" %)**Regex**|(% style="width:362px" %)**Description**|(% style="width:158px" %)**Output**
--|(% style="width:141px" %)A|(% style="width:362px" %)Rule match if input = 'A'|(% style="width:158px" %)OUT_A
--|(% style="width:141px" %)^[A-G]|(% style="width:362px" %)Rule match if the input starts with letters A to G|(% style="width:158px" %)OUT_B
--|(% style="width:141px" %)A~|B|(% style="width:362px" %)Rule match if input is either 'A' or 'B'|(% style="width:158px" %)OUT_C
++|Regex|Description|Output
++|A|Rule match if input = 'A'|OUT_A
++|^[A-G]|Rule match if the input starts with letters A to G|OUT_B
++|A~|B|Rule match if input is either 'A' or 'B'|OUT_C
--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]].
++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.
  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
--(% style="width:700.294px" %)
--|(% style="width:203px" %)Regex|(% style="width:148px" %)Target output|(% style="width:157px" %)Example Input|(% style="width:189px" %)Example Output
--|(% style="width:203px" %)(((
--([0-9]{4})[0-9]([0-9]{1})
--)))|(% style="width:148px" %)\1-Q\2|(% style="width:157px" %)200933|(% style="width:189px" %)2009-Q3
++|Regex|Target output|Example Input|Example Output
++|(((
++([0-9]{4})[0-
++9]([0-9]{1})
++)))|\1-Q\2|200933|2009-Q3
++
  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.
  The following example shows this:
--(% style="width:704.294px" %)
--|(% style="width:130px" %)Priority|(% style="width:125px" %)Regex|(% style="width:241px" %)Description|(% style="width:205px" %)Output
--|(% style="width:130px" %)1|(% style="width:125px" %)A|(% style="width:241px" %)Rule match if input = 'A'|(% style="width:205px" %)OUT_A
--|(% style="width:130px" %)2|(% style="width:125px" %)B|(% style="width:241px" %)Rule match if input = 'B'|(% style="width:205px" %)OUT_B
--|(% style="width:130px" %)3|(% style="width:125px" %)[A-Z]|(% style="width:241px" %)Any character A-Z|(% style="width:205px" %)OUT_C
++|Priority|Regex|Description|Output
++|1|A|Rule match if input = 'A'|OUT_A
++|2|B|Rule match if input = 'B'|OUT_B
++|3|[A-Z]|Any character A-Z|OUT_C
  The input 'A' matches both the first and the last rule, but the first takes precedence having the higher priority. The output is OUT_A.
@@ -231,27 +231,24 @@
  For instance:
--(% style="width:623.294px" %)
--|(% style="width:169px" %)Input String|(% style="width:147px" %)Start|(% style="width:133px" %)Length|(% style="width:171px" %)Output
--|(% style="width:169px" %)ABC_DEF_XYZ|(% style="width:147px" %)5|(% style="width:133px" %)3|(% style="width:171px" %)DEF
--|(% style="width:169px" %)XULADS|(% style="width:147px" %)1|(% style="width:133px" %)2|(% style="width:171px" %)XU
++|Input String|Start|Length|Output
++|ABC_DEF_XYZ|5|3|DEF
++|XULADS|1|2|XU
--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:
++Sub-strings can therefore be used for the conceptual rule //If starts with 'XU' map to Y// as shown in the following example:
--(% style="width:628.294px" %)
--|(% style="width:163px" %)Start|(% style="width:158px" %)Length|(% style="width:128px" %)Source|(% style="width:176px" %)Target
--|(% style="width:163px" %)1|(% style="width:158px" %)2|(% style="width:128px" %)XU|(% style="width:176px" %)Y
++|Start|Length|Source|Target
++|1|2|XU|Y
--== 13.7 Mapping non-SDMX time formats to SDMX formats ==
++== 13.6 Mapping non-SDMX time formats to SDMX formats ==
--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.
++Structure mapping allows non-SDMX compliant time values in source datasets to be mapped to an SDMX compliant time format.
  Two types of time input are defined:
--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.
++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.
--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:
++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:
  |Frequency|Format|Example
  |A|YYYY|2010
@@ -271,13 +271,13 @@
  There are two important points to note:
--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.
--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.
++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.
++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.
++11.
++111. Pattern based dates
--=== 13.7.1 Pattern based dates ===
++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.
--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.
--
  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:
  |English (en)|Australia (AU)|en-AU