Last modified by Artur on 2025/09/10 11:19

From version 5.1
edited by Helena
on 2025/05/22 10:45
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  
... ... @@ -116,21 +116,21 @@
116 116  ==== 7.3.4.2 Definitions ====
117 117  
118 118  |**Class**|**Feature**|**Description**
119 -|StructureUsage| |See “SDMX Base”.
117 +|StructureUsage||See “SDMX Base”.
120 120  |Metadataflow Definition|(((
121 121  Inherits from:
122 122  
123 123  //StructureUsage//
124 124  )))|Abstract concept (i.e. the structure without any metadata) of a flow of metadata that providers will provide for different reference periods.
125 -| |/structure|Associates a Metadata Structure Definition.
126 -|MetadataStructure Definition| |A collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata.
127 -| |/grouping|An association to a Metadata Target or Report Structure.
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
130 130  
131 131  //ComponentList//
132 132  )))|A set of components that define a key of an object type to which metadata may be attached.
133 -| |/components|Associates the Target Object components that define the key of the Metadata Target.
131 +||/components|Associates the Target Object components that define the key of the Metadata Target.
134 134  |//TargetObject//|(((
135 135  Abstract Class
136 136  
... ... @@ -145,8 +145,8 @@
145 145  DataSetTarget
146 146  
147 147  ReportPeriodTarget
148 -)))|
149 -| |/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.
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.
150 150  |DimensionDescriptor ValuesTarget|(((
151 151  Inherits from
152 152  
... ... @@ -157,7 +157,7 @@
157 157  
158 158  //TargetObject//
159 159  )))|The target object is a specified object type.
160 -| |objectType|Identifies the object type.
158 +||objectType|Identifies the object type.
161 161  |DataSetTarget|(((
162 162  Inherits from
163 163  
... ... @@ -178,17 +178,17 @@
178 178  
179 179  //ComponentList//
180 180  )))|Defines a set of concepts that comprises the Metadata Attributes to be reported.
181 -| |/components|An association to the Metadata Attributes relevant to the Report Structure.
182 -| |+reportFor|Associates the Metadata Targets for which this Report Structure is used.
183 -|MetadataAttribute| |Identifies a Concept for which a value may be reported in a Metadata Set.
184 -| |/hierarchy|Association to one or more child Metadata Attribute.
185 -| |/conceptIdentity|An association to the concept which defines the semantic of the attribute.
186 -| |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.
187 -| |minOccurs maxOccurs|Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadata Report.
188 -|ConceptUsage| |The use of a Concept as Metadata Attribute.
189 -| |concept|Association to a Concept in a ConceptScheme.
190 -| |/localRepresentation|Associates a Representation that overrides any core representation specified for the Concept itself.
191 -|Representation| |The representation of the Metadata Attribute.
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.
192 192  
193 193  
194 194  
... ... @@ -239,31 +239,31 @@
239 239  ==== 7.4.2.2 Definitions ====
240 240  
241 241  |**Class**|**Feature**|**Description**
242 -|MetadataSet| |Any organised collection of metadata.
243 -| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
244 -| |reportingEnd|A specific time period in a known system of time periods that identifies the ebd period of a report.
245 -| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
246 -| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
247 -| |validTo|Indicates the inclusive end time indicating the validity of the information in the metadata set.
248 -| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
249 -| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
250 -| |setId|Provides an identification of the metadata set.
251 -| |action|Defines the action to be taken by the recipient system (update, replace, delete)
252 -| |+describedBy|Associates a Metadataflow Definition to the Metadata Set.
253 -| |+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.
254 -| |+publishedBy|Associates the Data Provider that reports/publishes the metadata.
255 -| |+describedBy|Reference to the Report Structure.
256 -|MetadataReport| |A set of values for Metadata Attributes defined in a Report Structure of a Metadata Structure Definition.
257 -| |+attachesTo|Associates the object key to which metadata is to be attached.
258 -| |+target|Associates the Metadata Target that defines the target object to which the metadata are to be associated.
259 -| |+metadata|Associates the Reported Attribute values which are to be associated with the object or objects identified by the Target Object Key.
260 -|TargetObjectKey| |Identifies the key of the object to which the metadata are to be attached.
261 -| |+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|(((
262 262  Associates the Metadata Target that identifies the object type and the component structure of the Target Object Key.
263 263  
264 264  Note that this is a conceptual association showing the link to the MSD construct.
265 265  )))
266 -| |+keyValues|Associates the Target Object Values of the Target Object Key.
264 +||+keyValues|Associates the Target Object Values of the Target Object Key.
267 267  |//TargetObjectValue//|(((
268 268  Abstract class
269 269  
... ... @@ -275,7 +275,7 @@
275 275  
276 276  TargetReportPeriod
277 277  )))|The key of an individual object of the type specified in the Metadata Target of the Metadata Structure Definition.
278 -| |+valueFor|(((
276 +||+valueFor|(((
279 279  Associates the Target Object for which this value is provided.
280 280  
281 281  Note that this is a conceptual association showing the link to the MSD construct.
... ... @@ -285,17 +285,17 @@
285 285  
286 286  //TargetObjectValue//
287 287  )))|The identification of the components and the values that form the data or metadata key.
288 -|ComponentValue| |Collectively contain the identification of the components and the values that form the data key.
289 -|value| |The key value.
290 -| |+valueFor|Associates the Component for which the value is declared.
291 -|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.
292 292  |TargetIdentifiable Object|(((
293 293  Inherits from
294 294  
295 295  //TargetObjectValue    //
296 296  )))|Specifies the identification of an Identifiable object.
297 -|StructureRef| |Contains the identification of an Identifiable object.
298 -| |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.
299 299  |(((
300 300  Maintainable
301 301  
... ... @@ -304,8 +304,8 @@
304 304  Identifiable
305 305  
306 306  ArtefactRef
307 -)))| |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.
308 -| |+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.
309 309  |TargetDataSet|(((
310 310  Inherits from
311 311  
... ... @@ -321,14 +321,14 @@
321 321  
322 322  //NonEnumeratedAttributeValue//
323 323  
324 -EnumeratedAttributeValue//    //
322 +EnumeratedAttributeValue//    //
325 325  )))|The value for a Metadata Attribute.
326 -| |+valueFor|(((
324 +||+valueFor|(((
327 327  Association to the Metadata Attribute in the Metadata Structure Definition that identifies the Concept and allowed Representation for the Reported Attribute.
328 328  
329 329  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.
330 330  )))
331 -| |+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.
332 332  |//NonEnumerated AttributeValue//|(((
333 333  Inherits from
334 334  
... ... @@ -344,19 +344,19 @@
344 344  
345 345  //AttributeValue//
346 346  )))|The content of a Reported Attribute where this is textual.
347 -|XHTMLAttributeValue| |This contains XHTML.
348 -| |value|The string value of the XHTML.
349 -|TextAttributeValue| |This value of a Reported Attribute where the content is humanreadable text.
350 -| |text|The string value is text. This can be present in multiple language versions.
351 -|OtherNonEnumerated AttributeValue| |The value of a Reported Attribute where the content is not of humanreadable text.
352 -| |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.
353 353  |EnumeratedAttribute Value|(((
354 354  Inherits from
355 355  
356 356  //MetadataAttributeValue//
357 357  )))|The content of a Reported Attribute that is taken from a Code in a Code list.
358 -| |value|The Code value of the Reported Attribute.
359 -| |+value|(((
356 +||value|The Code value of the Reported Attribute.
357 +||+value|(((
360 360  Association to a Code in the Code list specified in the Representation of the Metadata Attribute for which this Reported Attribute is the value
361 361  
362 362  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.
... ... @@ -364,4 +364,4 @@
364 364  
365 365  
366 366  
367 -
365 +
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,1 +1,0 @@
1 -8