Skip to Content
Last modified by Elena on 2025/09/10 11:19
From version 5.3
edited by Helena
on 2025/06/08 11:23
Change comment: There is no comment for this version
To version 3.5
edited by Helena
on 2025/06/08 11:17
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -13,9 +13,13 @@
13 13  The actual SDMX Base construct from which the concrete classes inherit depends upon the requirements of the class for:
14 14  
15 15  Annotation – //AnnotableArtefact//
16 +
16 16  Identification – //IdentifiableArtefact//
18 +
17 17  Naming – //NameableArtefact//
20 +
18 18  Versioning – //VersionableArtefact//
22 +
19 19  Maintenance – //MaintainableArtefact//
20 20  
21 21  == 5.2 Inheritance View ==
... ... @@ -32,22 +32,28 @@
32 32  
33 33  Those classes in the SDMX metamodel which require annotations inherit from //AnnotableArtefact//. These are:
34 34  
35 -//IdentifiableArtefact
36 -DataSet
37 -Key// (and therefore //SeriesKey// and //GroupKey//)
39 +//IdentifiableArtefact//
40 +
41 +//DataSet//
42 +
43 +//Key// (and therefore //SeriesKey// and //GroupKey//)
44 +
38 38  //Observation//
39 39  
40 40  Those classes in the SDMX metamodel which require annotations and global identity are derived from //IdentifiableArtefact//. These are:
41 41  
42 -//NameableArtefact
43 -ComponentList
44 -Component//
49 +//NameableArtefact//
45 45  
51 +//ComponentList//
52 +
53 +//Component//
54 +
46 46  Those classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description are derived from //NameableArtefact//. These are:
47 47  
48 -//VersionableArtefact
49 -Item//
57 +//VersionableArtefact//
50 50  
59 +//Item//
60 +
51 51  The classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact//. These are:
52 52  
53 53  //MaintainableArtefact//
... ... @@ -54,10 +54,12 @@
54 54  
55 55  Abstract classes which represent information that is maintained by Maintenance Agencies all inherit from //MaintainableArtefact//, they also inherit all the features of a //VersionableArtefact//, and are:
56 56  
57 -//StructureUsage
58 -Structure
59 -ItemScheme//
67 +//StructureUsage//
60 60  
69 +//Structure//
70 +
71 +//ItemScheme//
72 +
61 61  All the above classes are abstract. The key to understanding the class diagrams presented in this section are the concrete classes that inherit from these abstract classes.
62 62  
63 63  Those concrete classes in the SDMX Data Structure Definition and Dataset packages of the metamodel which require to be maintained by Agencies all inherit (via other abstract classes) from //MaintainableArtefact//, these are:
... ... @@ -266,11 +266,11 @@
266 266  
267 267  ==== //5.4 Data Set – Relationship View// ====
268 268  
269 -=== 5.4.1 Context ===
281 +===== 5.4.1 Context =====
270 270  
271 271  A data set comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition.
272 272  
273 -=== 5.4.2 Class Diagram ===
285 +===== 5.4.2 Class Diagram =====
274 274  
275 275  [[image:1749246368794-672.jpeg]]
276 276  
... ... @@ -305,8 +305,11 @@
305 305  |**Class**|**Feature**|**Description**
306 306  |//DataSet//|(((
307 307  Abstract Class
320 +
308 308  Sub classes
322 +
309 309  StructureSpecificData
324 +
310 310  Set
311 311  )))|An organised collection of data.
312 312  | |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
... ... @@ -332,8 +332,11 @@
332 332  |StructureSpecific DataSet| |An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
333 333  |//Key//|(((
334 334  Abstract class
350 +
335 335  Sub classes
352 +
336 336  SeriesKey
354 +
337 337  GroupKey
338 338  )))|Comprises the cross product of values of dimensions that identify uniquely an Observation.
339 339  | |keyValues|Association to the individual Key Values that comprise the Key.
... ... @@ -340,26 +340,34 @@
340 340  | |+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
341 341  |//KeyValue//|(((
342 342  Abstract class
361 +
343 343  Sub classes
363 +
344 344  TimeKeyValue
365 +
345 345  CodedKeyValue
367 +
346 346  UncodedKeyValue
347 347  )))|The value of a component of a key such as the value of the instance a Dimension in a Dimension Descriptor of a Data Structure Definition.
348 348  | |+valueFor|(((
349 349  Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
372 +
350 350  Note that this is conceptual association as the key component is identified explicitly in the data set.
351 351  )))
352 352  |TimeKeyValue|(((
353 353  Inherits from
377 +
354 354  //KeyValue//
355 355  )))|The value of the Time Dimension component of the key.
356 356  |CodedKeyValue|(((
357 357  Inherits from
382 +
358 358  //KeyValue//
359 359  )))|The value of a coded component of the key. The value is the Code to which this class is associated.
360 360  | |+valueOf|Association to the Code. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Dimension in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Key Value.
361 361  |UnCodedKeyValue|(((
362 362  Inherits from
388 +
363 363  //KeyValue//
364 364  )))|The value of an uncoded component of the key.
365 365  | |value|The value of the key component.
... ... @@ -366,11 +366,13 @@
366 366  | |startTime|This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
367 367  |GroupKey|(((
368 368  Inherits from
395 +
369 369  //Key//
370 370  )))|A set of Key Values that comprise a partial key, of the same dimensionality as the Time Series Key for the purpose of attaching Data Attributes.
371 371  | |+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
372 372  |SeriesKey|(((
373 373  Inherits from
401 +
374 374  //Key//
375 375  )))|Comprises the cross product of values of all the Key Values that, together with the Key Value of the +observation Dimension identify uniquely an Observation.
376 376  | |+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
... ... @@ -387,46 +387,61 @@
387 387  
388 388  Sub classes
389 389  
390 -//UncodedObservationValue//
418 +//UncodedObservationVal ue//
391 391  
392 392  CodedObservation
393 393  )))|
394 394  |//UncodedObservatio nValue//|(((
395 395  Abstract class
424 +
396 396  Inherits from
426 +
397 397  //ObservationValue//
428 +
398 398  Sub classes
399 -OtherUncodedMeasureValue
430 +
431 +OtherUncodedMeasureVa lue
432 +
400 400  TextMeasureValue
401 401  )))|
402 402  |OtherUncodedMeasu reValue|(((
403 403  Inherits from
404 -//UncodedObservationValue//
437 +
438 +//UncodedObservationVal ue//
405 405  )))|An observation that has a text value.
406 406  | |value|The value of the Uncoded Observation.
407 407  | |startTime|This attribute is only used if the textFormat of the Measure is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
408 408  |TextMeasureValue|(((
409 409  Inherits from
410 -//UncodedObservationValue//
444 +
445 +//UncodedObservationVal ue//
411 411  )))|An observation that has a localised text value
412 412  | |text|The localised text values.
413 413  |CodedObservation|(((
414 414  Inherits from
450 +
415 415  //ObservationValue//
416 416  )))|An Observation that takes its value from a code in a Code list.
417 417  | |+valueOf|Association to the Code that is the value of the Observation. Note that this is a conceptual association showing that the Code must exist in the Codelist(s) associated with the Measure(s) in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Observation.
418 418  |//AttributeValue//|(((
419 419  Abstract class
456 +
420 420  Sub classes
458 +
421 421  //DataAttributeValue// //MetadataAttributeValu e//
422 422  )))|Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
423 423  |//DataAttributeValu e//|(((
424 424  Abstract class
463 +
425 425  Inherits from
465 +
426 426  //AttributeValue//
467 +
427 427  Sub classes
428 -//UncodedAttributeValue
429 -CodedAttributeValue//
469 +
470 +//UncodedAttributeValue//
471 +
472 +//CodedAttributeValue//
430 430  )))|The value of a Data Attribute, such as the instance of a Coded Attribute or of an Uncoded Attribute in a structure such as a Data Structure Definition.
431 431  | |+valueFor|(((
432 432  Association to the Data Attribute defined in the Data Structure Definition. Note that this is conceptual association as the Concept is identified explicitly in the data set.
... ... @@ -440,14 +440,20 @@
440 440  )))|The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition
441 441  |//UncodedAttributeV alue//|(((
442 442  Inherits from
486 +
443 443  //AttributeValue//
488 +
444 444  Sub classes
490 +
445 445  OtherUncodedAttribute
492 +
446 446  Value
494 +
447 447  TextAttributeValue
448 448  )))|
449 449  |OtherUncodedAttri buteValue|(((
450 450  Inherits from
499 +
451 451  //UncodedObservationVal ue//
452 452  )))|An attribute value that has a text value
453 453  | |value|The value of the Uncoded attribute.
... ... @@ -454,11 +454,13 @@
454 454  | |startTime|This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
455 455  |TextAttributeValu e|(((
456 456  Inherits from
506 +
457 457  //UncodedAttributeValue//
458 458  )))|An attribute that has a localised text value
459 459  | |text|The localised text values.
460 460  |CodedAttributeVal ue|(((
461 461  Inherits from
512 +
462 462  //AttributeValue//
463 463  )))|An attribute that takes it value from a Code in Code list.
464 464  | |+valueOf|Association to the Code that is the value of the Attribute Value. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Data Attribute in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Attribute Value.