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,15 +54,18 @@
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:
64	64
65	65	Dataflow
	78	+
66	66	DataStructureDefinition
67	67
68	68	The component structures that are lists of lists, inherit directly from //Structure//. A //Structure// contains several lists of components. The concrete class that inherits from //Structure// is:
...	...	@@ -74,8 +74,11 @@
74	74	The concrete classes which inherit from //ComponentList// and are subcomponents of the DataStructureDefinition are:
75	75
76	76	DimensionDescriptor – content is Dimension and TimeDimension
	90	+
77	77	DimensionGroupDescriptor – content is an association to Dimension, TimeDimension
	92	+
78	78	MeasureDescriptor – content is Measure
	94	+
79	79	AttributeDescriptor – content is DataAttribute and an association to MetadataAttribute
80	80
81	81	The classes that inherit from //Component// are:
...	...	@@ -83,6 +83,7 @@
83	83	Measure
84	84
85	85	//DimensionComponent// and thereby its sub classes of Dimension and TimeDimension
	102	+
86	86	//Attribute// and thereby its sub classes of DataAttribute and MetadataAttribute
87	87
88	88	The concrete classes identified above are the majority of the classes required to define the metamodel for the DataStructureDefinition. The diagrams and explanations in the rest of this section show how these concrete classes are related in order to support the functionality required.
...	...	@@ -310,9 +310,8 @@
310	310
311	311	==== 5.4.3.2 Definitions ====
312	312
313		-(% style="width:812.039px" %)
314		-|(% style="width:147px" %)**Class**|(% style="width:222px" %)**Feature**|(% style="width:437px" %)**Description**
315		-|(% style="width:147px" %)//DataSet//|(% style="width:222px" %)(((
	330	+|**Class**|**Feature**|**Description**
	331	+|//DataSet//|(((
316	316	Abstract Class
317	317
318	318	Sub classes
...	...	@@ -320,30 +320,30 @@
320	320	StructureSpecificData
321	321
322	322	Set
323		-)))|(% style="width:437px" %)An organised collection of data.
324		-|(% style="width:147px" %) |(% style="width:222px" %)reportingBegin|(% style="width:437px" %)A specific time period in a known system of time periods that identifies the start period of a report.
325		-|(% style="width:147px" %) |(% style="width:222px" %)reportingEnd|(% style="width:437px" %)A specific time period in a known system of time periods that identifies the end period of a report.
326		-|(% style="width:147px" %) |(% style="width:222px" %)dataExtractionDate|(% style="width:437px" %)A specific time period that identifies the date and time that the data are extracted from a data source.
327		-|(% style="width:147px" %) |(% style="width:222px" %)validFrom|(% style="width:437px" %)Indicates the inclusive start time indicating the validity of the information in the data set.
328		-|(% style="width:147px" %) |(% style="width:222px" %)validTo|(% style="width:437px" %)Indicates the inclusive end time indicating the validity of the information in the data set.
329		-|(% style="width:147px" %) |(% style="width:222px" %)publicationYear|(% style="width:437px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
330		-|(% style="width:147px" %) |(% style="width:222px" %)publicationPeriod|(% style="width:437px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
331		-|(% style="width:147px" %) |(% style="width:222px" %)setId|(% style="width:437px" %)Provides an identification of the data set.
332		-|(% style="width:147px" %) |(% style="width:222px" %)action|(% style="width:437px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
333		-|(% style="width:147px" %) |(% style="width:222px" %)describedBy|(% style="width:437px" %)Associates a Dataflow and thereby a Data Structure Definition to the data set.
334		-|(% style="width:147px" %) |(% style="width:222px" %)+structuredBy|(% style="width:437px" %)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 (non-mandatory) to the Dataflow.
335		-|(% style="width:147px" %) |(% style="width:222px" %)+publishedBy|(% style="width:437px" %)Associates the Data Provider that reports/publishes the data.
336		-|(% style="width:147px" %)StructureSpecific DataSet|(% style="width:222px" %) |(% style="width:437px" %)An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
337		-|(% style="width:147px" %)//Key//|(% style="width:222px" %)(((
	339	+)))|An organised collection of data.
	340	+| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
	341	+| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
	342	+| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
	343	+| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
	344	+| |validTo|Indicates the inclusive end time indicating the validity of the information in the data set.
	345	+| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
	346	+| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
	347	+| |setId|Provides an identification of the data set.
	348	+| |action|Defines the action to be taken by the recipient system (information, append, replace, delete)
	349	+| |describedBy|Associates a Dataflow and thereby a Data Structure Definition to the data set.
	350	+| |+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 (non-mandatory) to the Dataflow.
	351	+| |+publishedBy|Associates the Data Provider that reports/publishes the data.
	352	+|StructureSpecific DataSet| |An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
	353	+|//Key//|(((
338	338	Abstract class Sub classes
339	339
340	340	SeriesKey
341	341
342	342	GroupKey
343		-)))|(% style="width:437px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
344		-|(% style="width:147px" %) |(% style="width:222px" %)keyValues|(% style="width:437px" %)Association to the individual Key Values that comprise the Key.
345		-|(% style="width:147px" %) |(% style="width:222px" %)+attachedAttribute|(% style="width:437px" %)Association to the Attribute Values relating to the Series Key or Group Key.
346		-|(% style="width:147px" %)//KeyValue//|(% style="width:222px" %)(((
	359	+)))|Comprises the cross product of values of dimensions that identify uniquely an Observation.
	360	+| |keyValues|Association to the individual Key Values that comprise the Key.
	361	+| |+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
	362	+|//KeyValue//|(((
347	347	Abstract class Sub classes
348	348
349	349	TimeKeyValue
...	...	@@ -351,50 +351,51 @@
351	351	CodedKeyValue
352	352
353	353	UncodedKeyValue
354		-)))|(% style="width:437px" %)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.
355		-|(% style="width:147px" %) |(% style="width:222px" %)+valueFor|(% style="width:437px" %)(((
	370	+)))|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.
	371	+| |+valueFor|(((
356	356	Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
	373	+
357	357	Note that this is conceptual association as the key component is identified explicitly in the data set.
358	358	)))
359		-|(% style="width:147px" %)TimeKeyValue|(% style="width:222px" %)(((
	376	+|TimeKeyValue|(((
360	360	Inherits from
361	361
362	362	//KeyValue//
363		-)))|(% style="width:437px" %)The value of the Time Dimension component of the key.
364		-|(% style="width:147px" %)CodedKeyValue|(% style="width:222px" %)(((
	380	+)))|The value of the Time Dimension component of the key.
	381	+|CodedKeyValue|(((
365	365	Inherits from
366	366
367	367	//KeyValue//
368		-)))|(% style="width:437px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
369		-|(% style="width:147px" %) |(% style="width:222px" %)+valueOf|(% style="width:437px" %)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.
370		-|(% style="width:147px" %)UnCodedKeyValue|(% style="width:222px" %)(((
	385	+)))|The value of a coded component of the key. The value is the Code to which this class is associated.
	386	+| |+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.
	387	+|UnCodedKeyValue|(((
371	371	Inherits from
372	372
373	373	//KeyValue//
374		-)))|(% style="width:437px" %)The value of an uncoded component of the key.
375		-|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the key component.
376		-|(% style="width:147px" %) |(% style="width:222px" %)startTime|(% style="width:437px" %)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).
377		-|(% style="width:147px" %)GroupKey|(% style="width:222px" %)(((
	391	+)))|The value of an uncoded component of the key.
	392	+| |value|The value of the key component.
	393	+| |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).
	394	+|GroupKey|(((
378	378	Inherits from
379	379
380	380	//Key//
381		-)))|(% style="width:437px" %)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.
382		-|(% style="width:147px" %) |(% style="width:222px" %)+describedBy|(% style="width:437px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
383		-|(% style="width:147px" %)SeriesKey|(% style="width:222px" %)(((
	398	+)))|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.
	399	+| |+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
	400	+|SeriesKey|(((
384	384	Inherits from
385	385
386	386	//Key//
387		-)))|(% style="width:437px" %)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.
388		-|(% style="width:147px" %) |(% style="width:222px" %)+describedBy|(% style="width:437px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
389		-|(% style="width:147px" %)Observation|(% style="width:222px" %) |(% style="width:437px" %)The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
390		-|(% style="width:147px" %) |(% style="width:222px" %)+valueFor|(% style="width:437px" %)(((
	404	+)))|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.
	405	+| |+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
	406	+|Observation| |The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
	407	+| |+valueFor|(((
391	391	Associates the Measure(s) defined in the Data Structure Definition.
392	392
393	393	The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it.
394	394	)))
395		-|(% style="width:147px" %) |(% style="width:222px" %)+attachedAttribute|(% style="width:437px" %)Association to the Attribute Values relating to the Observation.
396		-|(% style="width:147px" %) |(% style="width:222px" %)+observationDimension|(% style="width:437px" %)Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
397		-|(% style="width:147px" %)//ObservationValue//|(% style="width:222px" %)(((
	412	+| |+attachedAttribute|Association to the Attribute Values relating to the Observation.
	413	+| |+observationDimension|Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
	414	+|//ObservationValue//|(((
398	398	Abstract class
399	399
400	400	Sub classes
...	...	@@ -404,8 +404,8 @@
404	404	//ue//
405	405
406	406	CodedObservation
407		-)))|(% style="width:437px" %)
408		-|(% style="width:147px" %)//UncodedObservatio nValue//|(% style="width:222px" %)(((
	424	+)))|
	425	+|//UncodedObservatio nValue//|(((
409	409	Abstract class
410	410
411	411	Inherits from
...	...	@@ -417,34 +417,34 @@
417	417	OtherUncodedMeasureVa lue
418	418
419	419	TextMeasureValue
420		-)))|(% style="width:437px" %)
421		-|(% style="width:147px" %)OtherUncodedMeasu reValue|(% style="width:222px" %)(((
	437	+)))|
	438	+|OtherUncodedMeasu reValue|(((
422	422	Inherits from
423	423
424	424	//UncodedObservationVal ue//
425		-)))|(% style="width:437px" %)An observation that has a text value.
426		-|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the Uncoded Observation.
427		-|(% style="width:147px" %) |(% style="width:222px" %)startTime|(% style="width:437px" %)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).
428		-|(% style="width:147px" %)TextMeasureValue|(% style="width:222px" %)(((
	442	+)))|An observation that has a text value.
	443	+| |value|The value of the Uncoded Observation.
	444	+| |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).
	445	+|TextMeasureValue|(((
429	429	Inherits from
430	430
431	431	//UncodedObservationVal ue//
432		-)))|(% style="width:437px" %)An observation that has a localised text value
433		-|(% style="width:147px" %) |(% style="width:222px" %)text|(% style="width:437px" %)The localised text values.
434		-|(% style="width:147px" %)CodedObservation|(% style="width:222px" %)(((
	449	+)))|An observation that has a localised text value
	450	+| |text|The localised text values.
	451	+|CodedObservation|(((
435	435	Inherits from
436	436
437	437	//ObservationValue//
438		-)))|(% style="width:437px" %)An Observation that takes its value from a code in a Code list.
439		-|(% style="width:147px" %) |(% style="width:222px" %)+valueOf|(% style="width:437px" %)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.
440		-|(% style="width:147px" %)//AttributeValue//|(% style="width:222px" %)(((
	455	+)))|An Observation that takes its value from a code in a Code list.
	456	+| |+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.
	457	+|//AttributeValue//|(((
441	441	Abstract class
442	442
443	443	Sub classes
444	444
445	445	//DataAttributeValue// //MetadataAttributeValu e//
446		-)))|(% style="width:437px" %)Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
447		-|(% style="width:147px" %)//DataAttributeValu e//|(% style="width:222px" %)(((
	463	+)))|Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
	464	+|//DataAttributeValu e//|(((
448	448	Abstract class
449	449
450	450	Inherits from
...	...	@@ -456,21 +456,22 @@
456	456	//UncodedAttributeValue//
457	457
458	458	//CodedAttributeValue//
459		-)))|(% style="width:437px" %)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.
460		-|(% style="width:147px" %) |(% style="width:222px" %)+valueFor|(% style="width:437px" %)(((
	476	+)))|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.
	477	+| |+valueFor|(((
461	461	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.
	479	+
462	462	The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it.
463	463	)))
464		-|(% style="width:147px" %)//MetadataAttribute Value//|(% style="width:222px" %)(((
	482	+|//MetadataAttribute Value//|(((
465	465	(explained further in section
466	466
467	467	“Metadata Set”)
468		-)))|(% style="width:437px" %)(((
	486	+)))|(((
469	469	The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure
470	470
471	471	Definition
472	472	)))
473		-|(% style="width:147px" %)//UncodedAttributeV alue//|(% style="width:222px" %)(((
	491	+|//UncodedAttributeV alue//|(((
474	474	Inherits from
475	475
476	476	//AttributeValue//
...	...	@@ -480,25 +480,27 @@
480	480	OtherUncodedAttribute Value
481	481
482	482	TextAttributeValue
483		-)))|(% style="width:437px" %)
484		-|(% style="width:147px" %)OtherUncodedAttri buteValue|(% style="width:222px" %)(((
	501	+)))|
	502	+|OtherUncodedAttri buteValue|(((
485	485	Inherits from
486	486
487	487	//UncodedObservationVal ue//
488		-)))|(% style="width:437px" %)An attribute value that has a text value
489		-|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the Uncoded attribute.
490		-|(% style="width:147px" %) |(% style="width:222px" %)startTime|(% style="width:437px" %)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).
491		-|(% style="width:147px" %)TextAttributeValu e|(% style="width:222px" %)(((
	506	+)))|An attribute value that has a text value
	507	+| |value|The value of the Uncoded attribute.
	508	+| |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).
	509	+|TextAttributeValu e|(((
492	492	Inherits from
493	493
494	494	//UncodedAttributeValue//
495		-)))|(% style="width:437px" %)An attribute that has a localised text value
496		-|(% style="width:147px" %) |(% style="width:222px" %)text|(% style="width:437px" %)The localised text values.
497		-|(% style="width:147px" %)CodedAttributeVal ue|(% style="width:222px" %)(((
	513	+)))|An attribute that has a localised text value
	514	+| |text|The localised text values.
	515	+|CodedAttributeVal ue|(((
498	498	Inherits from
499	499
500	500	//AttributeValue//
501		-)))|(% style="width:437px" %)An attribute that takes it value from a Code in Code list.
502		-|(% style="width:147px" %) |(% style="width:222px" %)+valueOf|(% style="width:437px" %)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.
	519	+)))|An attribute that takes it value from a Code in Code list.
	520	+| |+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.
503	503
	522	+
	523	+
504	504