Changes for page 3 SDMX Base Package

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

From 6.2 to 6.1 From 6.7 to 6.6

From version 6.6

edited by Helena
on 2025/05/20 00:25

Change comment: There is no comment for this version

To version 6.2

edited by Helena
on 2025/05/20 00: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

@@ -26,8 +26,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.
@@ -38,62 +38,70 @@
  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.
--==== 3.2.2.2 Definitions ====
++**3.2.2.2 Definitions**
--(% style="width:902.294px" %)
--|**Class**|(% style="width:246px" %)**Feature**|(% style="width:480px" %)**Description**
--|//AnnotableArtefact//|(% style="width:246px" %)(((
++|**Class**|**Feature**|**Description**
++|//AnnotableArtefact//|(((
  Base inheritance sub classes are:
++
  //IdentifiableArtefact//
--)))|(% style="width:480px" %)Objects of classes derived from this can have attached annotations.
--|Annotation|(% style="width:246px" %) |(% style="width:480px" %)Additional descriptive information attached to an object.
--| |(% style="width:246px" %)id|(% style="width:480px" %)(((
++)))|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.
  )))
--| |(% style="width:246px" %)title|(% style="width:480px" %)A title used to identify an annotation.
--| |(% style="width:246px" %)type|(% style="width:480px" %)Specifies how the annotation is to be processed.
--| |(% style="width:246px" %)url|(% style="width:480px" %)A link to external descriptive text.
--| |(% style="width:246px" %)+text|(% style="width:480px" %)An International String provides the multilingual text content of the annotation via this role.
--|//IdentifiableArtefact//|(% style="width:246px" %)(((
++| |title// &nbsp;&nbsp;&nbsp;//|A title used to identify an annotation.
++| |type|Specifies how the annotation is to be processed.
++| |url|A link to external descriptive text.
++| |+text|An International String provides the multilingual text content of the annotation via this role.
++|//IdentifiableArtefact//|(((
  Superclass is
++
  //AnnotableArtefact//
--Base inheritance sub classes are:
++
++Base inheritance sub classes are~:// &nbsp;&nbsp;&nbsp;//
++
  //NameableArtefact//
--)))|(% style="width:480px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
--| |(% style="width:246px" %)id|(% style="width:480px" %)The unique identifier of the object.
--| |(% style="width:246px" %)uri|(% style="width:480px" %)Universal resource identifier that may or may not be resolvable.
--| |(% style="width:246px" %)urn|(% style="width:480px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
--|//NameableArtefact//|(% style="width:246px" %)(((
++)))|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:480px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.
--| |(% style="width:246px" %)+description|(% style="width:480px" %)A multi-lingual description is provided by this role via the International String class.
--| |(% style="width:246px" %)+name|(% style="width:480px" %)A multi-lingual name is provided by this role via the International String class
--|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.
--|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.).
--| |(% style="width:246px" %)label|(% style="width:480px" %)Label of the string.
--| |(% style="width:246px" %)locale|(% style="width:480px" %)The geographic locale of the string e.g French, Canadian French.
--|//VersionableArtefact//|(% style="width:246px" %)(((
++)))|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.
++| |+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// Base inheritance sub classes are:
++
  //MaintainableArtefact//
--)))|(% style="width:480px" %)Provides versioning information for all derived objects.
--| |(% style="width:246px" %)version|(% style="width:480px" %)A version string following an agreed convention
--| |(% style="width:246px" %)validFrom|(% style="width:480px" %)Date from which the version is valid
--| |(% style="width:246px" %)validTo|(% style="width:480px" %)Date from which version is superceded
--|//MaintainableArtefact//|(% style="width:246px" %)(((
++)))|Provides versioning information for all derived objects.
++| |version|A version string following an agreed convention
++| |validFrom|Date from which the version is valid
++| |validTo|Date from which version is superceded
++|//MaintainableArtefact//|(((
  Inherits from
  //VersionableArtefact//
--)))|(% style="width:480px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
--| |(% style="width:246px" %)final|(% style="width:480px" %)Defines whether a maintained artefact is draft or final.
--| |(% style="width:246px" %)isExternalReference|(% style="width:480px" %)If set to “true” it indicates that the content of the object is held externally.
--| |(% style="width:246px" %)structureURL|(% style="width:480px" %)The URL of an SDMX-ML document containing the external object.
--| |(% style="width:246px" %)serviceURL|(% style="width:480px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved.
--| |(% style="width:246px" %)+maintainer|(% style="width:480px" %)Association to the Maintenance Agency responsible for maintaining the artefact.
--|Agency|(% style="width:246px" %) |(% style="width:480px" %)See section on “Organisations”
++)))|An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
++| |final|Defines whether a maintained artefact is draft or final.
++| |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// &nbsp;&nbsp;&nbsp;//|Association to the Maintenance Agency responsible for maintaining the artefact.
++|Agency| |See section on “Organisations”
  == {{id name="_Toc370972"/}}3.3 Basic Inheritance ==
@@ -159,8 +159,7 @@
  [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_a2879920.jpg||height="602" width="614"]]
--(% class="wikigeneratedid" id="HFigure12TheItemSchemePattern" %)
--**Figure 12 The Item Scheme Pattern**
++====== Figure 12 The Item Scheme Pattern ======
  ===== {{id name="_Toc370981"/}}3.5.3 Explanation of the Diagram =====
@@ -186,47 +186,73 @@
  ==== 3.5.3.2 Definitions ====
--(% style="width:911.294px" %)
--|**Class**|(% style="width:246px" %)**Feature**|(% style="width:478px" %)**Description**
--|//ItemScheme//|(% style="width:246px" %)(((
++|**Class**|**Feature**|**Description**
++|//ItemScheme//|(((
  Inherits from:
++
  //MaintainableArtefact//
++
  Direct sub classes are:
++
  CategoryScheme
++
  ConceptScheme
++
  Codelist
--)))|(% style="width:478px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
--| |(% style="width:246px" %)(((
++)))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
++| |(((
  ReportingTaxonomy
++
  //OrganisationScheme//
++
  Transformation Scheme
++
  CustomTypeScheme
++
  NamePersonasationScheme
++
  RuletScheme
++
  VtlMappingScheme
++
  UserDefinedOperatorScheme
--)))|(% style="width:478px" %)
--| |(% style="width:246px" %)isPartial|(% style="width:478px" %)Denotes whether the Item Scheme contains a sub set of the full set of Items in the maintained scheme.
--| |(% style="width:246px" %)items|(% style="width:478px" %)Association to the Items in the scheme.
--|//Item//|(% style="width:246px" %)(((
++)))|
++| |isPartial|Denotes whether the Item Scheme contains a sub set of the full set of Items in the maintained scheme.
++| |items|Association to the Items in the scheme.
++|//Item//|(((
  Inherits from:
++
  //NameableArtefact//
--Direct sub classes are Category
++
++Direct sub classes are
++
++Category
++
  Concept
++
  Code
++
  ReportingCategory
++
  //Organisation//
++
  Transformation
++
  CustomType
++
  NamePersonlisation
++
  Ruleset
++
  VtlMapping
--UserDefinedOperator
--)))|(% style="width:478px" %)(((
++
++UserDefinedOperator// &nbsp;&nbsp;&nbsp;//
++)))|(((
  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.
++
  Note that at the conceptual level the Organisation is not hierarchic
  )))
--| |(% style="width:246px" %)hierarchy|(% style="width:478px" %)This allows an Item optionally to have one or more child Items.
++| |hierarchy|This allows an Item optionally to have one or more child Items.
  == {{id name="_Toc370982"/}}3.6 The Structure Pattern ==
@@ -242,8 +242,7 @@
  [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_b6478a73.png||height="774" width="556"]]
--(% class="wikigeneratedid" id="HFigure14:RepresentationwithintheStructurePattern" %)
--**Figure 14: Representation within the Structure Pattern**
++====== Figure 14: Representation within the Structure Pattern ======
  === {{id name="_Toc370985"/}}3.6.3 Explanation of the Diagrams ===
@@ -267,7 +267,7 @@
  __ReportStructure__: MetadataAttribute
--Each Component takes its semantic (and possibly also its representation) from a Concept in a ConceptScheme. This is represented by the conceptIdentity association to Concept.
++Each Component takes its semantic (and possibly also its representation) from a Concept in 773 a ConceptScheme. This is represented by the conceptIdentity association to Concept.
  The //Component// may also have a localRepresentation, This allows a concrete class, such as Dimension, to specify its representation which is local to the //Structure// in which it is contained (for Dimension this will be DataStructureDefinition), and thus overrides any coreRepresentation specified for the Concept.