Skip to Content

Changes for page 1 Introduction

Last modified by Helena on 2025/09/10 11:19
From version 14.2
edited by Helena
on 2025/05/19 13:49
Change comment: Update document after refactoring.
To version 8.1
edited by Helena
on 2025/05/15 09:59
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -Methodology.SDMX STANDARDS\: SECTION 2\. INFORMATION MODEL\: UML CONCEPTUAL DESIGN Version 3\.0.WebHome
Content
... ... @@ -1,79 +1,83 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
1 += 1 Introduction =
4 4  
5 -This document is not normative but provides a detailed view of the information model on which the normative [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] specifications are based. Those new to the UML notation or to the (% style="color:#2ecc71" %)concept(%%) of [[Data Structure Definitions>>doc:xwiki:Glossary.Data structure definition.WebHome]] may wish to read the appendixes in this document as an introductory exercise.
3 +This document is not normative but provides a detailed view of the information model on which the normative SDMX specifications are based. Those new to the UML notation or to the concept of Data Structure Definitions may wish to read the appendixes in this document as an introductory exercise.
6 6  
7 7  == 1.1 Related Documents ==
8 8  
9 -This document is one of two documents concerned with the [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]. The complete set of documents is:
7 +This document is one of two documents concerned with the SDMX Information Model. The complete set of documents is:
10 10  
11 -* [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] SECTION 02 INFORMATION MODEL: UML CONCEPTUAL DESIGN (this document): This document comprises the complete definition of the information model, with the exception of the registry interfaces. It is intended for technicians wishing to understand the complete scope of the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] technical standards in a syntax neutral form.
12 -* [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] SECTION 05 REGISTRY SPECIFICATION: LOGICAL INTERFACES: This document provides the logical specification for the registry interfaces, including [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]]/[[notification>>doc:xwiki:Glossary.Notification.WebHome]], registration/submission of data and metadata, and querying.
9 +* SDMX SECTION 02 INFORMATION MODEL: UML CONCEPTUAL DESIGN (this document): This document comprises the complete definition of the information model, with the exception of the registry interfaces. It is intended for technicians wishing to understand the complete scope of the SDMX technical standards in a syntax neutral form.
10 +* SDMX SECTION 05 REGISTRY SPECIFICATION: LOGICAL INTERFACES: This document provides the logical specification for the registry interfaces, including subscription/notification, registration/submission of data and metadata, and querying.
13 13  
14 14  == 1.2 Modelling Technique and Diagrammatic Notes ==
15 15  
16 -The modelling technique used for the [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]] ([[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]) is the Unified Modelling Language (UML). An overview of the constructs of UML that are used in the SDMXIM can be found in the Appendix “A Short Guide to UML in the [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]”
14 +The modelling technique used for the SDMX Information Model (SDMX-IM) is the Unified Modelling Language (UML). An overview of the constructs of UML that are used in the SDMXIM can be found in the Appendix “A Short Guide to UML in the SDMX Information Model”
17 17  
18 -UML diagramming allows a class to be shown with or without the compartments for one or both of [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] and operations (sometimes called methods). In this document the operations compartment is not shown as there are no operations.
16 +UML diagramming allows a class to be shown with or without the compartments for one or both of attributes and operations (sometimes called methods). In this document the operations compartment is not shown as there are no operations.
19 19  
20 20  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_1ce09669.png||height="111" width="324"]]
21 21  
22 22  **Figure 1 Class with operations suppressed**
23 23  
24 -In some diagrams for some classes the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] compartment is suppressed even though there may be some [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]. This is deliberate and is done to aid clarity of the diagram. The method used is:
22 +In some diagrams for some classes the attribute compartment is suppressed even though there may be some attributes. This is deliberate and is done to aid clarity of the diagram. The method used is:
25 25  
26 -* The [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] will always be present on the class diagram where the class is defined and its [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] and associations are defined.
27 -* On other diagrams, such as inheritance diagrams, the [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] may be suppressed from the class for clarity.
24 +* The attributes will always be present on the class diagram where the class is defined and its attributes and associations are defined.// //
25 +* On other diagrams, such as inheritance diagrams, the attributes may be suppressed from the class for clarity.//  //
28 28  
29 29  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_bbb8fac9.png||height="54" width="158"]]
30 30  
31 31  **Figure 2 Class with attributes also suppressed**
32 32  
33 -Note that, in any case, [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] inherited from a super class are not shown in the sub class.
31 +Note that, in any case, attributes inherited from a super class are not shown in the sub class.
34 34  
35 -The following table structure is used in the definition of the classes, [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]], and associations.
33 +The following table structure is used in the definition of the classes, attributes, and associations.
36 36  
37 -(% style="width:640.039px" %)
38 -|(% style="width:138px" %)**Class**|(% style="width:268px" %)**Feature**|(% style="width:229px" %)**Description**
39 -|(% style="width:138px" %)ClassName|(% style="width:268px" %) |(% style="width:229px" %)
40 -|(% style="width:138px" %) |(% style="width:268px" %)attributeName|(% style="width:229px" %)
41 -|(% style="width:138px" %) |(% style="width:268px" %)associationName|(% style="width:229px" %)
42 -|(% style="width:138px" %) |(% style="width:268px" %)+roleName|(% style="width:229px" %)
35 +|**Class**|**Feature**|**Description**
36 +|ClassName||
37 +||attributeName|
38 +||associationName|
39 +||+roleName|
43 43  
44 44  The content in the “Feature” column comprises or explains one of the following structural features of the class:
45 45  
46 -* Whether it is an abstract class. Abstract classes are shown in //italic Courier// font.
47 -* The superclass this class inherits from, if any.// //
48 -* The sub classes of this class, if any.
49 -* Attribute – the attributeName is shown in Courier font.
50 -* Association – the associationName is shown in Courier font. If the association is derived from the association between super classes, then the format is /associationName.
51 -* Role – the +roleName is shown in Courier font.
43 +* Whether it is an abstract class. Abstract classes are shown in //italic Courier// font.//  //
44 +* The superclass this class inherits from, if any.//  //
45 +* The sub classes of this class, if any.//  //
46 +* Attribute – the attributeName is shown in Courier font.// //
47 +* Association – the associationName is shown in Courier font. If the association is derived from the association between super classes, then the format is
52 52  
53 -The Description column provides a short definition or explanation of the Class or Feature. UML class names may be used in the description and if so, they are presented in normal font with spaces between words. For example, the class ConceptScheme will be written as [[Concept Scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]].
49 +/associationName.// //
54 54  
51 +* Role – the +roleName is shown in Courier font.// //
52 +
53 +The Description column provides a short definition or explanation of the Class or Feature. UML class names may be used in the description and if so, they are presented in normal font with spaces between words. For example, the class ConceptScheme will be written as Concept Scheme.
54 +
55 55  == 1.3 Overall Functionality ==
56 56  
57 57  === 1.3.1 Information Model Packages ===
58 58  
59 -The [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]] ([[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]) is a conceptual metamodel from which syntax specific implementations are developed. The model is constructed as a set of functional packages which assist in the understanding, re-use and maintenance of the model.
59 +The SDMX Information Model (SDMX-IM) is a conceptual metamodel from which syntax specific implementations are developed. The model is constructed as a set of functional packages which assist in the understanding, re-use and maintenance of the model.
60 60  
61 61  In addition to this, in order to aid understanding each package can be considered to be in one of three conceptual layers:
62 62  
63 -* the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base layer comprises fundamental building blocks which are used by the Structural Definitions layer and the Reporting and Dissemination layer
64 -* the Structural Definitions layer comprises the definition of the structural [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] needed to support data and metadata reporting and dissemination
65 -* the Reporting and Dissemination layer comprises the definition of the data and metadata containers used for reporting and dissemination
66 -* In reality the layers have no implicit or explicit structural function as any package can make use of any construct in another package.
63 +the SDMX Base layer comprises fundamental building blocks which are used by the Structural Definitions layer and the Reporting and Dissemination layer
67 67  
65 +the Structural Definitions layer comprises the definition of the structural artefacts needed to support data and metadata reporting and dissemination
66 +
67 +the Reporting and Dissemination layer comprises the definition of the data and metadata containers used for reporting and dissemination
68 +
69 +In reality the layers have no implicit or explicit structural function as any package can make use of any construct in another package.
70 +
68 68  === 1.3.2 Version 1.0 ===
69 69  
70 -In (% style="color:#2ecc71" %)version(%%) 1.0 the metamodel supported the requirements for:
73 +In version 1.0 the metamodel supported the requirements for:
71 71  
72 -[[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] including (domain) [[category scheme>>doc:xwiki:Glossary.Category scheme.WebHome]], (metadata) [[concept scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]], and [[code>>doc:xwiki:Glossary.Code.WebHome]] list
73 -Data and related metadata reporting and dissemination
75 +Data Structure Definition including (domain) category scheme, (metadata) concept scheme, and code list
74 74  
75 -The [[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]] comprises a number of packages. These packages act as convenient compartments for the various sub models in the [[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]. The diagram below shows the sub models of the [[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]] that were included in the (% style="color:#2ecc71" %)version(%%) 1.0 specification.
77 +Data and related metadata reporting and dissemination// //
76 76  
79 +The SDMX-IM comprises a number of packages. These packages act as convenient compartments for the various sub models in the SDMX-IM. The diagram below shows the sub models of the SDMX-IM that were included in the version 1.0 specification.
80 +
77 77  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_c2c05d9c.jpg||height="203" width="612"]]
78 78  
79 79  **Figure 3: SDMX Information Model Version 1.0 package structure**
... ... @@ -80,19 +80,28 @@
80 80  
81 81  === 1.3.3 Version 2.0/2.1 ===
82 82  
83 -The (% style="color:#2ecc71" %)version(%%) 2.0/2.1 model extends the functionality of (% style="color:#2ecc71" %)version(%%) 1.0. principally in the area of metadata, but also in various ways to define structures to support data analysis by systems with knowledge of cube type structures such as OLAP{{footnote}}OLAP: On line analytical processing{{/footnote}} systems. The following major constructs have been added at (% style="color:#2ecc71" %)version(%%) 2.0/2.1
87 +The version 2.0/2.1 model extends the functionality of version 1.0. principally in the area of metadata, but also in various ways to define structures to support data analysis by systems with knowledge of cube type structures such as OLAP^^[[^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]]^^ systems. The following major constructs have been added at version 2.0/2.1
84 84  
85 85  Metadata structure definition
90 +
86 86  Metadata set
92 +
87 87  Hierarchical Codelist
94 +
88 88  Data and Metadata Provisioning
96 +
89 89  Process
98 +
90 90  Mapping
100 +
91 91  Constraints
102 +
92 92  Constructs supporting the Registry
93 93  
94 -Furthermore, the term [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] replaces the term Key Family: as both of these terms are used in various communities, they are synonymous. The term [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] is used in the model and this document.
105 +[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_59eee18f.gif||alt="Shape1" height="1" width="192"]]
95 95  
107 +Furthermore, the term Data Structure Definition replaces the term Key Family: as both of these terms are used in various communities, they are synonymous. The term Data Structure Definition is used in the model and this document.
108 +
96 96  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_d8008692.jpg||height="201" width="597"]]
97 97  
98 98  **Figure 4 SDMX Information Model Version 2.0/2.1 package structure**
... ... @@ -99,7 +99,7 @@
99 99  
100 100  Additional constructs that are specific to a registry-based scenario can be found in the Specification of Registry Interfaces. For information these are shown on the diagram below and comprise:
101 101  
102 -* [[Subscription>>doc:xwiki:Glossary.Subscription.WebHome]] and Notification
115 +* Subscription and Notification
103 103  * Registration
104 104  * Discovery
105 105  
... ... @@ -111,11 +111,9 @@
111 111  
112 112  === 1.3.4 Version 3.0 ===
113 113  
114 -The (% style="color:#2ecc71" %)version(%%) 3.0 model introduces changes in the way [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] are handled. In addition, it includes a few more [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]. Finally, a few abstractions have been added, as shown in section “Basic Inheritance” in “Figure 11: Basic Inheritance from the Base Structures”.
127 +The version 3.0 model introduces changes in the way reference metadata are handled. In addition, it includes a few more artefacts. Finally, a few abstractions have been added, as shown in section “Basic Inheritance” in “Figure 11: Basic Inheritance from the Base Structures”.
115 115  
116 116  The IM packages are largely the same.
117 117  
118 118  1. [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_26bb40b.jpg||height="202" width="613"]]
119 119  1. **Figure 6: SDMX Information Model version 3.0 package structure**
120 -
121 -{{putFootnotes/}}
SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_26bb40b.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -120.4 KB
Content