Interoperability Basis Platform

The DataStructureDefiniton is the class name for a structure definition for data. Some organisations know this type of definition as a “Key Family” and so the two names are synonymous. The term [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] (also referred to as [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]]) is used in this specification.

50

51

Many of the constructs in this layer of the model inherit from the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base Layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual packages. In simple sub models these are shown in the same diagram but are omitted from the more complex sub models for the sake of clarity. In these cases, the inheritance diagram below shows the full inheritance tree for the classes concerned with data structure definitions.

52

53

There are very few additional classes in this sub model other than those shown in the inheritance diagram below. In other words, the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base gives most of the structure of this sub model both in terms of associations and in terms of [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]. The relationship diagrams shown in this section show clearly when these associations are inherited from the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base (see the Appendix “A Short Guide to UML in the [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]” to see the diagrammatic notation used to depict this).

54

55

The actual [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base construct from which the concrete classes inherit depends upon the requirements of the class for:

56

57

[[Annotation>>doc:xwiki:Glossary.Annotation.WebHome]] – //AnnotableArtefact//

58

Identification – //IdentifiableArtefact//

59

Naming – //NameableArtefact//

60

Versioning – //VersionableArtefact//

61

Maintenance – //MaintainableArtefact//

62

63

== 5.2 Inheritance View ==

64

65

=== 5.2.1 Class Diagram ===

66

67

(% contenteditable="false" tabindex="-1" %)[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_91284c0b.jpg||data-widget="image" height="762" width="598"]]

68

69

**Figure 27 Class inheritance in the Data Structure Definition and Data Set Packages**

70

71

=== 5.2.2 Explanation of the Diagram ===

72

73

==== 5.2.2.1 Narrative ====

74

75

Those classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]] inherit from //AnnotableArtefact//. These are:

76

77

//IdentifiableArtefact

78

[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]

79

Key// (and therefore //SeriesKey// and //GroupKey//)

80

//Observation//

81

82

Those classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]] and global identity are derived from //IdentifiableArtefact//. These are:

//NameableArtefact

ComponentList

[[Component>>doc:xwiki:Glossary.Component.WebHome]]//

87

88

Those classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]], global identity, multilingual name and multilingual description are derived from //NameableArtefact//. These are:

89

90

//VersionableArtefact

91

Item//

92

93

The classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]], global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact//. These are:

94

95

//MaintainableArtefact//

96

97

Abstract classes which represent information that is maintained by [[Maintenance Agencies>>doc:xwiki:Glossary.Maintenance agency.WebHome]] all inherit from //MaintainableArtefact//, they also inherit all the features of a //VersionableArtefact//, and are:

//StructureUsage

Structure

ItemScheme//

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.

104

105

Those concrete classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] and [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]] packages of the metamodel which require to be maintained by Agencies all inherit (via other abstract classes) from //MaintainableArtefact//, these are:

106

107

Dataflow

108

DataStructureDefinition

109

110

The [[component>>doc:xwiki:Glossary.Component.WebHome]] structures that are lists of lists, inherit directly from //Structure//. A //Structure// contains several lists of [[components>>doc:xwiki:Glossary.Component.WebHome]]. The concrete class that inherits from //Structure// is:

111

112

DataStructureDefinition

113

114

A DataStructureDefinition contains a list of [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]], a list of [[measures>>doc:xwiki:Glossary.Measure.WebHome]] and a list of attributes.

115

116

The concrete classes which inherit from //ComponentList// and are subcomponents of the DataStructureDefinition are:

117

118

DimensionDescriptor – content is [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] and TimeDimension

119

DimensionGroupDescriptor – content is an association to [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension

120

MeasureDescriptor – content is Measure

121

AttributeDescriptor – content is DataAttribute and an association to MetadataAttribute

122

123

The classes that inherit from //[[Component>>doc:xwiki:Glossary.Component.WebHome]]// are:

Measure

//DimensionComponent// and thereby its sub classes of [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] and TimeDimension

128

//Attribute// and thereby its sub classes of DataAttribute and MetadataAttribute

129

130

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.

131

132

== 5.3 Data Structure Definition – Relationship View ==

133

134

=== 5.3.1 Class Diagram ===

135

136

(% contenteditable="false" tabindex="-1" %)[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_c415af49.jpg||data-widget="image" height="478" width="583"]]

137

138

**Figure 28 Relationship class diagram of the Data Structure Definition excluding representation**

139

140

=== 5.3.2 Explanation of the Diagrams ===

141

142

==== 5.3.2.1 Narrative ====

143

144

A DataStructureDefinition defines the [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension, DataAttributes, and [[Measures>>doc:xwiki:Glossary.Measure.WebHome]], and associated [[Representations>>doc:xwiki:Glossary.Representation.WebHome]], that comprise the valid structure of data and related [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] that are contained in a [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]], which is defined by a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]. In addition, a DataStructureDefinition may be related to one MetadataStructureDefinition, in order to use the latter’s MetadataAttributes, by relating them to other //[[Components>>doc:xwiki:Glossary.Component.WebHome]]// within the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]], as explained below.

145

146

The [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] may also have additional metadata attached that define qualitative information and (% style="color:#2ecc71" %)Constraints(%%) on the use of the DataStructureDefinition such as the subset of [[Codes>>doc:xwiki:Glossary.Code.WebHome]] used in a [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] (this is covered later in this document – see sections “(% style="color:#2ecc71" %)Constraints(%%)” and “Data Provisioning”). Each [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] has a maximum of one DataStructureDefinition specified which defines the structure of any [[DataSets>>doc:xwiki:Glossary.Data set.WebHome]] to be reported/disseminated.

147

148

There are two types of [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] each having a common association to (% style="color:#2ecc71" %)Concept(%%):

149

150

* [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]]

151

* TimeDimension

152

153

Note that DimensionComponent can be any or all its sub classes i.e., [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension.

154

155

The //DimensionComponent//, DataAttribute, MetadataAttribute and [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] link to the (% style="color:#2ecc71" %)Concept(%%) that defines its name and semantic (/conceptIdentity association to (% style="color:#2ecc71" %)Concept(%%)). The DataAttribute, [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] (but not TimeDimension) and [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] can optionally have a +conceptRole association with a (% style="color:#2ecc71" %)Concept(%%) that identifies its role in the DataStructureDefinition, or one of the standard pre-defined roles, i.e., those published in "GUIDELINES FOR [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#2ecc71" %)CONCEPT(%%) ROLES" by the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] SWG. The use of these roles is to enable applications to process the data in a meaningful way (e.g., relating a [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] value to a mapping vector). It is expected, beyond the standard roles published by the SWG, that communities (such as the official statistics community) will harmonise such roles within their community so that data can be exchanged and shared in a meaningful way within that community.

156

157

The valid values for a //DimensionComponent//, [[Measure>>doc:xwiki:Glossary.Measure.WebHome]], DataAttribute or MetadataAttribute, when used in this DataStructureDefinition, are defined by the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]]. This [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] is taken from the (% style="color:#2ecc71" %)Concept(%%) definition (coreRepresentation) unless it is overridden in this DataStructureDefinition (localRepresentation) – see Figure 28. Note also that TimeDimension is constrained to specific FacetValueTypes. Moreover, the [[Representations>>doc:xwiki:Glossary.Representation.WebHome]] of MetadataAttributes are specified in the corresponding MetadataStructureDefinition, linked by the DataStructureDefinition.

158

159

There will always be a DimensionDescriptor grouping that identifies all of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] comprising the full key. Together the [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] specify the key of an Observation.

160

161

The //DimensionComponent// can optionally be grouped by multiple GroupDimensionDescriptors each of which identifies the group of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] that can form a partial key. The GroupDimensionDescriptor must be identified (GroupDimensionDescriptor.id) and this is used in the GroupKey of the [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]] to declare which DataAttributes or MetadataAttributes are reported at this group (% style="color:#2ecc71" %)level(%%) in the [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]].

162

163

There can be a maximum of one TimeDimension specified in the DimensionDescriptor. The TimeDimension is used to specify the (% style="color:#2ecc71" %)Concept(%%) used to convey the [[time period>>doc:xwiki:Glossary.Time period.WebHome]] of the observation in a [[data set>>doc:xwiki:Glossary.Data set.WebHome]]. The TimeDimension must contain a valid [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of time and cannot be coded.

164

165

here can be one or more [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] under the MeasureDescriptor. [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] represent the observable phenomena. Each [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] may have a valid [[representation>>doc:xwiki:Glossary.Representation.WebHome]], a maxOccurs [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] limiting the maximum number of values per [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] (which may be set to 'unbounded' for unlimited occurrences), as well as a minOccurs [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]], indicating the minimum required number of values, when the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] is reported. If minOccurs or maxOccurs are omitted (they both default to ‘1’), the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] is considered to take a single value; otherwise, it is an array. Moreover, the usage [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] indicates whether a [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] must be reported or not, by the corresponding values: mandatory or optional.

166

167

The AttributeDescriptor may contain one or more //[[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]]//s, i.e., at least one DataAttribute definition or one MetadataAttribute reference.

168

169

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 indicated if it must be reported or not, by the corresponding value of the usage [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]]: i.e., mandatory or optional. The property minOccurs specifies the minimum number of array values to be included when the DataAttribute is reported. Moreover, a maxOccurs [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] indicates whether the DataAttribute may need to report more than one values, i.e., an array of values. The DataAttribute may play a specific role in the structure and this is specified by the +role association to the (% style="color:#2ecc71" %)Concept(%%) that identifies its role.

170

171

The MetadataAttribute defines [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] that may be collected or disseminated and is grouped together with DataAttribute under the AttributeDescriptor.

172

173

A DataAttribute or a MetadataAttribute (i.e., an //AttributeComponent//) is specified as being +relatedTo an AttributeRelationship, which defines the constructs to which the //AttributeComponent// is to be reported within a //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//. An //AttributeComponent// can be specified as being related to one of the following [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]:

174

175

* All data within the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] (DataflowRelationship) – this is equivalent to attaching an [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] to all data within the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]].

176

* [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] or set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] (DimensionRelationship)

177

* Set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] specified by a GroupKey (GroupRelationship – this is retained for compatibility reasons – or +groupKey of the DimensionRelationship)

178

* Observation (ObservationRelationship)

179

* In addition to the positioning of an //AttributeComponent// within a //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//, another relationship indicates the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]](s) for which the //AttributeComponent// is reported. Regardless of the position of the //AttributeComponent// within the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//, the //AttributeComponent// may concern one, more than one, or all [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] included in the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]]. This is expressed using the MeasureRelationship class, which relates a DataAttribute to one or more [[Measures>>doc:xwiki:Glossary.Measure.WebHome]]. Lack of the MeasureRelationship defaults to a relationship to all [[Measures>>doc:xwiki:Glossary.Measure.WebHome]].

180

181

(% contenteditable="false" tabindex="-1" %)[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_f235bfd4.jpg||data-widget="image" height="542" width="604"]]

182

183

**Figure 29: Attribute Attachment Defined in the Data Structure Definition**

184

185

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.

186

187

(% style="width:839.039px" %)

188

|**Relationship**|(% style="width:384px" %)**Meaning**|(% style="width:303px" %)**Location in Data Set at which the Attribute is reported**

189

|DataflowRelationship|(% style="width:384px" %)The value of the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is fixed for all data contained in the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]]. The [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] value applies to all data defined by the underlying [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]].|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]] (% style="color:#2ecc71" %)level(%%).

190

|[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] (1..n)|(% style="width:384px" %)The value of the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] will vary with the value(s) of the referenced [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]](s). In this case, Group(s) to which the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] should be attached may optionally be specified.|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the lowest (% style="color:#2ecc71" %)level(%%) of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] to which the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related, otherwise at the (% style="color:#2ecc71" %)level(%%) of the Group if Attachment Group(s) is specified.

191

|Group|(% style="width:384px" %)The value of the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] varies with combination of values for all of the [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] contained in the Group. This is added as a convenience to listing all [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] and the attachment Group, but should only be used when the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] value varies based on __all__ Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] values.|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the (% style="color:#2ecc71" %)level(%%) of Group.

192

|Observation|(% style="width:384px" %)The value of the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] varies with the observed value.|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the (% style="color:#2ecc71" %)level(%%) of Observation.

193

194

(% contenteditable="false" tabindex="-1" %)[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_42ff01fb.jpg||data-widget="image" height="380" width="590"]]

195

196

**Figure 30: Representation of DSD Components**

197

198

Each of [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension, [[Measure>>doc:xwiki:Glossary.Measure.WebHome]], DataAttribute and MetadataAttribute can have a [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] specified (using the localRepresentation association). If this is not specified in the DataStructureDefinition then the [[representation>>doc:xwiki:Glossary.Representation.WebHome]] specified for (% style="color:#2ecc71" %)Concept(%%) (coreRepresentation) is used. [[Measure>>doc:xwiki:Glossary.Measure.WebHome]], and DataAttribute may be also represented by multilingual text (as seen in the [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]] diagram further down). An exception is the MetadataAttribute, where its [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] is specified in the MetadataStructureDefinition.

199

200

A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap.

201

202

==== 5.3.2.2 Definitions ====

203

204

(((

205

(% style="width:834.039px" %)

206

|(% style="width:209px" %)**Class**|(% style="width:175px" %)**Feature**|(% style="width:454px" %)**Description**

207

|(% style="width:209px" %)StructureUsage|(% style="width:175px" %) |(% style="width:454px" %)See “[[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base”.

208

|(% style="width:209px" %)[[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]|(% style="width:175px" %)(((

209

Inherits from

210

//StructureUsage//

211

)))|(% style="width:454px" %)Abstract (% style="color:#2ecc71" %)concept(%%) (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.

212

|(% style="width:209px" %) |(% style="width:175px" %)/structure|(% style="width:454px" %)Associates a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] to the Data Structure Definition.

213

|(% style="width:209px" %)DataStructureDefiniti on|(% style="width:175px" %) |(% style="width:454px" %)A collection of metadata (% style="color:#2ecc71" %)concepts(%%), their structure and usage when used to collect or disseminate data.

214

|(% style="width:209px" %) |(% style="width:175px" %)/grouping|(% style="width:454px" %)An association to a set of metadata (% style="color:#2ecc71" %)concepts(%%) that have an identified structural role in a Data Structure Definition.

215

|(% style="width:209px" %)GroupDimensionDescriptor|(% style="width:175px" %)(((

216

Inherits from

217

//ComponentList//

218

)))|(% style="width:454px" %)A set of metadata (% style="color:#2ecc71" %)concepts(%%) that define a partial key derived from the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor in a Data Structure Definition.

219

|(% style="width:209px" %) |(% style="width:175px" %)/components|(% style="width:454px" %)An association to the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[components>>doc:xwiki:Glossary.Component.WebHome]] that comprise the group.

220

|(% style="width:209px" %)DimensionDescriptor|(% style="width:175px" %)(((

221

Inherits from

222

//ComponentList//

223

)))|(% style="width:454px" %)An ordered set of metadata (% style="color:#2ecc71" %)concepts(%%) that, combined, classify a statistical series, and whose values, when combined (the key) in an instance such as a [[data set>>doc:xwiki:Glossary.Data set.WebHome]], uniquely identify a specific observation.

224

|(% style="width:209px" %) |(% style="width:175px" %)/components|(% style="width:454px" %)(((

225

An association to the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] and Time [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] comprising the Key Descriptor.

226

)))

227

|(% style="width:209px" %)AttributeDescriptor|(% style="width:175px" %)(((

228

Inherits from

229

//ComponentList//

230

)))|(% style="width:454px" %)A set metadata (% style="color:#2ecc71" %)concepts(%%) that define the [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] of a Data Structure Definition.

231

|(% style="width:209px" %) |(% style="width:175px" %)/[[components>>doc:xwiki:Glossary.Component.WebHome]]|(% style="width:454px" %)An association to a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] [[component>>doc:xwiki:Glossary.Component.WebHome]].

232

|(% style="width:209px" %)MeasureDescriptor|(% style="width:175px" %)(((

233

Inherits from

234

//ComponentList//

235

)))|(% style="width:454px" %)A metadata (% style="color:#2ecc71" %)concept(%%) that defines the [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] of a Data Structure Definition.

236

|(% style="width:209px" %) |(% style="width:175px" %)/components|(% style="width:454px" %)An association to a [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] [[component>>doc:xwiki:Glossary.Component.WebHome]].

237

|(% style="width:209px" %)//DimensionComponent//|(% style="width:175px" %)(((

238

Inherits from

239

//[[Component>>doc:xwiki:Glossary.Component.WebHome]]//

240

241

Sub class [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]]

242

TimeDimension

243

)))|(% style="width:454px" %)An abstract class representing any [[Component>>doc:xwiki:Glossary.Component.WebHome]] that can be used for identifying observations.

244

|(% style="width:209px" %) |(% style="width:175px" %)order|(% style="width:454px" %)Specifies the order of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[Components>>doc:xwiki:Glossary.Component.WebHome]] within the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]]. The property is used to indicate the position of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[Component>>doc:xwiki:Glossary.Component.WebHome]] and determines the Key for identifying observations, or series. The Time [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], when specified, must be the last within the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor.

245

|(% style="width:209px" %)[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]]|(% style="width:175px" %)(((

246

Inherits from

247

//DimensionComponent//

248

)))|(% style="width:454px" %)A metadata (% style="color:#2ecc71" %)concept(%%) used (most probably together with other metadata (% style="color:#2ecc71" %)concepts(%%)) to classify a statistical series, e.g., a statistical (% style="color:#2ecc71" %)concept(%%) indicating a certain [[economic activity>>doc:xwiki:Glossary.Economic activity.WebHome]] or a geographical reference area.

249

|(% style="width:209px" %) |(% style="width:175px" %)/role|(% style="width:454px" %)Association to the (% style="color:#2ecc71" %)Concept(%%) that specifies the role that that the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] plays in the Data Structure Definition.

250

|(% style="width:209px" %) |(% style="width:175px" %)/conceptIdentity|(% style="width:454px" %)An association to the metadata (% style="color:#2ecc71" %)concept(%%) which defines the semantic of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]].

251

|(% style="width:209px" %)TimeDimension|(% style="width:175px" %)(((

252

Inherits from

253

//DimensionComponent//

254

)))|(% style="width:454px" %)A metadata (% style="color:#2ecc71" %)concept(%%) that identifies the [[component>>doc:xwiki:Glossary.Component.WebHome]] in the key structure that has the role of “time”.

255

|(% style="width:209px" %)DataAttribute|(% style="width:175px" %)(((

256

Inherits from

257

//[[Component>>doc:xwiki:Glossary.Component.WebHome]]//

258

)))|(% style="width:454px" %)A characteristic of an object or entity.

259

|(% style="width:209px" %) |(% style="width:175px" %)/role|(% style="width:454px" %)Association to the (% style="color:#2ecc71" %)Concept(%%) that specifies the role that that the Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] plays in the Data Structure Definition.

260

|(% style="width:209px" %) |(% style="width:175px" %)minOccurs|(% style="width:454px" %)Defines the minimum required occurrences for the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]]. When equals to zero, the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is conditional.

261

|(% style="width:209px" %) |(% style="width:175px" %)maxOccurs|(% style="width:454px" %)Defines the maximum allowed occurrences for the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]].

262

|(% style="width:209px" %) |(% style="width:175px" %)usage|(% style="width:454px" %)Defines whether a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] must be reported or not.

263

|(% style="width:209px" %) |(% style="width:175px" %)+relatedTo|(% style="width:454px" %)Association to an [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Relationship.

264

|(% style="width:209px" %) |(% style="width:175px" %)/conceptIdentity|(% style="width:454px" %)An association to the (% style="color:#2ecc71" %)Concept(%%) which defines the semantic of the [[component>>doc:xwiki:Glossary.Component.WebHome]].

265

|(% style="width:209px" %)[[Measure>>doc:xwiki:Glossary.Measure.WebHome]]|(% style="width:175px" %)(((

266

Inherits from

267

//[[Component>>doc:xwiki:Glossary.Component.WebHome]]//

268

)))|(% style="width:454px" %)The metadata (% style="color:#2ecc71" %)concept(%%) that is the phenomenon to be measured in a [[data set>>doc:xwiki:Glossary.Data set.WebHome]]. In a [[data set>>doc:xwiki:Glossary.Data set.WebHome]] the instance of the [[measure>>doc:xwiki:Glossary.Measure.WebHome]] is often called the observation.

269

|(% style="width:209px" %) |(% style="width:175px" %)/conceptIdentity|(% style="width:454px" %)An association to the (% style="color:#2ecc71" %)Concept(%%) which carries the values of the [[measures>>doc:xwiki:Glossary.Measure.WebHome]].

270

|(% style="width:209px" %) |(% style="width:175px" %)minOccurs|(% style="width:454px" %)Defines the minimum required occurrences for the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]]. When equals to zero, the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] is conditional.

271

|(% style="width:209px" %) |(% style="width:175px" %)maxOccurs|(% style="width:454px" %)Defines the maximum allowed occurrences for the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]].

272

|(% style="width:209px" %) |(% style="width:175px" %)usage|(% style="width:454px" %)Defines whether a [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] must be reported or not.

273

|(% style="width:209px" %)//AttributeRelationship//|(% style="width:175px" %)(((

274

Abstract Class

275

Sub classes

276

ObservationRelationship

277

GroupRelationship DimensionRelationship

278

)))|(% style="width:454px" %)Specifies the type of [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] to which a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] can be attached in a [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]].

279

|(% style="width:209px" %)ObservationRelationship|(% style="width:175px" %) |(% style="width:454px" %)The Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related to the observations of the [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]].

280

|(% style="width:209px" %)GroupRelationship|(% style="width:175px" %) |(% style="width:454px" %)The Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related to a Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor construct.

281

|(% style="width:209px" %) |(% style="width:175px" %)+groupKey|(% style="width:454px" %)An association to the Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor

282

|(% style="width:209px" %)DimensionRelationship|(% style="width:175px" %) |(% style="width:454px" %)The Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related to a set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]].

283

|(% style="width:209px" %) |(% style="width:175px" %)+dimensions|(% style="width:454px" %)Association to the set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] to which the Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related.

284

|(% style="width:209px" %) |(% style="width:175px" %)+groupKey|(% style="width:454px" %)Association to the Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor which specifies the set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] to which the Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is attached.

285

|(% style="width:209px" %)MeasureRelationship|(% style="width:175px" %) |(% style="width:454px" %)The [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] that a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported for.

286

|(% style="width:209px" %) |(% style="width:175px" %)+measures|(% style="width:454px" %)Association to the set of [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] to which a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related to.

287

|(% style="width:209px" %)SentinelValuesType|(% style="width:175px" %) |(% style="width:454px" %)This [[facet>>doc:xwiki:Glossary.Facet.WebHome]] indicates that an [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] or a [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] has sentinel values with special meaning within their data type. This is realised by providing such values within the TextFormat, in addition to any textType or other [[Facet>>doc:xwiki:Glossary.Facet.WebHome]].

288

|(% style="width:209px" %)SentinelValue|(% style="width:175px" %) |(% style="width:454px" %)A value that has a special meaning within the text format [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of the [[Component>>doc:xwiki:Glossary.Component.WebHome]].

289

|(% style="width:209px" %) |(% style="width:175px" %)+name|(% style="width:454px" %)An association of a Sentinel Value to a multilingual name.

290

|(% style="width:209px" %) |(% style="width:175px" %)+description|(% style="width:454px" %)An association of a Sentinel Value to a multilingual description.

291

)))

292

293

The explanation of the classes, [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]], and associations comprising the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] is described in the section on the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base.

294

295

== 5.4 Data Set – Relationship View ==

296

297

=== 5.4.1 Context ===

298

299

A [[data set>>doc:xwiki:Glossary.Data set.WebHome]] comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition.

300

301

=== 5.4.2 Class Diagram ===

302

303

(% contenteditable="false" tabindex="-1" %)[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_78f5c87f.jpg||data-widget="image" height="822" width="535"]]

304

305

**Figure 31: Class Diagram of the Data Set**

306

307

=== 5.4.3 Explanation of the Diagram ===

308

309

==== 5.4.3.1 Narrative – Data Set ====

310

311

Note that the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// must conform to the DataStructureDefinition associated to the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] for which this [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]] 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>>doc:xwiki:Glossary.Data set.WebHome]]// as exchanged there must, of course, be a reference to the DataStructureDefinition and optionally a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] or a ProvisionAgreement, 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>>doc:xwiki:Glossary.Data set.WebHome]]// when the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// is exchanged. However, the [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] in the DataStructureDefinition can be used by an application to validate the contents of the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// in terms of the valid content of a //KeyValue// as defined by the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] in the DataStructureDefinition.

312

313

An organisation playing the role of DataProvider can be responsible for one or more //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//.

314

315

A //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// is formatted as a DataStructureDefinition specific [[data set>>doc:xwiki:Glossary.Data set.WebHome]] (StructureSpecificDataSet). The structured [[data set>>doc:xwiki:Glossary.Data set.WebHome]] is structured according to one specific DataStructureDefinition; hence the latter is required for validation at the syntax (% style="color:#2ecc71" %)level(%%).

316

317

A //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// is a collection of a set of //Observation//s that share the same dimensionality, which is specified by a set of unique [[components>>doc:xwiki:Glossary.Component.WebHome]] ([[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension) defined in the DimensionDescriptor of the DataStructureDefinition, together with associated

318

319

//AttributeValue//s that define specific characteristics about the [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] to which it is attached – //Observation//s, set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]]. It can be structured in terms of a SeriesKey to which //Observation//s are reported.

320

321

The //Observation// can be the value(s) of the variable(s) being measured for the (% style="color:#2ecc71" %)Concept(%%) associated to the Measure(s) in the MeasureDescriptor of the DataStructureDefinition. Each //Observation// associates one or more //ObservationValue//s with a KeyValue (+observationDimension) which is the value for the “[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] at the Observation (% style="color:#2ecc71" %)Level(%%)”. Any [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] can be specified as being the “[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] at the Observation (% style="color:#2ecc71" %)Level(%%)”, and this specification is made at the (% style="color:#2ecc71" %)level(%%) of the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// (i.e., it must be the same [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] for the entire //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//).

322

323

The //KeyValue// is a value for one of TimeDimension or [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] specified in the DataStructureDefinition. If it is a [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], it can be coded (CodedKeyValue) or uncoded (UncodedKeyValue). If it is the TimeDimension then it is a TimeKeyValue. The actual value that the CodedDimensionValue can take must be one of the [[Codes>>doc:xwiki:Glossary.Code.WebHome]] in the Codelist specified as the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] in the DataStructureDefinition.

324

325

An ObservationValue can be coded – this is the CodedObservation – or it can be uncoded – this is the UncodedObservation. In the case of uncoded observations, the values may be multilingual – expressed via the TextMeasureValue – or not (OtherUncodedMeasureValue).

326

327

The GroupKey is a subunit of the //Key// that has the same dimensionality as the SeriesKey but defines a subset of the KeyValues of the SeriesKey. Its sub [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] 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 GroupKey is to report one or more //AttributeValue// that are contained at this group (% style="color:#2ecc71" %)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>>doc:xwiki:Glossary.Data set.WebHome]]//. If the Group is related to the DimensionRelationship in the DataStructureDefinition then the //AttributeValue// will be reported with the appropriate [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] in the SeriesKey or Observation.

328

329

In this way each of SeriesKey, GroupKey, and Observation can have zero or more //AttributeValue//s that define some metadata about the object to which it is associated. The //AttributeValue// may be either a //DataAttributeValue// or a //MetadataAttributeValue//, representing values of DataAttributes defined in the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]] or MetadataAttributes of the linked [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], respectively. The allowable (% style="color:#2ecc71" %)Concepts(%%) and the objects to which these metadata can be associated (attached) are defined in the DataStructureDefinition and the linked MetadataStructureDefinition.

330

331

The //AttributeValue// links to the object type (SeriesKey, GroupKey, Observation) to which it is associated.

332

333

==== 5.4.3.2 Definitions ====

334

335

(% style="width:812.039px" %)

336

|(% style="width:147px" %)**Class**|(% style="width:246px" %)**Feature**|(% style="width:395px" %)**Description**

337

|(% style="width:147px" %)//[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//|(% style="width:246px" %)(((

338

Abstract Class

339

Sub classes

340

StructureSpecificData

341

Set

342

)))|(% style="width:395px" %)An organised collection of data.

343

|(% style="width:147px" %) |(% style="width:246px" %)reportingBegin|(% style="width:395px" %)A specific [[time period>>doc:xwiki:Glossary.Time period.WebHome]] in a known system of [[time periods>>doc:xwiki:Glossary.Time period.WebHome]] that identifies the start period of a report.

344

|(% style="width:147px" %) |(% style="width:246px" %)reportingEnd|(% style="width:395px" %)A specific [[time period>>doc:xwiki:Glossary.Time period.WebHome]] in a known system of [[time periods>>doc:xwiki:Glossary.Time period.WebHome]] that identifies the end period of a report.

345

|(% style="width:147px" %) |(% style="width:246px" %)dataExtractionDate|(% style="width:395px" %)A specific [[time period>>doc:xwiki:Glossary.Time period.WebHome]] that identifies the date and time that the data are extracted from a data source.

346

|(% style="width:147px" %) |(% style="width:246px" %)validFrom|(% style="width:395px" %)Indicates the inclusive start time indicating the validity of the information in the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].

347

|(% style="width:147px" %) |(% style="width:246px" %)validTo|(% style="width:395px" %)Indicates the inclusive end time indicating the validity of the information in the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].

348

|(% style="width:147px" %) |(% style="width:246px" %)publicationYear|(% style="width:395px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.

349

|(% style="width:147px" %) |(% style="width:246px" %)publicationPeriod|(% style="width:395px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.

350

|(% style="width:147px" %) |(% style="width:246px" %)setId|(% style="width:395px" %)Provides an identification of the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].

351

|(% style="width:147px" %) |(% style="width:246px" %)action|(% style="width:395px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)

352

|(% style="width:147px" %) |(% style="width:246px" %)describedBy|(% style="width:395px" %)Associates a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] and thereby a [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] to the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].

353

|(% style="width:147px" %) |(% style="width:246px" %)+structuredBy|(% style="width:395px" %)Associates the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] that defines the structure of the [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]]. Note that the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] is the same as that associated (non-mandatory) to the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]].

354

|(% style="width:147px" %) |(% style="width:246px" %)+publishedBy|(% style="width:395px" %)Associates the [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]] that reports/publishes the data.

355

|(% style="width:147px" %)StructureSpecificDataSet|(% style="width:246px" %) |(% style="width:395px" %)An XML specific data format structure that contains data corresponding to one specific [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].

356

|(% style="width:147px" %)//Key//|(% style="width:246px" %)(((

357

Abstract class Sub classes

358

SeriesKey

359

GroupKey

360

)))|(% style="width:395px" %)Comprises the cross product of values of [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] that identify uniquely an Observation.

361

|(% style="width:147px" %) |(% style="width:246px" %)keyValues|(% style="width:395px" %)Association to the individual Key Values that comprise the Key.

362

|(% style="width:147px" %) |(% style="width:246px" %)+attachedAttribute|(% style="width:395px" %)Association to the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Values relating to the [[Series Key>>doc:xwiki:Glossary.Series key.WebHome]] or Group Key.

363

|(% style="width:147px" %)//KeyValue//|(% style="width:246px" %)(((

364

Abstract class Sub classes

TimeKeyValue

CodedKeyValue

UncodedKeyValue

)))|(% style="width:395px" %)The value of a [[component>>doc:xwiki:Glossary.Component.WebHome]] of a key such as the value of the instance a [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] in a [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor of a [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].

369

|(% style="width:147px" %) |(% style="width:246px" %)+valueFor|(% style="width:395px" %)(((

370

Association to the key [[component>>doc:xwiki:Glossary.Component.WebHome]] in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] for which this Key Value is a valid representation.

371

Note that this is conceptual association as the key [[component>>doc:xwiki:Glossary.Component.WebHome]] is identified explicitly in the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].

372

)))

373

|(% style="width:147px" %)TimeKeyValue|(% style="width:246px" %)(((

374

Inherits from

375

//KeyValue//

376

)))|(% style="width:395px" %)The value of the Time [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[component>>doc:xwiki:Glossary.Component.WebHome]] of the key.

377

|(% style="width:147px" %)CodedKeyValue|(% style="width:246px" %)(((

378

Inherits from

379

//KeyValue//

380

)))|(% style="width:395px" %)The value of a coded [[component>>doc:xwiki:Glossary.Component.WebHome]] of the key. The value is the [[Code>>doc:xwiki:Glossary.Code.WebHome]] to which this class is associated.

381

|(% style="width:147px" %) |(% style="width:246px" %)+valueOf|(% style="width:395px" %)Association to the [[Code>>doc:xwiki:Glossary.Code.WebHome]]. Note that this is a conceptual association showing that the [[Code>>doc:xwiki:Glossary.Code.WebHome]] must exist in the [[Code list>>doc:xwiki:Glossary.Code list.WebHome]] associated with the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. In the actual [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]] the value of the [[Code>>doc:xwiki:Glossary.Code.WebHome]] is placed in the Key Value.

382

|(% style="width:147px" %)UnCodedKeyValue|(% style="width:246px" %)(((

383

Inherits from

384

//KeyValue//

385

)))|(% style="width:395px" %)The value of an uncoded [[component>>doc:xwiki:Glossary.Component.WebHome]] of the key.

386

|(% style="width:147px" %) |(% style="width:246px" %)value|(% style="width:395px" %)The value of the key [[component>>doc:xwiki:Glossary.Component.WebHome]].

387

|(% style="width:147px" %) |(% style="width:246px" %)startTime|(% style="width:395px" %)This [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is only used if the textFormat of the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is of the Timespan type in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] (in which case the value field takes a duration).

388

|(% style="width:147px" %)GroupKey|(% style="width:246px" %)(((

389

Inherits from

390

//Key//

391

)))|(% style="width:395px" %)A set of Key Values that comprise a partial key, of the same dimensionality as the Time [[Series Key>>doc:xwiki:Glossary.Series key.WebHome]] for the purpose of attaching Data Attributes.

392

|(% style="width:147px" %) |(% style="width:246px" %)+describedBy|(% style="width:395px" %)Associates the Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor defined in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].

393

|(% style="width:147px" %)SeriesKey|(% style="width:246px" %)(((

394

Inherits from

395

//Key//

396

)))|(% style="width:395px" %)Comprises the cross product of values of all the Key Values that, together with the Key Value of the +observation [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] identify uniquely an Observation.

397

|(% style="width:147px" %) |(% style="width:246px" %)+describedBy|(% style="width:395px" %)Associates the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor defined in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].

398

|(% style="width:147px" %)Observation|(% style="width:246px" %) |(% style="width:395px" %)The value(s) of the observed phenomenon in the context of the Key Values comprising the key.

399

|(% style="width:147px" %) |(% style="width:246px" %)+valueFor|(% style="width:395px" %)(((

400

Associates the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]](s) defined in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].

401

402

The source multiplicity (1..*) indicates that more than one values may be provided for a [[Measure>>doc:xwiki:Glossary.Measure.WebHome]], if the latter allows it.

403

)))

404

|(% style="width:147px" %) |(% style="width:246px" %)+attachedAttribute|(% style="width:395px" %)Association to the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Values relating to the Observation.

405

|(% style="width:147px" %) |(% style="width:246px" %)+observationDimension|(% style="width:395px" %)Association to the Key Value that holds the value of the “[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] at the Observation Level”.

406

|(% style="width:147px" %)//ObservationValue//|(% style="width:246px" %)(((

407

Abstract class

408

Sub classes

409

//UncodedObservationValue//

410

CodedObservation

411

)))|(% style="width:395px" %)

412

|(% style="width:147px" %)//UncodedObservationValue//|(% style="width:246px" %)(((

Abstract class

Inherits from

//ObservationValue//

Sub classes

OtherUncodedMeasureValue

418

TextMeasureValue

419

)))|(% style="width:395px" %)

420

|(% style="width:147px" %)OtherUncodedMeasureValue|(% style="width:246px" %)(((

421

Inherits from

422

423

//UncodedObservationValue//

424

)))|(% style="width:395px" %)An observation that has a text value.

425

|(% style="width:147px" %) |(% style="width:246px" %)value|(% style="width:395px" %)The value of the Uncoded Observation.

426

|(% style="width:147px" %) |(% style="width:246px" %)startTime|(% style="width:395px" %)This [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is only used if the textFormat of the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] is of the Timespan type in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] (in which case the value field takes a duration).

427

|(% style="width:147px" %)TextMeasureValue|(% style="width:246px" %)(((

428

Inherits from

429

//UncodedObservationValue//

430

)))|(% style="width:395px" %)An observation that has a localised text value

431

|(% style="width:147px" %) |(% style="width:246px" %)text|(% style="width:395px" %)The localised text values.

432

|(% style="width:147px" %)CodedObservation|(% style="width:246px" %)(((

433

Inherits from

434

//ObservationValue//

435

)))|(% style="width:395px" %)An Observation that takes its value from a [[code>>doc:xwiki:Glossary.Code.WebHome]] in a [[Code list>>doc:xwiki:Glossary.Code list.WebHome]].

436

|(% style="width:147px" %) |(% style="width:246px" %)+valueOf|(% style="width:395px" %)Association to the [[Code>>doc:xwiki:Glossary.Code.WebHome]] that is the value of the Observation. Note that this is a conceptual association showing that the [[Code>>doc:xwiki:Glossary.Code.WebHome]] must exist in the Codelist(s) associated with the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]](s) in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. In the actual [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]] the value of the [[Code>>doc:xwiki:Glossary.Code.WebHome]] is placed in the Observation.

437

|(% style="width:147px" %)//AttributeValue//|(% style="width:246px" %)(((

438

Abstract class

439

Sub classes

440

//DataAttributeValue// //MetadataAttributeValue//

441

)))|(% style="width:395px" %)Represents the value for any [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] reported in the [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]], i.e., Data or Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]].

442

|(% style="width:147px" %)//DataAttributeValue//|(% style="width:246px" %)(((

Abstract class

Inherits from

//AttributeValue//

Sub classes

//UncodedAttributeValue

448

CodedAttributeValue//

449

)))|(% style="width:395px" %)The value of a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]], such as the instance of a Coded [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] or of an Uncoded [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] in a structure such as a [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].

450

|(% style="width:147px" %) |(% style="width:246px" %)+valueFor|(% style="width:395px" %)(((

451

Association to the Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] defined in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. Note that this is conceptual association as the (% style="color:#2ecc71" %)Concept(%%) is identified explicitly in the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].

452

The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]], if the latter allows it.

453

)))

454

|(% style="width:147px" %)//MetadataAttributeValue//|(% style="width:246px" %)(((

455

(explained further in section “Metadata Set”)

456

)))|(% style="width:395px" %)(((

457

The value of a Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]], as specified in the [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], which is linked in the Data Structure

Definition

)))

|(% style="width:147px" %)//UncodedAttributeValue//|(% style="width:246px" %)(((

Inherits from

//AttributeValue//

Sub classes

OtherUncodedAttribute Value

466

TextAttributeValue

467

)))|(% style="width:395px" %)

468

|(% style="width:147px" %)OtherUncodedAttributeValue|(% style="width:246px" %)(((

469

Inherits from

470

//UncodedObservationValue//

471

)))|(% style="width:395px" %)An [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] value that has a text value

472

|(% style="width:147px" %) |(% style="width:246px" %)value|(% style="width:395px" %)The value of the Uncoded [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]].

473

|(% style="width:147px" %) |(% style="width:246px" %)startTime|(% style="width:395px" %)This [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is only used if the textFormat of the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is of the Timespan type in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] (in which case the value field takes a duration).

474

|(% style="width:147px" %)TextAttributeValue|(% style="width:246px" %)(((

475

Inherits from

476

//UncodedAttributeValue//

477

)))|(% style="width:395px" %)An [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] that has a localised text value

478

|(% style="width:147px" %) |(% style="width:246px" %)text|(% style="width:395px" %)The localised text values.

479

|(% style="width:147px" %)CodedAttributeValue|(% style="width:246px" %)(((

480

Inherits from

481

//AttributeValue//

482

)))|(% style="width:395px" %)An [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] that takes it value from a [[Code>>doc:xwiki:Glossary.Code.WebHome]] in [[Code list>>doc:xwiki:Glossary.Code list.WebHome]].

483

|(% style="width:147px" %) |(% style="width:246px" %)+valueOf|(% style="width:395px" %)Association to the [[Code>>doc:xwiki:Glossary.Code.WebHome]] that is the value of the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Value. Note that this is a conceptual association showing that the [[Code>>doc:xwiki:Glossary.Code.WebHome]] must exist in the [[Code list>>doc:xwiki:Glossary.Code list.WebHome]] associated with the Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. In the actual [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]] the value of the [[Code>>doc:xwiki:Glossary.Code.WebHome]] is placed in the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Value.

484

485

Wiki source code of 5 Data Structure Definition and Dataset