Skip to Content

Changes for page 3 SDMX Base Package

Last modified by Helena K. on 2026/06/08 16:18
From version 28.1
edited by Artur K.
on 2026/04/20 15:00
Change comment: There is no comment for this version
To version 29.1
edited by Artur K.
on 2026/06/02 10:17
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -24,19 +24,19 @@
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>>doc: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.
27 +This group of classes forms the nucleus of the administration [[facets>>doc:sdmx:Glossary 2\.1.Facet.WebHome]] of [[SDMX>>doc:sdmx:Glossary 2\.1.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>>doc:IMElements.AnnotableArtefact.WebHome]]// may have Annotations (or notes): this supports the need to add notes to all [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] elements. The [[Annotation>>doc:IMElements.Annotation.WebHome]] is used to convey extra information to describe any [[SDMX>>doc: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>>doc:IMElements.InternationalString.WebHome]]).
29 +All classes derived from the abstract class //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// may have [[Annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] (or notes): this supports the need to add notes to all [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] elements. The [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] is used to convey extra information to describe any [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] construct. This information may be in the form of a URL reference and/or a multilingual [[text>>doc:IMElements.text.WebHome]] (represented by the association to [[InternationalString>>doc:IMElements.InternationalString.WebHome]]).
30 30  
31 -The //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// is an abstract class that comprises the basic [[attributes>>doc:Glossary.Attribute.WebHome]] needed for identification. Concrete classes based on //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// all inherit the ability to be uniquely identified.
31 +The //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// is an abstract class that comprises the basic [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] needed for identification. Concrete classes based on //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// all inherit the ability to be uniquely identified.
32 32  
33 -The (% style="background-color:#e74c3c" %)//NamableArtefact//(%%) is an abstract class that inherits from //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]] //and in addition the +[[description>>doc:IMElements.description.WebHome]] and +[[name>>doc:IMElements.name.WebHome]] roles support multilingual descriptions and names for all objects based on //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]//. The [[InternationalString>>doc:IMElements.InternationalString.WebHome]] supports the representation of a [[description>>doc:IMElements.description.WebHome]] in multiple locales ([[locale>>doc:IMElements.locale.WebHome]] is similar to language but includes geographic variations such as Canadian French, US English etc.). The //[[LocalisedString>>doc:IMElements.LocalisedString.WebHome]]// supports the representation of a [[description>>doc:IMElements.description.WebHome]] in one [[locale>>doc:IMElements.locale.WebHome]].
33 +The (% style="background-color:#e74c3c" %)//NamableArtefact//(%%) is an abstract class that inherits from //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]] //and in addition the +[[description>>doc:IMElements.description.WebHome]] and +[[name>>doc:IMElements.name.WebHome]] roles support multilingual descriptions and names for all objects based on //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]//. The [[InternationalString>>doc:IMElements.InternationalString.WebHome]] supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of a [[description>>doc:IMElements.description.WebHome]] in multiple locales ([[locale>>doc:IMElements.locale.WebHome]] is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.). The //[[LocalisedString>>doc:IMElements.LocalisedString.WebHome]]// supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of a [[description>>doc:IMElements.description.WebHome]] in one [[locale>>doc:IMElements.locale.WebHome]].
34 34  
35 -//[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]// is an abstract class which inherits from //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// and adds versioning ability to all classes derived from it, as explained in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”.
35 +//[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]// is an abstract class which inherits from //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// and adds versioning ability to all classes derived from it, as explained in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”.
36 36  
37 37  //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// further adds the ability for derived classes to be maintained via its association to an //[[Organisation>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.WebHome]]//, and adds locational information (i.e., from where the object can be retrieved).
38 38  
39 -The inheritance chain from //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// through to //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// allows [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] classes to inherit the features they need, from simple [[annotation>>doc:IMElements.annotation.WebHome]], through identity, naming, to versioning and maintenance.
39 +The inheritance chain from //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// through to //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// allows [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] classes to inherit the features they need, from simple [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]], through identity, naming, to versioning and maintenance.
40 40  
41 41  ==== 3.2.2.2 Definitions ====
42 42  
... ... @@ -45,22 +45,22 @@
45 45  |//[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]//|(% style="width:262px" %)(((
46 46  Base inheritance sub classes are:
47 47  //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]//
48 -)))|(% style="width:543px" %)Objects of classes derived from this can have attached annotations.
48 +)))|(% style="width:543px" %)Objects of classes derived from this can have attached [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]].
49 49  |[[Annotation>>doc:IMElements.Annotation.WebHome]]|(% style="width:262px" %)// //|(% style="width:543px" %)Additional descriptive information attached to an object.
50 -| |(% style="width:262px" %)[[id>>doc:IMElements.id.WebHome]]|(% 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>>doc:IMElements.title.WebHome]]|(% style="width:543px" %)A title used to identify an annotation.
52 -| |(% style="width:262px" %)[[type>>doc:IMElements.type.WebHome]]|(% style="width:543px" %)Specifies how the annotation is to be processed.
50 +| |(% style="width:262px" %)[[id>>doc:IMElements.id.WebHome]]|(% style="width:543px" %)Identifier for the [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]]. It can be used to disambiguate one [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] from another where there are several [[Annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] for the same annotated object.
51 +| |(% style="width:262px" %)[[title>>doc:IMElements.title.WebHome]]|(% style="width:543px" %)A [[title>>doc:sdmx:Glossary 2\.1.Title.WebHome]] used to identify an [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]].
52 +| |(% style="width:262px" %)[[type>>doc:IMElements.type.WebHome]]|(% style="width:543px" %)Specifies how the [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] is to be processed.
53 53  | |(% style="width:262px" %)[[url>>doc:IMElements.url.WebHome]]|(% 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>>doc:IMElements.url.WebHome]]|(% 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.
54 +| |(% style="width:262px" %)[[value>>doc:IMElements.value.WebHome]]|(% style="width:543px" %)A non-localised version of the [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] content.
55 +| |(% style="width:262px" %)+[[url>>doc:IMElements.url.WebHome]]|(% style="width:543px" %)An International URI provides a set of links that are [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] specific, via this role.
56 +| |(% style="width:262px" %)+[[text>>doc:IMElements.text.WebHome]]|(% style="width:543px" %)An [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] provides the multilingual text content of the [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] via this role.
57 57  |[[InternationalUri>>doc:IMElements.InternationalURI.WebHome]]|(% 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>>doc:IMElements.LocalisedURI.WebHome]]|(% 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.).
58 +|[[LocalisedUri>>doc:IMElements.LocalisedURI.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The Localised URI supports the link to an external description in one locale (locale is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.).
59 59  |//[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]//|(% style="width:262px" %)(((
60 60  Superclass is //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]//
61 61  Base inheritance sub classes are:
62 62  //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]//
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>>doc:Glossary.Artefact.WebHome]].
63 +)))|(% style="width:543px" %)Provides identity to all derived classes. It also provides [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] to derived classes because it is a subclass of [[Annotable Artefact>>doc:sdmx:Glossary 2\.1.Annotable artefact.WebHome]].
64 64  | |(% style="width:262px" %)[[id>>doc:IMElements.id.WebHome]]|(% style="width:543px" %)The unique identifier of the object.
65 65  | |(% style="width:262px" %)[[uri>>doc:IMElements.uri.WebHome]]|(% style="width:543px" %)Universal resource identifier that may or may not be resolvable.
66 66  | |(% style="width:262px" %)[[urn>>doc:IMElements.urn.WebHome]]|(% style="width:543px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
... ... @@ -67,11 +67,11 @@
67 67  |//[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]//|(% style="width:262px" %)(((
68 68  Superclass is //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// Base inheritance sub classes are:
69 69  //[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]//
70 -)))|(% style="width:543px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.
71 -| |(% style="width:262px" %)+[[description>>doc:IMElements.description.WebHome]]|(% style="width:543px" %)A multi-lingual description is provided by this role via the International String class.
72 -| |(% style="width:262px" %)+[[name>>doc:IMElements.name.WebHome]]|(% style="width:543px" %)A multi-lingual name is provided by this role via the International String class
73 -|[[InternationalString>>doc:IMElements.InternationalString.WebHome]]|(% 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>>doc:IMElements.LocalisedString.WebHome]]|(% 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.).
70 +)))|(% style="width:543px" %)Provides a Name and Description to all derived classes in addition to identification and [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]].
71 +| |(% style="width:262px" %)+[[description>>doc:IMElements.description.WebHome]]|(% style="width:543px" %)A multi-lingual description is provided by this role via the [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] class.
72 +| |(% style="width:262px" %)+[[name>>doc:IMElements.name.WebHome]]|(% style="width:543px" %)A multi-lingual name is provided by this role via the [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] class
73 +|[[InternationalString>>doc:IMElements.InternationalString.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] is a collection of Localised Strings and supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of text in multiple locales.
74 +|[[LocalisedString>>doc:IMElements.LocalisedString.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The Localised String supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of text in one locale (locale is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.).
75 75  | |(% style="width:262px" %)[[label>>doc:IMElements.label.WebHome]]|(% style="width:543px" %)Label of the string.
76 76  | |(% style="width:262px" %)[[locale>>doc:IMElements.locale.WebHome]]|(% style="width:543px" %)The geographic locale of the string e.g French, Canadian French.
77 77  |//[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]//|(% style="width:262px" %)(((
... ... @@ -80,7 +80,7 @@
80 80  Base inheritance sub classes are:
81 81  //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]//
82 82  )))|(% style="width:543px" %)Provides versioning information for all derived objects.
83 -| |(% style="width:262px" %)[[version>>doc:IMElements.version.WebHome]]|(% style="width:543px" %)A version string following [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules.
83 +| |(% style="width:262px" %)[[version>>doc:IMElements.version.WebHome]]|(% style="width:543px" %)A version string following [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules.
84 84  | |(% style="width:262px" %)[[validFrom>>doc:IMElements.validFrom.WebHome]]|(% style="width:543px" %)Date from which the version is valid
85 85  | |(% style="width:262px" %)[[validTo>>doc:IMElements.validTo.WebHome]]|(% style="width:543px" %)Date from which version is superseded
86 86  |//[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]//|(% style="width:262px" %)(((
... ... @@ -87,11 +87,11 @@
87 87  Inherits from
88 88  
89 89  //[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]//
90 -)))|(% style="width:543px" %)An abstract class to group together primary [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:Glossary.Artefact.WebHome]] that are maintained by an Agency.
90 +)))|(% style="width:543px" %)An abstract class to group together primary [[structural metadata>>doc:sdmx:Glossary 2\.1.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] that are maintained by an Agency.
91 91  | |(% style="width:262px" %)[[isExternalReference>>doc:IMElements.isExternalReference.WebHome]]|(% 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>>doc:Glossary.SDMX-ML.WebHome]] document containing the external object.
93 -| |(% style="width:262px" %)[[serviceURL>>doc:IMElements.serviceURL.WebHome]]|(% style="width:543px" %)The URL of an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-compliant web service from which the external object can be retrieved.
94 -| |(% style="width:262px" %)+[[maintainer>>doc:IMElements.maintainer.WebHome]]|(% style="width:543px" %)Association to the [[Maintenance Agency>>doc:Glossary.Maintenance agency.WebHome]] responsible for maintaining the [[artefact>>doc:Glossary.Artefact.WebHome]].
92 +| |(% style="width:262px" %)[[structureURL>>doc:IMElements.structureURL.WebHome]]|(% style="width:543px" %)The URL of an [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] document containing the external object.
93 +| |(% style="width:262px" %)[[serviceURL>>doc:IMElements.serviceURL.WebHome]]|(% style="width:543px" %)The URL of an [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]]-compliant web service from which the external object can be retrieved.
94 +| |(% style="width:262px" %)+[[maintainer>>doc:IMElements.maintainer.WebHome]]|(% style="width:543px" %)Association to the [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]] responsible for maintaining the [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]].
95 95  |[[Agency>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.Agency.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)See section on “Organisations”
96 96  
97 97  == 3.3 Basic Inheritance ==
© Semantic R&D Group, 2026