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 ==
...	...	@@ -270,11 +270,11 @@
270	270
271	271	==== //5.4 Data Set – Relationship View// ====
272	272
273		-===== 5.4.1 Context =====
	269	+=== 5.4.1 Context ===
274	274
275	275	A data set comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition.
276	276
277		-===== 5.4.2 Class Diagram =====
	273	+=== 5.4.2 Class Diagram ===
278	278
279	279	[[image:1749246368794-672.jpeg]]
280	280
...	...	@@ -306,205 +306,167 @@
306	306
307	307	==== 5.4.3.2 Definitions ====
308	308
309		-|**Class**|**Feature**|**Description**
310		-|//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" %)(((
311	311	Abstract Class
312		-
313	313	Sub classes
314		-
315	315	StructureSpecificData
316		-
317	317	Set
318		-)))|An organised collection of data.
319		-| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
320		-| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
321		-| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
322		-| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
323		-| |validTo|Indicates the inclusive end time indicating the validity of the information in the data set.
324		-| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
325		-| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
326		-| |setId|Provides an identification of the data set.
327		-| |action|Defines the action to be taken by the recipient system (information, append, replace, delete)
328		-| |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" %)(((
329	329	Associates a Dataflow and thereby a Data Structure
330	330
331	331	Definition to the data set.
332	332	)))
333		-| |+structuredBy|(((
	327	+|(% style="width:200px" %) |(% style="width:285px" %)+structuredBy|(% style="width:454px" %)(((
334	334	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
335	335
336	336	(non-mandatory) to the Dataflow.
337	337	)))
338		-| |+publishedBy|Associates the Data Provider that reports/publishes the data.
339		-|StructureSpecific DataSet| |An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
340		-|//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" %)(((
341	341	Abstract class
342		-
343	343	Sub classes
344		-
345	345	SeriesKey
346		-
347	347	GroupKey
348		-)))|Comprises the cross product of values of dimensions that identify uniquely an Observation.
349		-| |keyValues|Association to the individual Key Values that comprise the Key.
350		-| |+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
351		-|//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" %)(((
352	352	Abstract class
353		-
354	354	Sub classes
355		-
356	356	TimeKeyValue
357		-
358	358	CodedKeyValue
359		-
360	360	UncodedKeyValue
361		-)))|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.
362		-| |+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" %)(((
363	363	Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
364		-
365	365	Note that this is conceptual association as the key component is identified explicitly in the data set.
366	366	)))
367		-|TimeKeyValue|(((
	353	+|(% style="width:200px" %)TimeKeyValue|(% style="width:285px" %)(((
368	368	Inherits from
369		-
370	370	//KeyValue//
371		-)))|The value of the Time Dimension component of the key.
372		-|CodedKeyValue|(((
	356	+)))|(% style="width:454px" %)The value of the Time Dimension component of the key.
	357	+|(% style="width:200px" %)CodedKeyValue|(% style="width:285px" %)(((
373	373	Inherits from
374		-
375	375	//KeyValue//
376		-)))|The value of a coded component of the key. The value is the Code to which this class is associated.
377		-| |+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.
378		-|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" %)(((
379	379	Inherits from
380		-
381	381	//KeyValue//
382		-)))|The value of an uncoded component of the key.
383		-| |value|The value of the key component.
384		-| |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).
385		-|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" %)(((
386	386	Inherits from
387		-
388	388	//Key//
389		-)))|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.
390		-| |+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
391		-|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" %)(((
392	392	Inherits from
393		-
394	394	//Key//
395		-)))|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.
396		-| |+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
397		-|Observation| |The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
398		-| |+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" %)(((
399	399	Associates the Measure(s) defined in the Data Structure Definition.
400	400
401	401	The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it.
402	402	)))
403		-| |+attachedAttribute|Association to the Attribute Values relating to the Observation.
404		-| |+observationDimension|Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
405		-|//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" %)(((
406	406	Abstract class
407	407
408	408	Sub classes
409	409
410		-//UncodedObservationVal ue//
	391	+//UncodedObservationValue//
411	411
412	412	CodedObservation
413		-)))|
414		-|//UncodedObservatio nValue//|(((
	394	+)))|(% style="width:454px" %)
	395	+|(% style="width:200px" %)//UncodedObservationValue//|(% style="width:285px" %)(((
415	415	Abstract class
416		-
417	417	Inherits from
418		-
419	419	//ObservationValue//
420		-
421	421	Sub classes
422		-
423		-OtherUncodedMeasureVa lue
424		-
	400	+OtherUncodedMeasureValue
425	425	TextMeasureValue
426		-)))|
427		-|OtherUncodedMeasu reValue|(((
	402	+)))|(% style="width:454px" %)
	403	+|(% style="width:200px" %)OtherUncodedMeasureValue|(% style="width:285px" %)(((
428	428	Inherits from
429		-
430		-//UncodedObservationVal ue//
431		-)))|An observation that has a text value.
432		-| |value|The value of the Uncoded Observation.
433		-| |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).
434		-|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" %)(((
435	435	Inherits from
436		-
437		-//UncodedObservationVal ue//
438		-)))|An observation that has a localised text value
439		-| |text|The localised text values.
440		-|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" %)(((
441	441	Inherits from
442		-
443	443	//ObservationValue//
444		-)))|An Observation that takes its value from a code in a Code list.
445		-| |+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.
446		-|//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" %)(((
447	447	Abstract class
448		-
449	449	Sub classes
450		-
451		-//DataAttributeValue// //MetadataAttributeValu e//
452		-)))|Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
453		-|//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" %)(((
454	454	Abstract class
455		-
456	456	Inherits from
457		-
458	458	//AttributeValue//
459		-
460	460	Sub classes
461		-
462		-//UncodedAttributeValue//
463		-
464		-//CodedAttributeValue//
465		-)))|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.
466		-| |+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" %)(((
467	467	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.
468	468
469	469	The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it.
470	470	)))
471		-|//MetadataAttribute Value//|(((
	437	+|(% style="width:200px" %)//MetadataAttributeValue//|(% style="width:285px" %)(((
472	472	(explained further in section
473	473
474	474	“Metadata Set”)
475		-)))|The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition
476		-|//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" %)(((
477	477	Inherits from
478		-
479	479	//AttributeValue//
480		-
481	481	Sub classes
482		-
483	483	OtherUncodedAttribute
484		-
485	485	Value
486		-
487	487	TextAttributeValue
488		-)))|
489		-|OtherUncodedAttri buteValue|(((
	449	+)))|(% style="width:454px" %)
	450	+|(% style="width:200px" %)OtherUncodedAttributeValue|(% style="width:285px" %)(((
490	490	Inherits from
491		-
492		-//UncodedObservationVal ue//
493		-)))|An attribute value that has a text value
494		-| |value|The value of the Uncoded attribute.
495		-| |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).
496		-|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" %)(((
497	497	Inherits from
498		-
499	499	//UncodedAttributeValue//
500		-)))|An attribute that has a localised text value
501		-| |text|The localised text values.
502		-|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" %)(((
503	503	Inherits from
504		-
505	505	//AttributeValue//
506		-)))|An attribute that takes it value from a Code in Code list.
507		-| |+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.
508	508
509	509	----
510	510