Skip to Content
Last modified by Elena on 2025/09/10 11:19
From version 3.2
edited by Helena
on 2025/06/08 11:11
Change comment: There is no comment for this version
To version 3.5
edited by Helena
on 2025/06/08 11:17
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -30,9 +30,9 @@
30 30  
31 31  **Figure 27 Class inheritance in the Data Structure Definition and Data Set Packages**
32 32  
33 -===== 5.2.2 Explanation of the Diagram =====
33 +=== 5.2.2 Explanation of the Diagram ===
34 34  
35 -====== 5.2.2.1 Narrative ======
35 +==== 5.2.2.1 Narrative ====
36 36  
37 37  Those classes in the SDMX metamodel which require annotations inherit from //AnnotableArtefact//. These are:
38 38  
... ... @@ -75,11 +75,8 @@
75 75  Those concrete classes in the SDMX Data Structure Definition and Dataset packages of the metamodel which require to be maintained by Agencies all inherit (via other abstract classes) from //MaintainableArtefact//, these are:
76 76  
77 77  Dataflow
78 -
79 79  DataStructureDefinition
80 -
81 81  The component structures that are lists of lists, inherit directly from //Structure//. A //Structure// contains several lists of components. The concrete class that inherits from //Structure// is:
82 -
83 83  DataStructureDefinition
84 84  
85 85  A DataStructureDefinition contains a list of dimensions, a list of measures and a list of attributes.
... ... @@ -87,34 +87,29 @@
87 87  The concrete classes which inherit from //ComponentList// and are subcomponents of the DataStructureDefinition are:
88 88  
89 89  DimensionDescriptor – content is Dimension and TimeDimension
90 -
91 91  DimensionGroupDescriptor – content is an association to Dimension, TimeDimension
92 -
93 93  MeasureDescriptor – content is Measure
94 -
95 95  AttributeDescriptor – content is DataAttribute and an association to MetadataAttribute
96 96  
97 97  The classes that inherit from //Component// are:
98 98  
99 99  Measure
100 -
101 101  //DimensionComponent// and thereby its sub classes of Dimension and TimeDimension
102 -
103 103  //Attribute// and thereby its sub classes of DataAttribute and MetadataAttribute
104 104  
105 105  The concrete classes identified above are the majority of the classes required to define the metamodel for the DataStructureDefinition. The diagrams and explanations in the rest of this section show how these concrete classes are related in order to support the functionality required.
106 106  
107 -==== //5.3 Data Structure Definition – Relationship View// ====
99 +== 5.3 Data Structure Definition – Relationship View ==
108 108  
109 -===== 5.3.1 Class Diagram =====
101 +=== 5.3.1 Class Diagram ===
110 110  
111 111  [[image:1749246368782-690.jpeg]]
112 112  
113 113  **Figure 28 Relationship class diagram of the Data Structure Definition excluding representation**
114 114  
115 -===== 5.3.2 Explanation of the Diagrams =====
107 +=== 5.3.2 Explanation of the Diagrams ===
116 116  
117 -====== 5.3.2.1 Narrative ======
109 +==== 5.3.2.1 Narrative ====
118 118  
119 119  A DataStructureDefinition defines the Dimensions, TimeDimension, DataAttributes, and Measures, and associated Representations, that comprise the valid structure of data and related attributes that are contained in a DataSet, which is defined by a Dataflow. In addition, a DataStructureDefinition may be related to one MetadataStructureDefinition, in order to use the latter’s MetadataAttributes, by relating them to other //Components// within the DSD, as explained below.
120 120  
... ... @@ -159,11 +159,12 @@
159 159  
160 160  The following table details the possible relationships a DataAttribute may specify. Note that these relationships are mutually exclusive, and therefore only one of the following is possible.
161 161  
162 -|**Relationship**|**Meaning**|**Location in Data Set at which the Attribute is reported**
163 -|DataflowRelationship|The value of the attribute is fixed for all data contained in the dataset. The Attribute value applies to all data defined by the underlying Dataflow.|The attribute is reported at the Dataset level.
164 -|Dimension (1..n)|The value of the attribute will vary with the value(s) of the referenced Dimension(s). In this case, Group(s) to which the attribute should be attached may optionally be specified.|The attribute is reported at the lowest level of the Dimension to which the Attribute is related, otherwise at the level of the Group if Attachment Group(s) is specified.
165 -|Group|The value of the Attribute varies with combination of values for all of the Dimensions contained in the Group. This is added as a convenience to listing all Dimensions and the attachment Group, but should only be used when the Attribute value varies based on all Group Dimension values.|The attribute is reported at the level of Group.
166 -|Observation|The value of the Attribute varies with the observed value.|The attribute is reported at the level of Observation.
154 +(% style="width:1142.83px" %)
155 +|**Relationship**|(% style="width:537px" %)**Meaning**|(% style="width:434px" %)**Location in Data Set at which the Attribute is reported**
156 +|DataflowRelationship|(% style="width:537px" %)The value of the attribute is fixed for all data contained in the dataset. The Attribute value applies to all data defined by the underlying Dataflow.|(% style="width:434px" %)The attribute is reported at the Dataset level.
157 +|Dimension (1..n)|(% style="width:537px" %)The value of the attribute will vary with the value(s) of the referenced Dimension(s). In this case, Group(s) to which the attribute should be attached may optionally be specified.|(% style="width:434px" %)The attribute is reported at the lowest level of the Dimension to which the Attribute is related, otherwise at the level of the Group if Attachment Group(s) is specified.
158 +|Group|(% style="width:537px" %)The value of the Attribute varies with combination of values for all of the Dimensions contained in the Group. This is added as a convenience to listing all Dimensions and the attachment Group, but should only be used when the Attribute value varies based on all Group Dimension values.|(% style="width:434px" %)The attribute is reported at the level of Group.
159 +|Observation|(% style="width:537px" %)The value of the Attribute varies with the observed value.|(% style="width:434px" %)The attribute is reported at the level of Observation.
167 167  
168 168  [[image:1749246368790-555.jpeg]]
169 169  
... ... @@ -173,7 +173,7 @@
173 173  
174 174  A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap.
175 175  
176 -**5.3.2.2 Definitions**
169 +==== 5.3.2.2 Definitions ====
177 177  
178 178  |**Class**|**Feature**|**Description**
179 179  |StructureUsage| |See “SDMX Base”.
... ... @@ -183,7 +183,7 @@
183 183  //StructureUsage//
184 184  )))|Abstract concept (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.
185 185  | |/structure|Associates a Dataflow to the Data Structure Definition.
186 -| |dimensionConstraint|A list of Dimensions which the Dataflow uses. This is only required when the referenced DataStructureDefinition has the evolvingStructure property set to true and when the association to the DataStructureDefinition in on the latest minor version[[(% class="wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]](%%).
179 +| |dimensionConstraint|A list of Dimensions which the Dataflow uses. This is only required when the referenced DataStructureDefinition has the evolvingStructure property set to true and when the association to the DataStructureDefinition in on the latest minor version{{footnote}}Referencing the latest minor version of the Data Structure is achieved by the reference including the plus operator on the minor version to indicate it links to the latest stable version, for example 2.0+.0 will resolve to the highest version 2.x.y.{{/footnote}}.
187 187  |DataStructureDefiniti on| |A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
188 188  | |/grouping|An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
189 189  | |evolvingStructure|An optional boolean property, defaulting to false. When true the DataStructureDefinition may have new Dimensions added without having to change its major version number.
... ... @@ -223,9 +223,6 @@
223 223  TimeDimension
224 224  )))|An abstract class representing any Component that can be used for identifying observations.
225 225  
226 -
227 -
228 -
229 229  |**Class**|**Feature**|**Description**
230 230  | |Order|Specifies the order of the Dimension Components within the DSD. The property is used to indicate the position of the Dimension Component and determines the Key for identifying observations, or series. The Time Dimension, when specified, must be the last within the Dimension Descriptor.
231 231  |Dimension|(((
... ... @@ -298,9 +298,9 @@
298 298  
299 299  **Figure 31: Class Diagram of the Data Set**
300 300  
301 -====== 5.4.3 Explanation of the Diagram ======
291 +=== 5.4.3 Explanation of the Diagram ===
302 302  
303 -5.4.3.1 Narrative – Data Set
293 +==== 5.4.3.1 Narrative – Data Set ====
304 304  
305 305  Note that the //DataSet// must conform to the DataStructureDefinition associated to the Dataflow for which this DataSet is an “instance of data”. Whilst the model shows the association to the classes of the DataStructureDefinition, this is for conceptual purposes to show the link to the DataStructureDefinition. In the actual //DataSet// as exchanged there must, of course, be a reference to the DataStructureDefinition and optionally a Dataflow or a ProvisionAgreement, but the DataStructureDefinition is not necessarily exchanged with the data. Therefore, the DataStructureDefinition classes are shown in the grey areas, as these are not a part of the //DataSet// when the //DataSet// is exchanged. However, the structural metadata in the DataStructureDefinition can be used by an application to validate the contents of the //DataSet// in terms of the valid content of a //KeyValue// as defined by the Representation in the DataStructureDefinition.
306 306  
... ... @@ -318,11 +318,11 @@
318 318  
319 319  The GroupKey is a subunit of the //Key// that has the same dimensionality as the SeriesKey but defines a subset of the KeyValues of the SeriesKey. Its sub dimension structure is defined in the GroupDimensionDescriptor of the DataStructureDefinition identified by the same id as the GroupKey. The id identifies a “type” of group and the purpose of the GroupKey is to report one or more //AttributeValue// that are contained at this group level. The GroupKey is present when the GroupDimensionDescriptor is related to the GroupRelationship in the DataStructureDefinition. There can be many types of groups in a //DataSet//. If the Group is related to the DimensionRelationship in the DataStructureDefinition then the //AttributeValue// will be reported with the appropriate dimension in the SeriesKey or Observation.
320 320  
321 -In this way each of SeriesKey, GroupKey, and Observation can have zero or more //AttributeValue//s that define some metadata about the object to which it is associated. The //AttributeValue// may be either a //DataAttributeValue// or a //MetadataAttributeValue//, representing values of DataAttributes defined in the DSD or MetadataAttributes of the linked MSD, respectively. The allowable Concepts and the objects to which these metadata can be associated (attached) are defined in the DataStructureDefinition and the linked MetadataStructureDefinition.
311 +In this way each of SeriesKey, GroupKey, and Observation can have zero or more //AttributeValue//s that define some metadata about the object to which it is associated. The //AttributeValue// may be either a //DataAttributeValue// or a //MetadataAttributeValue//, representing values of DataAttributes defined in the DSD or MetadataAttributes of the linked MSD, respectively. The allowable Concepts and the objects to which these metadata can be associated (attached) are defined in the DataStructureDefinition and the linked MetadataStructureDefinition.
322 322  
323 323  The //AttributeValue// links to the object type (SeriesKey, GroupKey, Observation) to which it is associated.
324 324  
325 -5.4.3.2 Definitions
315 +==== 5.4.3.2 Definitions ====
326 326  
327 327  |**Class**|**Feature**|**Description**
328 328  |//DataSet//|(((
... ... @@ -524,8 +524,6 @@
524 524  )))|An attribute that takes it value from a Code in Code list.
525 525  | |+valueOf|Association to the Code that is the value of the Attribute Value. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Data Attribute in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Attribute Value.
526 526  
527 -
528 -
529 529  ----
530 530  
531 -[[~[1~]>>path:#_ftnref1]] Referencing the latest minor version of the Data Structure is achieved by the reference including the plus operator on the minor version to indicate it links to the latest stable version, for example 2.0+.0 will resolve to the highest version 2.x.y.
519 +{{putFootnotes/}}