Skip to Content

Changes for page 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19
From version 7.1
edited by Helena
on 2025/05/15 09:59
Change comment: There is no comment for this version
To version 10.3
edited by Helena
on 2025/05/15 10:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,4 +1,6 @@
1 -= 3 SDMX Base Package =
1 +{{box title="**Contents**"}}
2 +{{toc/}}
3 +{{/box}}
2 2  
3 3  == 3.1 Introduction ==
4 4  
... ... @@ -28,10 +28,8 @@
28 28  
29 29  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.
30 30  
31 -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
33 +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).
32 32  
33 -InternationalString).
34 -
35 35  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.
36 36  
37 37  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,52 +44,53 @@
44 44  
45 45  ==== 3.2.2.2 Definitions ====
46 46  
47 -|**Class**|**Feature**|**Description**
48 -|//AnnotableArtefact//|(((
47 +(% style="width:914.039px" %)
48 +|**Class**|(% style="width:244px" %)**Feature**|(% style="width:514px" %)**Description**
49 +|//AnnotableArtefact//|(% style="width:244px" %)(((
49 49  Base inheritance sub classes are:
50 50  
51 51  //IdentifiableArtefact//
52 -)))|Objects of classes derived from this can have attached annotations.
53 -|Annotation||Additional descriptive information attached to an object.
54 -||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.
55 -||title//    //|A title used to identify an annotation.
56 -||type|Specifies how the annotation is to be processed.
57 -||url|A link to external descriptive text.
58 -||value|A non-localised version of the Annotation content.
59 -||+url|An International URI provides a set of links that are language specific, via this role.
60 -||+text|An International String provides the multilingual text content of the annotation via this role.
61 -|InternationalUri||The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales.
62 -|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.).
63 -|//IdentifiableArtefact//|(((
53 +)))|(% style="width:514px" %)Objects of classes derived from this can have attached annotations.
54 +|Annotation|(% style="width:244px" %) |(% style="width:514px" %)Additional descriptive information attached to an object.
55 +| |(% 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.
56 +| |(% style="width:244px" %)title|(% style="width:514px" %)A title used to identify an annotation.
57 +| |(% style="width:244px" %)type|(% style="width:514px" %)Specifies how the annotation is to be processed.
58 +| |(% style="width:244px" %)url|(% style="width:514px" %)A link to external descriptive text.
59 +| |(% style="width:244px" %)value|(% style="width:514px" %)A non-localised version of the Annotation content.
60 +| |(% style="width:244px" %)+url|(% style="width:514px" %)An International URI provides a set of links that are language specific, via this role.
61 +| |(% style="width:244px" %)+text|(% style="width:514px" %)An International String provides the multilingual text content of the annotation via this role.
62 +|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.
63 +|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.).
64 +|//IdentifiableArtefact//|(% style="width:244px" %)(((
64 64  Superclass is
65 65  
66 66  //AnnotableArtefact//
67 67  
68 -Base inheritance sub classes are~://    //
69 +Base inheritance sub classes are:
69 69  
70 70  //NameableArtefact//
71 -)))|Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
72 -||id|The unique identifier of the object.
73 -||uri|Universal resource identifier that may or may not be resolvable.
74 -||urn|Universal resource name – this is for use in registries: all registered objects have a urn.
75 -|//NameableArtefact//|(((
72 +)))|(% style="width:514px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
73 +| |(% style="width:244px" %)id|(% style="width:514px" %)The unique identifier of the object.
74 +| |(% style="width:244px" %)uri|(% style="width:514px" %)Universal resource identifier that may or may not be resolvable.
75 +| |(% style="width:244px" %)urn|(% style="width:514px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
76 +|//NameableArtefact//|(% style="width:244px" %)(((
76 76  Superclass is
77 77  
78 78  //IdentifiableArtefact// Base inheritance sub classes are:
79 79  
80 80  //VersionableArtefact//
81 -)))|Provides a Name and Description to all derived classes in addition to identification and annotations.
82 -||+description|(((
82 +)))|(% style="width:514px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.
83 +| |(% style="width:244px" %)+description|(% style="width:514px" %)(((
83 83  A multi-lingual description is provided by this role via the
84 84  
85 85  International String class.
86 86  )))
87 -||+name|A multi-lingual name is provided by this role via the International String class
88 -|InternationalString||The International String is a collection of Localised Strings and supports the representation of text in multiple locales.
89 -|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.).
90 -||label|Label of the string.
91 -||locale|The geographic locale of the string e.g French, Canadian French.
92 -|//VersionableArtefact//|(((
88 +| |(% style="width:244px" %)+name|(% style="width:514px" %)A multi-lingual name is provided by this role via the International String class
89 +|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.
90 +|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.).
91 +| |(% style="width:244px" %)label|(% style="width:514px" %)Label of the string.
92 +| |(% style="width:244px" %)locale|(% style="width:514px" %)The geographic locale of the string e.g French, Canadian French.
93 +|//VersionableArtefact//|(% style="width:244px" %)(((
93 93  Superclass is
94 94  
95 95  //NameableArtefact//
... ... @@ -97,20 +97,20 @@
97 97  Base inheritance sub classes are:
98 98  
99 99  //MaintainableArtefact//
100 -)))|Provides versioning information for all derived objects.
101 -||version|A version string following SDMX versioning rules.
102 -||validFrom|Date from which the version is valid
103 -||validTo|Date from which version is superseded
104 -|//MaintainableArtefact//|(((
101 +)))|(% style="width:514px" %)Provides versioning information for all derived objects.
102 +| |(% style="width:244px" %)version|(% style="width:514px" %)A version string following SDMX versioning rules.
103 +| |(% style="width:244px" %)validFrom|(% style="width:514px" %)Date from which the version is valid
104 +| |(% style="width:244px" %)validTo|(% style="width:514px" %)Date from which version is superseded
105 +|//MaintainableArtefact//|(% style="width:244px" %)(((
105 105  Inherits from
106 106  
107 107  //VersionableArtefact//
108 -)))|An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
109 -||isExternalReference|If set to “true” it indicates that the content of the object is held externally.
110 -||structureURL|The URL of an SDMX-ML document containing the external object.
111 -||serviceURL|The URL of an SDMX-compliant web service from which the external object can be retrieved.
112 -||+maintainer//    //|Association to the Maintenance Agency responsible for maintaining the artefact.
113 -|Agency||See section on “Organisations”
109 +)))|(% style="width:514px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
110 +| |(% style="width:244px" %)isExternalReference|(% style="width:514px" %)If set to “true” it indicates that the content of the object is held externally.
111 +| |(% style="width:244px" %)structureURL|(% style="width:514px" %)The URL of an SDMX-ML document containing the external object.
112 +| |(% style="width:244px" %)serviceURL|(% style="width:514px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved.
113 +| |(% style="width:244px" %)+maintainer|(% style="width:514px" %)Association to the Maintenance Agency responsible for maintaining the artefact.
114 +|Agency|(% style="width:244px" %) |(% style="width:514px" %)See section on “Organisations”
114 114  
115 115  == 3.3 Basic Inheritance ==
116 116  
... ... @@ -179,7 +179,7 @@
179 179  
180 180  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".
181 181  
182 -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//.
183 +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//.
183 183  
184 184  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.
185 185  
... ... @@ -215,8 +215,8 @@
215 215  
216 216  VtlMappingScheme UserDefinedOperatorSc heme
217 217  )))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
218 -||isPartial|Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme.
219 -||/items|Association to the Items in the scheme.
219 +| |isPartial|Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme.
220 +| |/items|Association to the Items in the scheme.
220 220  |//Item//|(((
221 221  Inherits from:
222 222  
... ... @@ -244,9 +244,9 @@
244 244  
245 245  VtlMapping
246 246  
247 -UserDefinedOperator//    //
248 +UserDefinedOperator
248 248  )))|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.
249 -||hierarchy|This allows an Item optionally to have one or more child Items.
250 +| |hierarchy|This allows an Item optionally to have one or more child Items.
250 250  
251 251  == 3.6 The Structure Pattern ==
252 252  
... ... @@ -312,7 +312,7 @@
312 312  
313 313  Metadataflow
314 314  )))|An artefact whose components are described by a Structure. In concrete terms (sub-classes) an example would be a Dataflow which is linked to a given structure – in this case the Data Structure Definition.
315 -||structure|An association to a Structure specifying the structure of the artefact.
316 +| |structure|An association to a Structure specifying the structure of the artefact.
316 316  |Structure|(((
317 317  Inherits from:
318 318  
... ... @@ -322,7 +322,7 @@
322 322  
323 323  DataStructureDefinition MetadataStructureDefinit ion
324 324  )))|Abstract specification of a list of lists to define a complex tabular structure. A concrete example of this would be statistical concepts, code lists, and their organisation in a data or metadata structure definition, defined by a centre institution, usually for the exchange of statistical information with its partners.
325 -||grouping|A composite association to one or more component lists.
326 +| |grouping|A composite association to one or more component lists.
326 326  |//ComponentList//|(((
327 327  Inherits from:
328 328  
... ... @@ -338,7 +338,7 @@
338 338  
339 339  AttributeDescriptor MetadataAttributeDescriptor
340 340  )))|An abstract definition of a list of components. A concrete example is a Dimension Descriptor, which defines the list of Dimensions in a Data Structure Definition.
341 -||components|An aggregate association to one or more components which make up the list.
342 +| |components|An aggregate association to one or more components which make up the list.
342 342  |//Component//|(((
343 343  Inherits from:
344 344  
... ... @@ -352,19 +352,19 @@
352 352  
353 353  //DimensionComponent//
354 354  )))|A Component is an abstract super class used to define qualitative and quantitative data and metadata items that belong to a Component List and hence a Structure. Component is refined through its sub-classes.
355 -||conceptIdentity|(((
356 +| |conceptIdentity|(((
356 356  Association to a Concept in a Concept Scheme that identifies and defines the
357 357  
358 358  semantic of the Component.
359 359  )))
360 -||localRepresentation|Association to the Representation of the Component if this is different from the coreRepresentation of the Concept, which the Component uses (ConceptUsage).
361 -|Representation||The allowable value or format for Component or Concept
362 -||+enumerated|Association to an enumerated list that contains the allowable content for the Component when reported in a data or metadata set. The type of enumerated list that is allowed for any concrete Component is shown in the constraints on the association.
363 -||+nonEnumerated|Association to a set of Facets that define the allowable format for the content of the Component when reported in a data or metadata set.
364 -|Facet||Defines the format for the content of the Component when reported in a data or metadata set.
365 -||facetType|A specific content type, which is constrained by the Facet Type enumeration.
366 -||facetValueType|The format of the value of a Component when reported in a data or metadata set. This is constrained by the Facet Value Type enumeration.
367 -|||Defines the format of the identifiers in an Item Scheme used by a Component. Typically, this would define the number of characters (length) of the identifier.
361 +| |localRepresentation|Association to the Representation of the Component if this is different from the coreRepresentation of the Concept, which the Component uses (ConceptUsage).
362 +|Representation| |The allowable value or format for Component or Concept
363 +| |+enumerated|Association to an enumerated list that contains the allowable content for the Component when reported in a data or metadata set. The type of enumerated list that is allowed for any concrete Component is shown in the constraints on the association.
364 +| |+nonEnumerated|Association to a set of Facets that define the allowable format for the content of the Component when reported in a data or metadata set.
365 +|Facet| |Defines the format for the content of the Component when reported in a data or metadata set.
366 +| |facetType|A specific content type, which is constrained by the Facet Type enumeration.
367 +| |facetValueType|The format of the value of a Component when reported in a data or metadata set. This is constrained by the Facet Value Type enumeration.
368 +| | |Defines the format of the identifiers in an Item Scheme used by a Component. Typically, this would define the number of characters (length) of the identifier.
368 368  |ExtendedFacet|+itemSchemeFacet|This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute and a Data Attribute.
369 369  
370 370  The specification of the content and use of the sub classes to //ComponentList// and //Component// can be found in the section in which they are used (DataStructureDefinition and MetadataStructureDefinition). Moreover, the FacetType SentinelValues is explained in the datastructure representation diagram (see 5.3.2.2), since it only concerns DataStructureDefinitions.
... ... @@ -400,23 +400,23 @@
400 400  
401 401  The Representation is composed of Facets, each of which conveys characteristic information related to the definition of a value domain. Often a set of Facets are needed to convey the required semantic. For example, a sequence is defined by a minimum of two Facets: one to define the start value, and one to define the interval.
402 402  
403 -|**Facet Type**||**Explanation**
404 -|isSequence||The isSequence facet indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue facet or the timeInterval, startTime, and endTime, facets. If this attribute holds a value of true, a start value or time and a numeric or time interval must be supplied. If an end value is not given, then the sequence continues indefinitely.
405 -|interval||The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true.
406 -|startValue||The startValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric sequence and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed
407 -|endValue||The endValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric sequence and indicates that ending point (if any) of the sequence.
408 -|timeInterval||The timeInterval facet indicates the permitted duration in a time sequence. In order for this to be used, the isSequence facet must have a value of true.
409 -|startTime||The startTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). This attribute is used for a time sequence and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
410 -|endTime||The endTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). This facet is used for a time sequence and indicates that ending point (if any) of the sequence.
411 -|minLength||The minLength facet specifies the minimum and length of the value in characters.
412 -|maxLength||The maxLength facet specifies the maximum length of the value in characters.
413 -|minValue||The minValue facet is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g., this facet is used with an integer data type), the value is assumed to be inclusive.
414 -|minLength||The minLength facet specifies the minimum and length of the value in characters.
415 -|maxLength||The maxLength facet specifies the maximum length of the value in characters.
416 -|minValue||The minValue facet is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g., this facet is used with an integer data type), the value is assumed to be inclusive.
417 -|maxValue||The maxValue facet is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g., this facet is used with an integer data type), the value is assumed to be inclusive.
418 -|decimals||The decimals facet indicates the number of characters allowed after the decimal separator.
419 -|pattern||The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).
404 +|**Facet Type**| |**Explanation**
405 +|isSequence| |The isSequence facet indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue facet or the timeInterval, startTime, and endTime, facets. If this attribute holds a value of true, a start value or time and a numeric or time interval must be supplied. If an end value is not given, then the sequence continues indefinitely.
406 +|interval| |The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true.
407 +|startValue| |The startValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric sequence and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed
408 +|endValue| |The endValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric sequence and indicates that ending point (if any) of the sequence.
409 +|timeInterval| |The timeInterval facet indicates the permitted duration in a time sequence. In order for this to be used, the isSequence facet must have a value of true.
410 +|startTime| |The startTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). This attribute is used for a time sequence and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
411 +|endTime| |The endTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). This facet is used for a time sequence and indicates that ending point (if any) of the sequence.
412 +|minLength| |The minLength facet specifies the minimum and length of the value in characters.
413 +|maxLength| |The maxLength facet specifies the maximum length of the value in characters.
414 +|minValue| |The minValue facet is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g., this facet is used with an integer data type), the value is assumed to be inclusive.
415 +|minLength| |The minLength facet specifies the minimum and length of the value in characters.
416 +|maxLength| |The maxLength facet specifies the maximum length of the value in characters.
417 +|minValue| |The minValue facet is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g., this facet is used with an integer data type), the value is assumed to be inclusive.
418 +|maxValue| |The maxValue facet is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g., this facet is used with an integer data type), the value is assumed to be inclusive.
419 +|decimals| |The decimals facet indicates the number of characters allowed after the decimal separator.
420 +|pattern| |The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).
420 420  
421 421  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_59eee18f.gif||alt="Shape29" height="1" width="192"]]
422 422  
SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_828a9828.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +217.9 KB
Content
SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_b6346072.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +332.9 KB
Content
SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_ec1b8edc.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +159.6 KB
Content