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

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.helena
1 +xwiki:XWiki.arturkryazhev
Content
... ... @@ -1,6 +1,4 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
1 += {{id name="_Toc371008"/}}5 Data Structure Definition and Dataset =
4 4  
5 5  == {{id name="_Toc371009"/}}5.1 Introduction ==
6 6  
... ... @@ -34,7 +34,7 @@
34 34  
35 35  * //IdentifiableArtefact//
36 36  * DataSet (and therefore StructureSpecificDataSet, GenericDataSet, GenericTimeSeriesDataSet StructureSpecificTimeSeriesDataSet)
37 -* //Key //(and therefore SeriesKey and GroupKey)
35 +* //Key //(and therefore SeriesKey and GroupKey)//  //
38 38  
39 39  Those classes in the SDMX metamodel which require annotations and global identity are derived from //IdentifiableArtefact// . These are:
40 40  
... ... @@ -61,12 +61,12 @@
61 61  
62 62  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:
63 63  
64 -* DataflowDefinition
65 -* DataStructureDefinition
62 +* DataflowDefinition//  //
63 +* DataStructureDefinition//  //
66 66  
67 67  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:
68 68  
69 -* DataStructureDefinition
67 +* DataStructureDefinition//  //
70 70  
71 71  A DataStructureDefinition contains a list of dimensions, a list of measures and a list of attributes.
72 72  
... ... @@ -93,12 +93,8 @@
93 93  
94 94  === {{id name="_Toc371014"/}}5.3.1 Class Diagram ===
95 95  
96 -(% class="wikigeneratedid" %)
97 -[[image:1747897165713-725.png]]
94 +====== Figure 23 Relationship class diagram of the Data Structure Definition excluding representation ======
98 98  
99 -(% class="wikigeneratedid" id="HFigure23RelationshipclassdiagramoftheDataStructureDefinitionexcludingrepresentation" %)
100 -**Figure 23 Relationship class diagram of the Data Structure Definition excluding representation**
101 -
102 102  === {{id name="_Toc371015"/}}5.3.2 Explanation of the Diagrams ===
103 103  
104 104  ==== 5.3.2.1 Narrative ====
... ... @@ -110,15 +110,16 @@
110 110  There are three types of dimension each having a common association to Concept:
111 111  
112 112  * Dimension
113 -* MeasureDimension
114 -* TimeDimension
107 +* MeasureDimension  TimeDimension
115 115  
116 116  Note that In the description here //DimensionComponent// can be oany or all of its sub classes i.e. Dimension, MeasureDimension, TimeDimension., and the term “DataAttribute” refers to both DataAttribute and its sub class ReportingYearStartDate.
117 117  
118 118  The //DimensionComponent//, DataAttribute, and PrimaryMeasure link to the Concept that defines its name and semantic (/conceptIdentity association to Concept). The DataAttribute, Dimension, and MeasureDimension (but not TimeDimension) can optionally have a +conceptRole association with a Concept that identifies its role in the DataStructureDefinition. Therefore, the allowable roles of a Concept are maintained in a ConceptScheme. Examples of roles are: geography, entity, count, unit of measure. The use of these roles is to enable applications to process the data in a meaningful way (e.g. relating a dimension value to a mapping vector). It is expected that communities (such as the official statistics community) will harmonise these roles with their community so that data can be exchanged and shared in a meaningful way in the community.
119 119  
120 -The valid values for a //DimensionComponent//, PrimaryMeasure, or DataAttribute, when used in this DataStructureDefinition, are defined by the Representation. This Representation is taken from the Concept definition (coreRepresentation) unless it is overridden in this DataStructureDefinition (localRepresentation) – see Figure 23. Note that for the MeasureDimension the Representation must be a ConceptScheme and this must always be referenced from the MeasureDimension and cannot therefore be defaulted to the Representation of the Concept associated by the/conceptIdentity. Note also that TimeDimension and ReportingYearStartDate are constrained to specific FacetValueTypes
113 +The valid values for a //DimensionComponent//, PrimaryMeasure, or DataAttribute, when used in this DataStructureDefinition, are defined by the Representation. This Representation is taken from the Concept definition (coreRepresentation) unless it is overridden in this DataStructureDefinition (localRepresentation) – see Figure 23. Note that for the MeasureDimension the Representation must be a ConceptScheme and this must always be referenced from the MeasureDimension and cannot therefore be defaulted to the Representation of the Concept associated by the/conceptIdentity. Note also that TimeDimension and ReportingYearStartDate are constrained to specific
121 121  
115 +FacetValueTypes
116 +
122 122  There will always be a DimensionDescriptor grouping that identifies all of the Dimension comprising the full key. Together the Dimensions specify the key of an Observation.
123 123  
124 124  The //DimensionComponent// can optionally be grouped by multiple GroupDimensionDescriptors each of which identifies the group of Dimensions that can form a partial key. The GroupDimensionDescriptor must be identified (GroupDimensionDescriptor.id) and this is used in the GroupKey of the DataSet to declare which DataAttributes are reported at this group level in the DataSet.
... ... @@ -138,26 +138,27 @@
138 138  * Set of Dimensions specified by a GroupKey (GroupRelationship – this is retained for compatibility reasons – or +groupKey of the DimensionRelationship)
139 139  * Observation (PrimaryMeasureRelationship)
140 140  
141 -[[image:1747896950895-141.png]]
142 -
143 143  **Figure 24: Attribute Attachment Defined in the Data Structure Definition**
144 144  
145 145  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.
146 146  
140 +:
141 +
147 147  (((
148 -(% style="width:1104.83px" %)
149 -|**Relationship**|(% style="width:415px" %)**Meaning**|(% style="width:556px" %)**Location in Data Set at which the Attribute is reported**
150 -|None|(% style="width:415px" %)The value of the attribute does not vary with the values of any other Component.|(% style="width:556px" %)The attribute is reported at the level of the Dataset Attribute.
143 +|**Relationship**|**Meaning**|**Location in Data Set at which the Attribute is reported**
144 +|None|The value of the attribute does not vary with the values of any other Component.|The attribute is reported at the level of the Dataset Attribute.
151 151  |(((
152 152  Dimension
153 153  
154 154  (1..n)
155 -)))|(% style="width:415px" %)The value of the attribute will vary with the value(s) of the referenced Dimension(s). In this case, Group(s) to which the attribute should be attached may optionally be specified.|(% style="width:556px" %)The attribute is reported at the lowest level of the Dimension to which the Attribute is related, otherwise at the level of the Group if Attachment Group(s) is specified.
156 -|**Relationship**|(% style="width:415px" %)**Meaning**|(% style="width:556px" %)**Location in Data Set at which the Attribute is reported**
157 -|Group|(% style="width:415px" %)(((
158 -The value of the Attribute varies with combination of values for all of the Dimensions contained in the Group. This is added as a convenience to listing all Dimensions and the attachment Group, but should only be used when the Attribute value varies based on __all__ Group Dimension values.
159 -)))|(% style="width:556px" %)The attribute is reported at the level of Group.
160 -|Primary Measure|(% style="width:415px" %)The value of the Attribute varies with the observed value.|(% style="width:556px" %)The attribute is reported at the level of Observation.
149 +)))|The value of the attribute will vary with the value(s) of the referenced Dimension(s). In this case, Group(s) to which the attribute should be attached may optionally be specified.|The attribute is reported at the lowest level of the Dimension to which the Attribute is related, otherwise at the level of the Group if Attachment Group(s) is specified.
150 +|**Relationship**|**Meaning**|**Location in Data Set at which the Attribute is reported**
151 +|Group|(((
152 +The value of the Attribute varies with combination of values for all of the
153 +
154 +Dimensions contained in the Group. This is added as a convenience to listing all Dimensions and the attachment Group, but should only be used when the Attribute value varies based on __all__ Group Dimension values.
155 +)))|The attribute is reported at the level of Group.
156 +|Primary Measure|The value of the Attribute varies with the observed value.|The attribute is reported at the level of Observation.
161 161  )))
162 162  
163 163  **Figure 25: Representation of DSD Components**
... ... @@ -168,16 +168,16 @@
168 168  
169 169  ==== 5.3.2.2 Definitions ====
170 170  
171 -(% style="width:1060.83px" %)
172 -|**Class**|**Feature**|(% style="width:695px" %)**Description**
173 -|StructureUsage| |(% style="width:695px" %)See “SDMX Base”.
167 +|**Class**|**Feature**|**Description**
168 +|StructureUsage||See “SDMX Base”.
174 174  |DataflowDefinition|(((
175 175  Inherits from
171 +
176 176  //StructureUsage//
177 -)))|(% style="width:695px" %)Abstract concept (i.e. the structure without any data) of a flow of data that providers will provide for different reference periods.
178 -| |/structure|(% style="width:695px" %)Associates a Dataflow Definition to the Data Structure Definition.
179 -|DataStructureDefinition| |(% style="width:695px" %)A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
180 -| |///grouping//|(% style="width:695px" %)An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
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.
181 181  |(((
182 182  Group
183 183  
... ... @@ -184,81 +184,101 @@
184 184  DimensionDescriptor
185 185  )))|(((
186 186  Inherits from
183 +
187 187  //ComponentList//
188 -)))|(% style="width:695px" %)A set metadata concepts that define a partial key derived from the Dimension Descriptor in a Data Structure Definition.
189 -| |+constraint|(% style="width:695px" %)Identifies an Attachment Constraint that specifies the sub set of Dimension, Measure, or Attribute values to which an Attribute can be attached.
190 -| |/components|(% style="width:695px" %)An association to the Dimension and Measure Dimension components that comprise the group.
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.
191 191  |DimensionDescriptor|(((
192 192  Inherits from
190 +
193 193  //ComponentList//
194 -)))|(% style="width:695px" %)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.
195 -| |/components|(% style="width:695px" %)An association to the Dimension, Measure Dimension, and Time Dimension comprising the Key Descriptor.
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.
196 196  |AttributeDescriptor|(((
197 197  Inherits from
196 +
198 198  //ComponentList//
199 -)))|(% style="width:695px" %)A set metadata concepts that define the attributes of a Data Structure Definition.
200 -| |/components|(% style="width:695px" %)An association to a Data Attribute component.
198 +)))|A set metadata concepts that define the attributes of a Data Structure Definition.
199 +||/////components//    //|An association to a Data Attribute component.
201 201  |MeasureDescriptor|(((
202 202  Inherits from
203 203  
204 204  //ComponentList//
205 -)))|(% style="width:695px" %)A metadata concept that defines the measure of a Data Structure Definition.
206 -| |/components|(% style="width:695px" %)An association to a measure component.
204 +)))|A metadata concept that defines the measure of a Data Structure Definition.
205 +||/components|An association to a measure component.
207 207  |Dimension|(((
208 208  Inherits from
208 +
209 209  Component
210 -)))|(% style="width:695px" %)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|(% style="width:695px" %)Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
212 -| |/conceptIdentity|(% style="width:695px" %)An association to the metadata concept which defines the semantic of the Dimension.
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.
213 213  |MeasureDimension|(((
214 214  Inherits from
215 215  
216 -Dimension
217 -)))|(% style="width:695px" %)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.
216 +Dimension//    //
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
220 +
220 220  Component
222 +
221 221  Sub class
224 +
222 222  ReportingYear
226 +
223 223  StartDay
224 -)))|(% style="width:695px" %)A characteristic of an object or entity.
225 -| |/role|(% style="width:695px" %)Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
226 -| |usageStatus|(% style="width:695px" %)Defines the usage status which is constrained by the data type Usage Status.
227 -| |+relatedTo|(% style="width:695px" %)Association to a Attribute Relationship.
228 -| |/conceptIdentity|(% style="width:695px" %)An association to the Concept which defines the semantic of the component.
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 229  |TimeDimension|(((
230 230  Inherits from
231 231  
232 -Dimension
233 -)))|(% style="width:695px" %)A metadata concept that identifies the component in the key structure that has the role of “time”.
236 +Dimension//    //
237 +)))|A metadata concept that identifies the component in the key structure that has the role of “time”.
234 234  |ReportingYearStartDay|(((
235 235  Inherits from
240 +
236 236  DataAttribute
237 -)))|(% style="width:695px" %)A specialised Data Attribute whose value is used in conjunction with the predefined reporting periods in the Time Dimension. If this is not present, then by default all reporting period values for the Time Dimension will be assumed to be based on a reporting year start day of January 1.
242 +)))|A specialised Data Attribute whose value is used in conjunction with the predefined reporting periods in the Time Dimension. If this is not present, then by default all reporting period values for the Time Dimension will be assumed to be based on a reporting year start day of January 1.
238 238  |PrimaryMeasure|(((
239 239  Inherits from
245 +
240 240  //Component//
241 -)))|(% style="width:695px" %)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.
242 -| |/conceptIdentity|(% style="width:695px" %)An association to the Concept which carries the values of the measures.
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.
243 243  |//AttributeRelationship//|(((
244 244  Abstract Class
251 +
245 245  Sub classes
253 +
246 246  NoSpecified
255 +
247 247  Relationship
257 +
248 248  PrimaryMeasure
259 +
249 249  Relationship
261 +
250 250  GroupRelationship
263 +
251 251  Dimension
265 +
252 252  Relationship
253 -)))|(% style="width:695px" %)Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
254 -|NoSpecifiedRelationship| |(% style="width:695px" %)The Data Attribute is not related to any specific construct.
255 -|PrimaryMeasure Relationship| |(% style="width:695px" %)The Data Attribute is related to the Primary Measure construct.
256 -|GroupRelationship| |(% style="width:695px" %)The Data Attribute is related to a Group Dimension Descriptor construct.
257 -| |+groupKey|(% style="width:695px" %)An association to the Group Dimension Descriptor
258 -|DimensionRelationship| |(% style="width:695px" %)The Data Attribute is related to a set of Dimensions.
259 -| |+dimensions|(% style="width:695px" %)Association to the set of Dimensions to which the Data Attribute is related.
260 -| |+groupKey|(% style="width:695px" %)Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
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.
261 261  
276 +
277 +
262 262  The explanation of the classes, attributes, and associations comprising the Representation is described in the section on the SDMX Base.
263 263  
264 264  == {{id name="_Toc371016"/}}5.4 Data Set – Relationship View ==
... ... @@ -269,12 +269,8 @@
269 269  
270 270  === {{id name="_Toc371018"/}}5.4.2 Class Diagram ===
271 271  
272 -(% class="wikigeneratedid" id="H" %)
273 -[[image:1747897072125-219.png]]
288 +====== Figure 26 Class Diagram of the Data Set ======
274 274  
275 -(% class="wikigeneratedid" id="HFigure26ClassDiagramoftheDataSet" %)
276 -**Figure 26 Class Diagram of the Data Set**
277 -
278 278  === {{id name="_Toc371019"/}}5.4.3 Explanation of the Diagram ===
279 279  
280 280  ==== 5.4.3.1 Narrative – Data Set ====
... ... @@ -283,8 +283,10 @@
283 283  
284 284  An organisation playing the role of DataProvider can be responsible for one or more //DataSet//.
285 285  
286 -A //DataSet// can be formatted either as a generic data set (GenericDataSet, GenericTimeseriesDataSet) or a DataStructureDefinition specific data set (StructureSpecificDataSet, StructureSpecificTimeseriesDataSet). The generic data set is structured in exactly the same way no matter which DataStructureDefinition the DataSet expresses. The structured data set is structured according to one specific DataStructureDefinition. Depending on the syntax chosen for the implementation the structured data set should support better validation at the syntax level.
298 +A //DataSet// can be formatted either as a generic data set (GenericDataSet,
287 287  
300 +GenericTimeseriesDataSet) or a DataStructureDefinition specific data set (StructureSpecificDataSet, StructureSpecificTimeseriesDataSet). The generic data set is structured in exactly the same way no matter which DataStructureDefinition the DataSet expresses. The structured data set is structured according to one specific DataStructureDefinition. Depending on the syntax chosen for the implementation the structured data set should support better validation at the syntax level.
301 +
288 288  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, MeasureDimension, TimeDimension) defined in the DimensionDescriptor of the DataStructureDefinition, together with associated //AttributeValue//s that define specific characteristics about the artefact to which it is attached. - DataSet, Observation, set of Dimensions. It is structured in terms of a SeriesKey to which //Observation//s are reported.
289 289  
290 290  The Observation can be the value of the variable being measured for the Concept associated to the PrimaryMeasure in the MeasureDescriptor of the DataStructureDefinition. This is true when there is no MeasureDimension that specifies the precise meaning of each Observation. Each Observation associates an ObservationValue 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//).
... ... @@ -307,146 +307,186 @@
307 307  
308 308  ==== 5.4.3.2 Definitions ====
309 309  
310 -(% style="width:1012.83px" %)
311 -|(% style="width:182px" %)**Class**|(% style="width:210px" %)**Feature**|(% style="width:617px" %)**Description**
312 -|(% style="width:182px" %)//DataSet//|(% style="width:210px" %)(((
324 +|**Class**|**Feature**|**Description**
325 +|//DataSet//|(((
313 313  Abstract Class
327 +
314 314  Sub classes
329 +
315 315  GenericDataSet
331 +
316 316  StructureSpecificDataSet
333 +
317 317  GenericTime
335 +
318 318  SeriesDataSet
337 +
319 319  StructureSpecificTime
339 +
320 320  SeriesDataSet
321 -)))|(% style="width:617px" %)An organised collection of data.
322 -|(% style="width:182px" %) |(% style="width:210px" %)reportingBegin|(% style="width:617px" %)A specific time period in a known system of time periods that identifies the start period of a report.
323 -|(% style="width:182px" %) |(% style="width:210px" %)reportingEnd|(% style="width:617px" %)A specific time period in a known system of time periods that identifies the end period of a report.
324 -|(% style="width:182px" %) |(% style="width:210px" %)dataExtractionDate|(% style="width:617px" %)A specific time period that identifies the date and time that the data are extracted from a data source.
325 -|(% style="width:182px" %) |(% style="width:210px" %)validFrom|(% style="width:617px" %)Indicates the inclusive start time indicating the validity of the information in the data set.
326 -|(% style="width:182px" %) |(% style="width:210px" %)validTo|(% style="width:617px" %)Indicates the inclusive end time indicating the validity of the information in the data set.
327 -|(% style="width:182px" %) |(% style="width:210px" %)publicationYear|(% style="width:617px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
328 -|(% style="width:182px" %) |(% style="width:210px" %)publicationPeriod|(% style="width:617px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
329 -|(% style="width:182px" %) |(% style="width:210px" %)setId|(% style="width:617px" %)Provides an identification of the data set.
330 -|(% style="width:182px" %) |(% style="width:210px" %)action|(% style="width:617px" %)Defines the action to be taken by the recipient system (update, append, delete)
331 -|(% style="width:182px" %) |(% style="width:210px" %)describedBy|(% style="width:617px" %)Associates a data flow definition and thereby a Data Structure Definition to the data set.
332 -|(% style="width:182px" %) |(% style="width:210px" %)+structuredBy|(% style="width:617px" %)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.
333 -|(% style="width:182px" %) |(% style="width:210px" %)+publishedBy|(% style="width:617px" %)Associates the Data Provider that reports/publishes the data.
334 -|(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Data Set
335 -|(% style="width:182px" %)GenericDataSet|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that is able to contain data corresponding to any Data Structure Definition.
336 -|(% style="width:182px" %)StructureSpecific DataSet|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that contains data corresponding to one specific Data Structure Definition.
337 -|(% style="width:182px" %)GenericTimeseries DataSet|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that is able to contain timeseries data corresponding to any Data Structure Definition.
338 -|(% style="width:182px" %)(((
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.
358 +|(((
339 339  StructureSpecific
340 340  
341 341  TimeseriesDataSet
342 -)))|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that contains timeseries data corresponding to one specific Data Structure Definition.
343 -|(% style="width:182px" %)Key|(% style="width:210px" %)(((
362 +)))||A data format structure that contains timeseries data corresponding to one specific Data Structure Definition.
363 +|Key|(((
344 344  Abstract class Sub classes
365 +
345 345  SeriesKey
367 +
346 346  GroupKey
347 -)))|(% style="width:617px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
348 -|(% style="width:182px" %) |(% style="width:210px" %)keyValues|(% style="width:617px" %)Association to the individual Key Values that comprise the Key.
349 -|(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Series Key or Group Key.
350 -|(% style="width:182px" %)//KeyValue//|(% style="width:210px" %)(((
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.
372 +|//KeyValue//|(((
351 351  Abstract class
374 +
352 352  Sub classes
376 +
353 353  MeasureKeyValue
378 +
354 354  TimeKeyValue
380 +
355 355  CodedKeyValue
382 +
356 356  UncodedKeyValue
357 -)))|(% style="width:617px" %)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.
358 -|(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)(((
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|(((
359 359  Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
387 +
360 360  Note that this is conceptual association as the key component is identified explicitly in the data set.
361 361  )))
362 -|(% style="width:182px" %)MeasureKeyValue|(% style="width:210px" %)(((
390 +|MeasureKeyValue|(((
363 363  Inherits from
392 +
364 364  //KeyValue//
365 -)))|(% style="width:617px" %)The value of the Measure Dimension component of the key. The value is the Concept to which this class is associated.
366 -|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
394 +)))|The value of the Measure Dimension component of the key. The value is the Concept to which this class is associated.
395 +||+value|(((
367 367  Association to the Concept.
368 -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 Definition. In the actual Data Set the value of the Concept is placed in the Key Value.
397 +
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
399 +
400 +Definition. In the actual Data Set the value of the Concept is placed in the Key Value.
369 369  )))
370 -|(% style="width:182px" %)TimeKeyValue|(% style="width:210px" %)(((
402 +|TimeKeyValue|(((
371 371  Inherits from
404 +
372 372  //KeyValue//
373 -)))|(% style="width:617px" %)The value of the Time Dimension component of the key.
374 -|(% style="width:182px" %)CodedKeyValue|(% style="width:210px" %)(((
406 +)))|The value of the Time Dimension component of the key.
407 +|CodedKeyValue|(((
375 375  Inherits from
409 +
376 376  //KeyValue//
377 -)))|(% style="width:617px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
378 -|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
411 +)))|The value of a coded component of the key. The value is the Code to which this class is associated.
412 +||+value|(((
379 379  Association to the Code.
380 -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.
414 +
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
416 +
417 +Structure Definition. In the actual Data Set the value of the Code is placed in the Key Value.
381 381  )))
382 -|(% style="width:182px" %)UnCodedKeyValue|(% style="width:210px" %)(((
419 +|UnCodedKeyValue|(((
383 383  Inherits from
421 +
384 384  //KeyValue//
385 -)))|(% style="width:617px" %)The value of an uncoded component of the key.
386 -|(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the key component.
387 -|(% style="width:182px" %) |(% style="width:210px" %)startTime|(% style="width:617px" %)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).
388 -|(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)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.
389 -|(% style="width:182px" %)GroupKey|(% style="width:210px" %)(((
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.
427 +|GroupKey|(((
390 390  Inherits from
391 391  
392 392  Key
393 -)))|(% style="width:617px" %)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.
394 -|(% style="width:182px" %) |(% style="width:210px" %)+describedBy|(% style="width:617px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
395 -|(% style="width:182px" %)SeriesKey|(% style="width:210px" %)(((
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.
433 +|SeriesKey|(((
396 396  Inherits from
435 +
397 397  Key
398 -)))|(% style="width:617px" %)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.
399 -|(% style="width:182px" %) |(% style="width:210px" %)+describedBy|(% style="width:617px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
400 -|(% style="width:182px" %)Observation|(% style="width:210px" %) |(% style="width:617px" %)The value of the observed phenomenon in the context of the Key Values comprising the key.
401 -|(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)Associates the Primary Measure defined in the Data Structure Definition.
402 -|(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Observation.
403 -|(% style="width:182px" %) |(% style="width:210px" %)+observationDimension|(% style="width:617px" %)Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
404 -|(% style="width:182px" %)//ObservationValue//|(% style="width:210px" %)(((
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”.
443 +|//ObservationValue//|(((
405 405  Abstract class
445 +
406 406  Sub classes
447 +
407 407  UncodedObservation
449 +
408 408  CodedObservation
409 -)))|(% style="width:617px" %)
410 -|(% style="width:182px" %)UncodedObservation|(% style="width:210px" %)(((
451 +)))|
452 +|UncodedObservation|(((
411 411  Inherits from
454 +
412 412  ObservationValue
413 -)))|(% style="width:617px" %)An observation that has a text value.
414 -|(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the Uncoded Observation.
415 -|(% style="width:182px" %)CodedObservation|(% style="width:210px" %)(((
456 +)))|An observation that has a text value.
457 +||value|The value of the Uncoded Observation.
458 +|CodedObservation|(((
416 416  Inherits from
460 +
417 417  ObservationValue
418 -)))|(% style="width:617px" %)An Observation that takes its value from a code in a Code list.
419 -|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
462 +)))|An Observation that takes its value from a code in a Code list.
463 +||+value|(((
420 420  Association to the Code that is the value of the Observation.
421 -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 Structure Definition. In the actual Data Set the value of the Code is placed in the Observation.
465 +
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
467 +
468 +Structure Definition. In the actual Data Set the value of the Code is placed in the Observation.
422 422  )))
423 -|(% style="width:182px" %)//AttributeValue//|(% style="width:210px" %)(((
470 +|//AttributeValue//|(((
424 424  Abstract class
472 +
425 425  Sub classes
426 -//UncodedAttributeValue
427 -CodedAttributeValue//
428 -)))|(% style="width:617px" %)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.
429 -|(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the attribute.
430 -|(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)(((
474 +
475 +//UncodedAttributeValue//
476 +
477 +//CodedAttributeValue//
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|(((
431 431  Association to the Data Attribute defined in the Data Structure Definition.
482 +
432 432  Note that this is conceptual association as the Concept is identified explicitly in the data set.
433 433  )))
434 -|(% style="width:182px" %)//UncodedAttribute Value//|(% style="width:210px" %)(((
485 +|//UncodedAttribute Value//|(((
435 435  Inherits from
487 +
436 436  //AttributeValue//
437 -)))|(% style="width:617px" %)An attribute value that has a text value.
438 -|(% style="width:182px" %) |(% style="width:210px" %)startTime|(% style="width:617px" %)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).
439 -|(% style="width:182px" %)(((
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).
491 +|(((
440 440  CodedAttribute
441 441  
442 442  Value
443 -)))|(% style="width:210px" %)(((
495 +)))|(((
444 444  Inherits from
497 +
445 445  //AttributeValue//
446 -)))|(% style="width:617px" %)An attribute that takes it value from a Code in Code list.
447 -|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
499 +)))|An attribute that takes it value from a Code in Code list.
500 +||+value|(((
448 448  Association to the Code that is the value of the Attribute Value.
502 +
449 449  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.
450 450  )))
451 451  
452 -
506 +Ъ
1747896950895-141.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -29.5 KB
Content
1747897072125-219.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -101.7 KB
Content
1747897165713-725.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -64.1 KB
Content
SUZ.Methodology.Code.MethodologyClass[0]