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 ==
...	...	@@ -323,9 +323,8 @@
323	323
324	324	==== 5.4.3.2 Definitions ====
325	325
326		-(% style="width:812.039px" %)
327		-|(% style="width:147px" %)**Class**|(% style="width:222px" %)**Feature**|(% style="width:437px" %)**Description**
328		-|(% style="width:147px" %)//DataSet//|(% style="width:222px" %)(((
	330	+|**Class**|**Feature**|**Description**
	331	+|//DataSet//|(((
329	329	Abstract Class
330	330
331	331	Sub classes
...	...	@@ -333,30 +333,30 @@
333	333	StructureSpecificData
334	334
335	335	Set
336		-)))|(% style="width:437px" %)An organised collection of data.
337		-|(% 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.
338		-|(% 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.
339		-|(% 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.
340		-|(% 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.
341		-|(% 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.
342		-|(% 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.
343		-|(% 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.
344		-|(% style="width:147px" %) |(% style="width:222px" %)setId|(% style="width:437px" %)Provides an identification of the data set.
345		-|(% style="width:147px" %) |(% style="width:222px" %)action|(% style="width:437px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
346		-|(% style="width:147px" %) |(% style="width:222px" %)describedBy|(% style="width:437px" %)Associates a Dataflow and thereby a Data Structure Definition to the data set.
347		-|(% 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.
348		-|(% style="width:147px" %) |(% style="width:222px" %)+publishedBy|(% style="width:437px" %)Associates the Data Provider that reports/publishes the data.
349		-|(% 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.
350		-|(% 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//|(((
351	351	Abstract class Sub classes
352	352
353	353	SeriesKey
354	354
355	355	GroupKey
356		-)))|(% style="width:437px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
357		-|(% style="width:147px" %) |(% style="width:222px" %)keyValues|(% style="width:437px" %)Association to the individual Key Values that comprise the Key.
358		-|(% style="width:147px" %) |(% style="width:222px" %)+attachedAttribute|(% style="width:437px" %)Association to the Attribute Values relating to the Series Key or Group Key.
359		-|(% 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//|(((
360	360	Abstract class Sub classes
361	361
362	362	TimeKeyValue
...	...	@@ -364,50 +364,51 @@
364	364	CodedKeyValue
365	365
366	366	UncodedKeyValue
367		-)))|(% 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.
368		-|(% 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|(((
369	369	Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
	373	+
370	370	Note that this is conceptual association as the key component is identified explicitly in the data set.
371	371	)))
372		-|(% style="width:147px" %)TimeKeyValue|(% style="width:222px" %)(((
	376	+|TimeKeyValue|(((
373	373	Inherits from
374	374
375	375	//KeyValue//
376		-)))|(% style="width:437px" %)The value of the Time Dimension component of the key.
377		-|(% style="width:147px" %)CodedKeyValue|(% style="width:222px" %)(((
	380	+)))|The value of the Time Dimension component of the key.
	381	+|CodedKeyValue|(((
378	378	Inherits from
379	379
380	380	//KeyValue//
381		-)))|(% style="width:437px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
382		-|(% 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.
383		-|(% 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|(((
384	384	Inherits from
385	385
386	386	//KeyValue//
387		-)))|(% style="width:437px" %)The value of an uncoded component of the key.
388		-|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the key component.
389		-|(% 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).
390		-|(% 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|(((
391	391	Inherits from
392	392
393	393	//Key//
394		-)))|(% 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.
395		-|(% style="width:147px" %) |(% style="width:222px" %)+describedBy|(% style="width:437px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
396		-|(% 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|(((
397	397	Inherits from
398	398
399	399	//Key//
400		-)))|(% 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.
401		-|(% style="width:147px" %) |(% style="width:222px" %)+describedBy|(% style="width:437px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
402		-|(% 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.
403		-|(% 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|(((
404	404	Associates the Measure(s) defined in the Data Structure Definition.
405	405
406	406	The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it.
407	407	)))
408		-|(% style="width:147px" %) |(% style="width:222px" %)+attachedAttribute|(% style="width:437px" %)Association to the Attribute Values relating to the Observation.
409		-|(% 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”.
410		-|(% 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//|(((
411	411	Abstract class
412	412
413	413	Sub classes
...	...	@@ -417,8 +417,8 @@
417	417	//ue//
418	418
419	419	CodedObservation
420		-)))|(% style="width:437px" %)
421		-|(% style="width:147px" %)//UncodedObservatio nValue//|(% style="width:222px" %)(((
	424	+)))|
	425	+|//UncodedObservatio nValue//|(((
422	422	Abstract class
423	423
424	424	Inherits from
...	...	@@ -430,34 +430,34 @@
430	430	OtherUncodedMeasureVa lue
431	431
432	432	TextMeasureValue
433		-)))|(% style="width:437px" %)
434		-|(% style="width:147px" %)OtherUncodedMeasu reValue|(% style="width:222px" %)(((
	437	+)))|
	438	+|OtherUncodedMeasu reValue|(((
435	435	Inherits from
436	436
437	437	//UncodedObservationVal ue//
438		-)))|(% style="width:437px" %)An observation that has a text value.
439		-|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the Uncoded Observation.
440		-|(% 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).
441		-|(% 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|(((
442	442	Inherits from
443	443
444	444	//UncodedObservationVal ue//
445		-)))|(% style="width:437px" %)An observation that has a localised text value
446		-|(% style="width:147px" %) |(% style="width:222px" %)text|(% style="width:437px" %)The localised text values.
447		-|(% style="width:147px" %)CodedObservation|(% style="width:222px" %)(((
	449	+)))|An observation that has a localised text value
	450	+| |text|The localised text values.
	451	+|CodedObservation|(((
448	448	Inherits from
449	449
450	450	//ObservationValue//
451		-)))|(% style="width:437px" %)An Observation that takes its value from a code in a Code list.
452		-|(% 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.
453		-|(% 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//|(((
454	454	Abstract class
455	455
456	456	Sub classes
457	457
458	458	//DataAttributeValue// //MetadataAttributeValu e//
459		-)))|(% style="width:437px" %)Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
460		-|(% 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//|(((
461	461	Abstract class
462	462
463	463	Inherits from
...	...	@@ -469,21 +469,22 @@
469	469	//UncodedAttributeValue//
470	470
471	471	//CodedAttributeValue//
472		-)))|(% 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.
473		-|(% 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|(((
474	474	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	+
475	475	The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it.
476	476	)))
477		-|(% style="width:147px" %)//MetadataAttribute Value//|(% style="width:222px" %)(((
	482	+|//MetadataAttribute Value//|(((
478	478	(explained further in section
479	479
480	480	“Metadata Set”)
481		-)))|(% style="width:437px" %)(((
	486	+)))|(((
482	482	The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure
483	483
484	484	Definition
485	485	)))
486		-|(% style="width:147px" %)//UncodedAttributeV alue//|(% style="width:222px" %)(((
	491	+|//UncodedAttributeV alue//|(((
487	487	Inherits from
488	488
489	489	//AttributeValue//
...	...	@@ -493,25 +493,27 @@
493	493	OtherUncodedAttribute Value
494	494
495	495	TextAttributeValue
496		-)))|(% style="width:437px" %)
497		-|(% style="width:147px" %)OtherUncodedAttri buteValue|(% style="width:222px" %)(((
	501	+)))|
	502	+|OtherUncodedAttri buteValue|(((
498	498	Inherits from
499	499
500	500	//UncodedObservationVal ue//
501		-)))|(% style="width:437px" %)An attribute value that has a text value
502		-|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the Uncoded attribute.
503		-|(% 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).
504		-|(% 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|(((
505	505	Inherits from
506	506
507	507	//UncodedAttributeValue//
508		-)))|(% style="width:437px" %)An attribute that has a localised text value
509		-|(% style="width:147px" %) |(% style="width:222px" %)text|(% style="width:437px" %)The localised text values.
510		-|(% 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|(((
511	511	Inherits from
512	512
513	513	//AttributeValue//
514		-)))|(% style="width:437px" %)An attribute that takes it value from a Code in Code list.
515		-|(% 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.
516	516
	522	+
	523	+
517	517