Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 5.4
edited by Helena
on 2025/05/22 11:23
Change comment: There is no comment for this version
To version 2.2
edited by Helena
on 2025/05/19 23:53
Change comment: Changed document title to [7 Metadata Structure Definition and Metadata Set].

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -Methodology.SDMX 2\.1 Standards\. Section 2\. Information model\: UML conceptual design.WebHome
Content
... ... @@ -1,6 +1,4 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
1 += {{id name="_Toc371023"/}}7 Metadata Structure Definition and Metadata Set =
4 4  
5 5  == {{id name="_Toc371024"/}}7.1 Context ==
6 6  
... ... @@ -39,8 +39,8 @@
39 39  
40 40  The concrete classes in this part of the SDMX metamodel which require to be maintained by Maintenance Agencies all inherit from MaintainableArtefact. These are:
41 41  
42 -* //StructureUsage// (concrete class is MetadataflowDefinition)
43 -* //Structure// (concrete class is MetadataStructureDefinition)
40 +* //StructureUsage// (concrete class is MetadataflowDefinition)//  //
41 +* //Structure// (concrete class is MetadataStructureDefinition)//  //
44 44  
45 45  These classes also inherit the identity and versioning facets of //IdentifiableArtefact, NameableArtefact,// and //VersionableArtefact//.
46 46  
... ... @@ -72,8 +72,6 @@
72 72  
73 73  === {{id name="_Toc371032"/}}7.3.3 Class Diagram – Relationship ===
74 74  
75 -[[image:1747902064472-244.png]]
76 -
77 77  **Figure 28: Relationship class diagram of the Metadata Structure Definition**
78 78  
79 79  === {{id name="_Toc371033"/}}7.3.4 Explanation of the Diagram ===
... ... @@ -97,8 +97,10 @@
97 97  
98 98  The valid content of a //TargetObject// when reported in a MetadataSet is defined in the Representation. This can be an enumerated representation (i.e. a reference to one of the sub clases of ItemScheme – these are Codelist, ConceptScheme, //OrganisationScheme,// CategoryScheme, or ReportingTaxonomy) or nonenumerated.
99 99  
100 -Thus a single MetadataStructureDefinition can be defined for a discrete set of related object types. For example, a single definition can be constructed to define the metadata that can be attached to any part of a Data Structure Definition, or that can be attached to any artefact concerned with the reporting of quality metadata (such as data provider and (data) category). The MetadataTarget specifies the identification properties of a specific object type to which metadata can be attached in a MetadataSet. For example, in a DataStructureDefinition the MetadataTarget might be a Dimension, and therefore the //TargetObject//s are those that uniquely identify a Dimension. This will include both the DataStructureDefinition and he Dimension both of these are an //IdentifiableArtefact //and will use the// //IdentitifableObjectTarget) as both //TargetObject//s are required in order to identify uniquely a Dimension).
96 +Thus a single MetadataStructureDefinition can be defined for a discrete set of related object types. For example, a single definition can be constructed to define the metadata that can be attached to any part of a Data Structure Definition, or that can be attached to any artefact concerned with the reporting of quality metadata (such as data provider and (data) category). The MetadataTarget specifies the identification properties of a specific object type to which metadata can be attached in a MetadataSet. For example, in a DataStructureDefinition the MetadataTarget might be a Dimension, and therefore the //TargetObject//s are those that uniquely identify a Dimension. This will include both the
101 101  
98 +DataStructureDefinition and he Dimension both of these are an //IdentifiableArtefact //and will use the// //IdentitifableObjectTarget) as both //TargetObject//s are required in order to identify uniquely a Dimension).
99 +
102 102  The ReportStructure comprises a set of MetadataAttributes - these can be defined as a hierarchy. Each MetadataAttribute// //identifies a Concept that is reported or disseminated in a MetadataSet (/conceptIdentity) that uses this MetadataStructureDefinition. Different MetadataAttributes in the same ReportStructure can use Concepts from different ConceptSchemes. Note that a MetadataAttribute does not link to a Concept that defines its role in this MetadataStructureDefinition (i.e. the MetadataAttribute does not play a role).
103 103  
104 104  The MetadataAttribute can be specified as having multiple occurrences and/or specified as being mandatory (minOccurs=1 or more) or conditional (minOccurs=0). A hierarchical ReportStructure can be defined by specifying a hierarchy for a MetadataAttribute.
... ... @@ -115,80 +115,93 @@
115 115  
116 116  ==== 7.3.4.2 Definitions ====
117 117  
118 -(% style="width:1144.29px" %)
119 -|**Class**|**Feature**|(% style="width:704px" %)**Description**
120 -|StructureUsage| |(% style="width:704px" %)See “SDMX Base”.
116 +|**Class**|**Feature**|**Description**
117 +|StructureUsage||See “SDMX Base”.
121 121  |Metadataflow Definition|(((
122 122  Inherits from:
120 +
123 123  //StructureUsage//
124 -)))|(% style="width:704px" %)Abstract concept (i.e. the structure without any metadata) of a flow of metadata that providers will provide for different reference periods.
125 -| |/structure|(% style="width:704px" %)Associates a Metadata Structure Definition.
126 -|MetadataStructure Definition| |(% style="width:704px" %)A collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata.
127 -| |/grouping|(% style="width:704px" %)An association to a Metadata Target or Report Structure.
122 +)))|Abstract concept (i.e. the structure without any metadata) of a flow of metadata that providers will provide for different reference periods.
123 +||/structure|Associates a Metadata Structure Definition.
124 +|MetadataStructure Definition||A collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata.
125 +||/grouping|An association to a Metadata Target or Report Structure.
128 128  |MetadataTarget|(((
129 129  Inherits from
128 +
130 130  //ComponentList//
131 -)))|(% style="width:704px" %)A set of components that define a key of an object type to which metadata may be attached.
132 -| |/components|(% style="width:704px" %)Associates the Target Object components that define the key of the Metadata Target.
130 +)))|A set of components that define a key of an object type to which metadata may be attached.
131 +||/components|Associates the Target Object components that define the key of the Metadata Target.
133 133  |//TargetObject//|(((
134 134  Abstract Class
134 +
135 135  Sub Classes
136 +
136 136  DimensionDescriptorValues
138 +
137 137  Target
140 +
138 138  IdentifiableObjectTarget
142 +
139 139  DataSetTarget
144 +
140 140  ReportPeriodTarget
141 -)))|(% style="width:704px" %)
142 -| |/localRepresentation|(% style="width:704px" %)Associates a Representation to the Target Object that must be respected when the object is identified in a Metadata Set. This may be enumerated or nonenumerated.
146 +)))|
147 +||/localRepresentation|Associates a Representation to the Target Object that must be respected when the object is identified in a Metadata Set. This may be enumerated or nonenumerated.
143 143  |DimensionDescriptor ValuesTarget|(((
144 144  Inherits from
145 145  
146 146  //TargetObject//
147 -)))|(% style="width:704px" %)The target object is the key of a data series.
152 +)))|The target object is the key of a data series.
148 148  |IdentifiableObject Target|(((
149 149  Inherits from
155 +
150 150  //TargetObject//
151 -)))|(% style="width:704px" %)The target object is a specified object type.
152 -| |objectType|(% style="width:704px" %)Identifies the object type.
157 +)))|The target object is a specified object type.
158 +||objectType|Identifies the object type.
153 153  |DataSetTarget|(((
154 154  Inherits from
161 +
155 155  //TargetObject//
156 -)))|(% style="width:704px" %)The target object is a Data Set.
163 +)))|The target object is a Data Set.
157 157  |ReportPeriodTarget|(((
158 158  Inherits from
166 +
159 159  //TargetObject//
160 -)))|(% style="width:704px" %)The target is a report period. Note that this does not describe the use of an object, but rather serves as a unique metadata key for metadata reports. Metadata reports attached to a particular object may vary over time, and this time identifier component can be used to disambiguate the reports, much like the time dimension disambiguates observations in a data series.
168 +)))|The target is a report period. Note that this does not describe the use of an object, but rather serves as a unique metadata key for metadata reports. Metadata reports attached to a particular object may vary over time, and this time identifier component can be used to disambiguate the reports, much like the time dimension disambiguates observations in a data series.
161 161  |ConstraintTarget|(((
162 162  Inherits from
171 +
163 163  //TargetObject//
164 -)))|(% style="width:704px" %)The target object is the data or reference metadata that is identified in the content of an Attachment Constraint.
173 +)))|The target object is the data or reference metadata that is identified in the content of an Attachment Constraint.
165 165  |ReportStructure|(((
166 166  Inherits from:
176 +
167 167  //ComponentList//
168 -)))|(% style="width:704px" %)Defines a set of concepts that comprises the Metadata Attributes to be reported.
169 -| |/components|(% style="width:704px" %)An association to the Metadata Attributes relevant to the Report Structure.
170 -| |+reportFor|(% style="width:704px" %)Associates the Metadata Targets for which this Report Structure is used.
171 -|MetadataAttribute| |(% style="width:704px" %)Identifies a Concept for which a value may be reported in a Metadata Set.
172 -| |/hierarchy|(% style="width:704px" %)Association to one or more child Metadata Attribute.
173 -| |/conceptIdentity|(% style="width:704px" %)An association to the concept which defines the semantic of the attribute.
174 -| |isPresentational|(% style="width:704px" %)Indication that the Metadata Attribute is present for structural purposes (i.e. it has child attributes) and that no value for this attribute is expected to be reported in a Metadata Set using this Report Structure.
175 -| |minOccurs maxOccurs|(% style="width:704px" %)Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadata Report.
176 -|ConceptUsage| |(% style="width:704px" %)The use of a Concept as Metadata Attribute.
177 -| |concept|(% style="width:704px" %)Association to a Concept in a ConceptScheme.
178 -| |/localRepresentation|(% style="width:704px" %)Associates a Representation that overrides any core representation specified for the Concept itself.
179 -|Representation| |(% style="width:704px" %)The representation of the Metadata Attribute.
178 +)))|Defines a set of concepts that comprises the Metadata Attributes to be reported.
179 +||/components|An association to the Metadata Attributes relevant to the Report Structure.
180 +||+reportFor|Associates the Metadata Targets for which this Report Structure is used.
181 +|MetadataAttribute||Identifies a Concept for which a value may be reported in a Metadata Set.
182 +||/hierarchy|Association to one or more child Metadata Attribute.
183 +||/conceptIdentity|An association to the concept which defines the semantic of the attribute.
184 +||isPresentational|Indication that the Metadata Attribute is present for structural purposes (i.e. it has child attributes) and that no value for this attribute is expected to be reported in a Metadata Set using this Report Structure.
185 +||minOccurs maxOccurs|Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadata Report.
186 +|ConceptUsage||The use of a Concept as Metadata Attribute.
187 +||concept|Association to a Concept in a ConceptScheme.
188 +||/localRepresentation|Associates a Representation that overrides any core representation specified for the Concept itself.
189 +|Representation||The representation of the Metadata Attribute.
180 180  
191 +
192 +
193 +
181 181  == {{id name="_Toc371034"/}}7.4 Metadata Set ==
182 182  
183 183  === {{id name="_Toc371035"/}}7.4.1 Class Diagram ===
184 184  
185 -[[image:1747902223404-649.png]]
186 -
187 187  **Figure 29: Relationship Class Diagram of the Metadata Set**
188 188  
189 189  === {{id name="_Toc371036"/}}7.4.2 Explanation of the Diagram ===
190 190  
191 -==== 7.4.2.1 Narrative ====
202 +**7.4.2.1 Narrative**
192 192  
193 193  Note that the MetadataSet must conform to the MetadataStructureDefinition associated to the MetadataflowDefinition for which this MetadataSet is an “instance of metadata”. Whilst the model shows the association to the classes of the MetadataStructureDefinition, this is for conceptual purposes to show the link to the
194 194  
... ... @@ -226,31 +226,31 @@
226 226  ==== 7.4.2.2 Definitions ====
227 227  
228 228  |**Class**|**Feature**|**Description**
229 -|MetadataSet| |Any organised collection of metadata.
230 -| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
231 -| |reportingEnd|A specific time period in a known system of time periods that identifies the ebd period of a report.
232 -| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
233 -| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
234 -| |validTo|Indicates the inclusive end time indicating the validity of the information in the metadata set.
235 -| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
236 -| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
237 -| |setId|Provides an identification of the metadata set.
238 -| |action|Defines the action to be taken by the recipient system (update, replace, delete)
239 -| |+describedBy|Associates a Metadataflow Definition to the Metadata Set.
240 -| |+structuredBy|Associates the Metadata Structure Definition that defines the structure of the Metadata Set. Note that the Metadata Structure Definition is the same as that associated (nonmandatory) to the Metadataflow Definition.
241 -| |+publishedBy|Associates the Data Provider that reports/publishes the metadata.
242 -| |+describedBy|Reference to the Report Structure.
243 -|MetadataReport| |A set of values for Metadata Attributes defined in a Report Structure of a Metadata Structure Definition.
244 -| |+attachesTo|Associates the object key to which metadata is to be attached.
245 -| |+target|Associates the Metadata Target that defines the target object to which the metadata are to be associated.
246 -| |+metadata|Associates the Reported Attribute values which are to be associated with the object or objects identified by the Target Object Key.
247 -|TargetObjectKey| |Identifies the key of the object to which the metadata are to be attached.
248 -| |+valueFor|(((
240 +|MetadataSet||Any organised collection of metadata.
241 +||reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
242 +||reportingEnd|A specific time period in a known system of time periods that identifies the ebd period of a report.
243 +||dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
244 +||validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
245 +||validTo|Indicates the inclusive end time indicating the validity of the information in the metadata set.
246 +||publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
247 +||publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
248 +||setId|Provides an identification of the metadata set.
249 +||action|Defines the action to be taken by the recipient system (update, replace, delete)
250 +||+describedBy|Associates a Metadataflow Definition to the Metadata Set.
251 +||+structuredBy|Associates the Metadata Structure Definition that defines the structure of the Metadata Set. Note that the Metadata Structure Definition is the same as that associated (nonmandatory) to the Metadataflow Definition.
252 +||+publishedBy|Associates the Data Provider that reports/publishes the metadata.
253 +||+describedBy|Reference to the Report Structure.
254 +|MetadataReport||A set of values for Metadata Attributes defined in a Report Structure of a Metadata Structure Definition.
255 +||+attachesTo|Associates the object key to which metadata is to be attached.
256 +||+target|Associates the Metadata Target that defines the target object to which the metadata are to be associated.
257 +||+metadata|Associates the Reported Attribute values which are to be associated with the object or objects identified by the Target Object Key.
258 +|TargetObjectKey||Identifies the key of the object to which the metadata are to be attached.
259 +||+valueFor|(((
249 249  Associates the Metadata Target that identifies the object type and the component structure of the Target Object Key.
250 250  
251 251  Note that this is a conceptual association showing the link to the MSD construct.
252 252  )))
253 -| |+keyValues|Associates the Target Object Values of the Target Object Key.
264 +||+keyValues|Associates the Target Object Values of the Target Object Key.
254 254  |//TargetObjectValue//|(((
255 255  Abstract class
256 256  
... ... @@ -262,7 +262,7 @@
262 262  
263 263  TargetReportPeriod
264 264  )))|The key of an individual object of the type specified in the Metadata Target of the Metadata Structure Definition.
265 -| |+valueFor|(((
276 +||+valueFor|(((
266 266  Associates the Target Object for which this value is provided.
267 267  
268 268  Note that this is a conceptual association showing the link to the MSD construct.
... ... @@ -272,17 +272,17 @@
272 272  
273 273  //TargetObjectValue//
274 274  )))|The identification of the components and the values that form the data or metadata key.
275 -|ComponentValue| |Collectively contain the identification of the components and the values that form the data key.
276 -|value| |The key value.
277 -| |+valueFor|Associates the Component for which the value is declared.
278 -|TimeDimensionValue| |Contains identification of the Time Dimension and the value.
286 +|ComponentValue||Collectively contain the identification of the components and the values that form the data key.
287 +|value||The key value.
288 +||+valueFor|Associates the Component for which the value is declared.
289 +|TimeDimensionValue||Contains identification of the Time Dimension and the value.
279 279  |TargetIdentifiable Object|(((
280 280  Inherits from
281 281  
282 282  //TargetObjectValue    //
283 283  )))|Specifies the identification of an Identifiable object.
284 -|StructureRef| |Contains the identification of an Identifiable object.
285 -| |structureType|The object type of the target object.
295 +|StructureRef||Contains the identification of an Identifiable object.
296 +||structureType|The object type of the target object.
286 286  |(((
287 287  Maintainable
288 288  
... ... @@ -291,8 +291,8 @@
291 291  Identifiable
292 292  
293 293  ArtefactRef
294 -)))| |Identification of the target object by means of its identifier constructs i.e agency ID, id, version for Maintainable Object plus, for Identifiable Object, the id.
295 -| |+containedObject|Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
305 +)))||Identification of the target object by means of its identifier constructs i.e agency ID, id, version for Maintainable Object plus, for Identifiable Object, the id.
306 +||+containedObject|Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
296 296  |TargetDataSet|(((
297 297  Inherits from
298 298  
... ... @@ -308,14 +308,14 @@
308 308  
309 309  //NonEnumeratedAttributeValue//
310 310  
311 -EnumeratedAttributeValue//    //
322 +EnumeratedAttributeValue//    //
312 312  )))|The value for a Metadata Attribute.
313 -| |+valueFor|(((
324 +||+valueFor|(((
314 314  Association to the Metadata Attribute in the Metadata Structure Definition that identifies the Concept and allowed Representation for the Reported Attribute.
315 315  
316 316  Note that this is a conceptual association showing the link to the MSD construct. The syntax for the Reported Attribute will state, in some form, the id of the Metadata Attribute.
317 317  )))
318 -| |+child|Association to a child Reported Attribute consistent with the hierarchy defined in the Report Structure for the Metadata Attribute for which this child is a Reported Attribute.
329 +||+child|Association to a child Reported Attribute consistent with the hierarchy defined in the Report Structure for the Metadata Attribute for which this child is a Reported Attribute.
319 319  |//NonEnumerated AttributeValue//|(((
320 320  Inherits from
321 321  
... ... @@ -331,19 +331,19 @@
331 331  
332 332  //AttributeValue//
333 333  )))|The content of a Reported Attribute where this is textual.
334 -|XHTMLAttributeValue| |This contains XHTML.
335 -| |value|The string value of the XHTML.
336 -|TextAttributeValue| |This value of a Reported Attribute where the content is humanreadable text.
337 -| |text|The string value is text. This can be present in multiple language versions.
338 -|OtherNonEnumerated AttributeValue| |The value of a Reported Attribute where the content is not of humanreadable text.
339 -| |value|A text string that is consistent in format to that defined in the Representation of the Metadata Attribute for which this is a Reported Attribute.
345 +|XHTMLAttributeValue||This contains XHTML.
346 +||value|The string value of the XHTML.
347 +|TextAttributeValue||This value of a Reported Attribute where the content is humanreadable text.
348 +||text|The string value is text. This can be present in multiple language versions.
349 +|OtherNonEnumerated AttributeValue||The value of a Reported Attribute where the content is not of humanreadable text.
350 +||value|A text string that is consistent in format to that defined in the Representation of the Metadata Attribute for which this is a Reported Attribute.
340 340  |EnumeratedAttribute Value|(((
341 341  Inherits from
342 342  
343 343  //MetadataAttributeValue//
344 344  )))|The content of a Reported Attribute that is taken from a Code in a Code list.
345 -| |value|The Code value of the Reported Attribute.
346 -| |+value|(((
356 +||value|The Code value of the Reported Attribute.
357 +||+value|(((
347 347  Association to a Code in the Code list specified in the Representation of the Metadata Attribute for which this Reported Attribute is the value
348 348  
349 349  Note that this shows the conceptual link to the Item that is the value. In reality, the value itself will be contained in the Enumerated Attribute Value.
... ... @@ -351,4 +351,4 @@
351 351  
352 352  
353 353  
354 -
365 +
1747902064472-244.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -56.8 KB
Content
1747902223404-649.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -115.9 KB
Content
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,1 +1,0 @@
1 -8