Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 1.1
edited by Helena
on 2025/05/19 23:52
Change comment: Changed document syntax from [XWiki 2.1] to [xwiki/2.1].
To version 4.2
edited by Helena
on 2025/05/22 00:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +5 Data Structure Definition and Dataset
Parent
... ... @@ -1,0 +1,1 @@
1 +Methodology.SDMX 2\.1 Standards\. Section 2\. Information model\: UML conceptual design.WebHome
Content
... ... @@ -1,0 +1,441 @@
1 += {{id name="_Toc371008"/}}5 Data Structure Definition and Dataset =
2 +
3 +== {{id name="_Toc371009"/}}5.1 Introduction ==
4 +
5 +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.
6 +
7 +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.
8 +
9 +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).
10 +
11 +The actual SDMX Base construct from which the concrete classes inherit depends upon the requirements of the class for:
12 +
13 +* Annotation - //AnnotableArtefact//
14 +* Identification - //IdentifiableArtefact//
15 +* Naming - //NameableArtefact//
16 +* Versioning – //VersionableArtefact//
17 +* Maintenance - //MaintainableArtefact//
18 +
19 +== {{id name="_Toc371010"/}}5.2 Inheritance View ==
20 +
21 +=== {{id name="_Toc371011"/}}5.2.1 Class Diagram ===
22 +
23 +[[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_aa1923f1.png||height="628" width="556"]]
24 +
25 +**Figure 22 Class inheritance in the Data Structure Definition and Data Set Packages**
26 +
27 +=== {{id name="_Toc371012"/}}5.2.2 Explanation of the Diagram ===
28 +
29 +==== 5.2.2.1 Narrative ====
30 +
31 +Those classes in the SDMX metamodel which require annotations inherit from //AnnotableArtefact// . These are:
32 +
33 +* //IdentifiableArtefact//
34 +* DataSet (and therefore StructureSpecificDataSet, GenericDataSet, GenericTimeSeriesDataSet StructureSpecificTimeSeriesDataSet)
35 +* //Key //(and therefore SeriesKey and GroupKey)
36 +
37 +Those classes in the SDMX metamodel which require annotations and global identity are derived from //IdentifiableArtefact// . These are:
38 +
39 +* //NameableArtefact//
40 +* //ComponentList//
41 +* //Component//
42 +
43 +Those classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description are derived from //NameableArtefact// . These are:
44 +
45 +* //VersionableArtefact//
46 +* //Item//
47 +
48 +The classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact// . These are:
49 +
50 +* //MaintainableArtefact//
51 +
52 +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:
53 +
54 +* //StructureUsage//
55 +* //Structure//
56 +* //ItemScheme//
57 +
58 +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.
59 +
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 +
62 +* DataflowDefinition
63 +* DataStructureDefinition
64 +
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 +
67 +* DataStructureDefinition
68 +
69 +A DataStructureDefinition contains a list of dimensions, a list of measures and a list of attributes.
70 +
71 +The concrete classes which inherit from //ComponentList// and are sub components of the DataStructureDefinition are:
72 +
73 +* DimensionDescriptor – content is Dimension, MeasureDimension and Time Dimension
74 +* DimensionGroupDescriptor – content is an association to Dimension, MeasureDimension, TimeDimension
75 +* MeasureDescriptor – content is PrimaryMeasure
76 +* AttributeDescriptor – content is DataAttribute
77 +
78 +The classes that inherit from //Component// are:
79 +
80 +* PrimaryMeasure
81 +* DimensionComponent and thereby its sub classes of Dimension, MeasureDimension, and TimeDimension
82 +* DataAttribute
83 +
84 +The class that inherit from DataAttribute is:
85 +
86 +* ReportingYearStartDay
87 +
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.
89 +
90 +== {{id name="_Toc371013"/}}5.3 Data Structure Definition – Relationship View ==
91 +
92 +=== {{id name="_Toc371014"/}}5.3.1 Class Diagram ===
93 +
94 +====== Figure 23 Relationship class diagram of the Data Structure Definition excluding representation ======
95 +
96 +=== {{id name="_Toc371015"/}}5.3.2 Explanation of the Diagrams ===
97 +
98 +==== 5.3.2.1 Narrative ====
99 +
100 +A DataStructureDefinition defines the Dimensions, MeasureDimension, TimeDimension, DataAttributes, and PrimaryMeasure, and associated Representation that comprise the valid structure of data and related attributes that are contained in a DataSet, which is defined by a DataflowDefinition.
101 +
102 +The DataflowDefinition may also have additional metadata attached that defines qualitative information and Constraints on the use of the DataStructureDefinition such as the sub set of Codes used in a Dimension (this is covered later in this document – see “Data Constraints and Provisioning” section 9). Each DataflowDefinition has a maximum of one DataStructureDefinition specified which defines the structure of any DataSets to be reported/disseminated.
103 +
104 +There are three types of dimension each having a common association to Concept:
105 +
106 +* Dimension
107 +* MeasureDimension
108 +* TimeDimension
109 +
110 +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.
111 +
112 +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.
113 +
114 +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
115 +
116 +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.
117 +
118 +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.
119 +
120 +There may be a maximum of one MeasureDimension specified in the DimensionDescriptor. The purpose of a MeasureDimension is to specify formally the meaning of the measures (because the PrimaryMeasure typically has a generic meaning e.g. observation value) and to enable multiple measures to be defined and reported in a StructureSpecificDataSet. Note that the MeasureDimension references a ConceptScheme as its Representation (see later) whereas a Dimension can have either an enumerated (Codelist) or non-enumerated (Facet) representation. For a MeasureDimension the Concepts in the ConceptScheme comprise the list of allowable measures. This enables the representation for each individual measure (Concept) to be declared as the coreRepresentation of the Concept, thus overriding the Representation specified for the PrimaryMeasure for the observation value of this MeasureDimension Concept.
121 +
122 +There can be a maximum of one TimeDimension specified in the DimensionDescriptor. The TimeDimension is used to specify the Concept used to convey the time period of the observation in a data set. The TimeDimension must contain a valid representation of time and cannot be coded
123 +
124 +The PrimaryMeasure is the observable phenomenon, and, although there can be only one PrimaryMeasure, for consistency with the ComponentList/Component pattern it is grouped by a MeasureDescriptor.
125 +
126 +The DataAttribute defines a characteristic of data that are collected or disseminated and is grouped in the DataStructureDefinition by a single AttributeDescriptor. The DataAttribute can be specified as being mandatory, or conditional, as defined in usageStatus. The DataAttribute may play a specific role in the structure and this is specified by the +role association to the Concept that identifies its role.
127 +
128 +A DataAttribute is specified as being +relatedTo an AttributeRelationship which defines the constructs to which the DataAttribute is to be reported present in a //DataSet//. The DataAttribute can be specified as being related to one of the following artefacts:
129 +
130 +* DataSet (NoSpecifiedRelationship)
131 +* Dimension or set of Dimensions (DimensionRelationship)
132 +* Set of Dimensions specified by a GroupKey (GroupRelationship – this is retained for compatibility reasons – or +groupKey of the DimensionRelationship)
133 +* Observation (PrimaryMeasureRelationship)
134 +
135 +**Figure 24: Attribute Attachment Defined in the Data Structure Definition**
136 +
137 +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.
138 +
139 +(((
140 +(% style="width:1104.83px" %)
141 +|**Relationship**|(% style="width:524px" %)**Meaning**|(% style="width:449px" %)**Location in Data Set at which the Attribute is reported**
142 +|None|(% style="width:524px" %)The value of the attribute does not vary with the values of any other Component.|(% style="width:449px" %)The attribute is reported at the level of the Dataset Attribute.
143 +|(((
144 +Dimension
145 +
146 +(1..n)
147 +)))|(% style="width:524px" %)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:449px" %)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.
148 +|**Relationship**|(% style="width:524px" %)**Meaning**|(% style="width:449px" %)**Location in Data Set at which the Attribute is reported**
149 +|Group|(% style="width:524px" %)(((
150 +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.
151 +)))|(% style="width:449px" %)The attribute is reported at the level of Group.
152 +|Primary Measure|(% style="width:524px" %)The value of the Attribute varies with the observed value.|(% style="width:449px" %)The attribute is reported at the level of Observation.
153 +)))
154 +
155 +**Figure 25: Representation of DSD Components**
156 +
157 +Each of Dimension, MeasureDimension, TimeDimension, PrimaryMeasure, and DataAttribute 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. For the MeasureDimension the representation for the individual measures is specified for the Concept in the ConceptScheme referenced by the MeasureDimension.
158 +
159 +A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap.
160 +
161 +==== 5.3.2.2 Definitions ====
162 +
163 +|**Class**|**Feature**|**Description**
164 +|StructureUsage| |See “SDMX Base”.
165 +|DataflowDefinition|(((
166 +Inherits from
167 +//StructureUsage//
168 +)))|Abstract concept (i.e. the structure without any data) of a flow of data that providers will provide for different reference periods.
169 +| |/structure|Associates a Dataflow Definition to the Data Structure Definition.
170 +|DataStructureDefinition| |A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
171 +| |///grouping//|An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
172 +|(((
173 +Group
174 +
175 +DimensionDescriptor
176 +)))|(((
177 +Inherits from
178 +//ComponentList//
179 +)))|A set metadata concepts that define a partial key derived from the Dimension Descriptor in a Data Structure Definition.
180 +| |+constraint|Identifies an Attachment Constraint that specifies the sub set of Dimension, Measure, or Attribute values to which an Attribute can be attached.
181 +| |/components|An association to the Dimension and Measure Dimension components that comprise the group.
182 +|DimensionDescriptor|(((
183 +Inherits from
184 +//ComponentList//
185 +)))|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.
186 +| |/components|An association to the Dimension, Measure Dimension, and Time Dimension comprising the Key Descriptor.
187 +|AttributeDescriptor|(((
188 +Inherits from
189 +//ComponentList//
190 +)))|A set metadata concepts that define the attributes of a Data Structure Definition.
191 +| |/components|An association to a Data Attribute component.
192 +|MeasureDescriptor|(((
193 +Inherits from
194 +
195 +//ComponentList//
196 +)))|A metadata concept that defines the measure of a Data Structure Definition.
197 +| |/components|An association to a measure component.
198 +|Dimension|(((
199 +Inherits from
200 +Component
201 +)))|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.
202 +| |/role|Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
203 +| |/conceptIdentity|An association to the metadata concept which defines the semantic of the Dimension.
204 +|MeasureDimension|(((
205 +Inherits from
206 +
207 +Dimension
208 +)))|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.
209 +|DataAttribute|(((
210 +Inherits from
211 +Component
212 +Sub class
213 +ReportingYear
214 +StartDay
215 +)))|A characteristic of an object or entity.
216 +| |/role|Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
217 +| |usageStatus|Defines the usage status which is constrained by the data type Usage Status.
218 +| |+relatedTo|Association to a Attribute Relationship.
219 +| |/conceptIdentity|An association to the Concept which defines the semantic of the component.
220 +|TimeDimension|(((
221 +Inherits from
222 +
223 +Dimension
224 +)))|A metadata concept that identifies the component in the key structure that has the role of “time”.
225 +|ReportingYearStartDay|(((
226 +Inherits from
227 +DataAttribute
228 +)))|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.
229 +|PrimaryMeasure|(((
230 +Inherits from
231 +//Component//
232 +)))|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.
233 +| |/conceptIdentity|An association to the Concept which carries the values of the measures.
234 +|//AttributeRelationship//|(((
235 +Abstract Class
236 +Sub classes
237 +NoSpecified
238 +Relationship
239 +PrimaryMeasure
240 +Relationship
241 +GroupRelationship
242 +Dimension
243 +Relationship
244 +)))|Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
245 +|NoSpecifiedRelationship| |The Data Attribute is not related to any specific construct.
246 +|PrimaryMeasure Relationship| |The Data Attribute is related to the Primary Measure construct.
247 +|GroupRelationship| |The Data Attribute is related to a Group Dimension Descriptor construct.
248 +| |+groupKey|An association to the Group Dimension Descriptor
249 +|DimensionRelationship| |The Data Attribute is related to a set of Dimensions.
250 +| |+dimensions|Association to the set of Dimensions to which the Data Attribute is related.
251 +| |+groupKey|Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
252 +
253 +The explanation of the classes, attributes, and associations comprising the Representation is described in the section on the SDMX Base.
254 +
255 +== {{id name="_Toc371016"/}}5.4 Data Set – Relationship View ==
256 +
257 +=== {{id name="_Toc371017"/}}5.4.1 Context ===
258 +
259 +A data set comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition.
260 +
261 +=== {{id name="_Toc371018"/}}5.4.2 Class Diagram ===
262 +
263 +====== ======
264 +
265 +====== **Figure 26 Class Diagram of the Data Set** ======
266 +
267 +=== {{id name="_Toc371019"/}}5.4.3 Explanation of the Diagram ===
268 +
269 +==== 5.4.3.1 Narrative – Data Set ====
270 +
271 +Note that the //DataSet// must conform to the DataStructureDefinition associated to the DataflowDefinition for which this DataSet is an “instance of data”. Whilst the model shows the association to the classes of the DataStructureDefinition, this is for conceptual purposes to show the link to the DataStructureDefinition. In the actual DataSet as exchanged there must, of course, be a reference to the DataStructureDefinition and optionally a DataflowDefinition, but the DataStructureDefinition is not necessarily exchanged with the data. Therefore, the DataStructureDefinition classes are shown in the grey areas, as these are not a part of the //DataSet// when the DataSet is exchanged. However, the structural metadata in the DataStructureDefinition can be used by an application to validate the contents of the //DataSet// in terms of the valid content of a //KeyValue// as defined by the Representation in the DataStructureDefinition.
272 +
273 +An organisation playing the role of DataProvider can be responsible for one or more //DataSet//.
274 +
275 +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.
276 +
277 +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.
278 +
279 +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//).
280 +
281 +If the “Dimension at the Observation Level” is the MeasureDimension it is possible (but not mandatory) that an Observation can be reported with an explicit identification of one or more Concept in the ConceptScheme referenced by the MeasureDimension as its Representation. In other words, the actual Concepts are explicitly stated in the Observation.
282 +
283 +If it is required to specify explicitly that the DataSet is time series then one of GenericTimeSeriesDataSet or StructureSpecificTimeSeriesDataSet is used and the //KeyValue// for the +observationDimension must be a TimeKeyValue. In a GenericDataSet and a StructureSpecificDataSet it is permissible to have any dimension as the +observationDimension including the TimeDimension.
284 +
285 +The //KeyValue// is a value for one of MeasureDimension, TimeDimension, or Dimension specified in the DataStructureDefinition. If it is a Dimension it can be coded (CodedKeyValue) or uncoded (UncodedKeyValue). If it is a MeasureDimension then it is MeasureKeyValue. If it is TimeDimension then it is a TimeKeyValue. The actual value that the CodedDimensionValue can take must be one of the Codes in the Codelist specified as the Representation of the Dimension in the DataStructureDefinition. The actual value that the MeasureDimensionValue can take must be a valid representation specified for the Concept in the ConceptScheme to which this MeasureDimensionValue is related (+valueFor).
286 +
287 +The ObservationValue can be coded - this is the CodedObservation – or it can be uncoded – this is the UncodedObservation.
288 +
289 +The GroupKey is a sub unit of the //Key// that has the same dimensionality as the SeriesKey, but defines a subset of the KeyValues of the SeriesKey. Its sub dimension structure is defined in the GroupDimensionDescriptor of the DataStructureDefinition identified by the same id as the GroupKey. The id identifies a “type” of group and the purpose of the
290 +
291 +GroupKey is to report one or more AttributeValue that are contained at this group level. The GroupKey is present when the GroupDimensionDescriptor is related to the GroupRelationship in the DataStructureDefinition. There can be many types of groups in a //DataSet//. If the Group is related to the DimensionRelationship in the DataStructureDefinition then the AttributeValue will be reported with the appropriate dimension in the SeriesKey or Observation.
292 +
293 +In this way each of //DataSet//, SeriesKey, GroupKey, and Observation can have zero or more AttributeValue that defines some metadata about the object to which it is associated. The allowable Concepts and the objects to which these metadata can be associated (attached) are defined in the DataStructureDefinition.
294 +
295 +The //AttributeValue// links to the object type (DataSet, SeriesKey, GroupKey, Observation,) to which it is associated.
296 +
297 +==== 5.4.3.2 Definitions ====
298 +
299 +(% style="width:1012.83px" %)
300 +|(% style="width:182px" %)**Class**|(% style="width:210px" %)**Feature**|(% style="width:617px" %)**Description**
301 +|(% style="width:182px" %)//DataSet//|(% style="width:210px" %)(((
302 +Abstract Class
303 +Sub classes
304 +GenericDataSet
305 +StructureSpecificDataSet
306 +GenericTime
307 +SeriesDataSet
308 +StructureSpecificTime
309 +SeriesDataSet
310 +)))|(% style="width:617px" %)An organised collection of data.
311 +|(% 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.
312 +|(% 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.
313 +|(% 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.
314 +|(% 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.
315 +|(% 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.
316 +|(% 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.
317 +|(% 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.
318 +|(% style="width:182px" %) |(% style="width:210px" %)setId|(% style="width:617px" %)Provides an identification of the data set.
319 +|(% style="width:182px" %) |(% style="width:210px" %)action|(% style="width:617px" %)Defines the action to be taken by the recipient system (update, append, delete)
320 +|(% 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.
321 +|(% 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.
322 +|(% style="width:182px" %) |(% style="width:210px" %)+publishedBy|(% style="width:617px" %)Associates the Data Provider that reports/publishes the data.
323 +|(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Data Set
324 +|(% 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.
325 +|(% 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.
326 +|(% 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.
327 +|(% style="width:182px" %)(((
328 +StructureSpecific
329 +
330 +TimeseriesDataSet
331 +)))|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that contains timeseries data corresponding to one specific Data Structure Definition.
332 +|(% style="width:182px" %)Key|(% style="width:210px" %)(((
333 +Abstract class Sub classes
334 +SeriesKey
335 +GroupKey
336 +)))|(% style="width:617px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
337 +|(% style="width:182px" %) |(% style="width:210px" %)keyValues|(% style="width:617px" %)Association to the individual Key Values that comprise the Key.
338 +|(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Series Key or Group Key.
339 +|(% style="width:182px" %)//KeyValue//|(% style="width:210px" %)(((
340 +Abstract class
341 +Sub classes
342 +MeasureKeyValue
343 +TimeKeyValue
344 +CodedKeyValue
345 +UncodedKeyValue
346 +)))|(% 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.
347 +|(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)(((
348 +Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
349 +Note that this is conceptual association as the key component is identified explicitly in the data set.
350 +)))
351 +|(% style="width:182px" %)MeasureKeyValue|(% style="width:210px" %)(((
352 +Inherits from
353 +//KeyValue//
354 +)))|(% style="width:617px" %)The value of the Measure Dimension component of the key. The value is the Concept to which this class is associated.
355 +|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
356 +Association to the Concept.
357 +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.
358 +)))
359 +|(% style="width:182px" %)TimeKeyValue|(% style="width:210px" %)(((
360 +Inherits from
361 +//KeyValue//
362 +)))|(% style="width:617px" %)The value of the Time Dimension component of the key.
363 +|(% style="width:182px" %)CodedKeyValue|(% style="width:210px" %)(((
364 +Inherits from
365 +//KeyValue//
366 +)))|(% style="width:617px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
367 +|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
368 +Association to the Code.
369 +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.
370 +)))
371 +|(% style="width:182px" %)UnCodedKeyValue|(% style="width:210px" %)(((
372 +Inherits from
373 +//KeyValue//
374 +)))|(% style="width:617px" %)The value of an uncoded component of the key.
375 +|(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the key component.
376 +|(% 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).
377 +|(% 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.
378 +|(% style="width:182px" %)GroupKey|(% style="width:210px" %)(((
379 +Inherits from
380 +
381 +Key
382 +)))|(% 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.
383 +|(% style="width:182px" %) |(% style="width:210px" %)+describedBy|(% style="width:617px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
384 +|(% style="width:182px" %)SeriesKey|(% style="width:210px" %)(((
385 +Inherits from
386 +Key
387 +)))|(% 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.
388 +|(% style="width:182px" %) |(% style="width:210px" %)+describedBy|(% style="width:617px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
389 +|(% 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.
390 +|(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)Associates the Primary Measure defined in the Data Structure Definition.
391 +|(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Observation.
392 +|(% 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”.
393 +|(% style="width:182px" %)//ObservationValue//|(% style="width:210px" %)(((
394 +Abstract class
395 +Sub classes
396 +UncodedObservation
397 +CodedObservation
398 +)))|(% style="width:617px" %)
399 +|(% style="width:182px" %)UncodedObservation|(% style="width:210px" %)(((
400 +Inherits from
401 +ObservationValue
402 +)))|(% style="width:617px" %)An observation that has a text value.
403 +|(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the Uncoded Observation.
404 +|(% style="width:182px" %)CodedObservation|(% style="width:210px" %)(((
405 +Inherits from
406 +ObservationValue
407 +)))|(% style="width:617px" %)An Observation that takes its value from a code in a Code list.
408 +|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
409 +Association to the Code that is the value of the Observation.
410 +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.
411 +)))
412 +|(% style="width:182px" %)//AttributeValue//|(% style="width:210px" %)(((
413 +Abstract class
414 +Sub classes
415 +//UncodedAttributeValue
416 +CodedAttributeValue//
417 +)))|(% 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.
418 +|(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the attribute.
419 +|(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)(((
420 +Association to the Data Attribute defined in the Data Structure Definition.
421 +Note that this is conceptual association as the Concept is identified explicitly in the data set.
422 +)))
423 +|(% style="width:182px" %)//UncodedAttribute Value//|(% style="width:210px" %)(((
424 +Inherits from
425 +//AttributeValue//
426 +)))|(% style="width:617px" %)An attribute value that has a text value.
427 +|(% 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).
428 +|(% style="width:182px" %)(((
429 +CodedAttribute
430 +
431 +Value
432 +)))|(% style="width:210px" %)(((
433 +Inherits from
434 +//AttributeValue//
435 +)))|(% style="width:617px" %)An attribute that takes it value from a Code in Code list.
436 +|(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
437 +Association to the Code that is the value of the Attribute Value.
438 +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.
439 +)))
440 +
441 +Ъ
SDMX_2-1_SECTION_2_InformationModel_2020-07_aa1923f1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +132.4 KB
Content