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
-
... ... @@ -12,17 +12,17 @@ 12 12 13 13 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. 14 14 15 -== =3.2 Base Structures - Identification, Versioning, and Maintenance ===15 +== 3.2 Base Structures - Identification, Versioning, and Maintenance == 16 16 17 -=== =3.2.1 Class Diagram ====17 +=== 3.2.1 Class Diagram === 18 18 19 19 [[image:1749246130522-547.jpeg]] 20 20 21 21 **Figure 10: SDMX Identification, Maintenance and Versioning** 22 22 23 -=== ==3.2.2 Explanation of the Diagram =====23 +=== 3.2.2 Explanation of the Diagram === 24 24 25 -==== ==3.2.2.1 Narrative ======25 +==== 3.2.2.1 Narrative ==== 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 ... ... @@ -38,99 +38,87 @@ 38 38 39 39 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. 40 40 41 -==== ==3.2.2.2 Definitions ======41 +==== 3.2.2.2 Definitions ==== 42 42 43 -|**Class**|**Feature**|**Description** 44 -|//AnnotableArtefact//|((( 43 +(% style="width:973.835px" %) 44 +|**Class**|(% style="width:262px" %)**Feature**|(% style="width:543px" %)**Description** 45 +|//AnnotableArtefact//|(% style="width:262px" %)((( 45 45 Base inheritance sub classes are: 46 - 47 47 //IdentifiableArtefact// 48 -)))|Objects of classes derived from this can have attached annotations. 49 -|Annotation|// //|Additional descriptive information attached to an object. 50 -| |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. 51 -| |title|A title used to identify an annotation. 52 -| |type|Specifies how the annotation is to be processed. 53 -| |url|A link to external descriptive text. 54 -| |value|A non-localised version of the Annotation content. 55 -| |+url|An International URI provides a set of links that are language specific, via this role. 56 -| |+text|An International String provides the multilingual text content of the annotation via this role. 57 -|InternationalUri| |The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales. 58 -|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.). 59 -|//IdentifiableArtefact//|((( 60 -Superclass is 61 - 62 -//AnnotableArtefact// 63 - 48 +)))|(% style="width:543px" %)Objects of classes derived from this can have attached annotations. 49 +|Annotation|(% style="width:262px" %)// //|(% style="width:543px" %)Additional descriptive information attached to an object. 50 +| |(% 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. 51 +| |(% style="width:262px" %)title|(% style="width:543px" %)A title used to identify an annotation. 52 +| |(% style="width:262px" %)type|(% style="width:543px" %)Specifies how the annotation is to be processed. 53 +| |(% style="width:262px" %)url|(% 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|(% 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. 57 +|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. 58 +|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.). 59 +|//IdentifiableArtefact//|(% style="width:262px" %)((( 60 +Superclass is //AnnotableArtefact// 64 64 Base inheritance sub classes are: 65 - 66 66 //NameableArtefact// 67 -)))|Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact. 68 -| |id|The unique identifier of the object. 69 -| |uri|Universal resource identifier that may or may not be resolvable. 70 -| |urn|Universal resource name – this is for use in registries: all registered objects have a urn. 71 -|//NameableArtefact//|((( 72 -Superclass is 73 - 74 -//IdentifiableArtefact// Base inheritance sub classes are: 75 - 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. 64 +| |(% style="width:262px" %)id|(% style="width:543px" %)The unique identifier of the object. 65 +| |(% style="width:262px" %)uri|(% style="width:543px" %)Universal resource identifier that may or may not be resolvable. 66 +| |(% style="width:262px" %)urn|(% style="width:543px" %)Universal resource name – this is for use in registries: all registered objects have a urn. 67 +|//NameableArtefact//|(% style="width:262px" %)((( 68 +Superclass is //IdentifiableArtefact// Base inheritance sub classes are: 76 76 //VersionableArtefact// 77 -)))|Provides a Name and Description to all derived classes in addition to identification and annotations. 78 -| |+description|A multi-lingual description is provided by this role via the International String class. 79 -| |+name|A multi-lingual name is provided by this role via the International String class 80 -|InternationalString| |The International String is a collection of Localised Strings and supports the representation of text in multiple locales. 81 -|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.). 82 -| |label|Label of the string. 83 -| |locale|The geographic locale of the string e.g French, Canadian French. 84 -|//VersionableArtefact//|((( 70 +)))|(% style="width:543px" %)Provides a Name and Description to all derived classes in addition to identification and annotations. 71 +| |(% style="width:262px" %)+description|(% style="width:543px" %)A multi-lingual description is provided by this role via the International String class. 72 +| |(% style="width:262px" %)+name|(% style="width:543px" %)A multi-lingual name is provided by this role via the International String class 73 +|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. 74 +|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.). 75 +| |(% style="width:262px" %)label|(% style="width:543px" %)Label of the string. 76 +| |(% style="width:262px" %)locale|(% style="width:543px" %)The geographic locale of the string e.g French, Canadian French. 77 +|//VersionableArtefact//|(% style="width:262px" %)((( 85 85 Superclass is 86 - 87 87 //NameableArtefact// 88 - 89 89 Base inheritance sub classes are: 90 - 91 91 //MaintainableArtefact// 92 -)))|Provides versioning information for all derived objects. 93 -| |version|A version string following SDMX versioning rules. 94 -| |validFrom|Date from which the version is valid 95 -| |validTo|Date from which version is superseded 96 -|//MaintainableArtefact//|((( 82 +)))|(% style="width:543px" %)Provides versioning information for all derived objects. 83 +| |(% style="width:262px" %)version|(% style="width:543px" %)A version string following SDMX versioning rules. 84 +| |(% style="width:262px" %)validFrom|(% style="width:543px" %)Date from which the version is valid 85 +| |(% style="width:262px" %)validTo|(% style="width:543px" %)Date from which version is superseded 86 +|//MaintainableArtefact//|(% style="width:262px" %)((( 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 -| |isExternalReference|If set to “true” it indicates that the content of the object is held externally. 102 -| |structureURL|The URL of an SDMX-ML document containing the external object. 103 -| |serviceURL|The URL of an SDMX-compliant web service from which the external object can be retrieved. 104 -| |+maintainer|Association to the Maintenance Agency responsible for maintaining the artefact. 105 -|Agency| |See section on “Organisations” 90 +)))|(% style="width:543px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency. 91 +| |(% style="width:262px" %)isExternalReference|(% 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 document containing the external object. 93 +| |(% style="width:262px" %)serviceURL|(% style="width:543px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved. 94 +| |(% style="width:262px" %)+maintainer|(% style="width:543px" %)Association to the Maintenance Agency responsible for maintaining the artefact. 95 +|Agency|(% style="width:262px" %) |(% style="width:543px" %)See section on “Organisations” 106 106 97 +== 3.3 Basic Inheritance == 107 107 99 +=== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes === 108 108 109 -==== //3.3 Basic Inheritance// ==== 110 - 111 -===== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes ===== 112 - 113 113 [[image:1749246130530-261.jpeg]] 114 114 115 115 **Figure 11: Basic Inheritance from the Base Structures** 116 116 117 -=== ==3.3.2 Explanation of the Diagram =====105 +=== 3.3.2 Explanation of the Diagram === 118 118 119 -==== ==3.3.2.1 Narrative ======107 +==== 3.3.2.1 Narrative ==== 120 120 121 121 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. 122 122 123 -== =3.4 Data Types ===111 +== 3.4 Data Types == 124 124 125 -=== =3.4.1 Class Diagram ====113 +=== 3.4.1 Class Diagram === 126 126 127 127 [[image:1749246130536-128.jpeg]] 128 128 129 129 **Figure 12: Class Diagram of Basic Data Types** 130 130 131 -=== ==3.4.2 Explanation of the Diagram =====119 +=== 3.4.2 Explanation of the Diagram === 132 132 133 -==== ==3.4.2.1 Narrative ======121 +==== 3.4.2.1 Narrative ==== 134 134 135 135 The FacetType and FacetValueType enumerations are used to specify the valid format of the content of a non-enumerated Concept or the usage of a Concept when specified for use on a //Component// on a //Structure// (such as a Dimension in a DataStructureDefinition). The description of the various types can be found in the chapter on ConceptScheme (section 4.5). 136 136 ... ... @@ -151,23 +151,23 @@ 151 151 152 152 The VersionType data types provides the details for versioning according to SDMX versioning rules, as explained in SDMX Standards Section 6, paragraph “4.3 Versioning”. 153 153 154 -== ==//3.5 The Item Scheme Pattern//====142 +== 3.5 The Item Scheme Pattern == 155 155 156 -=== ==3.5.1 Context =====144 +=== 3.5.1 Context === 157 157 158 158 The Item Scheme is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example. 159 159 160 160 The //ItemScheme// is the basis for CategoryScheme, Codelist, ConceptScheme, ReportingTaxonomy, //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme. 161 161 162 -=== ==3.5.2 Class Diagram =====150 +=== 3.5.2 Class Diagram === 163 163 164 164 [[image:1749246130543-644.jpeg]] 165 165 166 166 **Figure 13 The Item Scheme pattern** 167 167 168 -=== ==3.5.3 Explanation of the Diagram =====156 +=== 3.5.3 Explanation of the Diagram === 169 169 170 -==== ==3.5.3.1 Narrative ======158 +==== 3.5.3.1 Narrative ==== 171 171 172 172 The //ItemScheme// is an abstract class which defines a set of //Item// (this class is also abstract). Its main purpose is to define a mechanism which can be used to create taxonomies which can classify other parts of the SDMX Information Model. It is derived from //MaintainableArtefact// which gives it the ability to be annotated, have identity, naming, versioning and be associated with an Agency. An example of a concrete class is a ConceptScheme. The associated Concepts are //Item//s. 173 173 ... ... @@ -181,37 +181,28 @@ 181 181 182 182 The //Item// can be hierarchic and so one //Item// can have child //Item//s. The restriction of the hierarchic association is that a child //Item// can have only parent //Item//. 183 183 184 -==== ==3.5.3.2 Definitions ======172 +==== 3.5.3.2 Definitions ==== 185 185 186 -|**Class**|**Feature**|**Description** 187 -|//ItemScheme//|((( 174 +(% style="width:989.835px" %) 175 +|**Class**|(% style="width:297px" %)**Feature**|(% style="width:583px" %)**Description** 176 +|//ItemScheme//|(% style="width:297px" %)((( 188 188 Inherits from: 189 - 190 190 //MaintainableArtefact// 191 - 192 192 Direct sub classes are: 193 - 194 194 CategoryScheme 195 - 196 196 ConceptScheme 197 - 198 198 Codelist 199 - 200 200 ReportingTaxonomy 201 - 202 202 //OrganisationScheme// 203 - 204 204 TransformationScheme 205 - 206 206 CustomTypeScheme NamePersonalisationSc heme 207 - 208 208 RulesetScheme 209 - 210 - VtlMappingSchemeUserDefinedOperatorSc heme211 -)))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common. 212 -| |isPartial|Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme. 213 -| |/items|Association to the Items in the scheme. 214 -|//Item//|((( 188 +VtlMappingScheme 189 +UserDefinedOperatorSc heme 190 +)))|(% style="width:583px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common. 191 +| |(% style="width:297px" %)isPartial|(% style="width:583px" %)Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme. 192 +| |(% style="width:297px" %)/items|(% style="width:583px" %)Association to the Items in the scheme. 193 +|//Item//|(% style="width:297px" %)((( 215 215 Inherits from: 216 216 217 217 //NameableArtefact// ... ... @@ -237,15 +237,14 @@ 237 237 VtlMapping 238 238 239 239 UserDefinedOperator// //hierarchy 240 -)))|((( 219 +)))|(% style="width:583px" %)((( 241 241 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. Node that at the conceptual level the Organisation is not hierarchic. 242 - 243 243 This allows an Item optionally to have one or more child Items 244 244 ))) 245 245 246 -== ==//3.6 The Structure Pattern//====224 +== 3.6 The Structure Pattern == 247 247 248 -=== ==3.6.1 Context =====226 +=== 3.6.1 Context === 249 249 250 250 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. 251 251 ... ... @@ -389,7 +389,7 @@ 389 389 |URI|xsd:anyURI|string:uri|System.Uri|Java.net.URI or java.lang.String 390 390 |DateTime|xsd:dateTime|string:datetime|System.DateTime|javax.xml.datatype.XML GregorianCalendar 391 391 |Time|xsd:time|string:time|System.DateTime|javax.xml.datatype.XML GregorianCalendar 392 -|GregorianYear|xsd:gYear|string[[(% class="wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar 370 +|GregorianYear|xsd:gYear|string[[(% class="wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar 393 393 |GregorianMonth|xsd:gYearMonth|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar 394 394 |GregorianDay|xsd:date|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar 395 395 |Day, MonthDay, Month|xsd:g*|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar