Skip to Content

Changes for page 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19
From version 6.3
edited by Helena
on 2025/05/20 00:23
Change comment: There is no comment for this version
To version 2.2
edited by Helena
on 2025/05/19 23:53
Change comment: Changed document title to [3 SDMX Base Package].

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,4 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
1 += {{id name="_Toc370967"/}}3 SDMX Base Package =
4 4  
5 5  == {{id name="_Toc370968"/}}3.1 Introduction ==
6 6  
... ... @@ -8,9 +8,9 @@
8 8  
9 9  The motivation for establishing the SDMX Base package is as follows:
10 10  
11 -* it is accepted “Best Practise” to identify fundamental archetypes occurring in a model
12 -* identification of commonly found structures or “patterns” leads to easier understanding
13 -* identification of patterns encourages re-use
9 +* it is accepted “Best Practise” to identify fundamental archetypes occurring in a model//  //
10 +* identification of commonly found structures or “patterns” leads to easier understanding//  //
11 +* identification of patterns encourages re-use//  //
14 14  
15 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.
16 16  
... ... @@ -26,8 +26,10 @@
26 26  
27 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.
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).
27 +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
30 30  
29 +InternationalString).
30 +
31 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.
32 32  
33 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.
... ... @@ -38,62 +38,70 @@
38 38  
39 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.
40 40  
41 -==== 3.2.2.2 Definitions ====
41 +**3.2.2.2 Definitions**
42 42  
43 -(% style="width:902.294px" %)
44 -|**Class**|(% style="width:246px" %)**Feature**|(% style="width:480px" %)**Description**
45 -|//AnnotableArtefact//|(% style="width:246px" %)(((
43 +|**Class**|**Feature**|**Description**
44 +|//AnnotableArtefact//|(((
46 46  Base inheritance sub classes are:
46 +
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 +)))|Objects of classes derived from this can have attached annotations.
49 +|Annotation||Additional descriptive information attached to an object.
50 +||id|(((
51 51  Identifier for the Annotation.
52 +
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" %)(((
55 +||title//    //|A title used to identify an annotation.
56 +||type|Specifies how the annotation is to be processed.
57 +||url|A link to external descriptive text.
58 +||+text|An International String provides the multilingual text content of the annotation via this role.
59 +|//IdentifiableArtefact//|(((
59 59  Superclass is
61 +
60 60  //AnnotableArtefact//
61 -Base inheritance sub classes are:
63 +
64 +Base inheritance sub classes are~://    //
65 +
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" %)(((
67 +)))|Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
68 +||id|The unique identifier of the object.
69 +||uri|Universal resource identifier that may or may not be resolvable.
70 +||urn|Universal resource name – this is for use in registries: all registered objects have a urn.
71 +|//NameableArtefact//|(((
68 68  Superclass is
73 +
69 69  //IdentifiableArtefact// Base inheritance sub classes are:
75 +
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" %)(((
77 +)))|Provides a Name and Description to all derived classes in addition to identification and annotations.
78 +||+description|A multi-lingual description is provided by this role via the International String class.
79 +||+name|A multi-lingual name is provided by this role via the International String class
80 +|InternationalString||The International String is a collection of Localised Strings and supports the representation of text in multiple locales.
81 +|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.).
82 +||label|Label of the string.
83 +||locale|The geographic locale of the string e.g French, Canadian French.
84 +|//VersionableArtefact//|(((
79 79  Superclass is
86 +
80 80  //NameableArtefact// Base inheritance sub classes are:
88 +
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" %)(((
90 +)))|Provides versioning information for all derived objects.
91 +||version|A version string following an agreed convention
92 +||validFrom|Date from which the version is valid
93 +||validTo|Date from which version is superceded
94 +|//MaintainableArtefact//|(((
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”
98 +)))|An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
99 +||final|Defines whether a maintained artefact is draft or final.
100 +||isExternalReference|If set to “true” it indicates that the content of the object is held externally.
101 +||structureURL|The URL of an SDMX-ML document containing the external object.
102 +||serviceURL|The URL of an SDMX-compliant web service from which the external object can be retrieved.
103 +||+maintainer//    //|Association to the Maintenance Agency responsible for maintaining the artefact.
104 +|Agency||See section on “Organisations”
97 97  
98 98  == {{id name="_Toc370972"/}}3.3 Basic Inheritance ==
99 99  
... ... @@ -199,7 +199,7 @@
199 199  
200 200  Codelist
201 201  )))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
202 -| |(((
210 +||(((
203 203  ReportingTaxonomy
204 204  
205 205  //OrganisationScheme//
... ... @@ -215,9 +215,9 @@
215 215  VtlMappingScheme
216 216  
217 217  UserDefinedOperatorScheme
218 -)))|
219 -| |isPartial|Denotes whether the Item Scheme contains a sub set of the full set of Items in the maintained scheme.
220 -| |items|Association to the Items in the scheme.
226 +)))|
227 +||isPartial|Denotes whether the Item Scheme contains a sub set of the full set of Items in the maintained scheme.
228 +||items|Association to the Items in the scheme.
221 221  |//Item//|(((
222 222  Inherits from:
223 223  
... ... @@ -245,13 +245,13 @@
245 245  
246 246  VtlMapping
247 247  
248 -UserDefinedOperator//    //
256 +UserDefinedOperator//    //
249 249  )))|(((
250 250  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.
251 251  
252 252  Note that at the conceptual level the Organisation is not hierarchic
253 253  )))
254 -| |hierarchy|This allows an Item optionally to have one or more child Items.
262 +||hierarchy|This allows an Item optionally to have one or more child Items.
255 255  
256 256  == {{id name="_Toc370982"/}}3.6 The Structure Pattern ==
257 257  
... ... @@ -318,9 +318,9 @@
318 318  
319 319  DataflowDefinition
320 320  
321 -MetadataflowDefinition//    //
329 +MetadataflowDefinition//    //
322 322  )))|An artefact whose components are described by a Structure. In concrete terms (sub-classes) an example would be a Dataflow Definition which is linked to a given structure – in this case the Data Structure Definition.
323 -| |structure|An association to a Structure specifying the structure of the artefact.
331 +||structure|An association to a Structure specifying the structure of the artefact.
324 324  |//Structure//|(((
325 325  Inherits from:
326 326  
... ... @@ -336,7 +336,7 @@
336 336  
337 337  Definition
338 338  )))|Abstract specification of a list of lists to define a complex tabular structure. A concrete example of this would be statistical concepts, code lists, and their organisation in a data or metadata structure definition, defined by a centre institution, usually for the exchange of statistical information with its partners.
339 -| |grouping|A composite association to one or more component lists.
347 +||grouping|A composite association to one or more component lists.
340 340  |//ComponentList//|(((
341 341  Inherits from:
342 342  
... ... @@ -358,7 +358,7 @@
358 358  
359 359  ReportStructure
360 360  )))|An abstract definition of a list of components. A concrete example is a Dimension Descriptor which defines the list of Dimensions in a Data Structure Definition.
361 -| |components|An aggregate association to one or more components which make up the list.
369 +||components|An aggregate association to one or more components which make up the list.
362 362  |//Component//|(((
363 363  Inherits from:
364 364  
... ... @@ -376,20 +376,20 @@
376 376  
377 377  MetadataAttribute
378 378  )))|A component is an abstract super class used to define qualitative and quantitative data and metadata items that belong to a Component List and hence a Structure. Component is refined through its sub-classes.
379 -| |conceptIdentity|Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component
380 -| |localRepresentation|Association to the Representation of the Component if this is different from the coreRepresentation of the Concept which the Component uses (ConceptUsage)
381 -|Representation| |The allowable value or format for Component or Concept
382 -| |+enumerated|Association to an enumerated list that contains the allowable content for the Component when reported in a data or metadata set. The type of enumerated list that is allowed for any concrete Component is shown in the constraints on the association (e.g. Identifier Component can have any of the sub classes of Item Scheme, whereas Measure Dimension must have a Concept Scheme).
383 -| |+nonEnumerated|Association to a set of Facets that define the allowable format for the content of the Component when reported in a data or metadata set.
384 -|Facet| |Defines the format for the content of the Component when reported in a data or metadata set.
385 -| |facetType|A specific content type which is constrained by the FacetType enumeration
386 -| |facetValueType|(((
387 +||conceptIdentity|Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component
388 +||localRepresentation|Association to the Representation of the Component if this is different from the coreRepresentation of the Concept which the Component uses (ConceptUsage)
389 +|Representation||The allowable value or format for Component or Concept
390 +||+enumerated|Association to an enumerated list that contains the allowable content for the Component when reported in a data or metadata set. The type of enumerated list that is allowed for any concrete Component is shown in the constraints on the association (e.g. Identifier Component can have any of the sub classes of Item Scheme, whereas Measure Dimension must have a Concept Scheme).
391 +||+nonEnumerated|Association to a set of Facets that define the allowable format for the content of the Component when reported in a data or metadata set.
392 +|Facet||Defines the format for the content of the Component when reported in a data or metadata set.
393 +||facetType|A specific content type which is constrained by the FacetType enumeration
394 +||facetValueType|(((
387 387  The format of the value of a Component when reported in a data or metadata set.
388 388  
389 389  This is contrained by the FacetValueType enumeration.
390 390  )))
391 -| |+itemSchemeFacet|Defines the format of the identifiers in an Item Scheme used by a Component. Typically this would define the number of characters (length) of the identifier.
392 -|ExtendedFacet| |This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute
399 +||+itemSchemeFacet|Defines the format of the identifiers in an Item Scheme used by a Component. Typically this would define the number of characters (length) of the identifier.
400 +|ExtendedFacet||This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute
393 393  
394 394  The specification of the content and use of the sub classes to ,,ComponentList,, and ,,Component,, can be found in the section in which they are used (DataStructureDefinition and MetadataStructureDefinition)
395 395  
... ... @@ -397,7 +397,7 @@
397 397  
398 398  The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, 818 and have equivalents in most current implementation platforms:
399 399  
400 -:
408 +:
401 401  
402 402  (((
403 403  |**SDMX Facet Value Type**|**XML Schema Data Type     **|**.NET Framework Type**|**Java Data Type**
... ... @@ -424,13 +424,13 @@
424 424  
425 425  The ,,Representation,, is composed of ,,Facet,,s, each of which conveys characteristic 826 information related to the definition of a value domain. Often a set of Facets are needed to 827 convey the required semantic. For example, a sequence is defined by a minimum of two 828 Facets: one to define the start value, and one to define the interval.
426 426  
427 -:
435 +:
428 428  
429 429  (((
430 -|**Facet Type**|**Explanation**|
431 -|isSequence|The isSequence facet indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue facet or the timeInterval, startTime, and endTime, facets. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely.|
432 -|interval|The interval attribute specifies the permitted interval (increment) in a|
433 -| |(% colspan="2" %)sequence. In order for this to be used, the isSequence attribute must have a value of true.
438 +|**Facet Type**|**Explanation**|
439 +|isSequence|The isSequence facet indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue facet or the timeInterval, startTime, and endTime, facets. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely.|
440 +|interval|The interval attribute specifies the permitted interval (increment) in a|
441 +||(% colspan="2" %)sequence. In order for this to be used, the isSequence attribute must have a value of true.
434 434  |startValue|(% colspan="2" %)The startValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.
435 435  |endValue|(% colspan="2" %)The endValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric sequence, and indicates that ending point (if any) of the sequence.
436 436  |timeInterval|(% colspan="2" %)The timeInterval facet indicates the permitted duration in a time sequence. In order for this to be used, the isSequence facet must have a value of true.
SDMX_2-1_SECTION_2_InformationModel_2020-07_1645dbd1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -129.5 KB
Content
SDMX_2-1_SECTION_2_InformationModel_2020-07_84176ba5.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -158.3 KB
Content
SDMX_2-1_SECTION_2_InformationModel_2020-07_a2879920.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -207.8 KB
Content
SDMX_2-1_SECTION_2_InformationModel_2020-07_b6478a73.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -328.1 KB
Content