Skip to Content

Changes for page 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19
From version 2.3
edited by Helena
on 2025/06/08 00:51
Change comment: There is no comment for this version
To version 2.2
edited by Helena
on 2025/06/08 00:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -12,17 +12,17 @@
12 12  
13 13  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.
14 14  
15 -== 3.2 Base Structures - Identification, Versioning, and Maintenance ==
15 +=== 3.2 Base Structures - Identification, Versioning, and Maintenance ===
16 16  
17 -=== 3.2.1 Class Diagram ===
17 +==== 3.2.1 Class Diagram ====
18 18  
19 19  [[image:1749246130522-547.jpeg]]
20 20  
21 21  **Figure 10: SDMX Identification, Maintenance and Versioning**
22 22  
23 -=== 3.2.2 Explanation of the Diagram ===
23 +===== 3.2.2 Explanation of the Diagram =====
24 24  
25 -==== 3.2.2.1 Narrative ====
25 +====== 3.2.2.1 Narrative ======
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  
... ... @@ -38,79 +38,91 @@
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:973.835px" %)
44 -|**Class**|(% style="width:262px" %)**Feature**|(% style="width:543px" %)**Description**
45 -|//AnnotableArtefact//|(% style="width:262px" %)(((
43 +|**Class**|**Feature**|**Description**
44 +|//AnnotableArtefact//|(((
46 46  Base inheritance sub classes are:
46 +
47 47  //IdentifiableArtefact//
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//
48 +)))|Objects of classes derived from this can have attached annotations.
49 +|Annotation|// //|Additional descriptive information attached to an object.
50 +| |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.
51 +| |title|A title used to identify an annotation.
52 +| |type|Specifies how the annotation is to be processed.
53 +| |url|A link to external descriptive text.
54 +| |value|A non-localised version of the Annotation content.
55 +| |+url|An International URI provides a set of links that are language specific, via this role.
56 +| |+text|An International String provides the multilingual text content of the annotation via this role.
57 +|InternationalUri| |The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales.
58 +|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.).
59 +|//IdentifiableArtefact//|(((
60 +Superclass is
61 +
62 +//AnnotableArtefact//
63 +
61 61  Base inheritance sub classes are:
65 +
62 62  //NameableArtefact//
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:
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//|(((
72 +Superclass is
73 +
74 +//IdentifiableArtefact// Base inheritance sub classes are:
75 +
69 69  //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" %)(((
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//|(((
78 78  Superclass is
86 +
79 79  //NameableArtefact//
88 +
80 80  Base inheritance sub classes are:
90 +
81 81  //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" %)(((
92 +)))|Provides versioning information for all derived objects.
93 +| |version|A version string following SDMX versioning rules.
94 +| |validFrom|Date from which the version is valid
95 +| |validTo|Date from which version is superseded
96 +|//MaintainableArtefact//|(((
87 87  Inherits from
88 88  
89 89  //VersionableArtefact//
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”
100 +)))|An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
101 +| |isExternalReference|If set to “true” it indicates that the content of the object is held externally.
102 +| |structureURL|The URL of an SDMX-ML document containing the external object.
103 +| |serviceURL|The URL of an SDMX-compliant web service from which the external object can be retrieved.
104 +| |+maintainer|Association to the Maintenance Agency responsible for maintaining the artefact.
105 +|Agency| |See section on “Organisations”
96 96  
97 -== 3.3 Basic Inheritance ==
98 98  
99 -=== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes ===
100 100  
109 +==== //3.3 Basic Inheritance// ====
110 +
111 +===== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes =====
112 +
101 101  [[image:1749246130530-261.jpeg]]
102 102  
103 103  **Figure 11: Basic Inheritance from the Base Structures**
104 104  
105 -=== 3.3.2 Explanation of the Diagram ===
117 +===== 3.3.2 Explanation of the Diagram =====
106 106  
107 -==== 3.3.2.1 Narrative ====
119 +====== 3.3.2.1 Narrative ======
108 108  
109 109  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.
110 110  
111 -== 3.4 Data Types ==
123 +=== 3.4 Data Types ===
112 112  
113 -=== 3.4.1 Class Diagram ===
125 +==== 3.4.1 Class Diagram ====
114 114  
115 115  [[image:1749246130536-128.jpeg]]
116 116  
... ... @@ -377,7 +377,7 @@
377 377  |URI|xsd:anyURI|string:uri|System.Uri|Java.net.URI or java.lang.String
378 378  |DateTime|xsd:dateTime|string:datetime|System.DateTime|javax.xml.datatype.XML GregorianCalendar
379 379  |Time|xsd:time|string:time|System.DateTime|javax.xml.datatype.XML GregorianCalendar
380 -|GregorianYear|xsd:gYear|string[[(% class="wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar
392 +|GregorianYear|xsd:gYear|string[[(% class="wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar
381 381  |GregorianMonth|xsd:gYearMonth|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
382 382  |GregorianDay|xsd:date|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
383 383  |Day, MonthDay, Month|xsd:g*|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar