Skip to Content

Changes for page 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19
From version 1.2
edited by Helena
on 2025/06/07 00:42
Change comment: Update document after refactoring.
To version 2.4
edited by Helena
on 2025/06/08 00:53
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,3 +1,7 @@
1 +{{box title="**Contents**"}}
2 +{{toc/}}
3 +{{/box}}
4 +
1 1  == 3.1 Introduction ==
2 2  
3 3  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).
... ... @@ -8,17 +8,17 @@
8 8  
9 9  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.
10 10  
11 -=== 3.2 Base Structures - Identification, Versioning, and Maintenance ===
15 +== 3.2 Base Structures - Identification, Versioning, and Maintenance ==
12 12  
13 -==== 3.2.1 Class Diagram ====
17 +=== 3.2.1 Class Diagram ===
14 14  
15 15  [[image:1749246130522-547.jpeg]]
16 16  
17 17  **Figure 10: SDMX Identification, Maintenance and Versioning**
18 18  
19 -===== 3.2.2 Explanation of the Diagram =====
23 +=== 3.2.2 Explanation of the Diagram ===
20 20  
21 -====== 3.2.2.1 Narrative ======
25 +==== 3.2.2.1 Narrative ====
22 22  
23 23  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.
24 24  
... ... @@ -34,99 +34,87 @@
34 34  
35 35  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.
36 36  
37 -====== 3.2.2.2 Definitions ======
41 +==== 3.2.2.2 Definitions ====
38 38  
39 -|**Class**|**Feature**|**Description**
40 -|//AnnotableArtefact//|(((
43 +(% style="width:973.835px" %)
44 +|**Class**|(% style="width:262px" %)**Feature**|(% style="width:543px" %)**Description**
45 +|//AnnotableArtefact//|(% style="width:262px" %)(((
41 41  Base inheritance sub classes are:
42 -
43 43  //IdentifiableArtefact//
44 -)))|Objects of classes derived from this can have attached annotations.
45 -|Annotation|// //|Additional descriptive information attached to an object.
46 -| |id|Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.
47 -| |title|A title used to identify an annotation.
48 -| |type|Specifies how the annotation is to be processed.
49 -| |url|A link to external descriptive text.
50 -| |value|A non-localised version of the Annotation content.
51 -| |+url|An International URI provides a set of links that are language specific, via this role.
52 -| |+text|An International String provides the multilingual text content of the annotation via this role.
53 -|InternationalUri| |The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales.
54 -|LocalisedUri| |The Localised URI supports the link to an external description in one locale (locale is similar to language but includes geographic variations such as Canadian French, US English etc.).
55 -|//IdentifiableArtefact//|(((
56 -Superclass is
57 -
58 -//AnnotableArtefact//
59 -
48 +)))|(% style="width:543px" %)Objects of classes derived from this can have attached annotations.
49 +|Annotation|(% style="width:262px" %)// //|(% style="width:543px" %)Additional descriptive information attached to an object.
50 +| |(% style="width:262px" %)id|(% style="width:543px" %)Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.
51 +| |(% style="width:262px" %)title|(% style="width:543px" %)A title used to identify an annotation.
52 +| |(% style="width:262px" %)type|(% style="width:543px" %)Specifies how the annotation is to be processed.
53 +| |(% style="width:262px" %)url|(% style="width:543px" %)A link to external descriptive text.
54 +| |(% style="width:262px" %)value|(% style="width:543px" %)A non-localised version of the Annotation content.
55 +| |(% style="width:262px" %)+url|(% style="width:543px" %)An International URI provides a set of links that are language specific, via this role.
56 +| |(% style="width:262px" %)+text|(% style="width:543px" %)An International String provides the multilingual text content of the annotation via this role.
57 +|InternationalUri|(% style="width:262px" %) |(% style="width:543px" %)The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales.
58 +|LocalisedUri|(% style="width:262px" %) |(% style="width:543px" %)The Localised URI supports the link to an external description in one locale (locale is similar to language but includes geographic variations such as Canadian French, US English etc.).
59 +|//IdentifiableArtefact//|(% style="width:262px" %)(((
60 +Superclass is //AnnotableArtefact//
60 60  Base inheritance sub classes are:
61 -
62 62  //NameableArtefact//
63 -)))|Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
64 -| |id|The unique identifier of the object.
65 -| |uri|Universal resource identifier that may or may not be resolvable.
66 -| |urn|Universal resource name – this is for use in registries: all registered objects have a urn.
67 -|//NameableArtefact//|(((
68 -Superclass is
69 -
70 -//IdentifiableArtefact// Base inheritance sub classes are:
71 -
63 +)))|(% style="width:543px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
64 +| |(% style="width:262px" %)id|(% style="width:543px" %)The unique identifier of the object.
65 +| |(% style="width:262px" %)uri|(% style="width:543px" %)Universal resource identifier that may or may not be resolvable.
66 +| |(% style="width:262px" %)urn|(% style="width:543px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
67 +|//NameableArtefact//|(% style="width:262px" %)(((
68 +Superclass is //IdentifiableArtefact// Base inheritance sub classes are:
72 72  //VersionableArtefact//
73 -)))|Provides a Name and Description to all derived classes in addition to identification and annotations.
74 -| |+description|A multi-lingual description is provided by this role via the International String class.
75 -| |+name|A multi-lingual name is provided by this role via the International String class
76 -|InternationalString| |The International String is a collection of Localised Strings and supports the representation of text in multiple locales.
77 -|LocalisedString| |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.).
78 -| |label|Label of the string.
79 -| |locale|The geographic locale of the string e.g French, Canadian French.
80 -|//VersionableArtefact//|(((
70 +)))|(% style="width:543px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.
71 +| |(% style="width:262px" %)+description|(% style="width:543px" %)A multi-lingual description is provided by this role via the International String class.
72 +| |(% style="width:262px" %)+name|(% style="width:543px" %)A multi-lingual name is provided by this role via the International String class
73 +|InternationalString|(% style="width:262px" %) |(% style="width:543px" %)The International String is a collection of Localised Strings and supports the representation of text in multiple locales.
74 +|LocalisedString|(% style="width:262px" %) |(% style="width:543px" %)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.).
75 +| |(% style="width:262px" %)label|(% style="width:543px" %)Label of the string.
76 +| |(% style="width:262px" %)locale|(% style="width:543px" %)The geographic locale of the string e.g French, Canadian French.
77 +|//VersionableArtefact//|(% style="width:262px" %)(((
81 81  Superclass is
82 -
83 83  //NameableArtefact//
84 -
85 85  Base inheritance sub classes are:
86 -
87 87  //MaintainableArtefact//
88 -)))|Provides versioning information for all derived objects.
89 -| |version|A version string following SDMX versioning rules.
90 -| |validFrom|Date from which the version is valid
91 -| |validTo|Date from which version is superseded
92 -|//MaintainableArtefact//|(((
82 +)))|(% style="width:543px" %)Provides versioning information for all derived objects.
83 +| |(% style="width:262px" %)version|(% style="width:543px" %)A version string following SDMX versioning rules.
84 +| |(% style="width:262px" %)validFrom|(% style="width:543px" %)Date from which the version is valid
85 +| |(% style="width:262px" %)validTo|(% style="width:543px" %)Date from which version is superseded
86 +|//MaintainableArtefact//|(% style="width:262px" %)(((
93 93  Inherits from
94 94  
95 95  //VersionableArtefact//
96 -)))|An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
97 -| |isExternalReference|If set to “true” it indicates that the content of the object is held externally.
98 -| |structureURL|The URL of an SDMX-ML document containing the external object.
99 -| |serviceURL|The URL of an SDMX-compliant web service from which the external object can be retrieved.
100 -| |+maintainer|Association to the Maintenance Agency responsible for maintaining the artefact.
101 -|Agency| |See section on “Organisations”
90 +)))|(% style="width:543px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
91 +| |(% style="width:262px" %)isExternalReference|(% style="width:543px" %)If set to “true” it indicates that the content of the object is held externally.
92 +| |(% style="width:262px" %)structureURL|(% style="width:543px" %)The URL of an SDMX-ML document containing the external object.
93 +| |(% style="width:262px" %)serviceURL|(% style="width:543px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved.
94 +| |(% style="width:262px" %)+maintainer|(% style="width:543px" %)Association to the Maintenance Agency responsible for maintaining the artefact.
95 +|Agency|(% style="width:262px" %) |(% style="width:543px" %)See section on “Organisations”
102 102  
97 +== 3.3 Basic Inheritance ==
103 103  
99 +=== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes ===
104 104  
105 -==== //3.3 Basic Inheritance// ====
106 -
107 -===== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes =====
108 -
109 109  [[image:1749246130530-261.jpeg]]
110 110  
111 111  **Figure 11: Basic Inheritance from the Base Structures**
112 112  
113 -===== 3.3.2 Explanation of the Diagram =====
105 +=== 3.3.2 Explanation of the Diagram ===
114 114  
115 -====== 3.3.2.1 Narrative ======
107 +==== 3.3.2.1 Narrative ====
116 116  
117 117  The diagram above shows the inheritance within the base structures. The concrete classes are introduced and defined in the specific package to which they relate.
118 118  
119 -=== 3.4 Data Types ===
111 +== 3.4 Data Types ==
120 120  
121 -==== 3.4.1 Class Diagram ====
113 +=== 3.4.1 Class Diagram ===
122 122  
123 123  [[image:1749246130536-128.jpeg]]
124 124  
125 125  **Figure 12: Class Diagram of Basic Data Types**
126 126  
127 -===== 3.4.2 Explanation of the Diagram =====
119 +=== 3.4.2 Explanation of the Diagram ===
128 128  
129 -====== 3.4.2.1 Narrative ======
121 +==== 3.4.2.1 Narrative ====
130 130  
131 131  The FacetType and FacetValueType enumerations are used to specify the valid format of the content of a non-enumerated Concept or the usage of a Concept when specified for use on a //Component// on a //Structure// (such as a Dimension in a DataStructureDefinition). The description of the various types can be found in the chapter on ConceptScheme (section 4.5).
132 132  
... ... @@ -147,23 +147,23 @@
147 147  
148 148  The VersionType data types provides the details for versioning according to SDMX versioning rules, as explained in SDMX Standards Section 6, paragraph “4.3 Versioning”.
149 149  
150 -==== //3.5 The Item Scheme Pattern// ====
142 +== 3.5 The Item Scheme Pattern ==
151 151  
152 -===== 3.5.1 Context =====
144 +=== 3.5.1 Context ===
153 153  
154 154  The Item Scheme is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example.
155 155  
156 156  The //ItemScheme// is the basis for CategoryScheme, Codelist, ConceptScheme, ReportingTaxonomy, //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme.
157 157  
158 -===== 3.5.2 Class Diagram =====
150 +=== 3.5.2 Class Diagram ===
159 159  
160 160  [[image:1749246130543-644.jpeg]]
161 161  
162 162  **Figure 13 The Item Scheme pattern**
163 163  
164 -===== 3.5.3 Explanation of the Diagram =====
156 +=== 3.5.3 Explanation of the Diagram ===
165 165  
166 -====== 3.5.3.1 Narrative ======
158 +==== 3.5.3.1 Narrative ====
167 167  
168 168  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 is derived 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 ConceptScheme. The associated Concepts are //Item//s.
169 169  
... ... @@ -177,37 +177,28 @@
177 177  
178 178  The //Item// can be hierarchic and so one //Item// can have child //Item//s. The restriction of the hierarchic association is that a child //Item// can have only parent //Item//.
179 179  
180 -====== 3.5.3.2 Definitions ======
172 +==== 3.5.3.2 Definitions ====
181 181  
182 -|**Class**|**Feature**|**Description**
183 -|//ItemScheme//|(((
174 +(% style="width:989.835px" %)
175 +|**Class**|(% style="width:297px" %)**Feature**|(% style="width:583px" %)**Description**
176 +|//ItemScheme//|(% style="width:297px" %)(((
184 184  Inherits from:
185 -
186 186  //MaintainableArtefact//
187 -
188 188  Direct sub classes are:
189 -
190 190  CategoryScheme
191 -
192 192  ConceptScheme
193 -
194 194  Codelist
195 -
196 196  ReportingTaxonomy
197 -
198 198  //OrganisationScheme//
199 -
200 200  TransformationScheme
201 -
202 202  CustomTypeScheme NamePersonalisationSc heme
203 -
204 204  RulesetScheme
205 -
206 -VtlMappingScheme UserDefinedOperatorSc heme
207 -)))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
208 -| |isPartial|Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme.
209 -| |/items|Association to the Items in the scheme.
210 -|//Item//|(((
188 +VtlMappingScheme
189 +UserDefinedOperatorSc heme
190 +)))|(% style="width:583px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
191 +| |(% style="width:297px" %)isPartial|(% style="width:583px" %)Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme.
192 +| |(% style="width:297px" %)/items|(% style="width:583px" %)Association to the Items in the scheme.
193 +|//Item//|(% style="width:297px" %)(((
211 211  Inherits from:
212 212  
213 213  //NameableArtefact//
... ... @@ -233,9 +233,8 @@
233 233  VtlMapping
234 234  
235 235  UserDefinedOperator// //hierarchy
236 -)))|(((
219 +)))|(% style="width:583px" %)(((
237 237  The Item is an item of content in an Item Scheme. This may be a node in a taxonomy or ontology, a code in a code list etc. Node that at the conceptual level the Organisation is not hierarchic.
238 -
239 239  This allows an Item optionally to have one or more child Items
240 240  )))
241 241  
... ... @@ -245,7 +245,7 @@
245 245  
246 246  The Structure Pattern is a basic architectural pattern which allows the specification of complex tabular structures which are often found in statistical data (such as Data Structure Definition, and Metadata Structure Definition). A Structure is a set of ordered lists. A pattern to underpin this tabular structure has been developed, so that commonalities between these structure definitions can be supported by common software and common syntax structures.
247 247  
248 -===== 3.6.2 Class Diagrams [[image:1749246130548-601.jpeg]] =====
230 +===== 3.6.2 Class Diagrams [[image:1749246130548-601.jpeg]] =====
249 249  
250 250  **Figure 14: The Structure Pattern**
251 251  
... ... @@ -385,7 +385,7 @@
385 385  |URI|xsd:anyURI|string:uri|System.Uri|Java.net.URI or java.lang.String
386 386  |DateTime|xsd:dateTime|string:datetime|System.DateTime|javax.xml.datatype.XML GregorianCalendar
387 387  |Time|xsd:time|string:time|System.DateTime|javax.xml.datatype.XML GregorianCalendar
388 -|GregorianYear|xsd:gYear|string[[^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar
370 +|GregorianYear|xsd:gYear|string[[(% class="wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar
389 389  |GregorianMonth|xsd:gYearMonth|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
390 390  |GregorianDay|xsd:date|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
391 391  |Day, MonthDay, Month|xsd:g*|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,0 +1,1 @@
1 +4