Changes for page 5 Data Structure Definition and Dataset

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

From 1.1 to 2.1 From 5.2 to 5.3

From version 2.1

edited by Helena
on 2025/06/07 00:55

Change comment: There is no comment for this version

To version 5.2

edited by Helena
on 2025/06/08 11:22

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- SUZ.Methodology.Code.MethodologyClass[0]

Details

Page properties

Content

@@ -1,5 +1,9 @@
--=== 5.1 Introduction ===
++{{box title="**Contents**"}}
++{{toc/}}
++{{/box}}
++== 5.1 Introduction ==
++
  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.
  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.
@@ -9,51 +9,41 @@
  The actual SDMX Base construct from which the concrete classes inherit depends upon the requirements of the class for:
  Annotation – //AnnotableArtefact//
--
  Identification – //IdentifiableArtefact//
--
  Naming – //NameableArtefact//
--
  Versioning – //VersionableArtefact//
--
  Maintenance – //MaintainableArtefact//
--=== 5.2 Inheritance View ===
++== 5.2 Inheritance View ==
--==== 5.2.1 Class Diagram ====
++=== 5.2.1 Class Diagram ===
  [[image:1749246368774-202.jpeg]]
  **Figure 27 Class inheritance in the Data Structure Definition and Data Set Packages**
--===== 5.2.2 Explanation of the Diagram =====
++=== 5.2.2 Explanation of the Diagram ===
--====== 5.2.2.1 Narrative ======
++==== 5.2.2.1 Narrative ====
  Those classes in the SDMX metamodel which require annotations inherit from //AnnotableArtefact//. These are:
--//IdentifiableArtefact//
--
--//DataSet//
--
--//Key// (and therefore //SeriesKey// and //GroupKey//)
--
++//IdentifiableArtefact
++DataSet
++Key// (and therefore //SeriesKey// and //GroupKey//)
  //Observation//
  Those classes in the SDMX metamodel which require annotations and global identity are derived from //IdentifiableArtefact//. These are:
--//NameableArtefact//
++//NameableArtefact
++ComponentList
++Component//
--//ComponentList//
--
--//Component//
--
  Those classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description are derived from //NameableArtefact//. These are:
--//VersionableArtefact//
++//VersionableArtefact
++Item//
--//Item//
--
  The classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact//. These are:
  //MaintainableArtefact//
@@ -60,22 +60,17 @@
  Abstract classes which represent information that is maintained by Maintenance Agencies all inherit from //MaintainableArtefact//, they also inherit all the features of a //VersionableArtefact//, and are:
--//StructureUsage//
++//StructureUsage
++Structure
++ItemScheme//
--//Structure//
--
--//ItemScheme//
--
  All the above classes are abstract. The key to understanding the class diagrams presented in this section are the concrete classes that inherit from these abstract classes.
  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:
  Dataflow
--
  DataStructureDefinition
--
  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:
--
  DataStructureDefinition
  A DataStructureDefinition contains a list of dimensions, a list of measures and a list of attributes.
@@ -83,34 +83,29 @@
  The concrete classes which inherit from //ComponentList// and are subcomponents of the DataStructureDefinition are:
  DimensionDescriptor – content is Dimension and TimeDimension
--
  DimensionGroupDescriptor – content is an association to Dimension, TimeDimension
--
  MeasureDescriptor – content is Measure
--
  AttributeDescriptor – content is DataAttribute and an association to MetadataAttribute
  The classes that inherit from //Component// are:
  Measure
--
  //DimensionComponent// and thereby its sub classes of Dimension and TimeDimension
--
  //Attribute// and thereby its sub classes of DataAttribute and MetadataAttribute
  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.
--==== //5.3 Data Structure Definition – Relationship View// ====
++== 5.3 Data Structure Definition – Relationship View ==
--===== 5.3.1 Class Diagram =====
++=== 5.3.1 Class Diagram ===
  [[image:1749246368782-690.jpeg]]
  **Figure 28 Relationship class diagram of the Data Structure Definition excluding representation**
--===== 5.3.2 Explanation of the Diagrams =====
++=== 5.3.2 Explanation of the Diagrams ===
--====== 5.3.2.1 Narrative ======
++==== 5.3.2.1 Narrative ====
  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.
@@ -155,11 +155,12 @@
  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.
--|**Relationship**|**Meaning**|**Location in Data Set at which the Attribute is reported**
--|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.
--|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.
--|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.
--|Observation|The value of the Attribute varies with the observed value.|The attribute is reported at the level of Observation.
++(% style="width:1142.83px" %)
++|**Relationship**|(% style="width:537px" %)**Meaning**|(% style="width:434px" %)**Location in Data Set at which the Attribute is reported**
++|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.
++|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.
++|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.
++|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.
  [[image:1749246368790-555.jpeg]]
@@ -169,7 +169,7 @@
  A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap.
--**5.3.2.2 Definitions**
++==== 5.3.2.2 Definitions ====
  |**Class**|**Feature**|**Description**
  |StructureUsage| |See “SDMX Base”.
@@ -179,7 +179,7 @@
  //StructureUsage//
  )))|Abstract concept (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.
  | |/structure|Associates a Dataflow to the Data Structure Definition.
--| |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]].
++| |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}}.
  |DataStructureDefiniti on| |A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
  | |/grouping|An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
  | |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 @@
  //ComponentList//
  )))|A set metadata concepts that define the Attributes of a Data Structure Definition.
--| |/////components|An association to a Data Attribute component.
++| |/components|An association to a Data Attribute component.
  |MeasureDescriptor|(((
  Inherits from
@@ -219,9 +219,6 @@
  TimeDimension
  )))|An abstract class representing any Component that can be used for identifying observations.
--
--
--
  |**Class**|**Feature**|**Description**
  | |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.
  |Dimension|(((
@@ -284,19 +284,19 @@
  ==== //5.4 Data Set – Relationship View// ====
--===== 5.4.1 Context =====
++=== 5.4.1 Context ===
  A data set comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition.
--===== 5.4.2 Class Diagram =====
++=== 5.4.2 Class Diagram ===
  [[image:1749246368794-672.jpeg]]
  **Figure 31: Class Diagram of the Data Set**
--====== 5.4.3 Explanation of the Diagram ======
++=== 5.4.3 Explanation of the Diagram ===
--5.4.3.1 Narrative – Data Set
++==== 5.4.3.1 Narrative – Data Set ====
  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.
@@ -314,11 +314,11 @@
  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.
--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.
++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.
  The //AttributeValue// links to the object type (SeriesKey, GroupKey, Observation) to which it is associated.
--5.4.3.2 Definitions
++==== 5.4.3.2 Definitions ====
  |**Class**|**Feature**|**Description**
  |//DataSet//|(((
@@ -421,61 +421,46 @@
  Sub classes
--//UncodedObservationVal ue//
++//UncodedObservationValue//
  CodedObservation
  )))|
  |//UncodedObservatio nValue//|(((
  Abstract class
--
  Inherits from
--
  //ObservationValue//
--
  Sub classes
--
--OtherUncodedMeasureVa lue
--
++OtherUncodedMeasureValue
  TextMeasureValue
  )))|
  |OtherUncodedMeasu reValue|(((
  Inherits from
--
--//UncodedObservationVal ue//
++//UncodedObservationValue//
  )))|An observation that has a text value.
  | |value|The value of the Uncoded Observation.
  | |startTime|This attribute is only used if the textFormat of the Measure is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
  |TextMeasureValue|(((
  Inherits from
--
--//UncodedObservationVal ue//
++//UncodedObservationValue//
  )))|An observation that has a localised text value
  | |text|The localised text values.
  |CodedObservation|(((
  Inherits from
--
  //ObservationValue//
  )))|An Observation that takes its value from a code in a Code list.
  | |+valueOf|Association to the Code that is the value of the Observation. Note that this is a conceptual association showing that the Code must exist in the Codelist(s) associated with the Measure(s) in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Observation.
  |//AttributeValue//|(((
  Abstract class
--
  Sub classes
--
  //DataAttributeValue// //MetadataAttributeValu e//
  )))|Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
  |//DataAttributeValu e//|(((
  Abstract class
--
  Inherits from
--
  //AttributeValue//
--
  Sub classes
--
--//UncodedAttributeValue//
--
--//CodedAttributeValue//
++//UncodedAttributeValue
++CodedAttributeValue//
  )))|The value of a Data Attribute, such as the instance of a Coded Attribute or of an Uncoded Attribute in a structure such as a Data Structure Definition.
  | |+valueFor|(((
  Association to the Data Attribute defined in the Data Structure Definition. Note that this is conceptual association as the Concept is identified explicitly in the data set.
@@ -489,20 +489,14 @@
  )))|The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition
  |//UncodedAttributeV alue//|(((
  Inherits from
--
  //AttributeValue//
--
  Sub classes
--
  OtherUncodedAttribute
--
  Value
--
  TextAttributeValue
  )))|
  |OtherUncodedAttri buteValue|(((
  Inherits from
--
  //UncodedObservationVal ue//
  )))|An attribute value that has a text value
  | |value|The value of the Uncoded attribute.
@@ -509,19 +509,15 @@
  | |startTime|This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
  |TextAttributeValu e|(((
  Inherits from
--
  //UncodedAttributeValue//
  )))|An attribute that has a localised text value
  | |text|The localised text values.
  |CodedAttributeVal ue|(((
  Inherits from
--
  //AttributeValue//
  )))|An attribute that takes it value from a Code in Code list.
  | |+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.
--
--
  ----
--[[~[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.
++{{putFootnotes/}}

SUZ.Methodology.Code.MethodologyClass[0]

index

@@ -1,1 +1,1 @@
--13
++6