Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 3.4
edited by Helena
on 2025/05/22 00:44
Change comment: There is no comment for this version
To version 3.6
edited by Helena
on 2025/05/22 00:47
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -254,8 +254,6 @@
254 254  | |+dimensions|Association to the set of Dimensions to which the Data Attribute is related.
255 255  | |+groupKey|Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
256 256  
257 -
258 -
259 259  The explanation of the classes, attributes, and associations comprising the Representation is described in the section on the SDMX Base.
260 260  
261 261  == {{id name="_Toc371016"/}}5.4 Data Set – Relationship View ==
... ... @@ -266,8 +266,10 @@
266 266  
267 267  === {{id name="_Toc371018"/}}5.4.2 Class Diagram ===
268 268  
269 -====== Figure 26 Class Diagram of the Data Set ======
267 +====== ======
270 270  
269 +====== **Figure 26 Class Diagram of the Data Set** ======
270 +
271 271  === {{id name="_Toc371019"/}}5.4.3 Explanation of the Diagram ===
272 272  
273 273  ==== 5.4.3.1 Narrative – Data Set ====
... ... @@ -276,10 +276,8 @@
276 276  
277 277  An organisation playing the role of DataProvider can be responsible for one or more //DataSet//.
278 278  
279 -A //DataSet// can be formatted either as a generic data set (GenericDataSet,
279 +A //DataSet// can be formatted either as a generic data set (GenericDataSet, GenericTimeseriesDataSet) or a DataStructureDefinition specific data set (StructureSpecificDataSet, StructureSpecificTimeseriesDataSet). The generic data set is structured in exactly the same way no matter which DataStructureDefinition the DataSet expresses. The structured data set is structured according to one specific DataStructureDefinition. Depending on the syntax chosen for the implementation the structured data set should support better validation at the syntax level.
280 280  
281 -GenericTimeseriesDataSet) or a DataStructureDefinition specific data set (StructureSpecificDataSet, StructureSpecificTimeseriesDataSet). The generic data set is structured in exactly the same way no matter which DataStructureDefinition the DataSet expresses. The structured data set is structured according to one specific DataStructureDefinition. Depending on the syntax chosen for the implementation the structured data set should support better validation at the syntax level.
282 -
283 283  A //DataSet// is a collection of a set of //Observation//s that share the same dimensionality, which is specified by a set of unique components (Dimension, MeasureDimension, TimeDimension) defined in the DimensionDescriptor of the DataStructureDefinition, together with associated //AttributeValue//s that define specific characteristics about the artefact to which it is attached. - DataSet, Observation, set of Dimensions. It is structured in terms of a SeriesKey to which //Observation//s are reported.
284 284  
285 285  The Observation can be the value of the variable being measured for the Concept associated to the PrimaryMeasure in the MeasureDescriptor of the DataStructureDefinition. This is true when there is no MeasureDimension that specifies the precise meaning of each Observation. Each Observation associates an ObservationValue with a KeyValue (+observationDimension) which is the value for the “Dimension at the Observation Level”. Any dimension can be specified as being the “Dimension at the Observation Level”, and this specification is made at the level of the //DataSet// (i.e. it must be the same dimension for the entire //DataSet//).
... ... @@ -302,185 +302,145 @@
302 302  
303 303  ==== 5.4.3.2 Definitions ====
304 304  
305 -|**Class**|**Feature**|**Description**
306 -|//DataSet//|(((
303 +(% style="width:1012.83px" %)
304 +|(% style="width:182px" %)**Class**|(% style="width:210px" %)**Feature**|(% style="width:617px" %)**Description**
305 +|(% style="width:182px" %)//DataSet//|(% style="width:210px" %)(((
307 307  Abstract Class
308 -
309 309  Sub classes
310 -
311 311  GenericDataSet
312 -
313 313  StructureSpecificDataSet
314 -
315 315  GenericTime
316 -
317 317  SeriesDataSet
318 -
319 319  StructureSpecificTime
320 -
321 321  SeriesDataSet
322 -)))|An organised collection of data.
323 -| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
324 -| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
325 -| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
326 -| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
327 -| |validTo|Indicates the inclusive end time indicating the validity of the information in the data set.
328 -| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
329 -| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
330 -| |setId|Provides an identification of the data set.
331 -| |action|Defines the action to be taken by the recipient system (update, append, delete)
332 -| |describedBy|Associates a data flow definition and thereby a Data Structure Definition to the data set.
333 -| |+structuredBy|Associates the Data Structure Definition that defines the structure of the Data Set. Note that the Data Structure Definition is the same as that associated (nonmandatory) to the Dataflow Definition.
334 -| |+publishedBy|Associates the Data Provider that reports/publishes the data.
335 -| |+attachedAttribute|Association to the Attribute Values relating to the Data Set
336 -|GenericDataSet| |A data format structure that is able to contain data corresponding to any Data Structure Definition.
337 -|StructureSpecific DataSet| |A data format structure that contains data corresponding to one specific Data Structure Definition.
338 -|GenericTimeseries DataSet| |A data format structure that is able to contain timeseries data corresponding to any Data Structure Definition.
339 -|(((
314 +)))|(% style="width:617px" %)An organised collection of data.
315 +|(% style="width:182px" %) |(% style="width:210px" %)reportingBegin|(% style="width:617px" %)A specific time period in a known system of time periods that identifies the start period of a report.
316 +|(% style="width:182px" %) |(% style="width:210px" %)reportingEnd|(% style="width:617px" %)A specific time period in a known system of time periods that identifies the end period of a report.
317 +|(% style="width:182px" %) |(% style="width:210px" %)dataExtractionDate|(% style="width:617px" %)A specific time period that identifies the date and time that the data are extracted from a data source.
318 +|(% style="width:182px" %) |(% style="width:210px" %)validFrom|(% style="width:617px" %)Indicates the inclusive start time indicating the validity of the information in the data set.
319 +|(% style="width:182px" %) |(% style="width:210px" %)validTo|(% style="width:617px" %)Indicates the inclusive end time indicating the validity of the information in the data set.
320 +|(% style="width:182px" %) |(% style="width:210px" %)publicationYear|(% style="width:617px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
321 +|(% style="width:182px" %) |(% style="width:210px" %)publicationPeriod|(% style="width:617px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
322 +|(% style="width:182px" %) |(% style="width:210px" %)setId|(% style="width:617px" %)Provides an identification of the data set.
323 +|(% style="width:182px" %) |(% style="width:210px" %)action|(% style="width:617px" %)Defines the action to be taken by the recipient system (update, append, delete)
324 +|(% style="width:182px" %) |(% style="width:210px" %)describedBy|(% style="width:617px" %)Associates a data flow definition and thereby a Data Structure Definition to the data set.
325 +|(% style="width:182px" %) |(% style="width:210px" %)+structuredBy|(% style="width:617px" %)Associates the Data Structure Definition that defines the structure of the Data Set. Note that the Data Structure Definition is the same as that associated (nonmandatory) to the Dataflow Definition.
326 +|(% style="width:182px" %) |(% style="width:210px" %)+publishedBy|(% style="width:617px" %)Associates the Data Provider that reports/publishes the data.
327 +|(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Data Set
328 +|(% style="width:182px" %)GenericDataSet|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that is able to contain data corresponding to any Data Structure Definition.
329 +|(% style="width:182px" %)StructureSpecific DataSet|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that contains data corresponding to one specific Data Structure Definition.
330 +|(% style="width:182px" %)GenericTimeseries DataSet|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that is able to contain timeseries data corresponding to any Data Structure Definition.
331 +|(% style="width:182px" %)(((
340 340  StructureSpecific
341 341  
342 342  TimeseriesDataSet
343 -)))| |A data format structure that contains timeseries data corresponding to one specific Data Structure Definition.
344 -|Key|(((
335 +)))|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that contains timeseries data corresponding to one specific Data Structure Definition.
336 +|(% style="width:182px" %)Key|(% style="width:210px" %)(((
345 345  Abstract class Sub classes
346 -
347 347  SeriesKey
348 -
349 349  GroupKey
350 -)))|Comprises the cross product of values of dimensions that identify uniquely an Observation.
351 -| |keyValues|Association to the individual Key Values that comprise the Key.
352 -| |+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
353 -|//KeyValue//|(((
340 +)))|(% style="width:617px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
341 +|(% style="width:182px" %) |(% style="width:210px" %)keyValues|(% style="width:617px" %)Association to the individual Key Values that comprise the Key.
342 +|(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Series Key or Group Key.
343 +|(% style="width:182px" %)//KeyValue//|(% style="width:210px" %)(((
354 354  Abstract class
355 -
356 356  Sub classes
357 -
358 358  MeasureKeyValue
359 -
360 360  TimeKeyValue
361 -
362 362  CodedKeyValue
363 -
364 364  UncodedKeyValue
365 -)))|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.
366 -| |+valueFor|(((
350 +)))|(% style="width:617px" %)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.
351 +|(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)(((
367 367  Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
368 -
369 369  Note that this is conceptual association as the key component is identified explicitly in the data set.
370 370  )))
371 -|MeasureKeyValue|(((
355 +|(% style="width:182px" %)MeasureKeyValue|(% style="width:210px" %)(((
372 372  Inherits from
373 -
374 374  //KeyValue//
375 -)))|The value of the Measure Dimension component of the key. The value is the Concept to which this class is associated.
376 -| |+value|(((
358 +)))|(% style="width:617px" %)The value of the Measure Dimension component of the key. The value is the Concept to which this class is associated.
359 +|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
377 377  Association to the Concept.
378 -
379 -Note that this is a conceptual association showing that the Concept must exist in the Concept Scheme associated with the Measure Dimension in the Data Structure
380 -
381 -Definition. In the actual Data Set the value of the Concept is placed in the Key Value.
361 +Note that this is a conceptual association showing that the Concept must exist in the Concept Scheme associated with the Measure Dimension in the Data Structure Definition. In the actual Data Set the value of the Concept is placed in the Key Value.
382 382  )))
383 -|TimeKeyValue|(((
363 +|(% style="width:182px" %)TimeKeyValue|(% style="width:210px" %)(((
384 384  Inherits from
385 -
386 386  //KeyValue//
387 -)))|The value of the Time Dimension component of the key.
388 -|CodedKeyValue|(((
366 +)))|(% style="width:617px" %)The value of the Time Dimension component of the key.
367 +|(% style="width:182px" %)CodedKeyValue|(% style="width:210px" %)(((
389 389  Inherits from
390 -
391 391  //KeyValue//
392 -)))|The value of a coded component of the key. The value is the Code to which this class is associated.
393 -| |+value|(((
370 +)))|(% style="width:617px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
371 +|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
394 394  Association to the Code.
395 -
396 -Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Dimension in the Data
397 -
398 -Structure Definition. In the actual Data Set the value of the Code is placed in the Key Value.
373 +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.
399 399  )))
400 -|UnCodedKeyValue|(((
375 +|(% style="width:182px" %)UnCodedKeyValue|(% style="width:210px" %)(((
401 401  Inherits from
402 -
403 403  //KeyValue//
404 -)))|The value of an uncoded component of the key.
405 -| |value|The value of the key component.
406 -| |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).
407 -| |+valueFor|Associates Dimension, Measure Dimension, or Time Dimension to the Key Value, and thereby to the Concept that is the semantic of the Dimension, or Time Dimension.
408 -|GroupKey|(((
378 +)))|(% style="width:617px" %)The value of an uncoded component of the key.
379 +|(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the key component.
380 +|(% style="width:182px" %) |(% style="width:210px" %)startTime|(% style="width:617px" %)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).
381 +|(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)Associates Dimension, Measure Dimension, or Time Dimension to the Key Value, and thereby to the Concept that is the semantic of the Dimension, or Time Dimension.
382 +|(% style="width:182px" %)GroupKey|(% style="width:210px" %)(((
409 409  Inherits from
410 410  
411 411  Key
412 -)))|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.
413 -| |+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
414 -|SeriesKey|(((
386 +)))|(% style="width:617px" %)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.
387 +|(% style="width:182px" %) |(% style="width:210px" %)+describedBy|(% style="width:617px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
388 +|(% style="width:182px" %)SeriesKey|(% style="width:210px" %)(((
415 415  Inherits from
416 -
417 417  Key
418 -)))|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.
419 -| |+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
420 -|Observation| |The value of the observed phenomenon in the context of the Key Values comprising the key.
421 -| |+valueFor|Associates the Primary Measure defined in the Data Structure Definition.
422 -| |+attachedAttribute|Association to the Attribute Values relating to the Observation.
423 -| |+observationDimension|Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
424 -|//ObservationValue//|(((
391 +)))|(% style="width:617px" %)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.
392 +|(% style="width:182px" %) |(% style="width:210px" %)+describedBy|(% style="width:617px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
393 +|(% style="width:182px" %)Observation|(% style="width:210px" %) |(% style="width:617px" %)The value of the observed phenomenon in the context of the Key Values comprising the key.
394 +|(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)Associates the Primary Measure defined in the Data Structure Definition.
395 +|(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Observation.
396 +|(% style="width:182px" %) |(% style="width:210px" %)+observationDimension|(% style="width:617px" %)Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
397 +|(% style="width:182px" %)//ObservationValue//|(% style="width:210px" %)(((
425 425  Abstract class
426 -
427 427  Sub classes
428 -
429 429  UncodedObservation
430 -
431 431  CodedObservation
432 -)))|
433 -|UncodedObservation|(((
402 +)))|(% style="width:617px" %)
403 +|(% style="width:182px" %)UncodedObservation|(% style="width:210px" %)(((
434 434  Inherits from
435 -
436 436  ObservationValue
437 -)))|An observation that has a text value.
438 -| |value|The value of the Uncoded Observation.
439 -|CodedObservation|(((
406 +)))|(% style="width:617px" %)An observation that has a text value.
407 +|(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the Uncoded Observation.
408 +|(% style="width:182px" %)CodedObservation|(% style="width:210px" %)(((
440 440  Inherits from
441 -
442 442  ObservationValue
443 -)))|An Observation that takes its value from a code in a Code list.
444 -| |+value|(((
411 +)))|(% style="width:617px" %)An Observation that takes its value from a code in a Code list.
412 +|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
445 445  Association to the Code that is the value of the Observation.
446 -
447 -Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Primary Measure or the Concept of the Measure Dimension in the Data
448 -
449 -Structure Definition. In the actual Data Set the value of the Code is placed in the Observation.
414 +Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Primary Measure or the Concept of the Measure Dimension in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Observation.
450 450  )))
451 -|//AttributeValue//|(((
416 +|(% style="width:182px" %)//AttributeValue//|(% style="width:210px" %)(((
452 452  Abstract class
453 -
454 454  Sub classes
455 -
456 -//UncodedAttributeValue//
457 -
458 -//CodedAttributeValue//
459 -)))|The value of an attribute, such as the instance of a Coded Attribute or of an Uncoded Attribute in a structure such as a Data Structure Definition.
460 -| |value|The value of the attribute.
461 -| |+valueFor|(((
419 +//UncodedAttributeValue
420 +CodedAttributeValue//
421 +)))|(% style="width:617px" %)The value of an attribute, such as the instance of a Coded Attribute or of an Uncoded Attribute in a structure such as a Data Structure Definition.
422 +|(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the attribute.
423 +|(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)(((
462 462  Association to the Data Attribute defined in the Data Structure Definition.
463 -
464 464  Note that this is conceptual association as the Concept is identified explicitly in the data set.
465 465  )))
466 -|//UncodedAttribute Value//|(((
427 +|(% style="width:182px" %)//UncodedAttribute Value//|(% style="width:210px" %)(((
467 467  Inherits from
468 -
469 469  //AttributeValue//
470 -)))|An attribute value that has a text value.
471 -| |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).
472 -|(((
430 +)))|(% style="width:617px" %)An attribute value that has a text value.
431 +|(% style="width:182px" %) |(% style="width:210px" %)startTime|(% style="width:617px" %)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).
432 +|(% style="width:182px" %)(((
473 473  CodedAttribute
474 474  
475 475  Value
476 -)))|(((
436 +)))|(% style="width:210px" %)(((
477 477  Inherits from
478 -
479 479  //AttributeValue//
480 -)))|An attribute that takes it value from a Code in Code list.
481 -| |+value|(((
439 +)))|(% style="width:617px" %)An attribute that takes it value from a Code in Code list.
440 +|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
482 482  Association to the Code that is the value of the Attribute Value.
483 -
484 484  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.
485 485  )))
486 486