Skip to Content

Changes for page 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19
From version 8.1
edited by Helena
on 2025/05/20 00:30
Change comment: There is no comment for this version
To version 15.2
edited by Helena
on 2025/05/22 15:22
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +Methodology.SDMX 2\.1 Standards\. Section 2\. Information model\: UML conceptual design.WebHome
Content
... ... @@ -4,96 +4,96 @@
4 4  
5 5  == {{id name="_Toc370968"/}}3.1 Introduction ==
6 6  
7 -The constructs in the SDMX Base package comprise the fundamental building blocks that support many of the other structures in the model. For this reason, many of the classes in this package are abstract (i.e. only derived sub-classes can exist in an implementation).
7 +The constructs in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base package comprise the fundamental building blocks that support many of the other structures in the model. For this reason, many of the classes in this package are abstract (i.e. only derived sub-classes can exist in an implementation).
8 8  
9 -The motivation for establishing the SDMX Base package is as follows:
9 +The motivation for establishing the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base package is as follows:
10 10  
11 11  * it is accepted “Best Practise” to identify fundamental archetypes occurring in a model
12 12  * identification of commonly found structures or “patterns” leads to easier understanding
13 13  * identification of patterns encourages re-use
14 14  
15 -Each of the class diagrams in this section views classes from the SDMX Base package from a different perspective. There are detailed views of specific patterns, plus overviews showing inheritance between classes, and relationships amongst classes.
15 +Each of the class diagrams in this section views classes from the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base package from a different perspective. There are detailed views of specific patterns, plus overviews showing inheritance between classes, and relationships amongst classes.
16 16  
17 17  == {{id name="_Toc370969"/}}3.2 Base Structures - Identification, Versioning, and Maintenance ==
18 18  
19 19  === {{id name="_Toc370970"/}}3.2.1 Class Diagram ===
20 20  
21 -**Figure 9: SDMX Identification, Maintenance and Versioning**
21 +**Figure 9: [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Identification, Maintenance and Versioning**
22 22  
23 23  === {{id name="_Toc370971"/}}3.2.2 Explanation of the Diagram ===
24 24  
25 25  ==== 3.2.2.1 Narrative ====
26 26  
27 -This group of classes forms the nucleus of the administration facets of SDMX objects. They provide features which are reusable by derived classes to support horizontal functionality such as identity, versioning etc.
27 +This group of classes forms the nucleus of the administration [[facets>>doc:sdmx:Glossary.Facet.WebHome]] of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] objects. They provide features which are reusable by derived classes to support horizontal functionality such as identity, versioning etc.
28 28  
29 -All classes derived from the abstract class //AnnotableArtefact// may have Annotations (or notes): this supports the need to add notes to all SDMX-ML elements. The Annotation is used to convey extra information to describe any SDMX construct. This information may be in the form of a URL reference and/or a multilingual text (represented by the association to InternationalString).
29 +All classes derived from the abstract class //AnnotableArtefact// may have [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] (or notes): this supports the need to add notes to all [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] elements. The [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is used to convey extra information to describe any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] construct. This information may be in the form of a URL reference and/or a multilingual text (represented by the association to InternationalString).
30 30  
31 -The //IdentifiableArtefact// is an abstract class that comprises the basic attributes needed for identification. Concrete classes based on //IdentifiableArtefact// all inherit the ability to be uniquely identified.
31 +The //IdentifiableArtefact// is an abstract class that comprises the basic [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] needed for identification. Concrete classes based on //IdentifiableArtefact// all inherit the ability to be uniquely identified.
32 32  
33 -The //NamableArtefact// is an abstract class that inherits from //IdentifiableArtefact //and in addition the +description and +name roles support multilingual descriptions and names for all objects based on //NameableArtefact//. The InternationalString supports the representation of a description in multiple locales (locale is similar to language but includes geographic variations such as Canadian French, US English etc.). The //LocalisedString// supports the representation of a description in one locale.
33 +The //NamableArtefact// is an abstract class that inherits from //IdentifiableArtefact //and in addition the +description and +name roles support multilingual descriptions and names for all objects based on //NameableArtefact//. The InternationalString supports the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a description in multiple locales (locale is similar to language but includes geographic variations such as Canadian French, US English etc.). The //LocalisedString// supports the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a description in one locale.
34 34  
35 35  //VersionableArtefact// is an abstract class which inherits from //NameableArtefact// and adds versioning ability to all classes derived from it.
36 36  
37 -//MaintainableArtefact// further adds the ability for derived classes to be maintained via its association to //Agency, //and adds locational information (i.e. from where the object can be retrieved). It is possible to define whether the artefact is draft or final with the final attribute.
37 +//MaintainableArtefact// further adds the ability for derived classes to be maintained via its association to //Agency, //and adds locational information (i.e. from where the object can be retrieved). It is possible to define whether the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is draft or final with the final attribute.
38 38  
39 -The inheritance chain from //AnnotableArtefact// through to //MaintainableArtefact// allows SDMX classes to inherit the features they need, from simple annotation, through identity, naming, to versioning and maintenance.
39 +The inheritance chain from //AnnotableArtefact// through to //MaintainableArtefact// allows [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] classes to inherit the features they need, from simple [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]], through identity, naming, to versioning and maintenance.
40 40  
41 41  ==== 3.2.2.2 Definitions ====
42 42  
43 43  (% style="width:902.294px" %)
44 -|**Class**|(% style="width:246px" %)**Feature**|(% style="width:480px" %)**Description**
45 -|//AnnotableArtefact//|(% style="width:246px" %)(((
44 +|**Class**|(% style="width:269px" %)**Feature**|(% style="width:455px" %)**Description**
45 +|//AnnotableArtefact//|(% style="width:269px" %)(((
46 46  Base inheritance sub classes are:
47 47  //IdentifiableArtefact//
48 -)))|(% style="width:480px" %)Objects of classes derived from this can have attached annotations.
49 -|Annotation|(% style="width:246px" %) |(% style="width:480px" %)Additional descriptive information attached to an object.
50 -| |(% style="width:246px" %)id|(% style="width:480px" %)(((
48 +)))|(% style="width:455px" %)Objects of classes derived from this can have attached annotations.
49 +|Annotation|(% style="width:269px" %) |(% style="width:455px" %)Additional descriptive information attached to an object.
50 +| |(% style="width:269px" %)id|(% style="width:455px" %)(((
51 51  Identifier for the Annotation.
52 52  It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.
53 53  )))
54 -| |(% style="width:246px" %)title|(% style="width:480px" %)A title used to identify an annotation.
55 -| |(% style="width:246px" %)type|(% style="width:480px" %)Specifies how the annotation is to be processed.
56 -| |(% style="width:246px" %)url|(% style="width:480px" %)A link to external descriptive text.
57 -| |(% style="width:246px" %)+text|(% style="width:480px" %)An International String provides the multilingual text content of the annotation via this role.
58 -|//IdentifiableArtefact//|(% style="width:246px" %)(((
54 +| |(% style="width:269px" %)title|(% style="width:455px" %)A title used to identify an annotation.
55 +| |(% style="width:269px" %)type|(% style="width:455px" %)Specifies how the annotation is to be processed.
56 +| |(% style="width:269px" %)url|(% style="width:455px" %)A link to external descriptive text.
57 +| |(% style="width:269px" %)+text|(% style="width:455px" %)An International String provides the multilingual text content of the annotation via this role.
58 +|//IdentifiableArtefact//|(% style="width:269px" %)(((
59 59  Superclass is
60 60  //AnnotableArtefact//
61 61  Base inheritance sub classes are:
62 62  //NameableArtefact//
63 -)))|(% style="width:480px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
64 -| |(% style="width:246px" %)id|(% style="width:480px" %)The unique identifier of the object.
65 -| |(% style="width:246px" %)uri|(% style="width:480px" %)Universal resource identifier that may or may not be resolvable.
66 -| |(% style="width:246px" %)urn|(% style="width:480px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
67 -|//NameableArtefact//|(% style="width:246px" %)(((
63 +)))|(% style="width:455px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
64 +| |(% style="width:269px" %)id|(% style="width:455px" %)The unique identifier of the object.
65 +| |(% style="width:269px" %)uri|(% style="width:455px" %)Universal resource identifier that may or may not be resolvable.
66 +| |(% style="width:269px" %)urn|(% style="width:455px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
67 +|//NameableArtefact//|(% style="width:269px" %)(((
68 68  Superclass is
69 69  //IdentifiableArtefact// Base inheritance sub classes are:
70 70  //VersionableArtefact//
71 -)))|(% style="width:480px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.
72 -| |(% style="width:246px" %)+description|(% style="width:480px" %)A multi-lingual description is provided by this role via the International String class.
73 -| |(% style="width:246px" %)+name|(% style="width:480px" %)A multi-lingual name is provided by this role via the International String class
74 -|InternationalString|(% style="width:246px" %) |(% style="width:480px" %)The International String is a collection of Localised Strings and supports the representation of text in multiple locales.
75 -|LocalisedString|(% style="width:246px" %) |(% style="width:480px" %)The Localised String supports the representation of text in one locale (locale is similar to language but includes geographic variations such as Canadian French, US English etc.).
76 -| |(% style="width:246px" %)label|(% style="width:480px" %)Label of the string.
77 -| |(% style="width:246px" %)locale|(% style="width:480px" %)The geographic locale of the string e.g French, Canadian French.
78 -|//VersionableArtefact//|(% style="width:246px" %)(((
71 +)))|(% style="width:455px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.
72 +| |(% style="width:269px" %)+description|(% style="width:455px" %)A multi-lingual description is provided by this role via the International String class.
73 +| |(% style="width:269px" %)+name|(% style="width:455px" %)A multi-lingual name is provided by this role via the International String class
74 +|InternationalString|(% style="width:269px" %) |(% style="width:455px" %)The International String is a collection of Localised Strings and supports the representation of text in multiple locales.
75 +|LocalisedString|(% style="width:269px" %) |(% style="width:455px" %)The Localised String supports the representation of text in one locale (locale is similar to language but includes geographic variations such as Canadian French, US English etc.).
76 +| |(% style="width:269px" %)label|(% style="width:455px" %)Label of the string.
77 +| |(% style="width:269px" %)locale|(% style="width:455px" %)The geographic locale of the string e.g French, Canadian French.
78 +|//VersionableArtefact//|(% style="width:269px" %)(((
79 79  Superclass is
80 80  //NameableArtefact// Base inheritance sub classes are:
81 81  //MaintainableArtefact//
82 -)))|(% style="width:480px" %)Provides versioning information for all derived objects.
83 -| |(% style="width:246px" %)version|(% style="width:480px" %)A version string following an agreed convention
84 -| |(% style="width:246px" %)validFrom|(% style="width:480px" %)Date from which the version is valid
85 -| |(% style="width:246px" %)validTo|(% style="width:480px" %)Date from which version is superceded
86 -|//MaintainableArtefact//|(% style="width:246px" %)(((
82 +)))|(% style="width:455px" %)Provides versioning information for all derived objects.
83 +| |(% style="width:269px" %)version|(% style="width:455px" %)A version string following an agreed convention
84 +| |(% style="width:269px" %)validFrom|(% style="width:455px" %)Date from which the version is valid
85 +| |(% style="width:269px" %)validTo|(% style="width:455px" %)Date from which version is superceded
86 +|//MaintainableArtefact//|(% style="width:269px" %)(((
87 87  Inherits from
88 88  
89 89  //VersionableArtefact//
90 -)))|(% style="width:480px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
91 -| |(% style="width:246px" %)final|(% style="width:480px" %)Defines whether a maintained artefact is draft or final.
92 -| |(% style="width:246px" %)isExternalReference|(% style="width:480px" %)If set to “true” it indicates that the content of the object is held externally.
93 -| |(% style="width:246px" %)structureURL|(% style="width:480px" %)The URL of an SDMX-ML document containing the external object.
94 -| |(% style="width:246px" %)serviceURL|(% style="width:480px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved.
95 -| |(% style="width:246px" %)+maintainer|(% style="width:480px" %)Association to the Maintenance Agency responsible for maintaining the artefact.
96 -|Agency|(% style="width:246px" %) |(% style="width:480px" %)See section on “Organisations”
90 +)))|(% style="width:455px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
91 +| |(% style="width:269px" %)final|(% style="width:455px" %)Defines whether a maintained artefact is draft or final.
92 +| |(% style="width:269px" %)isExternalReference|(% style="width:455px" %)If set to “true” it indicates that the content of the object is held externally.
93 +| |(% style="width:269px" %)structureURL|(% style="width:455px" %)The URL of an SDMX-ML document containing the external object.
94 +| |(% style="width:269px" %)serviceURL|(% style="width:455px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved.
95 +| |(% style="width:269px" %)+maintainer|(% style="width:455px" %)Association to the Maintenance Agency responsible for maintaining the artefact.
96 +|Agency|(% style="width:269px" %) |(% style="width:455px" %)See section on “Organisations”
97 97  
98 98  == {{id name="_Toc370972"/}}3.3 Basic Inheritance ==
99 99  
... ... @@ -113,6 +113,8 @@
113 113  
114 114  === {{id name="_Toc370976"/}}3.4.1 Class Diagram ===
115 115  
116 +[[image:1747690333052-506.png]]
117 +
116 116  **Figure 11: Class Diagram of Basic Data Types**
117 117  
118 118  === {{id name="_Toc370977"/}}3.4.2 Explanation of the Diagram ===
... ... @@ -162,16 +162,14 @@
162 162  (% class="wikigeneratedid" id="HFigure12TheItemSchemePattern" %)
163 163  **Figure 12 The Item Scheme Pattern**
164 164  
165 -===== {{id name="_Toc370981"/}}3.5.3 Explanation of the Diagram =====
167 +=== {{id name="_Toc370981"/}}3.5.3 Explanation of the Diagram ===
166 166  
167 167  ==== 3.5.3.1 Narrative ====
168 168  
169 169  The //ItemScheme// is an abstract class which defines a set of //Item// (this class is also abstract). Its main purpose is to define a mechanism which can be used to create taxonomies which can classify other parts of the SDMX Information Model. It inherits from //MaintainableArtefact// which gives it the ability to be annotated, have identity, naming, versioning and be associated with an Agency. An example of a concrete class is a CategoryScheme. The associated Category are //Items//.
170 170  
171 -In an exchange environment an ItemScheme is allowed to contain a sub-set of the Items in the maintained //ItemScheme//. If such an //ItemScheme// is disseminated with a sub-set of the Items then the fact that this is a sub-set is denoted by setting the isPartial attribute to
173 +In an exchange environment an ItemScheme is allowed to contain a sub-set of the Items in the maintained //ItemScheme//. If such an //ItemScheme// is disseminated with a sub-set of the Items then the fact that this is a sub-set is denoted by setting the isPartial attribute to “true”.
172 172  
173 -“true”.
174 -
175 175  A “partial” //ItemScheme// cannot be maintained independently in its partial form i.e. it cannot contain //Item//s that are not present in the full //ItemScheme// and the content of any one //Item //(e.g. names and descriptions) cannot deviate from the content in the full //ItemScheme//.
176 176  
177 177  Furthermore, the Id of the //ItemScheme// where isPartial is set to “true” is the same as the Id of the full //ItemScheme// (maintenance agency, id, version). This is important as this is the Id that that is referenced in other structures (e.g. a Codelist referenced in a DSD) and this Id is always the same, regardless of whether the disseminated //ItemScheme// is the full //ItemScheme// or a partial //ItemScheme//.
... ... @@ -257,7 +257,7 @@
257 257  
258 258  __GroupDimensionDescriptor__: Dimension, Measure Dimension, Time Dimension
259 259  
260 -MeasureDescriptor: PrimaryMeasure
260 +__MeasureDescriptor__: PrimaryMeasure
261 261  
262 262  __AttributeDescriptor:__ Data Attribute
263 263  
1747690333052-506.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +67.4 KB
Content
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,0 +1,1 @@
1 +4