Changes for page 3 SDMX Base Package

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

From 1.2 to 1.1 From 2.4 to 2.3

From version 2.3

edited by Helena
on 2025/06/08 00:51

Change comment: There is no comment for this version

To version 1.2

edited by Helena
on 2025/06/07 00:42

Change comment: Update document after refactoring.

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- SUZ.Methodology.Code.MethodologyClass[0]

Details

Page properties

Content

@@ -1,7 +5,3 @@
--{{box title="**Contents**"}}
--{{toc/}}
--{{/box}}
--
  == 3.1 Introduction ==
  The constructs in the SDMX Base package comprise the fundamental building blocks that support many of the other structures in the model. For this reason, many of the classes in this package are abstract (i.e., only derived sub-classes can exist in an implementation).
@@ -12,17 +12,17 @@
  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.
--== 3.2 Base Structures - Identification, Versioning, and Maintenance ==
++=== 3.2 Base Structures - Identification, Versioning, and Maintenance ===
--=== 3.2.1 Class Diagram ===
++==== 3.2.1 Class Diagram ====
  [[image:1749246130522-547.jpeg]]
  **Figure 10: SDMX Identification, Maintenance and Versioning**
--=== 3.2.2 Explanation of the Diagram ===
++===== 3.2.2 Explanation of the Diagram =====
--==== 3.2.2.1 Narrative ====
++====== 3.2.2.1 Narrative ======
  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.
@@ -38,79 +38,91 @@
  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:973.835px" %)
--|**Class**|(% style="width:262px" %)**Feature**|(% style="width:543px" %)**Description**
--|//AnnotableArtefact//|(% style="width:262px" %)(((
++|**Class**|**Feature**|**Description**
++|//AnnotableArtefact//|(((
  Base inheritance sub classes are:
++
  //IdentifiableArtefact//
--)))|(% style="width:543px" %)Objects of classes derived from this can have attached annotations.
--|Annotation|(% style="width:262px" %)// //|(% style="width:543px" %)Additional descriptive information attached to an object.
--| |(% 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.
--| |(% style="width:262px" %)title|(% style="width:543px" %)A title used to identify an annotation.
--| |(% style="width:262px" %)type|(% style="width:543px" %)Specifies how the annotation is to be processed.
--| |(% style="width:262px" %)url|(% style="width:543px" %)A link to external descriptive text.
--| |(% style="width:262px" %)value|(% style="width:543px" %)A non-localised version of the Annotation content.
--| |(% style="width:262px" %)+url|(% style="width:543px" %)An International URI provides a set of links that are language specific, via this role.
--| |(% style="width:262px" %)+text|(% style="width:543px" %)An International String provides the multilingual text content of the annotation via this role.
--|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.
--|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.).
--|//IdentifiableArtefact//|(% style="width:262px" %)(((
--Superclass is //AnnotableArtefact//
++)))|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//
++
  Base inheritance sub classes are:
++
  //NameableArtefact//
--)))|(% style="width:543px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
--| |(% style="width:262px" %)id|(% style="width:543px" %)The unique identifier of the object.
--| |(% style="width:262px" %)uri|(% style="width:543px" %)Universal resource identifier that may or may not be resolvable.
--| |(% style="width:262px" %)urn|(% style="width:543px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
--|//NameableArtefact//|(% style="width:262px" %)(((
--Superclass is //IdentifiableArtefact// Base inheritance sub classes are:
++)))|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:543px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.
--| |(% style="width:262px" %)+description|(% style="width:543px" %)A multi-lingual description is provided by this role via the International String class.
--| |(% style="width:262px" %)+name|(% style="width:543px" %)A multi-lingual name is provided by this role via the International String class
--|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.
--|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.).
--| |(% style="width:262px" %)label|(% style="width:543px" %)Label of the string.
--| |(% style="width:262px" %)locale|(% style="width:543px" %)The geographic locale of the string e.g French, Canadian French.
--|//VersionableArtefact//|(% style="width:262px" %)(((
++)))|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:543px" %)Provides versioning information for all derived objects.
--| |(% style="width:262px" %)version|(% style="width:543px" %)A version string following SDMX versioning rules.
--| |(% style="width:262px" %)validFrom|(% style="width:543px" %)Date from which the version is valid
--| |(% style="width:262px" %)validTo|(% style="width:543px" %)Date from which version is superseded
--|//MaintainableArtefact//|(% style="width:262px" %)(((
++)))|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:543px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
--| |(% style="width:262px" %)isExternalReference|(% style="width:543px" %)If set to “true” it indicates that the content of the object is held externally.
--| |(% style="width:262px" %)structureURL|(% style="width:543px" %)The URL of an SDMX-ML document containing the external object.
--| |(% style="width:262px" %)serviceURL|(% style="width:543px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved.
--| |(% style="width:262px" %)+maintainer|(% style="width:543px" %)Association to the Maintenance Agency responsible for maintaining the artefact.
--|Agency|(% style="width:262px" %) |(% style="width:543px" %)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 ==
--=== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes ===
++==== //3.3 Basic Inheritance// ====
++
++===== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes =====
++
  [[image:1749246130530-261.jpeg]]
  **Figure 11: Basic Inheritance from the Base Structures**
--=== 3.3.2 Explanation of the Diagram ===
++===== 3.3.2 Explanation of the Diagram =====
--==== 3.3.2.1 Narrative ====
++====== 3.3.2.1 Narrative ======
  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.
--== 3.4 Data Types ==
++=== 3.4 Data Types ===
--=== 3.4.1 Class Diagram ===
++==== 3.4.1 Class Diagram ====
  [[image:1749246130536-128.jpeg]]
@@ -237,7 +237,7 @@
  The Structure Pattern is a basic architectural pattern which allows the specification of complex tabular structures which are often found in statistical data (such as Data Structure Definition, and Metadata Structure Definition). A Structure is a set of ordered lists. A pattern to underpin this tabular structure has been developed, so that commonalities between these structure definitions can be supported by common software and common syntax structures.
--===== 3.6.2 Class Diagrams [[image:1749246130548-601.jpeg]] =====
++===== 3.6.2 Class Diagrams [[image:1749246130548-601.jpeg]]  =====
  **Figure 14: The Structure Pattern**
@@ -377,7 +377,7 @@
  |URI|xsd:anyURI|string:uri|System.Uri|Java.net.URI or java.lang.String
  |DateTime|xsd:dateTime|string:datetime|System.DateTime|javax.xml.datatype.XML GregorianCalendar
  |Time|xsd:time|string:time|System.DateTime|javax.xml.datatype.XML GregorianCalendar
--|GregorianYear|xsd:gYear|string[[(% class="wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar
++|GregorianYear|xsd:gYear|string[[^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar
  |GregorianMonth|xsd:gYearMonth|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
  |GregorianDay|xsd:date|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
  |Day, MonthDay, Month|xsd:g*|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar

SUZ.Methodology.Code.MethodologyClass[0]

index

...	...	@@ -1,1 +1,0 @@
1		-4