Wiki source code of 1 Introduction
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | This document is not normative but provides a detailed view of the information model on which the normative [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] specifications are based. Those new to the UML notation or to the concept of [[Data Structure Definitions>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]] may wish to read the appendixes in this document as an introductory exercise. | ||
| 6 | |||
| 7 | == 1.1 Related Documents == | ||
| 8 | |||
| 9 | This document is one of two documents concerned with the [[SDMX Information Model>>doc:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]]. The complete set of documents is: | ||
| 10 | |||
| 11 | * [[SDMX>>doc:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] technical standards in a syntax neutral form. | ||
| 12 | * [[SDMX>>doc:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.Subscription.WebHome]]/[[notification>>doc:sdmx:Glossary 2\.1.Notification.WebHome]], registration/submission of data and [[metadata>>doc:IMElements.metadata.WebHome]], and querying. | ||
| 13 | |||
| 14 | == 1.2 Modelling Technique and Diagrammatic Notes == | ||
| 15 | |||
| 16 | The modelling technique used for the [[SDMX Information Model>>doc:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]] ([[SDMX-IM>>doc:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]]) is the Unified | ||
| 17 | |||
| 18 | Modelling [[Language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] (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:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]]” | ||
| 19 | |||
| 20 | UML diagramming allows a class to be shown with or without the compartments for one or both of [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] and operations (sometimes called methods). In this document the operations compartment is not shown as there are no operations. | ||
| 21 | |||
| 22 | [[image:1749563229253-391.png]] | ||
| 23 | |||
| 24 | **Figure 1 Class with operations suppressed** | ||
| 25 | |||
| 26 | In some diagrams for some classes the [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] compartment is suppressed even though there may be some [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]. This is deliberate and is done to aid clarity of the diagram. The method used is: | ||
| 27 | |||
| 28 | * The [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] will always be present on the class diagram where the class is defined and its [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] and associations are defined. | ||
| 29 | * On other diagrams, such as inheritance diagrams, the [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] may be suppressed from the class for clarity. | ||
| 30 | |||
| 31 | [[image:1749563243362-354.png]] | ||
| 32 | |||
| 33 | **Figure 2 Class with attributes also suppressed** | ||
| 34 | |||
| 35 | Note that, in any case, [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] inherited from a super class are not shown in the sub class. | ||
| 36 | |||
| 37 | The following table [[structure>>doc:IMElements.structure.WebHome]] is used in the definition of the classes, [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]], and associations. | ||
| 38 | |||
| 39 | (% style="width:680.835px" %) | ||
| 40 | |(% style="width:129px" %)**Class**|(% style="width:226px" %)**Feature**|(% style="width:322px" %)**Description** | ||
| 41 | |(% style="width:129px" %)ClassName|(% style="width:226px" %) |(% style="width:322px" %) | ||
| 42 | |(% style="width:129px" %) |(% style="width:226px" %)attributeName|(% style="width:322px" %) | ||
| 43 | |(% style="width:129px" %) |(% style="width:226px" %)associationName|(% style="width:322px" %) | ||
| 44 | |(% style="width:129px" %) |(% style="width:226px" %)+roleName | ||
| 45 | |||
| 46 | The content in the “Feature” column comprises or explains one of the following structural features of the class: | ||
| 47 | |||
| 48 | * Whether it is an abstract class. Abstract classes are shown in //italic Courier// font. | ||
| 49 | * The superclass this class inherits from, if any. | ||
| 50 | * The sub classes of this class, if any. | ||
| 51 | * [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] – the attributeName is shown in Courier font. | ||
| 52 | * Association – the associationName is shown in Courier font. If the association is derived from the association between super classes, then the format is /associationName. | ||
| 53 | * Role – the +roleName is shown in Courier font. | ||
| 54 | |||
| 55 | The Description column provides a short definition or explanation of the Class or Feature. UML class names may be used in the [[description>>doc:IMElements.description.WebHome]] and if so, they are presented in normal font with spaces between words. For example, the class [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]] will be written as [[Concept Scheme>>doc:sdmx:Glossary 2\.1.Concept scheme.WebHome]]. | ||
| 56 | |||
| 57 | == 1.3 Overall Functionality == | ||
| 58 | |||
| 59 | === 1.3.1 Information Model Packages === | ||
| 60 | |||
| 61 | The [[SDMX Information Model>>doc:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]] ([[SDMX-IM>>doc:sdmx:Glossary 2\.1.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. | ||
| 62 | |||
| 63 | In addition to this, to aid understanding each package can be considered to be in one of three conceptual layers: | ||
| 64 | |||
| 65 | the [[SDMX>>doc:sdmx:Glossary 2\.1.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 | ||
| 66 | |||
| 67 | the Structural Definitions layer comprises the definition of the structural [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] needed to support data and [[metadata>>doc:IMElements.metadata.WebHome]] reporting and dissemination | ||
| 68 | |||
| 69 | the Reporting and Dissemination layer comprises the definition of the data and [[metadata>>doc:IMElements.metadata.WebHome]] containers used for reporting and dissemination | ||
| 70 | |||
| 71 | In reality the layers have no implicit or explicit structural function as any package can make use of any construct in another package. | ||
| 72 | |||
| 73 | === 1.3.2 Version 1.0 === | ||
| 74 | |||
| 75 | In [[version>>doc:IMElements.version.WebHome]] 1.0 the metamodel supported the requirements for: | ||
| 76 | |||
| 77 | [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]] including (domain) [[category scheme>>doc:sdmx:Glossary 2\.1.Category scheme.WebHome]], ([[metadata>>doc:IMElements.metadata.WebHome]]) [[concept scheme>>doc:sdmx:Glossary 2\.1.Concept scheme.WebHome]], and [[code list>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] | ||
| 78 | |||
| 79 | Data and related [[metadata>>doc:IMElements.metadata.WebHome]] reporting and dissemination | ||
| 80 | |||
| 81 | The [[SDMX-IM>>doc:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]]. The diagram below shows the sub models of the [[SDMX-IM>>doc:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]] that were included in the [[version>>doc:IMElements.version.WebHome]] 1.0 specification. | ||
| 82 | |||
| 83 | [[image:image4.png]] | ||
| 84 | |||
| 85 | **Figure 3: SDMX Information Model Version 1.0 package structure** | ||
| 86 | |||
| 87 | === 1.3.3 Version 2.0/2.1 === | ||
| 88 | |||
| 89 | The [[version>>doc:IMElements.version.WebHome]] 2.0/2.1 model [[extends>>doc:IMElements.extends.WebHome]] the functionality of [[version>>doc:IMElements.version.WebHome]] 1.0. principally in the area of [[metadata>>doc:IMElements.metadata.WebHome]], but also in various ways to define structures to support data analysis by systems with knowledge of cube [[type>>doc:IMElements.type.WebHome]] structures such as OLAP{{footnote}}OLAP: On line analytical processing{{/footnote}} systems. The following major constructs have been added at [[version>>doc:IMElements.version.WebHome]] 2.0/2.1 | ||
| 90 | |||
| 91 | [[Metadata structure definition>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]] | ||
| 92 | [[Metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]] | ||
| 93 | [[Hierarchical Codelist>>doc:sdmx:Glossary 2\.1.Hierarchical code list.WebHome]] | ||
| 94 | Data and Metadata Provisioning | ||
| 95 | Process | ||
| 96 | Mapping | ||
| 97 | Constraints | ||
| 98 | Constructs supporting the Registry | ||
| 99 | |||
| 100 | Furthermore, the term [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]] replaces the term [[Key>>doc:IMElements.AnnotableArtefact.Key.WebHome]] Family: as both of these terms are used in various communities, they are synonymous. The term [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]] is used in the model and this document. | ||
| 101 | |||
| 102 | [[image:image5.png]] | ||
| 103 | |||
| 104 | **Figure 4 SDMX Information Model Version 2.0/2.1 package structure** | ||
| 105 | |||
| 106 | 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: | ||
| 107 | |||
| 108 | * [[Subscription>>doc:sdmx:Glossary 2\.1.Subscription.WebHome]] and [[Notification>>doc:sdmx:Glossary 2\.1.Notification.WebHome]] | ||
| 109 | * Registration | ||
| 110 | * Discovery | ||
| 111 | |||
| 112 | Note that the data and [[metadata>>doc:IMElements.metadata.WebHome]] required for registry functions are not confined to the registry, and the registry also makes use of the other packages in the Information Model. | ||
| 113 | |||
| 114 | [[image:image6.png]] | ||
| 115 | |||
| 116 | **Figure 5: SDMX Information Model Version 2.0/2.1 package structure including the registry** | ||
| 117 | |||
| 118 | === 1.3.4 Version 3.0 === | ||
| 119 | |||
| 120 | The [[version>>doc:IMElements.version.WebHome]] 3.0 model introduces changes in the way [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] are handled. In addition, it includes a few more [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. Finally, a few abstractions have been added, as shown in section “Basic Inheritance” in “Figure 11: Basic Inheritance from the Base Structures”. | ||
| 121 | |||
| 122 | The IM packages are largely the same. | ||
| 123 | |||
| 124 | [[image:image7.png]] | ||
| 125 | |||
| 126 | **Figure 6: SDMX Information Model version 3.0 package structure** | ||
| 127 | |||
| 128 | === 1.3.5 Version 3.1 === | ||
| 129 | |||
| 130 | Whilst some additional properties have been added to [[Dataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Dataflow.WebHome]], [[DSD>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]], Data Constraint, [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] v3.1 does not change the high level information model, it remains as it is in Figure 6. | ||
| 131 | |||
| 132 | ---- | ||
| 133 | |||
| 134 | {{putFootnotes/}} |