Skip to Content
Last modified by Elena on 2025/09/10 11:19
From version 1.1
edited by Helena
on 2025/06/07 00:46
Change comment: There is no comment for this version
To version 3.4
edited by Helena
on 2025/06/08 11:14
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,9 @@
1 -=== 5.1 Introduction ===
1 +{{box title="**Contents**"}}
2 +{{toc/}}
3 +{{/box}}
2 2  
5 +== 5.1 Introduction ==
6 +
3 3  The DataStructureDefiniton is the class name for a structure definition for data. Some organisations know this type of definition as a “Key Family” and so the two names are synonymous. The term Data Structure Definition (also referred to as DSD) is used in this specification.
4 4  
5 5  Many of the constructs in this layer of the model inherit from the SDMX Base Layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual packages. In simple sub models these are shown in the same diagram but are omitted from the more complex sub models for the sake of clarity. In these cases, the inheritance diagram below shows the full inheritance tree for the classes concerned with data structure definitions.
... ... @@ -18,17 +18,17 @@
18 18  
19 19  Maintenance – //MaintainableArtefact//
20 20  
21 -=== 5.2 Inheritance View ===
25 +== 5.2 Inheritance View ==
22 22  
23 -==== 5.2.1 Class Diagram ====
27 +=== 5.2.1 Class Diagram ===
24 24  
25 25  [[image:1749246368774-202.jpeg]]
26 26  
27 27  **Figure 27 Class inheritance in the Data Structure Definition and Data Set Packages**
28 28  
29 -===== 5.2.2 Explanation of the Diagram =====
33 +=== 5.2.2 Explanation of the Diagram ===
30 30  
31 -====== 5.2.2.1 Narrative ======
35 +==== 5.2.2.1 Narrative ====
32 32  
33 33  Those classes in the SDMX metamodel which require annotations inherit from //AnnotableArtefact//. These are:
34 34  
... ... @@ -100,17 +100,17 @@
100 100  
101 101  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.
102 102  
103 -==== //5.3 Data Structure Definition – Relationship View// ====
107 +== 5.3 Data Structure Definition – Relationship View ==
104 104  
105 -===== 5.3.1 Class Diagram =====
109 +=== 5.3.1 Class Diagram ===
106 106  
107 107  [[image:1749246368782-690.jpeg]]
108 108  
109 109  **Figure 28 Relationship class diagram of the Data Structure Definition excluding representation**
110 110  
111 -===== 5.3.2 Explanation of the Diagrams =====
115 +=== 5.3.2 Explanation of the Diagrams ===
112 112  
113 -====== 5.3.2.1 Narrative ======
117 +==== 5.3.2.1 Narrative ====
114 114  
115 115  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.
116 116  
... ... @@ -169,7 +169,7 @@
169 169  
170 170  A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap.
171 171  
172 -**5.3.2.2 Definitions**
176 +==== 5.3.2.2 Definitions ====
173 173  
174 174  |**Class**|**Feature**|**Description**
175 175  |StructureUsage| |See “SDMX Base”.
... ... @@ -179,7 +179,7 @@
179 179  //StructureUsage//
180 180  )))|Abstract concept (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.
181 181  | |/structure|Associates a Dataflow to the Data Structure Definition.
182 -| |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[[^^~[1~]^^>>path:#_ftn1]].
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{{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}}.
183 183  |DataStructureDefiniti on| |A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
184 184  | |/grouping|An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
185 185  | |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.
... ... @@ -200,7 +200,7 @@
200 200  
201 201  //ComponentList//
202 202  )))|A set metadata concepts that define the Attributes of a Data Structure Definition.
203 -| |/////components|An association to a Data Attribute component.
207 +| |/components|An association to a Data Attribute component.
204 204  |MeasureDescriptor|(((
205 205  Inherits from
206 206  
... ... @@ -294,9 +294,9 @@
294 294  
295 295  **Figure 31: Class Diagram of the Data Set**
296 296  
297 -====== 5.4.3 Explanation of the Diagram ======
301 +=== 5.4.3 Explanation of the Diagram ===
298 298  
299 -5.4.3.1 Narrative – Data Set
303 +==== 5.4.3.1 Narrative – Data Set ====
300 300  
301 301  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.
302 302  
... ... @@ -318,7 +318,7 @@
318 318  
319 319  The //AttributeValue// links to the object type (SeriesKey, GroupKey, Observation) to which it is associated.
320 320  
321 -5.4.3.2 Definitions
325 +==== 5.4.3.2 Definitions ====
322 322  
323 323  |**Class**|**Feature**|**Description**
324 324  |//DataSet//|(((
... ... @@ -520,8 +520,6 @@
520 520  )))|An attribute that takes it value from a Code in Code list.
521 521  | |+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.
522 522  
523 -
524 -
525 525  ----
526 526  
527 -[[~[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.
529 +{{putFootnotes/}}
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,0 +1,1 @@
1 +6