Skip to Content

Changes for page 9 Structure Map

Last modified by Helena K. on 2026/06/08 17:16
From version 18.3
edited by Helena K.
on 2026/06/08 17:12
Change comment: There is no comment for this version
To version 3.2
edited by Helena K.
on 2025/06/08 11:47
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,13 +4,13 @@
4 4  
5 5  == 9.1 Scope ==
6 6  
7 -A StructureMap allows mapping between Data Structures or [[Dataflows>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]]. It ultimately maps one DataStructureDefinition to another (source to target) although it can do this via the [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] or directly against the DataStructureDefinition.
7 +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.
8 8  
9 -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>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] and [[Attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] (collectively called [[Components>>doc:sdmx:Glossary 2\.1.Component.WebHome]]). An example relationship is source REF_AREA [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] maps to target COUNTRY [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]]. When converting data, systems should interpret this, as ‘data reported against REF_AREA in the source [[dataset>>doc:sdmx:Glossary 2\.1.Data set.WebHome]], should be converted to data against COUNTRY in the target [[dataset>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]’. 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.
9 +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.
10 10  
11 11  === 9.1.1 Class Diagram – Relationship ===
12 12  
13 -[[image:image63.png]]
13 +[[image:1749246555607-988.jpeg]]
14 14  
15 15  **Figure 37: Relationship Class diagram of the Structure Map**
16 16  
... ... @@ -30,13 +30,13 @@
30 30  
31 31  === 9.1.3 Class Diagram – Epoch Mapping and Date Pattern Mapping ===
32 32  
33 -[[image:image64.png]]
33 +[[image:1749246555612-421.jpeg]]
34 34  
35 35  **Figure 38: Relationship Class diagram of the EpochMap and DatePatternMap**
36 36  
37 -=== 9.1.4 Explanation of the Diagram ===
37 +==== 9.1.4 Explanation of the Diagram ====
38 38  
39 -==== 9.1.4.1 Narrative ====
39 +===== 9.1.4.1 Narrative =====
40 40  
41 41  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.
42 42  
... ... @@ -44,59 +44,61 @@
44 44  
45 45  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.
46 46  
47 -==== 9.1.4.2 Definitions ====
47 +===== 9.1.4.2 Definitions =====
48 48  
49 -(% style="width:974.835px" %)
50 -|**Class**|(% style="width:197px" %)**Feature**|(% style="width:568px" %)**Description**
51 -|StructureMap|(% style="width:197px" %)(((
49 +|**Class**|**Feature**|**Description**
50 +|StructureMap|(((
52 52  Inherits from
53 53  //MaintainableArtefact//
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" %)(((
53 +)))|Links a source and target structure where there is a semantic equivalence between the source and the target structures.
54 +| |+sourceStructure|Association to the source Data Structure.
55 +| |+targetStructure|Association to the target Data Structure
56 +| |+sourceStructureUsage|Association to the source Dataflow.
57 +| |+targetStructureUsage|Association to the target Dataflow.
58 +|ComponentMap|(((
60 60  Inherits from
61 61  //AnnotableArtefact//
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" %)(((
66 -Reference to either a RepresentationMap, an EpochMap or a DatePatternMap.
61 +)))|Links source and target Component(s) where there is a semantic equivalence between the source and the target Components.
62 +| |+source|Association to zero or more source Components.
63 +| |+target|Association to zero or more the target Components.
64 +| |mappingRules|(((
65 +Reference to either a
66 +RepresentationMap, an
67 +EpochMap or a DatePatternMap.
67 67  )))
68 -|FixedValueMap|(% style="width:197px" %)(((
69 +|FixedValueMap|(((
69 69  Inherits from
70 70  //AnnotableArtefact//
71 -)))|(% style="width:568px" %)Links a Component (source or target) to a fixed value.
72 -| |(% style="width:197px" %)value|(% style="width:568px" %)The value that a Component will be fixed in a fixed component map.
73 -|//DateMap//|(% style="width:197px" %)(((
72 +)))|Links a Component (source or target) to a fixed value.
73 +| |value|The value that a Component will be fixed in a fixed component map.
74 +|//DateMap//|(((
74 74  Inherits from
75 75  //IdentifiableArtefact//
76 -)))|(% style="width:568px" %)
77 -| |(% 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.
78 -| |(% style="width:197px" %)yearStart|(% style="width:568px" %)The date of the start of the year, enabling mapping from high frequency to lower frequency formats.
79 -| |(% style="width:197px" %)resolvePeriod|(% style="width:568px" %)Which point in time to resolve to when mapping from low frequency to high frequency periods.
80 -| |(% style="width:197px" %)mappedFrequencies|(% style="width:568px" %)A reference to a map of frequency id to date pattern for output.
81 -|EpochMap|(% style="width:197px" %)(((
77 +)))|
78 +| |freqDimension|The Dimension or Attribute of the target Data Structure Definition which will hold the frequency information for date conversion. Mutually exclusive with targetFrequencyId.
79 +| |yearStart|The date of the start of the year, enabling mapping from high frequency to lower frequency formats.
80 +| |resolvePeriod|Which point in time to resolve to when mapping from low frequency to high frequency periods.
81 +| |mappedFrequencies|A reference to a map of frequency id to date pattern for output.
82 +|EpochMap|(((
82 82  Inherits from
83 83  //DateMap//
84 -)))|(% style="width:568px" %)
85 -| |(% style="width:197px" %)basePeriod|(% style="width:568px" %)Epoch zero starts on this period.
86 -| |(% style="width:197px" %)targetFrequencyId|(% style="width:568px" %)The frequency to convert the input date into. Mutually exclusive with freqDimension.
87 -| |(% style="width:197px" %)epochPeriod|(% style="width:568px" %)Describes the period of time that each epoch represents.
88 -|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.
89 -| |(% style="width:197px" %)locale|(% style="width:568px" %)The locale on which the input will be parsed according to the pattern.
90 -|DateMapping|(% style="width:197px" %) |(% style="width:568px" %)
91 -| |(% style="width:197px" %)sourcePattern|(% style="width:568px" %)Describes the source date using conventions for describing years, months, days, etc.
92 -| |(% style="width:197px" %)targetFrequencyId|(% style="width:568px" %)The frequency to convert the input date into. Mutually exclusive with freqDimension.
93 -|FrequencyFormatMapping|(% style="width:197px" %)(((
85 +)))|
86 +| |basePeriod|Epoch zero starts on this period.
87 +| |targetFrequencyId|The frequency to convert the input date into. Mutually exclusive with freqDimension.
88 +| |epochPeriod|Describes the period of time that each epoch represents.
89 +|DatePatternMap|Inherits from //DateMap//|Described a source date based on a string pattern, and how it maps to the target date.
90 +| |locale|The locale on which the input will be parsed according to the pattern.
91 +|DateMapping| |
92 +| |sourcePattern|Describes the source date using conventions for describing years, months, days, etc.
93 +| |targetFrequencyId|The frequency to convert the input date into. Mutually exclusive with freqDimension.
94 +|FrequencyFormatMap ping|(((
94 94  Inherits from
95 95  //IdentifiableArtefact//
96 -)))|(% style="width:568px" %)Describes the relationship between a frequency Id to the what the output date is formatted
97 -| |(% style="width:197px" %)frequencyId|(% style="width:568px" %)The string used to describe the frequency
98 -| |(% style="width:197px" %)datePattern|(% style="width:568px" %)The output date pattern for that frequency
97 +)))|Describes the relationship between a frequency Id to the what the output date is formatted
98 +| |frequencyId|The string used to describe the frequency
99 +| |datePattern|The output date pattern for that frequency
99 99  
100 100  ----
101 101  
103 +
102 102  {{putFootnotes/}}
image63.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -52.4 KB
Content
image64.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -39.4 KB
Content
1749246555607-988.jpeg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +32.9 KB
Content
1749246555612-421.jpeg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +32.0 KB
Content
SKMS.Methodology.Code.MethodologyClass[0]
Index
... ... @@ -1,1 +1,0 @@
1 -10
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,0 +1,1 @@
1 +10
© Semantic R&D Group, 2026