Version 6.1 by Helena on 2025/05/22 09:57

Hide last authors
Helena 6.1 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Helena 2.1 4
5 == {{id name="_Toc371009"/}}5.1 Introduction ==
6
7 The DataStructureDefiniton is the class name for a structure definition for data. Some organisations know this type of definition as a “Key Family” and so the two names are synonymous. The term Data Structure Definition (also referred to as DSD) is used in this specification.
8
9 Many of the constructs in this layer of the model inherit from the SDMX Base Layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual packages. In simple sub models these are shown in the same diagram, but are omitted from the more complex sub models for the sake of clarity. In these cases, the inheritance diagram below shows the full inheritance tree for the classes concerned with data structure definitions.
10
11 There are very few additional classes in this sub model other than those shown in the inheritance diagram below. In other words, the SDMX Base gives most of the structure of this sub model both in terms of associations and in terms of attributes. The relationship diagrams shown in this section show clearly when these associations are inherited from the SDMX Base (see the Appendix “A Short Guide to UML in the SDMX Information Model” to see the diagrammatic notation used to depict this).
12
13 The actual SDMX Base construct from which the concrete classes inherit depends upon the requirements of the class for:
14
15 * Annotation - //AnnotableArtefact//
16 * Identification - //IdentifiableArtefact//
17 * Naming - //NameableArtefact//
18 * Versioning – //VersionableArtefact//
19 * Maintenance - //MaintainableArtefact//
20
21 == {{id name="_Toc371010"/}}5.2 Inheritance View ==
22
23 === {{id name="_Toc371011"/}}5.2.1 Class Diagram ===
24
25 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_aa1923f1.png||height="628" width="556"]]
26
27 **Figure 22 Class inheritance in the Data Structure Definition and Data Set Packages**
28
29 === {{id name="_Toc371012"/}}5.2.2 Explanation of the Diagram ===
30
31 ==== 5.2.2.1 Narrative ====
32
33 Those classes in the SDMX metamodel which require annotations inherit from //AnnotableArtefact// . These are:
34
35 * //IdentifiableArtefact//
36 * DataSet (and therefore StructureSpecificDataSet, GenericDataSet, GenericTimeSeriesDataSet StructureSpecificTimeSeriesDataSet)
Helena 3.3 37 * //Key //(and therefore SeriesKey and GroupKey)
Helena 2.1 38
39 Those classes in the SDMX metamodel which require annotations and global identity are derived from //IdentifiableArtefact// . These are:
40
41 * //NameableArtefact//
42 * //ComponentList//
43 * //Component//
44
45 Those classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description are derived from //NameableArtefact// . These are:
46
47 * //VersionableArtefact//
48 * //Item//
49
50 The classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact// . These are:
51
52 * //MaintainableArtefact//
53
54 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:
55
56 * //StructureUsage//
57 * //Structure//
58 * //ItemScheme//
59
60 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.
61
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
Helena 3.3 64 * DataflowDefinition
65 * DataStructureDefinition
Helena 2.1 66
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
Helena 3.3 69 * DataStructureDefinition
Helena 2.1 70
71 A DataStructureDefinition contains a list of dimensions, a list of measures and a list of attributes.
72
73 The concrete classes which inherit from //ComponentList// and are sub components of the DataStructureDefinition are:
74
75 * DimensionDescriptor – content is Dimension, MeasureDimension and Time Dimension
76 * DimensionGroupDescriptor – content is an association to Dimension, MeasureDimension, TimeDimension
77 * MeasureDescriptor – content is PrimaryMeasure
78 * AttributeDescriptor – content is DataAttribute
79
80 The classes that inherit from //Component// are:
81
82 * PrimaryMeasure
83 * DimensionComponent and thereby its sub classes of Dimension, MeasureDimension, and TimeDimension
84 * DataAttribute
85
86 The class that inherit from DataAttribute is:
87
88 * ReportingYearStartDay
89
90 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.
91
92 == {{id name="_Toc371013"/}}5.3 Data Structure Definition – Relationship View ==
93
94 === {{id name="_Toc371014"/}}5.3.1 Class Diagram ===
95
96 ====== Figure 23 Relationship class diagram of the Data Structure Definition excluding representation ======
97
98 === {{id name="_Toc371015"/}}5.3.2 Explanation of the Diagrams ===
99
100 ==== 5.3.2.1 Narrative ====
101
102 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.
103
104 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.
105
106 There are three types of dimension each having a common association to Concept:
107
108 * Dimension
Helena 4.2 109 * MeasureDimension
110 * TimeDimension
Helena 2.1 111
112 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.
113
114 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.
115
Helena 4.2 116 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
Helena 2.1 117
118 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.
119
120 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.
121
122 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.
123
124 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
125
126 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.
127
128 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.
129
130 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:
131
132 * DataSet (NoSpecifiedRelationship)
133 * Dimension or set of Dimensions (DimensionRelationship)
134 * Set of Dimensions specified by a GroupKey (GroupRelationship – this is retained for compatibility reasons – or +groupKey of the DimensionRelationship)
135 * Observation (PrimaryMeasureRelationship)
136
Helena 6.1 137 [[image:1747896950895-141.png]]
138
Helena 2.1 139 **Figure 24: Attribute Attachment Defined in the Data Structure Definition**
140
141 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.
142
143 (((
Helena 4.2 144 (% style="width:1104.83px" %)
Helena 5.1 145 |**Relationship**|(% style="width:415px" %)**Meaning**|(% style="width:556px" %)**Location in Data Set at which the Attribute is reported**
146 |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.
Helena 2.1 147 |(((
148 Dimension
149
150 (1..n)
Helena 5.1 151 )))|(% 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.
152 |**Relationship**|(% style="width:415px" %)**Meaning**|(% style="width:556px" %)**Location in Data Set at which the Attribute is reported**
153 |Group|(% style="width:415px" %)(((
Helena 4.2 154 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.
Helena 5.1 155 )))|(% style="width:556px" %)The attribute is reported at the level of Group.
156 |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.
Helena 2.1 157 )))
158
159 **Figure 25: Representation of DSD Components**
160
161 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.
162
163 A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap.
164
165 ==== 5.3.2.2 Definitions ====
166
Helena 5.1 167 (% style="width:1060.83px" %)
168 |**Class**|**Feature**|(% style="width:695px" %)**Description**
169 |StructureUsage| |(% style="width:695px" %)See “SDMX Base”.
Helena 2.1 170 |DataflowDefinition|(((
171 Inherits from
172 //StructureUsage//
Helena 5.1 173 )))|(% 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.
174 | |/structure|(% style="width:695px" %)Associates a Dataflow Definition to the Data Structure Definition.
175 |DataStructureDefinition| |(% style="width:695px" %)A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
176 | |///grouping//|(% style="width:695px" %)An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
Helena 2.1 177 |(((
178 Group
179
180 DimensionDescriptor
181 )))|(((
182 Inherits from
183 //ComponentList//
Helena 5.1 184 )))|(% style="width:695px" %)A set metadata concepts that define a partial key derived from the Dimension Descriptor in a Data Structure Definition.
185 | |+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.
186 | |/components|(% style="width:695px" %)An association to the Dimension and Measure Dimension components that comprise the group.
Helena 2.1 187 |DimensionDescriptor|(((
188 Inherits from
189 //ComponentList//
Helena 5.1 190 )))|(% 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.
191 | |/components|(% style="width:695px" %)An association to the Dimension, Measure Dimension, and Time Dimension comprising the Key Descriptor.
Helena 2.1 192 |AttributeDescriptor|(((
193 Inherits from
194 //ComponentList//
Helena 5.1 195 )))|(% style="width:695px" %)A set metadata concepts that define the attributes of a Data Structure Definition.
196 | |/components|(% style="width:695px" %)An association to a Data Attribute component.
Helena 2.1 197 |MeasureDescriptor|(((
198 Inherits from
199
200 //ComponentList//
Helena 5.1 201 )))|(% style="width:695px" %)A metadata concept that defines the measure of a Data Structure Definition.
202 | |/components|(% style="width:695px" %)An association to a measure component.
Helena 2.1 203 |Dimension|(((
204 Inherits from
205 Component
Helena 5.1 206 )))|(% 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.
207 | |/role|(% style="width:695px" %)Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
208 | |/conceptIdentity|(% style="width:695px" %)An association to the metadata concept which defines the semantic of the Dimension.
Helena 2.1 209 |MeasureDimension|(((
210 Inherits from
211
Helena 3.4 212 Dimension
Helena 5.1 213 )))|(% 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.
Helena 2.1 214 |DataAttribute|(((
215 Inherits from
216 Component
217 Sub class
218 ReportingYear
219 StartDay
Helena 5.1 220 )))|(% style="width:695px" %)A characteristic of an object or entity.
221 | |/role|(% style="width:695px" %)Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
222 | |usageStatus|(% style="width:695px" %)Defines the usage status which is constrained by the data type Usage Status.
223 | |+relatedTo|(% style="width:695px" %)Association to a Attribute Relationship.
224 | |/conceptIdentity|(% style="width:695px" %)An association to the Concept which defines the semantic of the component.
Helena 2.1 225 |TimeDimension|(((
226 Inherits from
227
Helena 3.4 228 Dimension
Helena 5.1 229 )))|(% style="width:695px" %)A metadata concept that identifies the component in the key structure that has the role of “time”.
Helena 2.1 230 |ReportingYearStartDay|(((
231 Inherits from
232 DataAttribute
Helena 5.1 233 )))|(% 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.
Helena 2.1 234 |PrimaryMeasure|(((
235 Inherits from
236 //Component//
Helena 5.1 237 )))|(% 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.
238 | |/conceptIdentity|(% style="width:695px" %)An association to the Concept which carries the values of the measures.
Helena 2.1 239 |//AttributeRelationship//|(((
240 Abstract Class
241 Sub classes
242 NoSpecified
243 Relationship
244 PrimaryMeasure
245 Relationship
246 GroupRelationship
247 Dimension
248 Relationship
Helena 5.1 249 )))|(% style="width:695px" %)Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
250 |NoSpecifiedRelationship| |(% style="width:695px" %)The Data Attribute is not related to any specific construct.
251 |PrimaryMeasure Relationship| |(% style="width:695px" %)The Data Attribute is related to the Primary Measure construct.
252 |GroupRelationship| |(% style="width:695px" %)The Data Attribute is related to a Group Dimension Descriptor construct.
253 | |+groupKey|(% style="width:695px" %)An association to the Group Dimension Descriptor
254 |DimensionRelationship| |(% style="width:695px" %)The Data Attribute is related to a set of Dimensions.
255 | |+dimensions|(% style="width:695px" %)Association to the set of Dimensions to which the Data Attribute is related.
256 | |+groupKey|(% style="width:695px" %)Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
Helena 2.1 257
258 The explanation of the classes, attributes, and associations comprising the Representation is described in the section on the SDMX Base.
259
260 == {{id name="_Toc371016"/}}5.4 Data Set – Relationship View ==
261
262 === {{id name="_Toc371017"/}}5.4.1 Context ===
263
264 A data set comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition.
265
266 === {{id name="_Toc371018"/}}5.4.2 Class Diagram ===
267
Helena 6.1 268 (% class="wikigeneratedid" id="H" %)
269 [[image:1747897072125-219.png]]
Helena 2.1 270
Helena 6.1 271 (% class="wikigeneratedid" id="HFigure26ClassDiagramoftheDataSet" %)
272 **Figure 26 Class Diagram of the Data Set**
Helena 3.6 273
Helena 2.1 274 === {{id name="_Toc371019"/}}5.4.3 Explanation of the Diagram ===
275
276 ==== 5.4.3.1 Narrative – Data Set ====
277
278 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.
279
280 An organisation playing the role of DataProvider can be responsible for one or more //DataSet//.
281
Helena 3.5 282 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.
Helena 2.1 283
284 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.
285
286 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//).
287
288 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.
289
290 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.
291
292 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).
293
294 The ObservationValue can be coded - this is the CodedObservation – or it can be uncoded – this is the UncodedObservation.
295
296 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
297
298 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.
299
300 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.
301
302 The //AttributeValue// links to the object type (DataSet, SeriesKey, GroupKey, Observation,) to which it is associated.
303
304 ==== 5.4.3.2 Definitions ====
305
Helena 3.5 306 (% style="width:1012.83px" %)
307 |(% style="width:182px" %)**Class**|(% style="width:210px" %)**Feature**|(% style="width:617px" %)**Description**
308 |(% style="width:182px" %)//DataSet//|(% style="width:210px" %)(((
Helena 2.1 309 Abstract Class
310 Sub classes
311 GenericDataSet
312 StructureSpecificDataSet
313 GenericTime
314 SeriesDataSet
315 StructureSpecificTime
316 SeriesDataSet
Helena 3.5 317 )))|(% style="width:617px" %)An organised collection of data.
318 |(% 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.
319 |(% 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.
320 |(% 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.
321 |(% 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.
322 |(% 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.
323 |(% 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.
324 |(% 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.
325 |(% style="width:182px" %) |(% style="width:210px" %)setId|(% style="width:617px" %)Provides an identification of the data set.
326 |(% style="width:182px" %) |(% style="width:210px" %)action|(% style="width:617px" %)Defines the action to be taken by the recipient system (update, append, delete)
327 |(% 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.
328 |(% 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.
329 |(% style="width:182px" %) |(% style="width:210px" %)+publishedBy|(% style="width:617px" %)Associates the Data Provider that reports/publishes the data.
330 |(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Data Set
331 |(% 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.
332 |(% 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.
333 |(% 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.
334 |(% style="width:182px" %)(((
Helena 2.1 335 StructureSpecific
336
337 TimeseriesDataSet
Helena 3.5 338 )))|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that contains timeseries data corresponding to one specific Data Structure Definition.
339 |(% style="width:182px" %)Key|(% style="width:210px" %)(((
Helena 2.1 340 Abstract class Sub classes
341 SeriesKey
342 GroupKey
Helena 3.5 343 )))|(% style="width:617px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
344 |(% style="width:182px" %) |(% style="width:210px" %)keyValues|(% style="width:617px" %)Association to the individual Key Values that comprise the Key.
345 |(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Series Key or Group Key.
346 |(% style="width:182px" %)//KeyValue//|(% style="width:210px" %)(((
Helena 2.1 347 Abstract class
348 Sub classes
349 MeasureKeyValue
350 TimeKeyValue
351 CodedKeyValue
352 UncodedKeyValue
Helena 3.5 353 )))|(% 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.
354 |(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)(((
Helena 2.1 355 Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
356 Note that this is conceptual association as the key component is identified explicitly in the data set.
357 )))
Helena 3.5 358 |(% style="width:182px" %)MeasureKeyValue|(% style="width:210px" %)(((
Helena 2.1 359 Inherits from
360 //KeyValue//
Helena 3.5 361 )))|(% style="width:617px" %)The value of the Measure Dimension component of the key. The value is the Concept to which this class is associated.
362 |(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
Helena 2.1 363 Association to the Concept.
Helena 3.5 364 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.
Helena 2.1 365 )))
Helena 3.5 366 |(% style="width:182px" %)TimeKeyValue|(% style="width:210px" %)(((
Helena 2.1 367 Inherits from
368 //KeyValue//
Helena 3.5 369 )))|(% style="width:617px" %)The value of the Time Dimension component of the key.
370 |(% style="width:182px" %)CodedKeyValue|(% style="width:210px" %)(((
Helena 2.1 371 Inherits from
372 //KeyValue//
Helena 3.5 373 )))|(% style="width:617px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
374 |(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
Helena 2.1 375 Association to the Code.
Helena 3.5 376 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.
Helena 2.1 377 )))
Helena 3.5 378 |(% style="width:182px" %)UnCodedKeyValue|(% style="width:210px" %)(((
Helena 2.1 379 Inherits from
380 //KeyValue//
Helena 3.5 381 )))|(% style="width:617px" %)The value of an uncoded component of the key.
382 |(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the key component.
383 |(% 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).
384 |(% 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.
385 |(% style="width:182px" %)GroupKey|(% style="width:210px" %)(((
Helena 2.1 386 Inherits from
387
388 Key
Helena 3.5 389 )))|(% 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.
390 |(% style="width:182px" %) |(% style="width:210px" %)+describedBy|(% style="width:617px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
391 |(% style="width:182px" %)SeriesKey|(% style="width:210px" %)(((
Helena 2.1 392 Inherits from
393 Key
Helena 3.5 394 )))|(% 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.
395 |(% style="width:182px" %) |(% style="width:210px" %)+describedBy|(% style="width:617px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
396 |(% 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.
397 |(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)Associates the Primary Measure defined in the Data Structure Definition.
398 |(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the Attribute Values relating to the Observation.
399 |(% 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”.
400 |(% style="width:182px" %)//ObservationValue//|(% style="width:210px" %)(((
Helena 2.1 401 Abstract class
402 Sub classes
403 UncodedObservation
404 CodedObservation
Helena 3.5 405 )))|(% style="width:617px" %)
406 |(% style="width:182px" %)UncodedObservation|(% style="width:210px" %)(((
Helena 2.1 407 Inherits from
408 ObservationValue
Helena 3.5 409 )))|(% style="width:617px" %)An observation that has a text value.
410 |(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the Uncoded Observation.
411 |(% style="width:182px" %)CodedObservation|(% style="width:210px" %)(((
Helena 2.1 412 Inherits from
413 ObservationValue
Helena 3.5 414 )))|(% style="width:617px" %)An Observation that takes its value from a code in a Code list.
415 |(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
Helena 2.1 416 Association to the Code that is the value of the Observation.
Helena 3.5 417 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.
Helena 2.1 418 )))
Helena 3.5 419 |(% style="width:182px" %)//AttributeValue//|(% style="width:210px" %)(((
Helena 2.1 420 Abstract class
421 Sub classes
Helena 3.5 422 //UncodedAttributeValue
423 CodedAttributeValue//
424 )))|(% 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.
425 |(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the attribute.
426 |(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)(((
Helena 2.1 427 Association to the Data Attribute defined in the Data Structure Definition.
428 Note that this is conceptual association as the Concept is identified explicitly in the data set.
429 )))
Helena 3.5 430 |(% style="width:182px" %)//UncodedAttribute Value//|(% style="width:210px" %)(((
Helena 2.1 431 Inherits from
432 //AttributeValue//
Helena 3.5 433 )))|(% style="width:617px" %)An attribute value that has a text value.
434 |(% 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).
435 |(% style="width:182px" %)(((
Helena 2.1 436 CodedAttribute
437
438 Value
Helena 3.5 439 )))|(% style="width:210px" %)(((
Helena 2.1 440 Inherits from
441 //AttributeValue//
Helena 3.5 442 )))|(% style="width:617px" %)An attribute that takes it value from a Code in Code list.
443 |(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)(((
Helena 2.1 444 Association to the Code that is the value of the Attribute Value.
445 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.
446 )))
447
Helena 6.1 448