Changes for page 5 Data Structure Definition and Dataset

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -13,13 +13,9 @@
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		-
17	17	Identification – //IdentifiableArtefact//
18		-
19	19	Naming – //NameableArtefact//
20		-
21	21	Versioning – //VersionableArtefact//
22		-
23	23	Maintenance – //MaintainableArtefact//
24	24
25	25	== 5.2 Inheritance View ==
...	...	@@ -36,28 +36,22 @@
36	36
37	37	Those classes in the SDMX metamodel which require annotations inherit from //AnnotableArtefact//. These are:
38	38
39		-//IdentifiableArtefact//
40		-
41		-//DataSet//
42		-
43		-//Key// (and therefore //SeriesKey// and //GroupKey//)
44		-
	35	+//IdentifiableArtefact
	36	+DataSet
	37	+Key// (and therefore //SeriesKey// and //GroupKey//)
45	45	//Observation//
46	46
47	47	Those classes in the SDMX metamodel which require annotations and global identity are derived from //IdentifiableArtefact//. These are:
48	48
49		-//NameableArtefact//
	42	+//NameableArtefact
	43	+ComponentList
	44	+Component//
50	50
51		-//ComponentList//
52		-
53		-//Component//
54		-
55	55	Those classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description are derived from //NameableArtefact//. These are:
56	56
57		-//VersionableArtefact//
	48	+//VersionableArtefact
	49	+Item//
58	58
59		-//Item//
60		-
61	61	The classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact//. These are:
62	62
63	63	//MaintainableArtefact//
...	...	@@ -64,12 +64,10 @@
64	64
65	65	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:
66	66
67		-//StructureUsage//
	57	+//StructureUsage
	58	+Structure
	59	+ItemScheme//
68	68
69		-//Structure//
70		-
71		-//ItemScheme//
72		-
73	73	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.
74	74
75	75	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:
...	...	@@ -278,11 +278,11 @@
278	278
279	279	==== //5.4 Data Set – Relationship View// ====
280	280
281		-===== 5.4.1 Context =====
	269	+=== 5.4.1 Context ===
282	282
283	283	A data set comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition.
284	284
285		-===== 5.4.2 Class Diagram =====
	273	+=== 5.4.2 Class Diagram ===
286	286
287	287	[[image:1749246368794-672.jpeg]]
288	288
...	...	@@ -314,205 +314,167 @@
314	314
315	315	==== 5.4.3.2 Definitions ====
316	316
317		-|**Class**|**Feature**|**Description**
318		-|//DataSet//|(((
	305	+(% style="width:964.835px" %)
	306	+|(% style="width:200px" %)**Class**|(% style="width:285px" %)**Feature**|(% style="width:454px" %)**Description**
	307	+|(% style="width:200px" %)//DataSet//|(% style="width:285px" %)(((
319	319	Abstract Class
320		-
321	321	Sub classes
322		-
323	323	StructureSpecificData
324		-
325	325	Set
326		-)))|An organised collection of data.
327		-| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
328		-| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
329		-| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
330		-| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
331		-| |validTo|Indicates the inclusive end time indicating the validity of the information in the data set.
332		-| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
333		-| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
334		-| |setId|Provides an identification of the data set.
335		-| |action|Defines the action to be taken by the recipient system (information, append, replace, delete)
336		-| |describedBy|(((
	312	+)))|(% style="width:454px" %)An organised collection of data.
	313	+|(% style="width:200px" %) |(% style="width:285px" %)reportingBegin|(% style="width:454px" %)A specific time period in a known system of time periods that identifies the start period of a report.
	314	+|(% style="width:200px" %) |(% style="width:285px" %)reportingEnd|(% style="width:454px" %)A specific time period in a known system of time periods that identifies the end period of a report.
	315	+|(% style="width:200px" %) |(% style="width:285px" %)dataExtractionDate|(% style="width:454px" %)A specific time period that identifies the date and time that the data are extracted from a data source.
	316	+|(% style="width:200px" %) |(% style="width:285px" %)validFrom|(% style="width:454px" %)Indicates the inclusive start time indicating the validity of the information in the data set.
	317	+|(% style="width:200px" %) |(% style="width:285px" %)validTo|(% style="width:454px" %)Indicates the inclusive end time indicating the validity of the information in the data set.
	318	+|(% style="width:200px" %) |(% style="width:285px" %)publicationYear|(% style="width:454px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
	319	+|(% style="width:200px" %) |(% style="width:285px" %)publicationPeriod|(% style="width:454px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
	320	+|(% style="width:200px" %) |(% style="width:285px" %)setId|(% style="width:454px" %)Provides an identification of the data set.
	321	+|(% style="width:200px" %) |(% style="width:285px" %)action|(% style="width:454px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
	322	+|(% style="width:200px" %) |(% style="width:285px" %)describedBy|(% style="width:454px" %)(((
337	337	Associates a Dataflow and thereby a Data Structure
338	338
339	339	Definition to the data set.
340	340	)))
341		-| |+structuredBy|(((
	327	+|(% style="width:200px" %) |(% style="width:285px" %)+structuredBy|(% style="width:454px" %)(((
342	342	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
343	343
344	344	(non-mandatory) to the Dataflow.
345	345	)))
346		-| |+publishedBy|Associates the Data Provider that reports/publishes the data.
347		-|StructureSpecific DataSet| |An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
348		-|//Key//|(((
	332	+|(% style="width:200px" %) |(% style="width:285px" %)+publishedBy|(% style="width:454px" %)Associates the Data Provider that reports/publishes the data.
	333	+|(% style="width:200px" %)StructureSpecificDataSet|(% style="width:285px" %) |(% style="width:454px" %)An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
	334	+|(% style="width:200px" %)//Key//|(% style="width:285px" %)(((
349	349	Abstract class
350		-
351	351	Sub classes
352		-
353	353	SeriesKey
354		-
355	355	GroupKey
356		-)))|Comprises the cross product of values of dimensions that identify uniquely an Observation.
357		-| |keyValues|Association to the individual Key Values that comprise the Key.
358		-| |+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
359		-|//KeyValue//|(((
	339	+)))|(% style="width:454px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
	340	+|(% style="width:200px" %) |(% style="width:285px" %)keyValues|(% style="width:454px" %)Association to the individual Key Values that comprise the Key.
	341	+|(% style="width:200px" %) |(% style="width:285px" %)+attachedAttribute|(% style="width:454px" %)Association to the Attribute Values relating to the Series Key or Group Key.
	342	+|(% style="width:200px" %)//KeyValue//|(% style="width:285px" %)(((
360	360	Abstract class
361		-
362	362	Sub classes
363		-
364	364	TimeKeyValue
365		-
366	366	CodedKeyValue
367		-
368	368	UncodedKeyValue
369		-)))|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.
370		-| |+valueFor|(((
	348	+)))|(% style="width:454px" %)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.
	349	+|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)(((
371	371	Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
372		-
373	373	Note that this is conceptual association as the key component is identified explicitly in the data set.
374	374	)))
375		-|TimeKeyValue|(((
	353	+|(% style="width:200px" %)TimeKeyValue|(% style="width:285px" %)(((
376	376	Inherits from
377		-
378	378	//KeyValue//
379		-)))|The value of the Time Dimension component of the key.
380		-|CodedKeyValue|(((
	356	+)))|(% style="width:454px" %)The value of the Time Dimension component of the key.
	357	+|(% style="width:200px" %)CodedKeyValue|(% style="width:285px" %)(((
381	381	Inherits from
382		-
383	383	//KeyValue//
384		-)))|The value of a coded component of the key. The value is the Code to which this class is associated.
385		-| |+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.
386		-|UnCodedKeyValue|(((
	360	+)))|(% style="width:454px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
	361	+|(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)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.
	362	+|(% style="width:200px" %)UnCodedKeyValue|(% style="width:285px" %)(((
387	387	Inherits from
388		-
389	389	//KeyValue//
390		-)))|The value of an uncoded component of the key.
391		-| |value|The value of the key component.
392		-| |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).
393		-|GroupKey|(((
	365	+)))|(% style="width:454px" %)The value of an uncoded component of the key.
	366	+|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the key component.
	367	+|(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)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).
	368	+|(% style="width:200px" %)GroupKey|(% style="width:285px" %)(((
394	394	Inherits from
395		-
396	396	//Key//
397		-)))|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.
398		-| |+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
399		-|SeriesKey|(((
	371	+)))|(% style="width:454px" %)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.
	372	+|(% style="width:200px" %) |(% style="width:285px" %)+describedBy|(% style="width:454px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
	373	+|(% style="width:200px" %)SeriesKey|(% style="width:285px" %)(((
400	400	Inherits from
401		-
402	402	//Key//
403		-)))|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.
404		-| |+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
405		-|Observation| |The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
406		-| |+valueFor|(((
	376	+)))|(% style="width:454px" %)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.
	377	+|(% style="width:200px" %) |(% style="width:285px" %)+describedBy|(% style="width:454px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
	378	+|(% style="width:200px" %)Observation|(% style="width:285px" %) |(% style="width:454px" %)The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
	379	+|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)(((
407	407	Associates the Measure(s) defined in the Data Structure Definition.
408	408
409	409	The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it.
410	410	)))
411		-| |+attachedAttribute|Association to the Attribute Values relating to the Observation.
412		-| |+observationDimension|Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
413		-|//ObservationValue//|(((
	384	+|(% style="width:200px" %) |(% style="width:285px" %)+attachedAttribute|(% style="width:454px" %)Association to the Attribute Values relating to the Observation.
	385	+|(% style="width:200px" %) |(% style="width:285px" %)+observationDimension|(% style="width:454px" %)Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
	386	+|(% style="width:200px" %)//ObservationValue//|(% style="width:285px" %)(((
414	414	Abstract class
415	415
416	416	Sub classes
417	417
418		-//UncodedObservationVal ue//
	391	+//UncodedObservationValue//
419	419
420	420	CodedObservation
421		-)))|
422		-|//UncodedObservatio nValue//|(((
	394	+)))|(% style="width:454px" %)
	395	+|(% style="width:200px" %)//UncodedObservationValue//|(% style="width:285px" %)(((
423	423	Abstract class
424		-
425	425	Inherits from
426		-
427	427	//ObservationValue//
428		-
429	429	Sub classes
430		-
431		-OtherUncodedMeasureVa lue
432		-
	400	+OtherUncodedMeasureValue
433	433	TextMeasureValue
434		-)))|
435		-|OtherUncodedMeasu reValue|(((
	402	+)))|(% style="width:454px" %)
	403	+|(% style="width:200px" %)OtherUncodedMeasureValue|(% style="width:285px" %)(((
436	436	Inherits from
437		-
438		-//UncodedObservationVal ue//
439		-)))|An observation that has a text value.
440		-| |value|The value of the Uncoded Observation.
441		-| |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).
442		-|TextMeasureValue|(((
	405	+//UncodedObservationValue//
	406	+)))|(% style="width:454px" %)An observation that has a text value.
	407	+|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the Uncoded Observation.
	408	+|(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)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).
	409	+|(% style="width:200px" %)TextMeasureValue|(% style="width:285px" %)(((
443	443	Inherits from
444		-
445		-//UncodedObservationVal ue//
446		-)))|An observation that has a localised text value
447		-| |text|The localised text values.
448		-|CodedObservation|(((
	411	+//UncodedObservationValue//
	412	+)))|(% style="width:454px" %)An observation that has a localised text value
	413	+|(% style="width:200px" %) |(% style="width:285px" %)text|(% style="width:454px" %)The localised text values.
	414	+|(% style="width:200px" %)CodedObservation|(% style="width:285px" %)(((
449	449	Inherits from
450		-
451	451	//ObservationValue//
452		-)))|An Observation that takes its value from a code in a Code list.
453		-| |+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.
454		-|//AttributeValue//|(((
	417	+)))|(% style="width:454px" %)An Observation that takes its value from a code in a Code list.
	418	+|(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)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.
	419	+|(% style="width:200px" %)//AttributeValue//|(% style="width:285px" %)(((
455	455	Abstract class
456		-
457	457	Sub classes
458		-
459		-//DataAttributeValue// //MetadataAttributeValu e//
460		-)))|Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
461		-|//DataAttributeValu e//|(((
	422	+//DataAttributeValue// //MetadataAttributeValue//
	423	+)))|(% style="width:454px" %)Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
	424	+|(% style="width:200px" %)//DataAttributeValue//|(% style="width:285px" %)(((
462	462	Abstract class
463		-
464	464	Inherits from
465		-
466	466	//AttributeValue//
467		-
468	468	Sub classes
469		-
470		-//UncodedAttributeValue//
471		-
472		-//CodedAttributeValue//
473		-)))|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.
474		-| |+valueFor|(((
	429	+//UncodedAttributeValue
	430	+CodedAttributeValue//
	431	+)))|(% style="width:454px" %)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.
	432	+|(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)(((
475	475	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.
476	476
477	477	The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it.
478	478	)))
479		-|//MetadataAttribute Value//|(((
	437	+|(% style="width:200px" %)//MetadataAttributeValue//|(% style="width:285px" %)(((
480	480	(explained further in section
481	481
482	482	“Metadata Set”)
483		-)))|The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition
484		-|//UncodedAttributeV alue//|(((
	441	+)))|(% style="width:454px" %)The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition
	442	+|(% style="width:200px" %)//UncodedAttributeValue//|(% style="width:285px" %)(((
485	485	Inherits from
486		-
487	487	//AttributeValue//
488		-
489	489	Sub classes
490		-
491	491	OtherUncodedAttribute
492		-
493	493	Value
494		-
495	495	TextAttributeValue
496		-)))|
497		-|OtherUncodedAttri buteValue|(((
	449	+)))|(% style="width:454px" %)
	450	+|(% style="width:200px" %)OtherUncodedAttributeValue|(% style="width:285px" %)(((
498	498	Inherits from
499		-
500		-//UncodedObservationVal ue//
501		-)))|An attribute value that has a text value
502		-| |value|The value of the Uncoded attribute.
503		-| |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).
504		-|TextAttributeValu e|(((
	452	+//UncodedObservationValue//
	453	+)))|(% style="width:454px" %)An attribute value that has a text value
	454	+|(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the Uncoded attribute.
	455	+|(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)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).
	456	+|(% style="width:200px" %)TextAttributeValue|(% style="width:285px" %)(((
505	505	Inherits from
506		-
507	507	//UncodedAttributeValue//
508		-)))|An attribute that has a localised text value
509		-| |text|The localised text values.
510		-|CodedAttributeVal ue|(((
	459	+)))|(% style="width:454px" %)An attribute that has a localised text value
	460	+|(% style="width:200px" %) |(% style="width:285px" %)text|(% style="width:454px" %)The localised text values.
	461	+|(% style="width:200px" %)CodedAttributeValue|(% style="width:285px" %)(((
511	511	Inherits from
512		-
513	513	//AttributeValue//
514		-)))|An attribute that takes it value from a Code in Code list.
515		-| |+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.
	464	+)))|(% style="width:454px" %)An attribute that takes it value from a Code in Code list.
	465	+|(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)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.
516	516
517	517	----
518	518