Changes for page 9 Structure Map

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

From version 5.1
edited by Helena
on 2025/05/15 09:59
Change comment: There is no comment for this version
To version 7.1
edited by Helena
on 2025/05/16 13:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,4 +1,6 @@
1 -= 9 Structure Map =
1 +{{box title="**Contents**"}}
2 +{{toc/}}
3 +{{/box}}
2 2  
3 3  == 9.1 Scope ==
4 4  
... ... @@ -18,7 +18,7 @@
18 18  
19 19  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.
20 20  
21 -Each ComponentMap maps one or more //Component//s from the source DataStructureDefinition to one or more //Component//s in the target DataStructureDefinition^^[[^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]]^^. In addition, the StructureMap contains zero or more FixedValueMaps. In this case, one or more //Component//s, from the source or target 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 DataStructureDefinition, map to a fixed value.
22 22  
23 23  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.
24 24  
... ... @@ -32,8 +32,6 @@
32 32  
33 33  **Figure 38: Relationship Class diagram of the EpochMap and DatePatternMap**
34 34  
35 -[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_59eee18f.gif||alt="Shape30" height="1" width="192"]]
36 -
37 37  === 9.1.4 Explanation of the Diagram ===
38 38  
39 39  ==== 9.1.4.1 Narrative ====
... ... @@ -46,56 +46,55 @@
46 46  
47 47  ==== 9.1.4.2 Definitions ====
48 48  
49 -|**Class**|**Feature**|**Description**
50 -|StructureMap|(((
49 +(% style="width:869.294px" %)
50 +|(% style="width:196px" %)**Class**|(% style="width:233px" %)**Feature**|(% style="width:436px" %)**Description**
51 +|(% style="width:196px" %)StructureMap|(% style="width:233px" %)(((
51 51  Inherits from
52 -
53 53  //MaintainableArtefact//
54 -)))|Links a source and target structure where there is a semantic equivalence between the source and the target structures.
55 -||+sourceStructure|Association to the source Data Structure.
56 -||+targetStructure|Association to the target Data Structure
57 -||+sourceStructureUsage|Association to the source Dataflow.
58 -||+targetStructureUsage|Association to the target Dataflow.
59 -|ComponentMap|(((
54 +)))|(% style="width:436px" %)Links a source and target structure where there is a semantic equivalence between the source and the target structures.
55 +|(% style="width:196px" %) |(% style="width:233px" %)+sourceStructure|(% style="width:436px" %)Association to the source Data Structure.
56 +|(% style="width:196px" %) |(% style="width:233px" %)+targetStructure|(% style="width:436px" %)Association to the target Data Structure
57 +|(% style="width:196px" %) |(% style="width:233px" %)+sourceStructureUsage|(% style="width:436px" %)Association to the source Dataflow.
58 +|(% style="width:196px" %) |(% style="width:233px" %)+targetStructureUsage|(% style="width:436px" %)Association to the target Dataflow.
59 +|(% style="width:196px" %)ComponentMap|(% style="width:233px" %)(((
60 60  Inherits from
61 -
62 62  //AnnotableArtefact//
63 -)))|Links source and target Component(s) where there is a semantic equivalence between the source and the target Components.
64 -||+source|Association to zero or more source Components.
65 -||+target|Association to zero or more the target Components.
66 -||mappingRules|Reference to either a RepresentationMap, an EpochMap or a DatePatternMap.
67 -|FixedValueMap|(((
62 +)))|(% style="width:436px" %)Links source and target Component(s) where there is a semantic equivalence between the source and the target Components.
63 +|(% style="width:196px" %) |(% style="width:233px" %)+source|(% style="width:436px" %)Association to zero or more source Components.
64 +|(% style="width:196px" %) |(% style="width:233px" %)+target|(% style="width:436px" %)Association to zero or more the target Components.
65 +|(% style="width:196px" %) |(% style="width:233px" %)mappingRules|(% style="width:436px" %)Reference to either a RepresentationMap, an EpochMap or a DatePatternMap.
66 +|(% style="width:196px" %)FixedValueMap|(% style="width:233px" %)(((
68 68  Inherits from
69 -
70 70  //AnnotableArtefact//
71 -)))|Links a Component (source or target) to a fixed value.
72 -||value|The value that a Component will be fixed in a fixed component map.
73 -|//DateMap//|(((
69 +)))|(% style="width:436px" %)Links a Component (source or target) to a fixed value.
70 +|(% style="width:196px" %) |(% style="width:233px" %)value|(% style="width:436px" %)The value that a Component will be fixed in a fixed component map.
71 +|(% style="width:196px" %)//DateMap//|(% style="width:233px" %)(((
74 74  Inherits from
75 -
76 76  //IdentifiableArtefact//
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|(((
74 +)))|(% style="width:436px" %)
75 +|(% style="width:196px" %) |(% style="width:233px" %)freqDimension|(% style="width:436px" %)The Dimension or Attribute of the target Data Structure Definition which will hold the frequency information for date conversion. Mutually exclusive with targetFrequencyId.
76 +|(% style="width:196px" %) |(% style="width:233px" %)yearStart|(% style="width:436px" %)The date of the start of the year, enabling mapping from high frequency to lower frequency formats.
77 +|(% style="width:196px" %) |(% style="width:233px" %)resolvePeriod|(% style="width:436px" %)Which point in time to resolve to when mapping from low frequency to high frequency periods.
78 +|(% style="width:196px" %) |(% style="width:233px" %)mappedFrequencies|(% style="width:436px" %)A reference to a map of frequency id to date pattern for output.
79 +|(% style="width:196px" %)EpochMap|(% style="width:233px" %)(((
83 83  Inherits from
84 -
85 85  //DateMap//
86 -)))|
87 -||basePeriod|Epoch zero starts on this period.
88 -||targetFrequencyId|The frequency to convert the input date into. Mutually exclusive with freqDimension.
89 -||epochPeriod|Describes the period of time that each epoch represents.
90 -|DatePatternMap|Inherits from //DateMap//|Described a source date based on a string pattern, and how it maps to the target date.
91 -||locale|The locale on which the input will be parsed according to the pattern.
92 -|DateMapping||
93 -||sourcePattern|Describes the source date using conventions for describing years, months, days, etc.
94 -||targetFrequencyId|The frequency to convert the input date into. Mutually exclusive with freqDimension.
95 -|FrequencyFormatMap ping|(((
82 +)))|(% style="width:436px" %)
83 +|(% style="width:196px" %) |(% style="width:233px" %)basePeriod|(% style="width:436px" %)Epoch zero starts on this period.
84 +|(% style="width:196px" %) |(% style="width:233px" %)targetFrequencyId|(% style="width:436px" %)The frequency to convert the input date into. Mutually exclusive with freqDimension.
85 +|(% style="width:196px" %) |(% style="width:233px" %)epochPeriod|(% style="width:436px" %)Describes the period of time that each epoch represents.
86 +|(% style="width:196px" %)DatePatternMap|(% style="width:233px" %)Inherits from //DateMap//|(% style="width:436px" %)Described a source date based on a string pattern, and how it maps to the target date.
87 +|(% style="width:196px" %) |(% style="width:233px" %)locale|(% style="width:436px" %)The locale on which the input will be parsed according to the pattern.
88 +|(% style="width:196px" %)DateMapping|(% style="width:233px" %) |(% style="width:436px" %)
89 +|(% style="width:196px" %) |(% style="width:233px" %)sourcePattern|(% style="width:436px" %)Describes the source date using conventions for describing years, months, days, etc.
90 +|(% style="width:196px" %) |(% style="width:233px" %)targetFrequencyId|(% style="width:436px" %)The frequency to convert the input date into. Mutually exclusive with freqDimension.
91 +|(% style="width:196px" %)FrequencyFormatMap ping|(% style="width:233px" %)(((
96 96  Inherits from
97 -
98 98  //IdentifiableArtefact//
99 -)))|Describes the relationship between a frequency Id to the what the output date is formatted
100 -||frequencyId|The string used to describe the frequency
101 -||datePattern|The output date pattern for that frequency
94 +)))|(% style="width:436px" %)Describes the relationship between a frequency Id to the what the output date is formatted
95 +|(% style="width:196px" %) |(% style="width:233px" %)frequencyId|(% style="width:436px" %)The string used to describe the frequency
96 +|(% style="width:196px" %) |(% style="width:233px" %)datePattern|(% style="width:436px" %)The output date pattern for that frequency
97 +
98 +----
99 +
100 +{{putFootnotes/}}