Changes for page 5 Data Structure Definition and Dataset

Summary

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

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
...	...	@@ -302,167 +302,205 @@
302	302
303	303	==== 5.4.3.2 Definitions ====
304	304
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" %)(((
	317	+|**Class**|**Feature**|**Description**
	318	+|//DataSet//|(((
308	308	Abstract Class
	320	+
309	309	Sub classes
	322	+
310	310	StructureSpecificData
	324	+
311	311	Set
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" %)(((
	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|(((
323	323	Associates a Dataflow and thereby a Data Structure
324	324
325	325	Definition to the data set.
326	326	)))
327		-|(% style="width:200px" %) |(% style="width:285px" %)+structuredBy|(% style="width:454px" %)(((
	341	+| |+structuredBy|(((
328	328	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
329	329
330	330	(non-mandatory) to the Dataflow.
331	331	)))
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" %)(((
	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//|(((
335	335	Abstract class
	350	+
336	336	Sub classes
	352	+
337	337	SeriesKey
	354	+
338	338	GroupKey
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" %)(((
	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//|(((
343	343	Abstract class
	361	+
344	344	Sub classes
	363	+
345	345	TimeKeyValue
	365	+
346	346	CodedKeyValue
	367	+
347	347	UncodedKeyValue
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" %)(((
	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|(((
350	350	Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
	372	+
351	351	Note that this is conceptual association as the key component is identified explicitly in the data set.
352	352	)))
353		-|(% style="width:200px" %)TimeKeyValue|(% style="width:285px" %)(((
	375	+|TimeKeyValue|(((
354	354	Inherits from
	377	+
355	355	//KeyValue//
356		-)))|(% style="width:454px" %)The value of the Time Dimension component of the key.
357		-|(% style="width:200px" %)CodedKeyValue|(% style="width:285px" %)(((
	379	+)))|The value of the Time Dimension component of the key.
	380	+|CodedKeyValue|(((
358	358	Inherits from
	382	+
359	359	//KeyValue//
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" %)(((
	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|(((
363	363	Inherits from
	388	+
364	364	//KeyValue//
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" %)(((
	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|(((
369	369	Inherits from
	395	+
370	370	//Key//
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" %)(((
	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|(((
374	374	Inherits from
	401	+
375	375	//Key//
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" %)(((
	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|(((
380	380	Associates the Measure(s) defined in the Data Structure Definition.
381	381
382	382	The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it.
383	383	)))
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" %)(((
	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//|(((
387	387	Abstract class
388	388
389	389	Sub classes
390	390
391		-//UncodedObservationValue//
	418	+//UncodedObservationVal ue//
392	392
393	393	CodedObservation
394		-)))|(% style="width:454px" %)
395		-|(% style="width:200px" %)//UncodedObservationValue//|(% style="width:285px" %)(((
	421	+)))|
	422	+|//UncodedObservatio nValue//|(((
396	396	Abstract class
	424	+
397	397	Inherits from
	426	+
398	398	//ObservationValue//
	428	+
399	399	Sub classes
400		-OtherUncodedMeasureValue
	430	+
	431	+OtherUncodedMeasureVa lue
	432	+
401	401	TextMeasureValue
402		-)))|(% style="width:454px" %)
403		-|(% style="width:200px" %)OtherUncodedMeasureValue|(% style="width:285px" %)(((
	434	+)))|
	435	+|OtherUncodedMeasu reValue|(((
404	404	Inherits from
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" %)(((
	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|(((
410	410	Inherits from
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" %)(((
	444	+
	445	+//UncodedObservationVal ue//
	446	+)))|An observation that has a localised text value
	447	+| |text|The localised text values.
	448	+|CodedObservation|(((
415	415	Inherits from
	450	+
416	416	//ObservationValue//
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" %)(((
	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//|(((
420	420	Abstract class
	456	+
421	421	Sub classes
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" %)(((
	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//|(((
425	425	Abstract class
	463	+
426	426	Inherits from
	465	+
427	427	//AttributeValue//
	467	+
428	428	Sub classes
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" %)(((
	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|(((
433	433	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.
434	434
435	435	The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it.
436	436	)))
437		-|(% style="width:200px" %)//MetadataAttributeValue//|(% style="width:285px" %)(((
	479	+|//MetadataAttribute Value//|(((
438	438	(explained further in section
439	439
440	440	“Metadata Set”)
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" %)(((
	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//|(((
443	443	Inherits from
	486	+
444	444	//AttributeValue//
	488	+
445	445	Sub classes
	490	+
446	446	OtherUncodedAttribute
	492	+
447	447	Value
	494	+
448	448	TextAttributeValue
449		-)))|(% style="width:454px" %)
450		-|(% style="width:200px" %)OtherUncodedAttributeValue|(% style="width:285px" %)(((
	496	+)))|
	497	+|OtherUncodedAttri buteValue|(((
451	451	Inherits from
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" %)(((
	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|(((
457	457	Inherits from
	506	+
458	458	//UncodedAttributeValue//
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" %)(((
	508	+)))|An attribute that has a localised text value
	509	+| |text|The localised text values.
	510	+|CodedAttributeVal ue|(((
462	462	Inherits from
	512	+
463	463	//AttributeValue//
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.
	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.
466	466
467	467	----
468	468