Last modified by Artur on 2025/09/10 11:19

From version 9.2
edited by Helena
on 2025/05/16 23:01
Change comment: There is no comment for this version
To version 7.3
edited by Helena
on 2025/05/15 10:39
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,18 +4,22 @@
4 4  
5 5  == 5.1 Introduction ==
6 6  
7 -The DataStructureDefiniton is the class name for a structure definition for data. Some organisations know this type of definition as a “Key Family” and so the two names are synonymous. The term [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] (also referred to as [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]]) is used in this specification.
7 +The DataStructureDefiniton is the class name for a structure definition for data. Some organisations know this type of definition as a “Key Family” and so the two names are synonymous. The term Data Structure Definition (also referred to as DSD) is used in this specification.
8 8  
9 -Many of the constructs in this layer of the model inherit from the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base Layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual packages. In simple sub models these are shown in the same diagram but are omitted from the more complex sub models for the sake of clarity. In these cases, the inheritance diagram below shows the full inheritance tree for the classes concerned with data structure definitions.
9 +Many of the constructs in this layer of the model inherit from the SDMX Base Layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual packages. In simple sub models these are shown in the same diagram but are omitted from the more complex sub models for the sake of clarity. In these cases, the inheritance diagram below shows the full inheritance tree for the classes concerned with data structure definitions.
10 10  
11 -There are very few additional classes in this sub model other than those shown in the inheritance diagram below. In other words, the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base gives most of the structure of this sub model both in terms of associations and in terms of [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]. The relationship diagrams shown in this section show clearly when these associations are inherited from the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base (see the Appendix “A Short Guide to UML in the [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]” to see the diagrammatic notation used to depict this).
11 +There are very few additional classes in this sub model other than those shown in the inheritance diagram below. In other words, the SDMX Base gives most of the structure of this sub model both in terms of associations and in terms of attributes. The relationship diagrams shown in this section show clearly when these associations are inherited from the SDMX Base (see the Appendix “A Short Guide to UML in the SDMX Information Model” to see the diagrammatic notation used to depict this).
12 12  
13 -The actual [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base construct from which the concrete classes inherit depends upon the requirements of the class for:
13 +The actual SDMX Base construct from which the concrete classes inherit depends upon the requirements of the class for:
14 14  
15 -[[Annotation>>doc:xwiki:Glossary.Annotation.WebHome]] – //AnnotableArtefact//
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 ==
... ... @@ -30,59 +30,72 @@
30 30  
31 31  ==== 5.2.2.1 Narrative ====
32 32  
33 -Those classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]] inherit from //AnnotableArtefact//. These are:
37 +Those classes in the SDMX metamodel which require annotations inherit from //AnnotableArtefact//. These are:
34 34  
35 -//IdentifiableArtefact
36 -[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]
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 -Those classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]] and global identity are derived from //IdentifiableArtefact//. These are:
47 +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>>doc:xwiki:Glossary.Component.WebHome]]//
49 +//NameableArtefact//
45 45  
46 -Those classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]], global identity, multilingual name and multilingual description are derived from //NameableArtefact//. These are:
51 +//ComponentList//
47 47  
48 -//VersionableArtefact
49 -Item//
53 +//Component//
50 50  
51 -The classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]], global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact//. These are:
55 +Those classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description are derived from //NameableArtefact//. These are:
52 52  
57 +//VersionableArtefact//
58 +
59 +//Item//
60 +
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 +
53 53  //MaintainableArtefact//
54 54  
55 -Abstract classes which represent information that is maintained by [[Maintenance Agencies>>doc:xwiki:Glossary.Maintenance agency.WebHome]] all inherit from //MaintainableArtefact//, they also inherit all the features of a //VersionableArtefact//, and are:
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:
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 -Those concrete classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] and [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]] packages of the metamodel which require to be maintained by Agencies all inherit (via other abstract classes) from //MaintainableArtefact//, these are:
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:
64 64  
65 65  Dataflow
78 +
66 66  DataStructureDefinition
67 67  
68 -The [[component>>doc:xwiki:Glossary.Component.WebHome]] structures that are lists of lists, inherit directly from //Structure//. A //Structure// contains several lists of [[components>>doc:xwiki:Glossary.Component.WebHome]]. The concrete class that inherits from //Structure// is:
81 +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:
69 69  
70 70  DataStructureDefinition
71 71  
72 -A DataStructureDefinition contains a list of [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]], a list of [[measures>>doc:xwiki:Glossary.Measure.WebHome]] and a list of attributes.
85 +A DataStructureDefinition contains a list of dimensions, a list of measures and a list of attributes.
73 73  
74 74  The concrete classes which inherit from //ComponentList// and are subcomponents of the DataStructureDefinition are:
75 75  
76 -DimensionDescriptor – content is [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] and TimeDimension
77 -DimensionGroupDescriptor – content is an association to [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension
89 +DimensionDescriptor – content is Dimension and TimeDimension
90 +
91 +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 -The classes that inherit from //[[Component>>doc:xwiki:Glossary.Component.WebHome]]// are:
97 +The classes that inherit from //Component// are:
82 82  
83 83  Measure
84 84  
85 -//DimensionComponent// and thereby its sub classes of [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] and TimeDimension
101 +//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.
... ... @@ -153,8 +153,10 @@
153 153  
154 154  **Figure 30: Representation of DSD Components**
155 155  
156 -Each of Dimension, TimeDimension, Measure, DataAttribute and MetadataAttribute can have a Representation specified (using the localRepresentation association). If this is not specified in the DataStructureDefinition then the representation specified for Concept (coreRepresentation) is used. Measure, and DataAttribute may be also represented by multilingual text (as seen in the DataSet diagram further down). An exception is the MetadataAttribute, where its Representation is specified in the MetadataStructureDefinition.
173 +Each of Dimension, TimeDimension, Measure, DataAttribute and MetadataAttribute can have a Representation specified (using the localRepresentation association). If this is not specified in the DataStructureDefinition then the representation specified for Concept
157 157  
175 +(coreRepresentation) is used. Measure, and DataAttribute may be also represented by multilingual text (as seen in the DataSet diagram further down). An exception is the MetadataAttribute, where its Representation is specified in the MetadataStructureDefinition.
176 +
158 158  A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap.
159 159  
160 160  ==== 5.3.2.2 Definitions ====
... ... @@ -162,95 +162,113 @@
162 162  :
163 163  
164 164  (((
165 -(% style="width:834.039px" %)
166 -|**Class**|(% style="width:194px" %)**Feature**|(% style="width:454px" %)**Description**
167 -|StructureUsage|(% style="width:194px" %) |(% style="width:454px" %)See “SDMX Base”.
168 -|Dataflow|(% style="width:194px" %)(((
184 +|**Class**|**Feature**|**Description**
185 +|StructureUsage| |See “SDMX Base”.
186 +|Dataflow|(((
169 169  Inherits from
188 +
170 170  //StructureUsage//
171 -)))|(% style="width:454px" %)Abstract concept (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.
172 -| |(% style="width:194px" %)/structure|(% style="width:454px" %)Associates a Dataflow to the Data Structure Definition.
173 -|DataStructureDefiniti on|(% style="width:194px" %) |(% style="width:454px" %)A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
174 -| |(% style="width:194px" %)/grouping|(% style="width:454px" %)An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
175 -|GroupDimensionDescrip tor|(% style="width:194px" %)(((
190 +)))|Abstract concept (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.
191 +| |/structure|Associates a Dataflow to the Data Structure Definition.
192 +|DataStructureDefiniti on| |A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
193 +| |/grouping|An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
194 +|GroupDimensionDescrip tor|(((
176 176  Inherits from
196 +
177 177  //ComponentList//
178 -)))|(% style="width:454px" %)A set of metadata concepts that define a partial key derived from the Dimension Descriptor in a Data Structure Definition.
179 -| |(% style="width:194px" %)/components|(% style="width:454px" %)An association to the Dimension components that comprise the group.
180 -|DimensionDescriptor|(% style="width:194px" %)(((
198 +)))|A set of metadata concepts that define a partial key derived from the Dimension Descriptor in a Data Structure Definition.
199 +| |/components|An association to the Dimension components that comprise the group.
200 +|DimensionDescriptor|(((
181 181  Inherits from
202 +
182 182  //ComponentList//
183 -)))|(% style="width:454px" %)An ordered set of metadata concepts that, combined, classify a statistical series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific observation.
184 -| |(% style="width:194px" %)/components|(% style="width:454px" %)(((
185 -An association to the Dimension and Time Dimension comprising the Key Descriptor.
204 +)))|An ordered set of metadata concepts that, combined, classify a statistical series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific observation.
205 +| |/components|(((
206 +An association to the Dimension and Time
207 +
208 +Dimension comprising the Key Descriptor.
186 186  )))
187 -|AttributeDescriptor|(% style="width:194px" %)(((
210 +|AttributeDescriptor|(((
188 188  Inherits from
212 +
189 189  //ComponentList//
190 -)))|(% style="width:454px" %)A set metadata concepts that define the Attributes of a Data Structure Definition.
191 -| |(% style="width:194px" %)/components|(% style="width:454px" %)An association to a Data Attribute component.
192 -|MeasureDescriptor|(% style="width:194px" %)(((
214 +)))|A set metadata concepts that define the Attributes of a Data Structure Definition.
215 +| |/components|An association to a Data Attribute component.
216 +|MeasureDescriptor|(((
193 193  Inherits from
218 +
194 194  //ComponentList//
195 -)))|(% style="width:454px" %)A metadata concept that defines the Measures of a Data Structure Definition.
196 -| |(% style="width:194px" %)/components|(% style="width:454px" %)An association to a Measure component.
197 -|//DimensionComponent//|(% style="width:194px" %)(((
220 +)))|A metadata concept that defines the Measures of a Data Structure Definition.
221 +| |/components|An association to a Measure component.
222 +|//DimensionComponent//|(((
198 198  Inherits from
224 +
199 199  //Component//
200 200  
201 201  Sub class Dimension
228 +
202 202  TimeDimension
203 -)))|(% style="width:454px" %)An abstract class representing any Component that can be used for identifying observations.
204 -| |(% style="width:194px" %)order|(% style="width:454px" %)Specifies the order of the Dimension Components within the DSD. The property is used to indicate the position of the Dimension Component and determines the Key for identifying observations, or series. The Time Dimension, when specified, must be the last within the Dimension Descriptor.
205 -|Dimension|(% style="width:194px" %)(((
230 +)))|An abstract class representing any Component that can be used for identifying observations.
231 +| |order|Specifies the order of the Dimension Components within the DSD. The property is used to indicate the position of the Dimension Component and determines the Key for identifying observations, or series. The Time Dimension, when specified, must be the last within the Dimension Descriptor.
232 +|Dimension|(((
206 206  Inherits from
234 +
207 207  //DimensionComponent//
208 -)))|(% style="width:454px" %)A metadata concept used (most probably together with other metadata concepts) to classify a statistical series, e.g., a statistical concept indicating a certain economic activity or a geographical reference area.
209 -| |(% style="width:194px" %)/role|(% style="width:454px" %)Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
210 -| |(% style="width:194px" %)/conceptIdentity|(% style="width:454px" %)An association to the metadata concept which defines the semantic of the Dimension.
211 -|TimeDimension|(% style="width:194px" %)(((
236 +)))|A metadata concept used (most probably together with other metadata concepts) to classify a statistical series, e.g., a statistical concept indicating a certain economic activity or a geographical reference area.
237 +| |/role|Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
238 +| |/conceptIdentity|An association to the metadata concept which defines the semantic of the Dimension.
239 +|TimeDimension|(((
212 212  Inherits from
241 +
213 213  //DimensionComponent//
214 -)))|(% style="width:454px" %)A metadata concept that identifies the component in the key structure that has the role of “time”.
215 -|DataAttribute|(% style="width:194px" %)(((
243 +)))|A metadata concept that identifies the component in the key structure that has the role of “time”.
244 +|DataAttribute|(((
216 216  Inherits from
217 217  
218 218  //Component//
219 -)))|(% style="width:454px" %)A characteristic of an object or entity.
220 -| |(% style="width:194px" %)/role|(% style="width:454px" %)Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
221 -| |(% style="width:194px" %)minOccurs|(% style="width:454px" %)Defines the minimum required occurrences for the Attribute. When equals to zero, the Attribute is conditional.
222 -| |(% style="width:194px" %)maxOccurs|(% style="width:454px" %)Defines the maximum allowed occurrences for the Attribute.
223 -| |(% style="width:194px" %)usage|(% style="width:454px" %)Defines whether a Data Attribute must be reported or not.
224 -| |(% style="width:194px" %)+relatedTo|(% style="width:454px" %)Association to an Attribute Relationship.
225 -| |(% style="width:194px" %)/conceptIdentity|(% style="width:454px" %)An association to the Concept which defines the semantic of the component.
226 -|Measure|(% style="width:194px" %)(((
248 +)))|A characteristic of an object or entity.
249 +| |/role|Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
250 +| |minOccurs|Defines the minimum required occurrences for the Attribute. When equals to zero, the Attribute is conditional.
251 +| |maxOccurs|Defines the maximum allowed occurrences for the Attribute.
252 +| |usage|Defines whether a Data Attribute must be reported or not.
253 +| |+relatedTo|Association to an Attribute Relationship.
254 +| |/conceptIdentity|An association to the Concept which defines the semantic of the component.
255 +|Measure|(((
227 227  Inherits from
257 +
228 228  //Component//
229 -)))|(% style="width:454px" %)The metadata concept that is the phenomenon to be measured in a data set. In a data set the instance of the measure is often called the observation.
230 -| |(% style="width:194px" %)/conceptIdentity|(% style="width:454px" %)An association to the Concept which carries the values of the measures.
231 -| |(% style="width:194px" %)minOccurs|(% style="width:454px" %)Defines the minimum required occurrences for the Measure. When equals to zero, the Measure is conditional.
232 -| |(% style="width:194px" %)maxOccurs|(% style="width:454px" %)Defines the maximum allowed occurrences for the Measure.
233 -| |(% style="width:194px" %)usage|(% style="width:454px" %)Defines whether a Measure must be reported or not.
234 -|//AttributeRelationship//|(% style="width:194px" %)(((
259 +)))|The metadata concept that is the phenomenon to be measured in a data set. In a data set the instance of the measure is often called the observation.
260 +| |/conceptIdentity|An association to the Concept which carries the values of the measures.
261 +| |minOccurs|Defines the minimum required occurrences for the Measure. When equals to zero, the Measure is conditional.
262 +| |maxOccurs|Defines the maximum allowed occurrences for the Measure.
263 +| |usage|Defines whether a Measure must be reported or not.
264 +|//AttributeRelationship//|(((
235 235  Abstract Class
266 +
236 236  Sub classes
268 +
237 237  ObservationRelationship
270 +
238 238  GroupRelationship DimensionRelationshi p
239 -)))|(% style="width:454px" %)Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
240 -|ObservationRelationsh ip|(% style="width:194px" %) |(% style="width:454px" %)The Data Attribute is related to the observations of the Data Set.
241 -|GroupRelationship|(% style="width:194px" %) |(% style="width:454px" %)The Data Attribute is related to a Group Dimension Descriptor construct.
242 -| |(% style="width:194px" %)+groupKey|(% style="width:454px" %)An association to the Group Dimension Descriptor
243 -|DimensionRelationship|(% style="width:194px" %) |(% style="width:454px" %)The Data Attribute is related to a set of Dimensions.
244 -| |(% style="width:194px" %)+dimensions|(% style="width:454px" %)Association to the set of Dimensions to which the Data Attribute is related.
245 -| |(% style="width:194px" %)+groupKey|(% style="width:454px" %)Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
246 -|MeasureRelationship|(% style="width:194px" %) |(% style="width:454px" %)The Measures that a Data Attribute is reported for.
247 -| |(% style="width:194px" %)+measures|(% style="width:454px" %)Association to the set of Measures to which a Data Attribute is related to.
248 -|SentinelValuesType|(% style="width:194px" %) |(% style="width:454px" %)This facet indicates that an Attribute or a Measure has sentinel values with special meaning within their data type. This is realised by providing such values within the TextFormat, in addition to any textType or other Facet.
249 -|SentinelValue|(% style="width:194px" %) |(% style="width:454px" %)A value that has a special meaning within the text format representation of the Component.
250 -| |(% style="width:194px" %)+name|(% style="width:454px" %)An association of a Sentinel Value to a multilingual name.
251 -| |(% style="width:194px" %)+description|(% style="width:454px" %)An association of a Sentinel Value to a multilingual description.
272 +)))|Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
273 +|ObservationRelationsh ip| |The Data Attribute is related to the observations of the Data Set.
274 +|GroupRelationship| |The Data Attribute is related to a Group Dimension Descriptor construct.
275 +| |+groupKey|An association to the Group Dimension Descriptor
276 +|DimensionRelationship| |The Data Attribute is related to a set of Dimensions.
277 +| |+dimensions|Association to the set of Dimensions to which the Data Attribute is related.
278 +| |+groupKey|Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
279 +|MeasureRelationship| |The Measures that a Data Attribute is reported for.
280 +| |+measures|Association to the set of Measures to which a Data Attribute is related to.
281 +|SentinelValuesType| |This facet indicates that an Attribute or a Measure has sentinel values with special meaning within their data type. This is realised by providing such values within the TextFormat, in addition to any textType or other Facet.
282 +|SentinelValue| |A value that has a special meaning within the text format representation of the Component.
283 +| |+name|An association of a Sentinel Value to a multilingual name.
284 +| |+description|An association of a Sentinel Value to a multilingual description.
252 252  )))
253 253  
287 +
288 +
289 +
290 +
254 254  The explanation of the classes, attributes, and associations comprising the Representation is described in the section on the SDMX Base.
255 255  
256 256  == 5.4 Data Set – Relationship View ==
... ... @@ -275,8 +275,10 @@
275 275  
276 276  A //DataSet// is formatted as a DataStructureDefinition specific data set (StructureSpecificDataSet). The structured data set is structured according to one specific DataStructureDefinition; hence the latter is required for validation at the syntax level.
277 277  
278 -A //DataSet// is a collection of a set of //Observation//s that share the same dimensionality, which is specified by a set of unique components (Dimension, TimeDimension) defined in the DimensionDescriptor of the DataStructureDefinition, together with associated
315 +A //DataSet// is a collection of a set of //Observation//s that share the same dimensionality, which is specified by a set of unique components (Dimension, TimeDimension) defined in the
279 279  
317 +DimensionDescriptor of the DataStructureDefinition, together with associated
318 +
280 280  //AttributeValue//s that define specific characteristics about the artefact to which it is attached – //Observation//s, set of Dimensions. It can be structured in terms of a SeriesKey to which //Observation//s are reported.
281 281  
282 282  The //Observation// can be the value(s) of the variable(s) being measured for the Concept associated to the Measure(s) in the MeasureDescriptor of the DataStructureDefinition. Each //Observation// associates one or more //ObservationValue//s with a KeyValue (+observationDimension) which is the value for the “Dimension at the Observation Level”. Any Dimension can be specified as being the “Dimension at the Observation Level”, and this specification is made at the level of the //DataSet// (i.e., it must be the same Dimension for the entire //DataSet//).
... ... @@ -293,154 +293,198 @@
293 293  
294 294  ==== 5.4.3.2 Definitions ====
295 295  
296 -(% style="width:812.039px" %)
297 -|(% style="width:147px" %)**Class**|(% style="width:246px" %)**Feature**|(% style="width:395px" %)**Description**
298 -|(% style="width:147px" %)//DataSet//|(% style="width:246px" %)(((
335 +|**Class**|**Feature**|**Description**
336 +|//DataSet//|(((
299 299  Abstract Class
338 +
300 300  Sub classes
340 +
301 301  StructureSpecificData
342 +
302 302  Set
303 -)))|(% style="width:395px" %)An organised collection of data.
304 -|(% style="width:147px" %) |(% style="width:246px" %)reportingBegin|(% style="width:395px" %)A specific time period in a known system of time periods that identifies the start period of a report.
305 -|(% style="width:147px" %) |(% style="width:246px" %)reportingEnd|(% style="width:395px" %)A specific time period in a known system of time periods that identifies the end period of a report.
306 -|(% style="width:147px" %) |(% style="width:246px" %)dataExtractionDate|(% style="width:395px" %)A specific time period that identifies the date and time that the data are extracted from a data source.
307 -|(% style="width:147px" %) |(% style="width:246px" %)validFrom|(% style="width:395px" %)Indicates the inclusive start time indicating the validity of the information in the data set.
308 -|(% style="width:147px" %) |(% style="width:246px" %)validTo|(% style="width:395px" %)Indicates the inclusive end time indicating the validity of the information in the data set.
309 -|(% style="width:147px" %) |(% style="width:246px" %)publicationYear|(% style="width:395px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
310 -|(% style="width:147px" %) |(% style="width:246px" %)publicationPeriod|(% style="width:395px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
311 -|(% style="width:147px" %) |(% style="width:246px" %)setId|(% style="width:395px" %)Provides an identification of the data set.
312 -|(% style="width:147px" %) |(% style="width:246px" %)action|(% style="width:395px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
313 -|(% style="width:147px" %) |(% style="width:246px" %)describedBy|(% style="width:395px" %)Associates a Dataflow and thereby a Data Structure Definition to the data set.
314 -|(% style="width:147px" %) |(% style="width:246px" %)+structuredBy|(% style="width:395px" %)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.
315 -|(% style="width:147px" %) |(% style="width:246px" %)+publishedBy|(% style="width:395px" %)Associates the Data Provider that reports/publishes the data.
316 -|(% style="width:147px" %)StructureSpecific DataSet|(% style="width:246px" %) |(% style="width:395px" %)An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
317 -|(% style="width:147px" %)//Key//|(% style="width:246px" %)(((
344 +)))|An organised collection of data.
345 +| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
346 +| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
347 +| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
348 +| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
349 +| |validTo|Indicates the inclusive end time indicating the validity of the information in the data set.
350 +| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
351 +| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
352 +| |setId|Provides an identification of the data set.
353 +| |action|Defines the action to be taken by the recipient system (information, append, replace, delete)
354 +| |describedBy|Associates a Dataflow and thereby a Data Structure Definition to the data set.
355 +| |+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.
356 +| |+publishedBy|Associates the Data Provider that reports/publishes the data.
357 +|StructureSpecific DataSet| |An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
358 +|//Key//|(((
318 318  Abstract class Sub classes
360 +
319 319  SeriesKey
362 +
320 320  GroupKey
321 -)))|(% style="width:395px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
322 -|(% style="width:147px" %) |(% style="width:246px" %)keyValues|(% style="width:395px" %)Association to the individual Key Values that comprise the Key.
323 -|(% style="width:147px" %) |(% style="width:246px" %)+attachedAttribute|(% style="width:395px" %)Association to the Attribute Values relating to the Series Key or Group Key.
324 -|(% style="width:147px" %)//KeyValue//|(% style="width:246px" %)(((
364 +)))|Comprises the cross product of values of dimensions that identify uniquely an Observation.
365 +| |keyValues|Association to the individual Key Values that comprise the Key.
366 +| |+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
367 +|//KeyValue//|(((
325 325  Abstract class Sub classes
369 +
326 326  TimeKeyValue
371 +
327 327  CodedKeyValue
373 +
328 328  UncodedKeyValue
329 -)))|(% style="width:395px" %)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.
330 -|(% style="width:147px" %) |(% style="width:246px" %)+valueFor|(% style="width:395px" %)(((
375 +)))|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.
376 +| |+valueFor|(((
331 331  Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
378 +
332 332  Note that this is conceptual association as the key component is identified explicitly in the data set.
333 333  )))
334 -|(% style="width:147px" %)TimeKeyValue|(% style="width:246px" %)(((
381 +|TimeKeyValue|(((
335 335  Inherits from
383 +
336 336  //KeyValue//
337 -)))|(% style="width:395px" %)The value of the Time Dimension component of the key.
338 -|(% style="width:147px" %)CodedKeyValue|(% style="width:246px" %)(((
385 +)))|The value of the Time Dimension component of the key.
386 +|CodedKeyValue|(((
339 339  Inherits from
388 +
340 340  //KeyValue//
341 -)))|(% style="width:395px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
342 -|(% style="width:147px" %) |(% style="width:246px" %)+valueOf|(% style="width:395px" %)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.
343 -|(% style="width:147px" %)UnCodedKeyValue|(% style="width:246px" %)(((
390 +)))|The value of a coded component of the key. The value is the Code to which this class is associated.
391 +| |+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.
392 +|UnCodedKeyValue|(((
344 344  Inherits from
394 +
345 345  //KeyValue//
346 -)))|(% style="width:395px" %)The value of an uncoded component of the key.
347 -|(% style="width:147px" %) |(% style="width:246px" %)value|(% style="width:395px" %)The value of the key component.
348 -|(% style="width:147px" %) |(% style="width:246px" %)startTime|(% style="width:395px" %)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).
349 -|(% style="width:147px" %)GroupKey|(% style="width:246px" %)(((
396 +)))|The value of an uncoded component of the key.
397 +| |value|The value of the key component.
398 +| |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).
399 +|GroupKey|(((
350 350  Inherits from
401 +
351 351  //Key//
352 -)))|(% style="width:395px" %)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.
353 -|(% style="width:147px" %) |(% style="width:246px" %)+describedBy|(% style="width:395px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
354 -|(% style="width:147px" %)SeriesKey|(% style="width:246px" %)(((
403 +)))|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.
404 +| |+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
405 +|SeriesKey|(((
355 355  Inherits from
407 +
356 356  //Key//
357 -)))|(% style="width:395px" %)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.
358 -|(% style="width:147px" %) |(% style="width:246px" %)+describedBy|(% style="width:395px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
359 -|(% style="width:147px" %)Observation|(% style="width:246px" %) |(% style="width:395px" %)The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
360 -|(% style="width:147px" %) |(% style="width:246px" %)+valueFor|(% style="width:395px" %)(((
409 +)))|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.
410 +| |+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
411 +|Observation| |The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
412 +| |+valueFor|(((
361 361  Associates the Measure(s) defined in the Data Structure Definition.
362 362  
363 363  The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it.
364 364  )))
365 -|(% style="width:147px" %) |(% style="width:246px" %)+attachedAttribute|(% style="width:395px" %)Association to the Attribute Values relating to the Observation.
366 -|(% style="width:147px" %) |(% style="width:246px" %)+observationDimension|(% style="width:395px" %)Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
367 -|(% style="width:147px" %)//ObservationValue//|(% style="width:246px" %)(((
417 +| |+attachedAttribute|Association to the Attribute Values relating to the Observation.
418 +| |+observationDimension|Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
419 +|//ObservationValue//|(((
368 368  Abstract class
421 +
369 369  Sub classes
370 -//UncodedObservationValue//
423 +
424 +//UncodedObservationVal//
425 +
426 +//ue//
427 +
371 371  CodedObservation
372 -)))|(% style="width:395px" %)
373 -|(% style="width:147px" %)//UncodedObservatio nValue//|(% style="width:246px" %)(((
429 +)))|
430 +|//UncodedObservatio nValue//|(((
374 374  Abstract class
432 +
375 375  Inherits from
434 +
376 376  //ObservationValue//
436 +
377 377  Sub classes
378 -OtherUncodedMeasureValue
438 +
439 +OtherUncodedMeasureVa lue
440 +
379 379  TextMeasureValue
380 -)))|(% style="width:395px" %)
381 -|(% style="width:147px" %)OtherUncodedMeasu reValue|(% style="width:246px" %)(((
442 +)))|
443 +|OtherUncodedMeasu reValue|(((
382 382  Inherits from
383 383  
384 -//UncodedObservationValue//
385 -)))|(% style="width:395px" %)An observation that has a text value.
386 -|(% style="width:147px" %) |(% style="width:246px" %)value|(% style="width:395px" %)The value of the Uncoded Observation.
387 -|(% style="width:147px" %) |(% style="width:246px" %)startTime|(% style="width:395px" %)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).
388 -|(% style="width:147px" %)TextMeasureValue|(% style="width:246px" %)(((
446 +//UncodedObservationVal ue//
447 +)))|An observation that has a text value.
448 +| |value|The value of the Uncoded Observation.
449 +| |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).
450 +|TextMeasureValue|(((
389 389  Inherits from
390 -//UncodedObservationValue//
391 -)))|(% style="width:395px" %)An observation that has a localised text value
392 -|(% style="width:147px" %) |(% style="width:246px" %)text|(% style="width:395px" %)The localised text values.
393 -|(% style="width:147px" %)CodedObservation|(% style="width:246px" %)(((
452 +
453 +//UncodedObservationVal ue//
454 +)))|An observation that has a localised text value
455 +| |text|The localised text values.
456 +|CodedObservation|(((
394 394  Inherits from
458 +
395 395  //ObservationValue//
396 -)))|(% style="width:395px" %)An Observation that takes its value from a code in a Code list.
397 -|(% style="width:147px" %) |(% style="width:246px" %)+valueOf|(% style="width:395px" %)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.
398 -|(% style="width:147px" %)//AttributeValue//|(% style="width:246px" %)(((
460 +)))|An Observation that takes its value from a code in a Code list.
461 +| |+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.
462 +|//AttributeValue//|(((
399 399  Abstract class
464 +
400 400  Sub classes
401 -//DataAttributeValue// //MetadataAttributeValue//
402 -)))|(% style="width:395px" %)Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
403 -|(% style="width:147px" %)//DataAttributeValue//|(% style="width:246px" %)(((
466 +
467 +//DataAttributeValue// //MetadataAttributeValu e//
468 +)))|Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
469 +|//DataAttributeValu e//|(((
404 404  Abstract class
471 +
405 405  Inherits from
473 +
406 406  //AttributeValue//
475 +
407 407  Sub classes
408 -//UncodedAttributeValue
409 -CodedAttributeValue//
410 -)))|(% style="width:395px" %)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.
411 -|(% style="width:147px" %) |(% style="width:246px" %)+valueFor|(% style="width:395px" %)(((
477 +
478 +//UncodedAttributeValue//
479 +
480 +//CodedAttributeValue//
481 +)))|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.
482 +| |+valueFor|(((
412 412  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.
484 +
413 413  The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it.
414 414  )))
415 -|(% style="width:147px" %)//MetadataAttribute Value//|(% style="width:246px" %)(((
416 -(explained further in section “Metadata Set”)
417 -)))|(% style="width:395px" %)(((
487 +|//MetadataAttribute Value//|(((
488 +(explained further in section
489 +
490 +“Metadata Set”)
491 +)))|(((
418 418  The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure
419 419  
420 420  Definition
421 421  )))
422 -|(% style="width:147px" %)//UncodedAttributeV alue//|(% style="width:246px" %)(((
496 +|//UncodedAttributeV alue//|(((
423 423  Inherits from
498 +
424 424  //AttributeValue//
500 +
425 425  Sub classes
502 +
426 426  OtherUncodedAttribute Value
504 +
427 427  TextAttributeValue
428 -)))|(% style="width:395px" %)
429 -|(% style="width:147px" %)OtherUncodedAttri buteValue|(% style="width:246px" %)(((
506 +)))|
507 +|OtherUncodedAttri buteValue|(((
430 430  Inherits from
431 -//UncodedObservationValue//
432 -)))|(% style="width:395px" %)An attribute value that has a text value
433 -|(% style="width:147px" %) |(% style="width:246px" %)value|(% style="width:395px" %)The value of the Uncoded attribute.
434 -|(% style="width:147px" %) |(% style="width:246px" %)startTime|(% style="width:395px" %)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).
435 -|(% style="width:147px" %)TextAttributeValu e|(% style="width:246px" %)(((
509 +
510 +//UncodedObservationVal ue//
511 +)))|An attribute value that has a text value
512 +| |value|The value of the Uncoded attribute.
513 +| |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).
514 +|TextAttributeValu e|(((
436 436  Inherits from
516 +
437 437  //UncodedAttributeValue//
438 -)))|(% style="width:395px" %)An attribute that has a localised text value
439 -|(% style="width:147px" %) |(% style="width:246px" %)text|(% style="width:395px" %)The localised text values.
440 -|(% style="width:147px" %)CodedAttributeVal ue|(% style="width:246px" %)(((
518 +)))|An attribute that has a localised text value
519 +| |text|The localised text values.
520 +|CodedAttributeVal ue|(((
441 441  Inherits from
522 +
442 442  //AttributeValue//
443 -)))|(% style="width:395px" %)An attribute that takes it value from a Code in Code list.
444 -|(% style="width:147px" %) |(% style="width:246px" %)+valueOf|(% style="width:395px" %)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.
524 +)))|An attribute that takes it value from a Code in Code list.
525 +| |+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.
445 445  
527 +
528 +
446 446