Skip to Content

Changes for page 9 Structure Map

Last modified by Artur on 2025/09/10 11:19
From version 3.2
edited by Helena
on 2025/06/08 11:47
Change comment: There is no comment for this version
To version 4.1
edited by Helena
on 2025/06/08 11:48
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -34,9 +34,9 @@
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,60 @@
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 -|**Class**|**Feature**|**Description**
50 -|StructureMap|(((
49 +(% style="width:974.835px" %)
50 +|**Class**|(% style="width:197px" %)**Feature**|(% style="width:568px" %)**Description**
51 +|StructureMap|(% style="width:197px" %)(((
51 51  Inherits from
52 52  //MaintainableArtefact//
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|(((
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" %)(((
59 59  Inherits from
60 60  //AnnotableArtefact//
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|(((
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" %)(((
65 65  Reference to either a
66 66  RepresentationMap, an
67 67  EpochMap or a DatePatternMap.
68 68  )))
69 -|FixedValueMap|(((
70 +|FixedValueMap|(% style="width:197px" %)(((
70 70  Inherits from
71 71  //AnnotableArtefact//
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//|(((
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" %)(((
75 75  Inherits from
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|(((
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" %)(((
83 83  Inherits from
84 84  //DateMap//
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|(((
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" %)(((
95 95  Inherits from
96 96  //IdentifiableArtefact//
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
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
100 100  
101 101  ----
102 102