Changes for page 9 Structure Map
Last modified by Artur on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,22 +1,26 @@ 1 -=== 9.1 Scope === 1 +{{box title="**Contents**"}} 2 +{{toc/}} 3 +{{/box}} 2 2 5 +== 9.1 Scope == 6 + 3 3 A StructureMap allows mapping between Data Structures or Dataflows. It ultimately maps one DataStructureDefinition to another (source to target) although it can do this via the Dataflow or directly against the DataStructureDefinition. 4 4 5 5 The StructureMap defines how the //structure// of a source DataStructureDefinition relates to the //structure// of the target DataStructureDefinition. The term //structure //in this instance refers to the Dimensions and Attributes (collectively called Components). An example relationship is source REF_AREA Dimension maps to target COUNTRY Dimension. When converting data, systems should interpret this, as ‘data reported against REF_AREA in the source dataset, should be converted to data against COUNTRY in the target dataset’. StructureMaps can make use of the RepresentationMap to describe how the reported value map, if there is a mapping to be done on the value, for example source REF_AREA.US may map to COUNTRY.USA. In the case of mapping Dates, the EpochMap or DatePatternMap is used and maintained in the StructureMap that uses it. 6 6 7 -=== =9.1.1 Class Diagram – Relationship ====11 +=== 9.1.1 Class Diagram – Relationship === 8 8 9 9 [[image:1749246555607-988.jpeg]] 10 10 11 11 **Figure 37: Relationship Class diagram of the Structure Map** 12 12 13 -=== =9.1.2 Explanation of the Diagram ====17 +=== 9.1.2 Explanation of the Diagram === 14 14 15 -==== =9.1.2.1 Narrative =====19 +==== 9.1.2.1 Narrative ==== 16 16 17 17 The StructureMap is a //MaintainableArtefact//. The StructureMap can either map a source and target DataStructureDefinition or a source and target Dataflow, it cannot mix source and target types. The StructureMap contains zero or more ComponentMaps. 18 18 19 -Each ComponentMap maps one or more //Component//s from the source DataStructureDefinition to one or more //Component//s in the target DataStructureDefinition [[^^~[1~]^^>>path:#_ftn1]]. In addition, the StructureMap contains zero or more FixedValueMaps. In this case, one or more //Component//s, from the source or target 1837 DataStructureDefinition, map to a fixed value.23 +Each ComponentMap maps one or more //Component//s from the source DataStructureDefinition to one or more //Component//s in the target DataStructureDefinition{{footnote}}Source and target Data Structure Definition are either directly linked from the StructureMap or indirectly via the linked source and target Dataflow{{/footnote}}. In addition, the StructureMap contains zero or more FixedValueMaps. In this case, one or more //Component//s, from the source or target 1837 DataStructureDefinition, map to a fixed value. 20 20 21 21 The rules pertaining to how reported values map, are maintained in either a RepresentationMap, EpochMap, or DatePatternMap. A ComponentMap can only reference one of these mapping types to define how the reported values relate from source Dataset to the target Dataset. If a ComponentMap has more than 1 source or target, a RepresentationMap must be used to describe how the values map, as it is the only map which can define multiple source and target values in combination. 22 22 ... ... @@ -24,15 +24,15 @@ 24 24 25 25 A RepresentationMap is a separate Maintainable structure. EpochMap and DatePatternMap are maintained in the same StructureMap and are referenced locally from the ComponentMap. EpochMap and DatePatternMap are maintained outside of the ComponentMap and can therefore be reused by multiple ComponentMaps. 26 26 27 -=== =9.1.3 Class Diagram – Epoch Mapping and Date Pattern Mapping ====31 +=== 9.1.3 Class Diagram – Epoch Mapping and Date Pattern Mapping === 28 28 29 29 [[image:1749246555612-421.jpeg]] 30 30 31 31 **Figure 38: Relationship Class diagram of the EpochMap and DatePatternMap** 32 32 33 -==== =9.1.4 Explanation of the Diagram =====37 +==== 9.1.4 Explanation of the Diagram ==== 34 34 35 -===== =9.1.4.1 Narrative ======39 +===== 9.1.4.1 Narrative ===== 36 36 37 37 The EpochMap and DatePatternMap are both //IdentifiableArtefact//. An EpochMap and DatePatternMap both provide the ability to map source to target date formats. The EpochMap describes the source date as the number of epochs since a point in time, where the duration of each epoch is defined, e.g., number of milliseconds since 1970. The DatePatternMap describes the source date as a pattern for example MM-YYYY, accompanied by the appropriate locale. 38 38 ... ... @@ -40,70 +40,62 @@ 40 40 41 41 If the Frequency Identifier aligns with standard SDMX frequencies the output date format can be derived using standard SDMX date formatting (e.g., A=YYYY, Q=YYYY-Qn). If the SDMX standard formatting is not desired or if the frequency Id is not a standard SDMX frequency Code, the FrequencyFormatMapping can be used to describe the relationship between the frequency Id and the output date format, e.g., A01=YYYY. 42 42 43 -===== =9.1.4.2 Definitions ======47 +===== 9.1.4.2 Definitions ===== 44 44 45 -|**Class**|**Feature**|**Description** 46 -|StructureMap|((( 49 +(% style="width:974.835px" %) 50 +|**Class**|(% style="width:197px" %)**Feature**|(% style="width:568px" %)**Description** 51 +|StructureMap|(% style="width:197px" %)((( 47 47 Inherits from 48 - 49 49 //MaintainableArtefact// 50 -)))|Links a source and target structure where there is a semantic equivalence between the source and the target structures. 51 -| |+sourceStructure|Association to the source Data Structure. 52 -| |+targetStructure|Association to the target Data Structure 53 -| |+sourceStructureUsage|Association to the source Dataflow. 54 -| |+targetStructureUsage|Association to the target Dataflow. 55 -|ComponentMap|((( 54 +)))|(% style="width:568px" %)Links a source and target structure where there is a semantic equivalence between the source and the target structures. 55 +| |(% style="width:197px" %)+sourceStructure|(% style="width:568px" %)Association to the source Data Structure. 56 +| |(% style="width:197px" %)+targetStructure|(% style="width:568px" %)Association to the target Data Structure 57 +| |(% style="width:197px" %)+sourceStructureUsage|(% style="width:568px" %)Association to the source Dataflow. 58 +| |(% style="width:197px" %)+targetStructureUsage|(% style="width:568px" %)Association to the target Dataflow. 59 +|ComponentMap|(% style="width:197px" %)((( 56 56 Inherits from 57 - 58 58 //AnnotableArtefact// 59 -)))|Links source and target Component(s) where there is a semantic equivalence between the source and the target Components. 60 -| |+source|Association to zero or more source Components. 61 -| |+target|Association to zero or more the target Components. 62 -| |mappingRules|((( 62 +)))|(% style="width:568px" %)Links source and target Component(s) where there is a semantic equivalence between the source and the target Components. 63 +| |(% style="width:197px" %)+source|(% style="width:568px" %)Association to zero or more source Components. 64 +| |(% style="width:197px" %)+target|(% style="width:568px" %)Association to zero or more the target Components. 65 +| |(% style="width:197px" %)mappingRules|(% style="width:568px" %)((( 63 63 Reference to either a 64 - 65 65 RepresentationMap, an 66 - 67 67 EpochMap or a DatePatternMap. 68 68 ))) 69 -|FixedValueMap|((( 70 +|FixedValueMap|(% style="width:197px" %)((( 70 70 Inherits from 71 - 72 72 //AnnotableArtefact// 73 -)))|Links a Component (source or target) to a fixed value. 74 -| |value|The value that a Component will be fixed in a fixed component map. 75 -|//DateMap//|((( 73 +)))|(% style="width:568px" %)Links a Component (source or target) to a fixed value. 74 +| |(% style="width:197px" %)value|(% style="width:568px" %)The value that a Component will be fixed in a fixed component map. 75 +|//DateMap//|(% style="width:197px" %)((( 76 76 Inherits from 77 - 78 78 //IdentifiableArtefact// 79 -)))| 80 -| |freqDimension|The Dimension or Attribute of the target Data Structure Definition which will hold the frequency information for date conversion. Mutually exclusive with targetFrequencyId. 81 -| |yearStart|The date of the start of the year, enabling mapping from high frequency to lower frequency formats. 82 -| |resolvePeriod|Which point in time to resolve to when mapping from low frequency to high frequency periods. 83 -| |mappedFrequencies|A reference to a map of frequency id to date pattern for output. 84 -|EpochMap|((( 78 +)))|(% style="width:568px" %) 79 +| |(% style="width:197px" %)freqDimension|(% style="width:568px" %)The Dimension or Attribute of the target Data Structure Definition which will hold the frequency information for date conversion. Mutually exclusive with targetFrequencyId. 80 +| |(% style="width:197px" %)yearStart|(% style="width:568px" %)The date of the start of the year, enabling mapping from high frequency to lower frequency formats. 81 +| |(% style="width:197px" %)resolvePeriod|(% style="width:568px" %)Which point in time to resolve to when mapping from low frequency to high frequency periods. 82 +| |(% style="width:197px" %)mappedFrequencies|(% style="width:568px" %)A reference to a map of frequency id to date pattern for output. 83 +|EpochMap|(% style="width:197px" %)((( 85 85 Inherits from 86 - 87 87 //DateMap// 88 -)))| 89 -| |basePeriod|Epoch zero starts on this period. 90 -| |targetFrequencyId|The frequency to convert the input date into. Mutually exclusive with freqDimension. 91 -| |epochPeriod|Describes the period of time that each epoch represents. 92 -|DatePatternMap|Inherits from //DateMap//|Described a source date based on a string pattern, and how it maps to the target date. 93 -| |locale|The locale on which the input will be parsed according to the pattern. 94 -|DateMapping| | 95 -| |sourcePattern|Describes the source date using conventions for describing years, months, days, etc. 96 -| |targetFrequencyId|The frequency to convert the input date into. Mutually exclusive with freqDimension. 97 -|FrequencyFormatMap 86 +)))|(% style="width:568px" %) 87 +| |(% style="width:197px" %)basePeriod|(% style="width:568px" %)Epoch zero starts on this period. 88 +| |(% style="width:197px" %)targetFrequencyId|(% style="width:568px" %)The frequency to convert the input date into. Mutually exclusive with freqDimension. 89 +| |(% style="width:197px" %)epochPeriod|(% style="width:568px" %)Describes the period of time that each epoch represents. 90 +|DatePatternMap|(% style="width:197px" %)Inherits from //DateMap//|(% style="width:568px" %)Described a source date based on a string pattern, and how it maps to the target date. 91 +| |(% style="width:197px" %)locale|(% style="width:568px" %)The locale on which the input will be parsed according to the pattern. 92 +|DateMapping|(% style="width:197px" %) |(% style="width:568px" %) 93 +| |(% style="width:197px" %)sourcePattern|(% style="width:568px" %)Describes the source date using conventions for describing years, months, days, etc. 94 +| |(% style="width:197px" %)targetFrequencyId|(% style="width:568px" %)The frequency to convert the input date into. Mutually exclusive with freqDimension. 95 +|FrequencyFormatMapping|(% style="width:197px" %)((( 98 98 Inherits from 99 - 100 100 //IdentifiableArtefact// 101 -)))|Describes the relationship between a frequency Id to the what the output date is formatted 102 -| |frequencyId|The string used to describe the frequency 103 -| |datePattern|The output date pattern for that frequency 98 +)))|(% style="width:568px" %)Describes the relationship between a frequency Id to the what the output date is formatted 99 +| |(% style="width:197px" %)frequencyId|(% style="width:568px" %)The string used to describe the frequency 100 +| |(% style="width:197px" %)datePattern|(% style="width:568px" %)The output date pattern for that frequency 104 104 105 - 106 - 107 107 ---- 108 108 109 -[[~[1~]>>path:#_ftnref1]] Source and target Data Structure Definition are either directly linked from the StructureMap or indirectly via the linked source and target Dataflow 104 + 105 +{{putFootnotes/}}
- SUZ.Methodology.Code.MethodologyClass[0]
-
- index
-
... ... @@ -1,0 +1,1 @@ 1 +10