Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 3.2
edited by Artur
on 2025/05/20 14:28
Change comment: Update document after refactoring.
To version 3.3
edited by Helena
on 2025/05/22 00:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.arturkryazhev
1 +xwiki:XWiki.helena
Content
... ... @@ -32,7 +32,7 @@
32 32  
33 33  * //IdentifiableArtefact//
34 34  * DataSet (and therefore StructureSpecificDataSet, GenericDataSet, GenericTimeSeriesDataSet StructureSpecificTimeSeriesDataSet)
35 -* //Key //(and therefore SeriesKey and GroupKey)//  //
35 +* //Key //(and therefore SeriesKey and GroupKey)
36 36  
37 37  Those classes in the SDMX metamodel which require annotations and global identity are derived from //IdentifiableArtefact// . These are:
38 38  
... ... @@ -59,12 +59,12 @@
59 59  
60 60  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:
61 61  
62 -* DataflowDefinition//  //
63 -* DataStructureDefinition//  //
62 +* DataflowDefinition
63 +* DataStructureDefinition
64 64  
65 65  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:
66 66  
67 -* DataStructureDefinition//  //
67 +* DataStructureDefinition
68 68  
69 69  A DataStructureDefinition contains a list of dimensions, a list of measures and a list of attributes.
70 70  
... ... @@ -137,7 +137,7 @@
137 137  
138 138  The following table details the possible relationships a DataAttribute may specify. Note that these relationships are mutually exclusive, and therefore only one of the following is possible.
139 139  
140 -:
140 +:
141 141  
142 142  (((
143 143  |**Relationship**|**Meaning**|**Location in Data Set at which the Attribute is reported**
... ... @@ -165,15 +165,15 @@
165 165  ==== 5.3.2.2 Definitions ====
166 166  
167 167  |**Class**|**Feature**|**Description**
168 -|StructureUsage||See “SDMX Base”.
168 +|StructureUsage| |See “SDMX Base”.
169 169  |DataflowDefinition|(((
170 170  Inherits from
171 171  
172 172  //StructureUsage//
173 173  )))|Abstract concept (i.e. the structure without any data) of a flow of data that providers will provide for different reference periods.
174 -||/structure|Associates a Dataflow Definition to the Data Structure Definition.
175 -|DataStructureDefinition||A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
176 -||///grouping //|An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
174 +| |/structure|Associates a Dataflow Definition to the Data Structure Definition.
175 +|DataStructureDefinition| |A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
176 +| |///grouping //|An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
177 177  |(((
178 178  Group
179 179  
... ... @@ -183,37 +183,37 @@
183 183  
184 184  //ComponentList//
185 185  )))|A set metadata concepts that define a partial key derived from the Dimension Descriptor in a Data Structure Definition.
186 -||+constraint|Identifies an Attachment Constraint that specifies the sub set of Dimension, Measure, or Attribute values to which an Attribute can be attached.
187 -||/components|An association to the Dimension and Measure Dimension components that comprise the group.
186 +| |+constraint|Identifies an Attachment Constraint that specifies the sub set of Dimension, Measure, or Attribute values to which an Attribute can be attached.
187 +| |/components|An association to the Dimension and Measure Dimension components that comprise the group.
188 188  |DimensionDescriptor|(((
189 189  Inherits from
190 190  
191 191  //ComponentList//
192 192  )))|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.
193 -||/components|An association to the Dimension, Measure Dimension, and Time Dimension comprising the Key Descriptor.
193 +| |/components|An association to the Dimension, Measure Dimension, and Time Dimension comprising the Key Descriptor.
194 194  |AttributeDescriptor|(((
195 195  Inherits from
196 196  
197 197  //ComponentList//
198 198  )))|A set metadata concepts that define the attributes of a Data Structure Definition.
199 -||/////components//    //|An association to a Data Attribute component.
199 +| |/components//    //|An association to a Data Attribute component.
200 200  |MeasureDescriptor|(((
201 201  Inherits from
202 202  
203 203  //ComponentList//
204 204  )))|A metadata concept that defines the measure of a Data Structure Definition.
205 -||/components|An association to a measure component.
205 +| |/components|An association to a measure component.
206 206  |Dimension|(((
207 207  Inherits from
208 208  
209 209  Component
210 210  )))|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.
211 -||/role|Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
212 -||/conceptIdentity|An association to the metadata concept which defines the semantic of the Dimension.
211 +| |/role|Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
212 +| |/conceptIdentity|An association to the metadata concept which defines the semantic of the Dimension.
213 213  |MeasureDimension|(((
214 214  Inherits from
215 215  
216 -Dimension//    //
216 +Dimension//    //
217 217  )))|A statistical concept that identifies the component in the key structure that has an enumerated list of measures. This dimension has, as its representation the Concept Scheme that enumerates the measure concepts.
218 218  |DataAttribute|(((
219 219  Inherits from
... ... @@ -226,14 +226,14 @@
226 226  
227 227  StartDay
228 228  )))|A characteristic of an object or entity.
229 -||/role|Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
230 -||usageStatus|Defines the usage status which is constrained by the data type Usage Status.
231 -||+relatedTo|Association to a Attribute Relationship.
232 -||/conceptIdentity|An association to the Concept which defines the semantic of the component.
229 +| |/role|Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
230 +| |usageStatus|Defines the usage status which is constrained by the data type Usage Status.
231 +| |+relatedTo|Association to a Attribute Relationship.
232 +| |/conceptIdentity|An association to the Concept which defines the semantic of the component.
233 233  |TimeDimension|(((
234 234  Inherits from
235 235  
236 -Dimension//    //
236 +Dimension//    //
237 237  )))|A metadata concept that identifies the component in the key structure that has the role of “time”.
238 238  |ReportingYearStartDay|(((
239 239  Inherits from
... ... @@ -245,7 +245,7 @@
245 245  
246 246  //Component//
247 247  )))|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.
248 -||/conceptIdentity|An association to the Concept which carries the values of the measures.
248 +| |/conceptIdentity|An association to the Concept which carries the values of the measures.
249 249  |//AttributeRelationship//|(((
250 250  Abstract Class
251 251  
... ... @@ -265,13 +265,13 @@
265 265  
266 266  Relationship
267 267  )))|Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
268 -|NoSpecifiedRelationship||The Data Attribute is not related to any specific construct.
269 -|PrimaryMeasure Relationship||The Data Attribute is related to the Primary Measure construct.
270 -|GroupRelationship||The Data Attribute is related to a Group Dimension Descriptor construct.
271 -||+groupKey|An association to the Group Dimension Descriptor
272 -|DimensionRelationship||The Data Attribute is related to a set of Dimensions.
273 -||+dimensions|Association to the set of Dimensions to which the Data Attribute is related.
274 -||+groupKey|Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
268 +|NoSpecifiedRelationship| |The Data Attribute is not related to any specific construct.
269 +|PrimaryMeasure Relationship| |The Data Attribute is related to the Primary Measure construct.
270 +|GroupRelationship| |The Data Attribute is related to a Group Dimension Descriptor construct.
271 +| |+groupKey|An association to the Group Dimension Descriptor
272 +|DimensionRelationship| |The Data Attribute is related to a set of Dimensions.
273 +| |+dimensions|Association to the set of Dimensions to which the Data Attribute is related.
274 +| |+groupKey|Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
275 275  
276 276  
277 277  
... ... @@ -339,27 +339,27 @@
339 339  
340 340  SeriesDataSet
341 341  )))|An organised collection of data.
342 -||reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
343 -||reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
344 -||dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
345 -||validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
346 -||validTo|Indicates the inclusive end time indicating the validity of the information in the data set.
347 -||publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
348 -||publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
349 -||setId|Provides an identification of the data set.
350 -||action|Defines the action to be taken by the recipient system (update, append, delete)
351 -||describedBy|Associates a data flow definition and thereby a Data Structure Definition to the data set.
352 -||+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 (nonmandatory) to the Dataflow Definition.
353 -||+publishedBy|Associates the Data Provider that reports/publishes the data.
354 -||+attachedAttribute|Association to the Attribute Values relating to the Data Set
355 -|GenericDataSet||A data format structure that is able to contain data corresponding to any Data Structure Definition.
356 -|StructureSpecific DataSet||A data format structure that contains data corresponding to one specific Data Structure Definition.
357 -|GenericTimeseries DataSet||A data format structure that is able to contain timeseries data corresponding to any Data Structure Definition.
342 +| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
343 +| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
344 +| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
345 +| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
346 +| |validTo|Indicates the inclusive end time indicating the validity of the information in the data set.
347 +| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
348 +| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
349 +| |setId|Provides an identification of the data set.
350 +| |action|Defines the action to be taken by the recipient system (update, append, delete)
351 +| |describedBy|Associates a data flow definition and thereby a Data Structure Definition to the data set.
352 +| |+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 (nonmandatory) to the Dataflow Definition.
353 +| |+publishedBy|Associates the Data Provider that reports/publishes the data.
354 +| |+attachedAttribute|Association to the Attribute Values relating to the Data Set
355 +|GenericDataSet| |A data format structure that is able to contain data corresponding to any Data Structure Definition.
356 +|StructureSpecific DataSet| |A data format structure that contains data corresponding to one specific Data Structure Definition.
357 +|GenericTimeseries DataSet| |A data format structure that is able to contain timeseries data corresponding to any Data Structure Definition.
358 358  |(((
359 359  StructureSpecific
360 360  
361 361  TimeseriesDataSet
362 -)))||A data format structure that contains timeseries data corresponding to one specific Data Structure Definition.
362 +)))| |A data format structure that contains timeseries data corresponding to one specific Data Structure Definition.
363 363  |Key|(((
364 364  Abstract class Sub classes
365 365  
... ... @@ -367,8 +367,8 @@
367 367  
368 368  GroupKey
369 369  )))|Comprises the cross product of values of dimensions that identify uniquely an Observation.
370 -|\\|keyValues|Association to the individual Key Values that comprise the Key.
371 -||+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
370 +| |keyValues|Association to the individual Key Values that comprise the Key.
371 +| |+attachedAttribute|Association to the Attribute Values relating to the Series Key or Group Key.
372 372  |//KeyValue//|(((
373 373  Abstract class
374 374  
... ... @@ -382,7 +382,7 @@
382 382  
383 383  UncodedKeyValue
384 384  )))|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.
385 -||+valueFor|(((
385 +| |+valueFor|(((
386 386  Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
387 387  
388 388  Note that this is conceptual association as the key component is identified explicitly in the data set.
... ... @@ -392,7 +392,7 @@
392 392  
393 393  //KeyValue//
394 394  )))|The value of the Measure Dimension component of the key. The value is the Concept to which this class is associated.
395 -||+value|(((
395 +| |+value|(((
396 396  Association to the Concept.
397 397  
398 398  Note that this is a conceptual association showing that the Concept must exist in the Concept Scheme associated with the Measure Dimension in the Data Structure
... ... @@ -409,7 +409,7 @@
409 409  
410 410  //KeyValue//
411 411  )))|The value of a coded component of the key. The value is the Code to which this class is associated.
412 -||+value|(((
412 +| |+value|(((
413 413  Association to the Code.
414 414  
415 415  Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Dimension in the Data
... ... @@ -421,25 +421,25 @@
421 421  
422 422  //KeyValue//
423 423  )))|The value of an uncoded component of the key.
424 -||value|The value of the key component.
425 -||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).
426 -||+valueFor|Associates Dimension, Measure Dimension, or Time Dimension to the Key Value, and thereby to the Concept that is the semantic of the Dimension, or Time Dimension.
424 +| |value|The value of the key component.
425 +| |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).
426 +| |+valueFor|Associates Dimension, Measure Dimension, or Time Dimension to the Key Value, and thereby to the Concept that is the semantic of the Dimension, or Time Dimension.
427 427  |GroupKey|(((
428 428  Inherits from
429 429  
430 430  Key
431 431  )))|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.
432 -||+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
432 +| |+describedBy|Associates the Group Dimension Descriptor defined in the Data Structure Definition.
433 433  |SeriesKey|(((
434 434  Inherits from
435 435  
436 436  Key
437 437  )))|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.
438 -||+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
439 -|Observation||The value of the observed phenomenon in the context of the Key Values comprising the key.
440 -||+valueFor|Associates the Primary Measure defined in the Data Structure Definition.
441 -||+attachedAttribute|Association to the Attribute Values relating to the Observation.
442 -||+observationDimension|Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
438 +| |+describedBy|Associates the Dimension Descriptor defined in the Data Structure Definition.
439 +|Observation| |The value of the observed phenomenon in the context of the Key Values comprising the key.
440 +| |+valueFor|Associates the Primary Measure defined in the Data Structure Definition.
441 +| |+attachedAttribute|Association to the Attribute Values relating to the Observation.
442 +| |+observationDimension|Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
443 443  |//ObservationValue//|(((
444 444  Abstract class
445 445  
... ... @@ -448,19 +448,19 @@
448 448  UncodedObservation
449 449  
450 450  CodedObservation
451 -)))|
451 +)))|
452 452  |UncodedObservation|(((
453 453  Inherits from
454 454  
455 455  ObservationValue
456 456  )))|An observation that has a text value.
457 -||value|The value of the Uncoded Observation.
457 +| |value|The value of the Uncoded Observation.
458 458  |CodedObservation|(((
459 459  Inherits from
460 460  
461 461  ObservationValue
462 462  )))|An Observation that takes its value from a code in a Code list.
463 -||+value|(((
463 +| |+value|(((
464 464  Association to the Code that is the value of the Observation.
465 465  
466 466  Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Primary Measure or the Concept of the Measure Dimension in the Data
... ... @@ -476,8 +476,8 @@
476 476  
477 477  //CodedAttributeValue//
478 478  )))|The value of an attribute, such as the instance of a Coded Attribute or of an Uncoded Attribute in a structure such as a Data Structure Definition.
479 -||value|The value of the attribute.
480 -||+valueFor|(((
479 +| |value|The value of the attribute.
480 +| |+valueFor|(((
481 481  Association to the Data Attribute defined in the Data Structure Definition.
482 482  
483 483  Note that this is conceptual association as the Concept is identified explicitly in the data set.
... ... @@ -487,7 +487,7 @@
487 487  
488 488  //AttributeValue//
489 489  )))|An attribute value that has a text value.
490 -||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).
490 +| |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).
491 491  |(((
492 492  CodedAttribute
493 493  
... ... @@ -497,7 +497,7 @@
497 497  
498 498  //AttributeValue//
499 499  )))|An attribute that takes it value from a Code in Code list.
500 -||+value|(((
500 +| |+value|(((
501 501  Association to the Code that is the value of the Attribute Value.
502 502  
503 503  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.