Changes for page 3 SDMX Base Package
Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -26,10 +26,8 @@ 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 29 -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 29 +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). 30 30 31 -InternationalString). 32 - 33 33 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. 34 34 35 35 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. ... ... @@ -40,70 +40,62 @@ 40 40 41 41 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. 42 42 43 - **3.2.2.2 Definitions**41 +==== 3.2.2.2 Definitions ==== 44 44 45 -|**Class**|**Feature**|**Description** 46 -|//AnnotableArtefact//|((( 43 +(% style="width:902.294px" %) 44 +|**Class**|(% style="width:246px" %)**Feature**|(% style="width:480px" %)**Description** 45 +|//AnnotableArtefact//|(% style="width:246px" %)((( 47 47 Base inheritance sub classes are: 48 - 49 49 //IdentifiableArtefact// 50 -)))|Objects of classes derived from this can have attached annotations. 51 -|Annotation| |Additional descriptive information attached to an object. 52 -| |id|((( 48 +)))|(% style="width:480px" %)Objects of classes derived from this can have attached annotations. 49 +|Annotation|(% style="width:246px" %) |(% style="width:480px" %)Additional descriptive information attached to an object. 50 +| |(% style="width:246px" %)id|(% style="width:480px" %)((( 53 53 Identifier for the Annotation. 54 - 55 55 It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object. 56 56 ))) 57 -| |title // //|A title used to identify an annotation.58 -| |type|Specifies how the annotation is to be processed. 59 -| |url|A link to external descriptive text. 60 -| |+text|An International String provides the multilingual text content of the annotation via this role. 61 -|//IdentifiableArtefact//|((( 54 +| |(% style="width:246px" %)title|(% style="width:480px" %)A title used to identify an annotation. 55 +| |(% style="width:246px" %)type|(% style="width:480px" %)Specifies how the annotation is to be processed. 56 +| |(% style="width:246px" %)url|(% style="width:480px" %)A link to external descriptive text. 57 +| |(% style="width:246px" %)+text|(% style="width:480px" %)An International String provides the multilingual text content of the annotation via this role. 58 +|//IdentifiableArtefact//|(% style="width:246px" %)((( 62 62 Superclass is 63 - 64 64 //AnnotableArtefact// 65 - 66 -Base inheritance sub classes are~:// // 67 - 61 +Base inheritance sub classes are: 68 68 //NameableArtefact// 69 -)))|Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact. 70 -| |id|The unique identifier of the object. 71 -| |uri|Universal resource identifier that may or may not be resolvable. 72 -| |urn|Universal resource name – this is for use in registries: all registered objects have a urn. 73 -|//NameableArtefact//|((( 63 +)))|(% style="width:480px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact. 64 +| |(% style="width:246px" %)id|(% style="width:480px" %)The unique identifier of the object. 65 +| |(% style="width:246px" %)uri|(% style="width:480px" %)Universal resource identifier that may or may not be resolvable. 66 +| |(% style="width:246px" %)urn|(% style="width:480px" %)Universal resource name – this is for use in registries: all registered objects have a urn. 67 +|//NameableArtefact//|(% style="width:246px" %)((( 74 74 Superclass is 75 - 76 76 //IdentifiableArtefact// Base inheritance sub classes are: 77 - 78 78 //VersionableArtefact// 79 -)))|Provides a Name and Description to all derived classes in addition to identification and annotations. 80 -| |+description|A multi-lingual description is provided by this role via the International String class. 81 -| |+name|A multi-lingual name is provided by this role via the International String class 82 -|InternationalString| |The International String is a collection of Localised Strings and supports the representation of text in multiple locales. 83 -|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.). 84 -| |label|Label of the string. 85 -| |locale|The geographic locale of the string e.g French, Canadian French. 86 -|//VersionableArtefact//|((( 71 +)))|(% style="width:480px" %)Provides a Name and Description to all derived classes in addition to identification and annotations. 72 +| |(% style="width:246px" %)+description|(% style="width:480px" %)A multi-lingual description is provided by this role via the International String class. 73 +| |(% style="width:246px" %)+name|(% style="width:480px" %)A multi-lingual name is provided by this role via the International String class 74 +|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. 75 +|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.). 76 +| |(% style="width:246px" %)label|(% style="width:480px" %)Label of the string. 77 +| |(% style="width:246px" %)locale|(% style="width:480px" %)The geographic locale of the string e.g French, Canadian French. 78 +|//VersionableArtefact//|(% style="width:246px" %)((( 87 87 Superclass is 88 - 89 89 //NameableArtefact// Base inheritance sub classes are: 90 - 91 91 //MaintainableArtefact// 92 -)))|Provides versioning information for all derived objects. 93 -| |version|A version string following an agreed convention 94 -| |validFrom|Date from which the version is valid 95 -| |validTo|Date from which version is superceded 96 -|//MaintainableArtefact//|((( 82 +)))|(% style="width:480px" %)Provides versioning information for all derived objects. 83 +| |(% style="width:246px" %)version|(% style="width:480px" %)A version string following an agreed convention 84 +| |(% style="width:246px" %)validFrom|(% style="width:480px" %)Date from which the version is valid 85 +| |(% style="width:246px" %)validTo|(% style="width:480px" %)Date from which version is superceded 86 +|//MaintainableArtefact//|(% style="width:246px" %)((( 97 97 Inherits from 98 98 99 99 //VersionableArtefact// 100 -)))|An abstract class to group together primary structural metadata artefacts that are maintained by an Agency. 101 -| |final|Defines whether a maintained artefact is draft or final. 102 -| |isExternalReference|If set to “true” it indicates that the content of the object is held externally. 103 -| |structureURL|The URL of an SDMX-ML document containing the external object. 104 -| |serviceURL|The URL of an SDMX-compliant web service from which the external object can be retrieved. 105 -| |+maintainer // //|Association to the Maintenance Agency responsible for maintaining the artefact.106 -|Agency| |See section on “Organisations” 90 +)))|(% style="width:480px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency. 91 +| |(% style="width:246px" %)final|(% style="width:480px" %)Defines whether a maintained artefact is draft or final. 92 +| |(% style="width:246px" %)isExternalReference|(% style="width:480px" %)If set to “true” it indicates that the content of the object is held externally. 93 +| |(% style="width:246px" %)structureURL|(% style="width:480px" %)The URL of an SDMX-ML document containing the external object. 94 +| |(% style="width:246px" %)serviceURL|(% style="width:480px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved. 95 +| |(% style="width:246px" %)+maintainer|(% style="width:480px" %)Association to the Maintenance Agency responsible for maintaining the artefact. 96 +|Agency|(% style="width:246px" %) |(% style="width:480px" %)See section on “Organisations” 107 107 108 108 == {{id name="_Toc370972"/}}3.3 Basic Inheritance == 109 109 ... ... @@ -169,7 +169,8 @@ 169 169 170 170 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_a2879920.jpg||height="602" width="614"]] 171 171 172 -====== Figure 12 The Item Scheme Pattern ====== 162 +(% class="wikigeneratedid" id="HFigure12TheItemSchemePattern" %) 163 +**Figure 12 The Item Scheme Pattern** 173 173 174 174 ===== {{id name="_Toc370981"/}}3.5.3 Explanation of the Diagram ===== 175 175