Changes for page 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19

From 10.2 to 10.1 From 11.1 to 10.3

From version 10.3

edited by Helena
on 2025/05/15 10:23

Change comment: There is no comment for this version

To version 10.2

edited by Helena
on 2025/05/15 10:22

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -30,8 +30,10 @@
  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.
--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).
++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).
++
  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.
  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.
@@ -44,24 +44,23 @@
  ==== 3.2.2.2 Definitions ====
--(% style="width:914.039px" %)
--|**Class**|(% style="width:244px" %)**Feature**|(% style="width:514px" %)**Description**
--|//AnnotableArtefact//|(% style="width:244px" %)(((
++|**Class**|**Feature**|**Description**
++|//AnnotableArtefact//|(((
  Base inheritance sub classes are:
  //IdentifiableArtefact//
--)))|(% style="width:514px" %)Objects of classes derived from this can have attached annotations.
--|Annotation|(% style="width:244px" %) |(% style="width:514px" %)Additional descriptive information attached to an object.
--| |(% style="width:244px" %)id|(% style="width:514px" %)Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.
--| |(% style="width:244px" %)title|(% style="width:514px" %)A title used to identify an annotation.
--| |(% style="width:244px" %)type|(% style="width:514px" %)Specifies how the annotation is to be processed.
--| |(% style="width:244px" %)url|(% style="width:514px" %)A link to external descriptive text.
--| |(% style="width:244px" %)value|(% style="width:514px" %)A non-localised version of the Annotation content.
--| |(% style="width:244px" %)+url|(% style="width:514px" %)An International URI provides a set of links that are language specific, via this role.
--| |(% style="width:244px" %)+text|(% style="width:514px" %)An International String provides the multilingual text content of the annotation via this role.
--|InternationalUri|(% style="width:244px" %) |(% style="width:514px" %)The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales.
--|LocalisedUri|(% style="width:244px" %) |(% style="width:514px" %)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.).
--|//IdentifiableArtefact//|(% style="width:244px" %)(((
++)))|Objects of classes derived from this can have attached annotations.
++|Annotation| |Additional descriptive information attached to an object.
++| |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.
++| |title|A title used to identify an annotation.
++| |type|Specifies how the annotation is to be processed.
++| |url|A link to external descriptive text.
++| |value|A non-localised version of the Annotation content.
++| |+url|An International URI provides a set of links that are language specific, via this role.
++| |+text|An International String provides the multilingual text content of the annotation via this role.
++|InternationalUri| |The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales.
++|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.).
++|//IdentifiableArtefact//|(((
  Superclass is
  //AnnotableArtefact//
@@ -69,28 +69,28 @@
  Base inheritance sub classes are:
  //NameableArtefact//
--)))|(% style="width:514px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
--| |(% style="width:244px" %)id|(% style="width:514px" %)The unique identifier of the object.
--| |(% style="width:244px" %)uri|(% style="width:514px" %)Universal resource identifier that may or may not be resolvable.
--| |(% style="width:244px" %)urn|(% style="width:514px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
--|//NameableArtefact//|(% style="width:244px" %)(((
++)))|Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
++| |id|The unique identifier of the object.
++| |uri|Universal resource identifier that may or may not be resolvable.
++| |urn|Universal resource name – this is for use in registries: all registered objects have a urn.
++|//NameableArtefact//|(((
  Superclass is
  //IdentifiableArtefact// Base inheritance sub classes are:
  //VersionableArtefact//
--)))|(% style="width:514px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.
--| |(% style="width:244px" %)+description|(% style="width:514px" %)(((
++)))|Provides a Name and Description to all derived classes in addition to identification and annotations.
++| |+description|(((
  A multi-lingual description is provided by this role via the
  International String class.
  )))
--| |(% style="width:244px" %)+name|(% style="width:514px" %)A multi-lingual name is provided by this role via the International String class
--|InternationalString|(% style="width:244px" %) |(% style="width:514px" %)The International String is a collection of Localised Strings and supports the representation of text in multiple locales.
--|LocalisedString|(% style="width:244px" %) |(% style="width:514px" %)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.).
--| |(% style="width:244px" %)label|(% style="width:514px" %)Label of the string.
--| |(% style="width:244px" %)locale|(% style="width:514px" %)The geographic locale of the string e.g French, Canadian French.
--|//VersionableArtefact//|(% style="width:244px" %)(((
++| |+name|A multi-lingual name is provided by this role via the International String class
++|InternationalString| |The International String is a collection of Localised Strings and supports the representation of text in multiple locales.
++|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.).
++| |label|Label of the string.
++| |locale|The geographic locale of the string e.g French, Canadian French.
++|//VersionableArtefact//|(((
  Superclass is
  //NameableArtefact//
@@ -98,20 +98,20 @@
  Base inheritance sub classes are:
  //MaintainableArtefact//
--)))|(% style="width:514px" %)Provides versioning information for all derived objects.
--| |(% style="width:244px" %)version|(% style="width:514px" %)A version string following SDMX versioning rules.
--| |(% style="width:244px" %)validFrom|(% style="width:514px" %)Date from which the version is valid
--| |(% style="width:244px" %)validTo|(% style="width:514px" %)Date from which version is superseded
--|//MaintainableArtefact//|(% style="width:244px" %)(((
++)))|Provides versioning information for all derived objects.
++| |version|A version string following SDMX versioning rules.
++| |validFrom|Date from which the version is valid
++| |validTo|Date from which version is superseded
++|//MaintainableArtefact//|(((
  Inherits from
  //VersionableArtefact//
--)))|(% style="width:514px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
--| |(% style="width:244px" %)isExternalReference|(% style="width:514px" %)If set to “true” it indicates that the content of the object is held externally.
--| |(% style="width:244px" %)structureURL|(% style="width:514px" %)The URL of an SDMX-ML document containing the external object.
--| |(% style="width:244px" %)serviceURL|(% style="width:514px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved.
--| |(% style="width:244px" %)+maintainer|(% style="width:514px" %)Association to the Maintenance Agency responsible for maintaining the artefact.
--|Agency|(% style="width:244px" %) |(% style="width:514px" %)See section on “Organisations”
++)))|An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
++| |isExternalReference|If set to “true” it indicates that the content of the object is held externally.
++| |structureURL|The URL of an SDMX-ML document containing the external object.
++| |serviceURL|The URL of an SDMX-compliant web service from which the external object can be retrieved.
++| |+maintainer|Association to the Maintenance Agency responsible for maintaining the artefact.
++|Agency| |See section on “Organisations”
  == 3.3 Basic Inheritance ==
@@ -180,7 +180,7 @@
  In an exchange environment an //ItemScheme// is allowed to contain a sub-set of the //Item//s in the maintained //ItemScheme//. If such an ItemScheme is disseminated with a sub-set of the //Item//s then the fact that this is a sub-set is denoted by setting the isPartial attribute to "true".
--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//. Furthermore, the id of the //ItemScheme// where isPartial is set to "true" is the same as the id of the full //ItemScheme// (agencyId, 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//.
++A[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_99fcc5a.gif||alt="Shape28" height="36" width="31"]] “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//. Furthermore, the id of the //ItemScheme// where isPartial is set to "true" is the same as the id of the full //ItemScheme// (agencyId, 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//.
  The purpose of a partial //ItemScheme// is to support the exchange and dissemination of a subset //ItemScheme// without the need to maintain multiple //ItemScheme//s which contain the same //Item//s. For instance, when a Codelist is used in a DataStructureDefinition it is sometimes the case that only a sub-set of the Codes in a Codelist are relevant. In this case a partial Codelist can be constructed using the Constraint mechanism explained later in this document.