Skip to Content

Changes for page 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19
From version 15.3
edited by Helena
on 2025/05/22 15:22
Change comment: There is no comment for this version
To version 6.3
edited by Helena
on 2025/05/20 00:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -Methodology.SDMX 2\.1 Standards\. Section 2\. Information model\: UML conceptual design.WebHome
Content
... ... @@ -4,22 +4,20 @@
4 4  
5 5  == {{id name="_Toc370968"/}}3.1 Introduction ==
6 6  
7 -The constructs in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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).
7 +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).
8 8  
9 -The motivation for establishing the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base package is as follows:
9 +The motivation for establishing the SDMX Base package is as follows:
10 10  
11 11  * it is accepted “Best Practise” to identify fundamental archetypes occurring in a model
12 12  * identification of commonly found structures or “patterns” leads to easier understanding
13 13  * identification of patterns encourages re-use
14 14  
15 -Each of the class diagrams in this section views classes from the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base package from a different perspective. There are detailed views of specific patterns, plus overviews showing inheritance between classes, and relationships amongst classes.
15 +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.
16 16  
17 17  == {{id name="_Toc370969"/}}3.2 Base Structures - Identification, Versioning, and Maintenance ==
18 18  
19 19  === {{id name="_Toc370970"/}}3.2.1 Class Diagram ===
20 20  
21 -[[image:1747916560887-863.png]]
22 -
23 23  **Figure 9: SDMX Identification, Maintenance and Versioning**
24 24  
25 25  === {{id name="_Toc370971"/}}3.2.2 Explanation of the Diagram ===
... ... @@ -26,76 +26,76 @@
26 26  
27 27  ==== 3.2.2.1 Narrative ====
28 28  
29 -This group of classes forms the nucleus of the administration [[facets>>doc:sdmx:Glossary.Facet.WebHome]] of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] objects. They provide features which are reusable by derived classes to support horizontal functionality such as identity, versioning etc.
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.
30 30  
31 -All classes derived from the abstract class //AnnotableArtefact// may have [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] (or notes): this supports the need to add notes to all [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] elements. The [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is used to convey extra information to describe any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] construct. This information may be in the form of a URL reference and/or a multilingual text (represented by the association to InternationalString).
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).
32 32  
33 -The //IdentifiableArtefact// is an abstract class that comprises the basic [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] needed for identification. Concrete classes based on //IdentifiableArtefact// all inherit the ability to be uniquely identified.
31 +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 -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>>doc:sdmx:Glossary.Representation.WebHome]] 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>>doc:sdmx:Glossary.Representation.WebHome]] of a description in one locale.
33 +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.
36 36  
37 37  //VersionableArtefact// is an abstract class which inherits from //NameableArtefact// and adds versioning ability to all classes derived from it.
38 38  
39 -//MaintainableArtefact// further adds the ability for derived classes to be maintained via its association to //Agency, //and adds locational information (i.e. from where the object can be retrieved). It is possible to define whether the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is draft or final with the final attribute.
37 +//MaintainableArtefact// further adds the ability for derived classes to be maintained via its association to //Agency, //and adds locational information (i.e. from where the object can be retrieved). It is possible to define whether the artefact is draft or final with the final attribute.
40 40  
41 -The inheritance chain from //AnnotableArtefact// through to //MaintainableArtefact// allows [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] classes to inherit the features they need, from simple [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]], through identity, naming, to versioning and maintenance.
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.
42 42  
43 43  ==== 3.2.2.2 Definitions ====
44 44  
45 45  (% style="width:902.294px" %)
46 -|**Class**|(% style="width:269px" %)**Feature**|(% style="width:455px" %)**Description**
47 -|//AnnotableArtefact//|(% style="width:269px" %)(((
44 +|**Class**|(% style="width:246px" %)**Feature**|(% style="width:480px" %)**Description**
45 +|//AnnotableArtefact//|(% style="width:246px" %)(((
48 48  Base inheritance sub classes are:
49 49  //IdentifiableArtefact//
50 -)))|(% style="width:455px" %)Objects of classes derived from this can have attached annotations.
51 -|Annotation|(% style="width:269px" %) |(% style="width:455px" %)Additional descriptive information attached to an object.
52 -| |(% style="width:269px" %)id|(% style="width:455px" %)(((
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 54  It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.
55 55  )))
56 -| |(% style="width:269px" %)title|(% style="width:455px" %)A title used to identify an annotation.
57 -| |(% style="width:269px" %)type|(% style="width:455px" %)Specifies how the annotation is to be processed.
58 -| |(% style="width:269px" %)url|(% style="width:455px" %)A link to external descriptive text.
59 -| |(% style="width:269px" %)+text|(% style="width:455px" %)An International String provides the multilingual text content of the annotation via this role.
60 -|//IdentifiableArtefact//|(% style="width:269px" %)(((
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" %)(((
61 61  Superclass is
62 62  //AnnotableArtefact//
63 63  Base inheritance sub classes are:
64 64  //NameableArtefact//
65 -)))|(% style="width:455px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
66 -| |(% style="width:269px" %)id|(% style="width:455px" %)The unique identifier of the object.
67 -| |(% style="width:269px" %)uri|(% style="width:455px" %)Universal resource identifier that may or may not be resolvable.
68 -| |(% style="width:269px" %)urn|(% style="width:455px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
69 -|//NameableArtefact//|(% style="width:269px" %)(((
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" %)(((
70 70  Superclass is
71 71  //IdentifiableArtefact// Base inheritance sub classes are:
72 72  //VersionableArtefact//
73 -)))|(% style="width:455px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.
74 -| |(% style="width:269px" %)+description|(% style="width:455px" %)A multi-lingual description is provided by this role via the International String class.
75 -| |(% style="width:269px" %)+name|(% style="width:455px" %)A multi-lingual name is provided by this role via the International String class
76 -|InternationalString|(% style="width:269px" %) |(% style="width:455px" %)The International String is a collection of Localised Strings and supports the representation of text in multiple locales.
77 -|LocalisedString|(% style="width:269px" %) |(% style="width:455px" %)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.).
78 -| |(% style="width:269px" %)label|(% style="width:455px" %)Label of the string.
79 -| |(% style="width:269px" %)locale|(% style="width:455px" %)The geographic locale of the string e.g French, Canadian French.
80 -|//VersionableArtefact//|(% style="width:269px" %)(((
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" %)(((
81 81  Superclass is
82 82  //NameableArtefact// Base inheritance sub classes are:
83 83  //MaintainableArtefact//
84 -)))|(% style="width:455px" %)Provides versioning information for all derived objects.
85 -| |(% style="width:269px" %)version|(% style="width:455px" %)A version string following an agreed convention
86 -| |(% style="width:269px" %)validFrom|(% style="width:455px" %)Date from which the version is valid
87 -| |(% style="width:269px" %)validTo|(% style="width:455px" %)Date from which version is superceded
88 -|//MaintainableArtefact//|(% style="width:269px" %)(((
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" %)(((
89 89  Inherits from
90 90  
91 91  //VersionableArtefact//
92 -)))|(% style="width:455px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
93 -| |(% style="width:269px" %)final|(% style="width:455px" %)Defines whether a maintained artefact is draft or final.
94 -| |(% style="width:269px" %)isExternalReference|(% style="width:455px" %)If set to “true” it indicates that the content of the object is held externally.
95 -| |(% style="width:269px" %)structureURL|(% style="width:455px" %)The URL of an SDMX-ML document containing the external object.
96 -| |(% style="width:269px" %)serviceURL|(% style="width:455px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved.
97 -| |(% style="width:269px" %)+maintainer|(% style="width:455px" %)Association to the Maintenance Agency responsible for maintaining the artefact.
98 -|Agency|(% style="width:269px" %) |(% style="width:455px" %)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”
99 99  
100 100  == {{id name="_Toc370972"/}}3.3 Basic Inheritance ==
101 101  
... ... @@ -115,8 +115,6 @@
115 115  
116 116  === {{id name="_Toc370976"/}}3.4.1 Class Diagram ===
117 117  
118 -[[image:1747690333052-506.png]]
119 -
120 120  **Figure 11: Class Diagram of Basic Data Types**
121 121  
122 122  === {{id name="_Toc370977"/}}3.4.2 Explanation of the Diagram ===
... ... @@ -163,17 +163,18 @@
163 163  
164 164  [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_a2879920.jpg||height="602" width="614"]]
165 165  
166 -(% class="wikigeneratedid" id="HFigure12TheItemSchemePattern" %)
167 -**Figure 12 The Item Scheme Pattern**
162 +====== Figure 12 The Item Scheme Pattern ======
168 168  
169 -=== {{id name="_Toc370981"/}}3.5.3 Explanation of the Diagram ===
164 +===== {{id name="_Toc370981"/}}3.5.3 Explanation of the Diagram =====
170 170  
171 -==== 3.5.3.1 Narrative ====
166 +**3.5.3.1 Narrative**
172 172  
173 173  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 inherits 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 CategoryScheme. The associated Category are //Items//.
174 174  
175 -In an exchange environment an ItemScheme is allowed to contain a sub-set of the Items in the maintained //ItemScheme//. If such an //ItemScheme// is disseminated with a sub-set of the Items then the fact that this is a sub-set is denoted by setting the isPartial attribute to “true”.
170 +In an exchange environment an ItemScheme is allowed to contain a sub-set of the Items in the maintained //ItemScheme//. If such an //ItemScheme// is disseminated with a sub-set of the Items then the fact that this is a sub-set is denoted by setting the isPartial attribute to
176 176  
172 +“true”.
173 +
177 177  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//.
178 178  
179 179  Furthermore, the Id of the //ItemScheme// where isPartial is set to “true” is the same as the Id of the full //ItemScheme// (maintenance agency, 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//.
... ... @@ -180,53 +180,81 @@
180 180  
181 181  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.
182 182  
183 -//Item// inherits from //NameableArtefact// which gives it the ability to be annotated and have identity, and therefore has id, uri and urn attributes, a name and a description in the form of an InternationalString. Unlike the parent //ItemScheme//, the //Item// itself is not a //MaintainableArtefact// and therefore cannot have an independent Agency (i.e. it implicitly has the same agency as the //ItemScheme//).
180 +//Item// inherits from //NameableArtefact// which gives it the ability to be annotated and have identity, and therefore has id, uri and urn attributes, a name and a description in the form of an
184 184  
182 +InternationalString. Unlike the parent //ItemScheme//, the //Item// itself is not a //MaintainableArtefact// and therefore cannot have an independent Agency (i.e. it implicitly has the same agency as the //ItemScheme//).
183 +
185 185  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//.
186 186  
187 187  ==== 3.5.3.2 Definitions ====
188 188  
189 -(% style="width:911.294px" %)
190 -|**Class**|(% style="width:246px" %)**Feature**|(% style="width:478px" %)**Description**
191 -|//ItemScheme//|(% style="width:246px" %)(((
188 +|**Class**|**Feature**|**Description**
189 +|//ItemScheme//|(((
192 192  Inherits from:
191 +
193 193  //MaintainableArtefact//
193 +
194 194  Direct sub classes are:
195 +
195 195  CategoryScheme
197 +
196 196  ConceptScheme
199 +
197 197  Codelist
198 -)))|(% style="width:478px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
199 -| |(% style="width:246px" %)(((
201 +)))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
202 +| |(((
200 200  ReportingTaxonomy
204 +
201 201  //OrganisationScheme//
206 +
202 202  Transformation Scheme
208 +
203 203  CustomTypeScheme
210 +
204 204  NamePersonasationScheme
212 +
205 205  RuletScheme
214 +
206 206  VtlMappingScheme
216 +
207 207  UserDefinedOperatorScheme
208 -)))|(% style="width:478px" %)
209 -| |(% 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.
210 -| |(% style="width:246px" %)items|(% style="width:478px" %)Association to the Items in the scheme.
211 -|//Item//|(% style="width:246px" %)(((
218 +)))|
219 +| |isPartial|Denotes whether the Item Scheme contains a sub set of the full set of Items in the maintained scheme.
220 +| |items|Association to the Items in the scheme.
221 +|//Item//|(((
212 212  Inherits from:
223 +
213 213  //NameableArtefact//
214 -Direct sub classes are Category
225 +
226 +Direct sub classes are
227 +
228 +Category
229 +
215 215  Concept
231 +
216 216  Code
233 +
217 217  ReportingCategory
235 +
218 218  //Organisation//
237 +
219 219  Transformation
239 +
220 220  CustomType
241 +
221 221  NamePersonlisation
243 +
222 222  Ruleset
245 +
223 223  VtlMapping
224 -UserDefinedOperator
225 -)))|(% style="width:478px" %)(((
247 +
248 +UserDefinedOperator//    //
249 +)))|(((
226 226  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.
251 +
227 227  Note that at the conceptual level the Organisation is not hierarchic
228 228  )))
229 -| |(% style="width:246px" %)hierarchy|(% style="width:478px" %)This allows an Item optionally to have one or more child Items.
254 +| |hierarchy|This allows an Item optionally to have one or more child Items.
230 230  
231 231  == {{id name="_Toc370982"/}}3.6 The Structure Pattern ==
232 232  
... ... @@ -242,8 +242,7 @@
242 242  
243 243  [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_b6478a73.png||height="774" width="556"]]
244 244  
245 -(% class="wikigeneratedid" id="HFigure14:RepresentationwithintheStructurePattern" %)
246 -**Figure 14: Representation within the Structure Pattern**
270 +====== Figure 14: Representation within the Structure Pattern ======
247 247  
248 248  === {{id name="_Toc370985"/}}3.6.3 Explanation of the Diagrams ===
249 249  
... ... @@ -259,7 +259,7 @@
259 259  
260 260  __GroupDimensionDescriptor__: Dimension, Measure Dimension, Time Dimension
261 261  
262 -__MeasureDescriptor__: PrimaryMeasure
286 +MeasureDescriptor: PrimaryMeasure
263 263  
264 264  __AttributeDescriptor:__ Data Attribute
265 265  
... ... @@ -267,7 +267,7 @@
267 267  
268 268  __ReportStructure__: MetadataAttribute
269 269  
270 -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.
294 +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.
271 271  
272 272  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.
273 273  
... ... @@ -282,112 +282,140 @@
282 282  
283 283  The //Structure// may be used by one or more //StructureUsage//. An example of this in terms of concrete classes is that a DataflowDefinition (sub class of //StructureUsage//) may use a particular DataStructureDefinition (sub class of //Structure//), and similar constructs apply for the MetadataflowDefinition (link to MetadataStructureDefinition).
284 284  
285 -==== 3.6.3.2 Definitions ====
309 +**3.6.3.2 Definitions**
286 286  
287 -(% style="width:1001.29px" %)
288 -|**Class**|**Feature**|(% style="width:537px" %)**Description**
311 +|**Class**|**Feature**|**Description**
289 289  |//StructureUsage//|(((
290 290  Inherits from:
314 +
291 291  //MaintainableArtefact//
316 +
292 292  Sub classes are:
318 +
293 293  DataflowDefinition
294 -MetadataflowDefinition
295 -)))|(% style="width:537px" %)An artefact whose components are described by a Structure. In concrete terms (sub-classes) an example would be a Dataflow Definition which is linked to a given structure – in this case the Data Structure Definition.
296 -| |structure|(% style="width:537px" %)An association to a Structure specifying the structure of the artefact.
320 +
321 +MetadataflowDefinition//    //
322 +)))|An artefact whose components are described by a Structure. In concrete terms (sub-classes) an example would be a Dataflow Definition which is linked to a given structure – in this case the Data Structure Definition.
323 +| |structure|An association to a Structure specifying the structure of the artefact.
297 297  |//Structure//|(((
298 298  Inherits from:
326 +
299 299  //MaintainableArtefact//
328 +
300 300  Sub classes are:
330 +
301 301  DataStructure
332 +
302 302  Definition
334 +
303 303  MetadataStructure
336 +
304 304  Definition
305 -)))|(% style="width:537px" %)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.
306 -| |grouping|(% style="width:537px" %)A composite association to one or more component lists.
338 +)))|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.
339 +| |grouping|A composite association to one or more component lists.
307 307  |//ComponentList//|(((
308 308  Inherits from:
342 +
309 309  //IdentifiableArtefact//
344 +
310 310  Sub classes are:
346 +
311 311  DimensionDescriptor
348 +
312 312  GroupDimension
350 +
313 313  Descriptor
352 +
314 314  MeasureDescriptor
354 +
315 315  AttributeDescriptor
356 +
316 316  MetadataTarget
358 +
317 317  ReportStructure
318 -)))|(% style="width:537px" %)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.
319 -| |components|(% style="width:537px" %)An aggregate association to one or more components which make up the list.
360 +)))|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.
361 +| |components|An aggregate association to one or more components which make up the list.
320 320  |//Component//|(((
321 321  Inherits from:
364 +
322 322  //IdentifiableArtefact//
366 +
323 323  Sub classes are:
368 +
324 324  PrimaryMeasure
370 +
325 325  DataAttribute
326 -//DimensionComponent
327 -TargetObject//
372 +
373 +//DimensionComponent//
374 +
375 +//TargetObject//
376 +
328 328  MetadataAttribute
329 -)))|(% style="width:537px" %)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.
330 -| |conceptIdentity|(% style="width:537px" %)Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component
331 -| |localRepresentation|(% style="width:537px" %)Association to the Representation of the Component if this is different from the coreRepresentation of the Concept which the Component uses (ConceptUsage)
332 -|Representation| |(% style="width:537px" %)The allowable value or format for Component or Concept
333 -| |+enumerated|(% style="width:537px" %)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 (e.g. Identifier Component can have any of the sub classes of Item Scheme, whereas Measure Dimension must have a Concept Scheme).
334 -| |+nonEnumerated|(% style="width:537px" %)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.
335 -|Facet| |(% style="width:537px" %)Defines the format for the content of the Component when reported in a data or metadata set.
336 -| |facetType|(% style="width:537px" %)A specific content type which is constrained by the FacetType enumeration
337 -| |facetValueType|(% style="width:537px" %)(((
378 +)))|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.
379 +| |conceptIdentity|Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component
380 +| |localRepresentation|Association to the Representation of the Component if this is different from the coreRepresentation of the Concept which the Component uses (ConceptUsage)
381 +|Representation| |The allowable value or format for Component or Concept
382 +| |+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 (e.g. Identifier Component can have any of the sub classes of Item Scheme, whereas Measure Dimension must have a Concept Scheme).
383 +| |+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.
384 +|Facet| |Defines the format for the content of the Component when reported in a data or metadata set.
385 +| |facetType|A specific content type which is constrained by the FacetType enumeration
386 +| |facetValueType|(((
338 338  The format of the value of a Component when reported in a data or metadata set.
339 339  
340 340  This is contrained by the FacetValueType enumeration.
341 341  )))
342 -| |+itemSchemeFacet|(% style="width:537px" %)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.
343 -|ExtendedFacet| |(% style="width:537px" %)This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute
391 +| |+itemSchemeFacet|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.
392 +|ExtendedFacet| |This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute
344 344  
345 -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)
394 +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)
346 346  
347 347  ==== 3.6.3.3 Representation Constructs ====
348 348  
349 349  The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, 818 and have equivalents in most current implementation platforms:
350 350  
400 +:
401 +
351 351  (((
352 -(% style="width:1034.29px" %)
353 -|(% style="width:222px" %)**SDMX Facet Value Type**|(% style="width:229px" %)**XML Schema Data Type**|(% style="width:216px" %)**.NET Framework Type**|(% style="width:354px" %)**Java Data Type**
354 -|(% style="width:222px" %)String|(% style="width:229px" %)xsd:string|(% style="width:216px" %)System.String|(% style="width:354px" %)java.lang.String
355 -|(% style="width:222px" %)Big Integer|(% style="width:229px" %)xsd:integer|(% style="width:216px" %)System.Decimal|(% style="width:354px" %)java.math.BigInteger
356 -|(% style="width:222px" %)Integer|(% style="width:229px" %)xsd:int|(% style="width:216px" %)System.Int32|(% style="width:354px" %)int
357 -|(% style="width:222px" %)Long|(% style="width:229px" %)xsd.long|(% style="width:216px" %)System.Int64|(% style="width:354px" %)long
358 -|(% style="width:222px" %)Short|(% style="width:229px" %)xsd:short|(% style="width:216px" %)System.Int16|(% style="width:354px" %)short
359 -|(% style="width:222px" %)Decimal|(% style="width:229px" %)xsd:decimal|(% style="width:216px" %)System.Decimal|(% style="width:354px" %)java.math.BigDecimal
360 -|(% style="width:222px" %)Float|(% style="width:229px" %)xsd:float|(% style="width:216px" %)System.Single|(% style="width:354px" %)float
361 -|(% style="width:222px" %)Double|(% style="width:229px" %)xsd:double|(% style="width:216px" %)System.Double|(% style="width:354px" %)double
362 -|(% style="width:222px" %)Boolean|(% style="width:229px" %)xsd:boolean|(% style="width:216px" %)System.Boolean|(% style="width:354px" %)boolean
363 -|(% style="width:222px" %)URI|(% style="width:229px" %)xsd:anyURI|(% style="width:216px" %)System.Uri|(% style="width:354px" %)Java.net.URI or java.lang.String
364 -|(% style="width:222px" %)DateTime|(% style="width:229px" %)xsd:dateTime|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
365 -|(% style="width:222px" %)Time|(% style="width:229px" %)xsd:time|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
366 -|(% style="width:222px" %)GregorianYear|(% style="width:229px" %)xsd:gYear|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
367 -|(% style="width:222px" %)GregorianMonth|(% style="width:229px" %)xsd:gYearMonth|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
368 -|(% style="width:222px" %)GregorianDay|(% style="width:229px" %)xsd:date|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
369 -|(% style="width:222px" %)Day, MonthDay, Month|(% style="width:229px" %)xsd:g*|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
370 -|(% style="width:222px" %)Duration|(% style="width:229px" %)xsd:duration|(% style="width:216px" %)System.TimeSpan|(% style="width:354px" %)javax.xml.datatype.Dura tion
403 +|**SDMX Facet Value Type**|**XML Schema Data Type     **|**.NET Framework Type**|**Java Data Type**
404 +|String|xsd:string|System.String|java.lang.String
405 +|Big Integer|xsd:integer|System.Decimal|java.math.BigInteger
406 +|Integer|xsd:int|System.Int32|int
407 +|Long|xsd.long|System.Int64|long
408 +|Short|xsd:short|System.Int16|short
409 +|Decimal|xsd:decimal|System.Decimal|java.math.BigDecimal
410 +|Float|xsd:float|System.Single|float
411 +|Double|xsd:double|System.Double|double
412 +|Boolean|xsd:boolean|System.Boolean|boolean
413 +|URI|xsd:anyURI|System.Uri|Java.net.URI or java.lang.String
414 +|DateTime|xsd:dateTime|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
415 +|Time|xsd:time|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
416 +|GregorianYear|xsd:gYear|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
417 +|GregorianMonth|xsd:gYearMonth|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
418 +|GregorianDay|xsd:date|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
419 +|Day, MonthDay, Month|xsd:g*|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
420 +|Duration|xsd:duration|System.TimeSpan|javax.xml.datatype.Dura tion
371 371  )))
372 372  
373 -There are also a number of SDMX data types which do not have these direct correspondences, often because they are composite representations or restrictions of a broader data type. These are detailed in Section 6 of the standards.
423 +There are also a number of SDMX data types which do not have these direct 822 correspondences, often because they are composite representations or restrictions of a 823 broader data type. These are detailed in Section 6 of the standards.
374 374  
375 -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.
425 +The ,,Representation,, is composed of ,,Facet,,s, each of which conveys characteristic 826 information related to the definition of a value domain. Often a set of Facets are needed to 827 convey the required semantic. For example, a sequence is defined by a minimum of two 828 Facets: one to define the start value, and one to define the interval.
376 376  
427 +:
428 +
377 377  (((
378 -(% style="width:1043.29px" %)
379 -|(% style="width:179px" %)**Facet Type**|(% style="width:862px" %)**Explanation**
380 -|(% style="width:179px" %)isSequence|(% style="width:862px" %)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 supplied. If an end value is not given, then the sequence continues indefinitely.
381 -|(% style="width:179px" %)interval|(% style="width:862px" %)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.
382 -|(% style="width:179px" %)startValue|(% colspan="1" style="width:862px" %)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.
383 -|(% style="width:179px" %)endValue|(% colspan="1" style="width:862px" %)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.
384 -|(% style="width:179px" %)timeInterval|(% colspan="1" style="width:862px" %)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.
385 -|(% style="width:179px" %)startTime|(% colspan="1" style="width:862px" %)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.
386 -|(% style="width:179px" %)endTime|(% colspan="1" style="width:862px" %)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.
387 -|(% style="width:179px" %)minLength|(% colspan="1" style="width:862px" %)The minLength facet specifies the minimum and length of the value in characters.
388 -|(% style="width:179px" %)maxLength|(% colspan="1" style="width:862px" %)The maxLength facet specifies the maximum length of the value in characters.
389 -|(% style="width:179px" %)minValue|(% colspan="1" style="width:862px" %)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.
390 -|(% style="width:179px" %)maxValue|(% colspan="1" style="width:862px" %)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.
391 -|(% style="width:179px" %)decimals|(% colspan="1" style="width:862px" %)The decimals facet indicates the number of characters allowed after the decimal separator.
392 -|(% style="width:179px" %)pattern|(% colspan="1" style="width:862px" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g. W3C XML Schema).
430 +|**Facet Type**|**Explanation**|
431 +|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 supplied. If an end value is not given, then the sequence continues indefinitely.|
432 +|interval|The interval attribute specifies the permitted interval (increment) in a|
433 +| |(% colspan="2" %)sequence. In order for this to be used, the isSequence attribute must have a value of true.
434 +|startValue|(% colspan="2" %)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.
435 +|endValue|(% colspan="2" %)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.
436 +|timeInterval|(% colspan="2" %)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.
437 +|startTime|(% colspan="2" %)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.
438 +|endTime|(% colspan="2" %)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.
439 +|minLength|(% colspan="2" %)The minLength facet specifies the minimum and length of the value in characters.
440 +|maxLength|(% colspan="2" %)The maxLength facet specifies the maximum length of the value in characters.
441 +|minValue|(% colspan="2" %)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.
442 +|maxValue|(% colspan="2" %)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.
443 +|decimals|(% colspan="2" %)The decimals facet indicates the number of characters allowed after the decimal separator.
444 +|pattern|(% colspan="2" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g. W3C XML Schema).
393 393  )))
1747690333052-506.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -67.4 KB
Content
1747916560887-863.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -56.0 KB
Content
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,1 +1,0 @@
1 -4