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

From version 4.2
edited by Helena
on 2025/06/08 11:39
Change comment: There is no comment for this version
To version 3.1
edited by Helena
on 2025/06/07 00:56
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,9 +1,5 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
1 +=== 7.1 Context ===
4 4  
5 -== 7.1 Context ==
6 -
7 7  Besides the possibility to extend the components of Data Structure Definitions by metadata attributes defined in Metadata Structure Definitions, the SDMX metamodel allows metadata to describe any identifiable artefact. These metadata can be:
8 8  
9 9  1. Exchanged without the need to embed it within the object that it is describing.
... ... @@ -17,23 +17,23 @@
17 17  * The Metadataflow and/or Metadata Provision Agreement, which contains the objects to which the metadata are to be associated (attached),
18 18  * The Metadata Set, which contains reported metadata.
19 19  
20 -== 7.2 Inheritance ==
16 +=== 7.2 Inheritance ===
21 21  
22 -=== 7.2.1 Introduction ===
18 +==== 7.2.1 Introduction ====
23 23  
24 24  As with the Data Structure Definition Structure, many of the constructs in this layer of the model inherit from the SDMX Base layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual packages. The diagram below shows the full inheritance tree for the classes concerned with the MetadataStructureDefinition, the MetadataProvisionAgreement, the Metadataflow and the MetadataSet.
25 25  
26 26  There are very few additional classes in the MetadataStructureDefinition package that do not themselves inherit from classes in the SDMX Base. In other words, the SDMX Base gives most of the structure of this sub model both in terms of associations and in terms of attributes. The relationship diagrams shown in this section show clearly when these associations are inherited from the SDMX Base (see the Appendix “A Short Guide to UML in the SDMX Information Model” to see the diagrammatic notation used to depict this).
27 27  
28 -=== 7.2.2 Class Diagram - Inheritance ===
24 +==== 7.2.2 Class Diagram - Inheritance ====
29 29  
30 30  [[image:1749246462779-763.jpeg]]** **
31 31  
32 32  **Figure 32: Inheritance class diagram of the Metadata Structure Definition**
33 33  
34 -=== 7.2.3 Explanation of the Diagram ===
30 +==== 7.2.3 Explanation of the Diagram ====
35 35  
36 -==== 7.2.3.1 Narrative ====
32 +===== 7.2.3.1 Narrative =====
37 37  
38 38  It is important to the understanding of the relationship class diagrams presented in this section to identify the concrete classes that inherit from the abstract classes.
39 39  
... ... @@ -40,7 +40,9 @@
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 42  //StructureUsage// (concrete class is Metadataflow)
39 +
43 43  //Structure// (concrete class is MetadataStructureDefinition)
41 +
44 44  MetadataProvisionAgreement
45 45  
46 46  These classes also inherit the identity and versioning facets of //IdentifiableArtefact//, //NameableArtefact// and //VersionableArtefact//.
... ... @@ -47,25 +47,25 @@
47 47  
48 48  A //Structure// may contain several lists of components. In this case the MetadataStructureDefinition acts as a list and contains //Component//s, i.e., MetadataAttributes.
49 49  
50 -== 7.3 Metadata Structure Definition ==
48 +=== 7.3 Metadata Structure Definition ===
51 51  
52 -=== 7.3.1 Introduction ===
50 +==== 7.3.1 Introduction ====
53 53  
54 54  The diagrams and explanations in the rest of this section show how these concrete classes are related in order to support the required functionality.
55 55  
56 -=== 7.3.2 Structures Already Described ===
54 +==== 7.3.2 Structures Already Described ====
57 57  
58 58  The MetadataStructureDefinition only contains MetadataAttributes, since target objects are contained in Metadataflow and MetadataProvisionAgreement, since SDMX 3.0.
59 59  
60 -=== 7.3.3 Class Diagram – Relationship ===
58 +==== 7.3.3 Class Diagram – Relationship ====
61 61  
62 62  [[image:1749246462786-944.jpeg]]
63 63  
64 64  **Figure 33: Relationship class diagram of the Metadata Structure Definition**
65 65  
66 -=== 7.3.4 Explanation of the Diagram ===
64 +==== 7.3.4 Explanation of the Diagram ====
67 67  
68 -==== 7.3.4.1 Narrative ====
66 +===== 7.3.4.1 Narrative =====
69 69  
70 70  In brief, a MetadataStructureDefinition (MSD) defines the MetadataAttributes, within an MetadataAttributeDescriptor, that can be associated with the objects identified in the Metadataflows and MetadataProvisionAgreements that refer to the MSD. The hierarchy of the MetadataAttributes is specified within the MetadataAttributeDescriptor.
71 71  
... ... @@ -116,22 +116,26 @@
116 116  | |/conceptIdentity|An association to the concept which defines the semantic of the attribute.
117 117  | |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.
118 118  | |minOccurs maxOccurs|(((
119 -Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadataset.
117 +Specifies how many occurrences of the
118 +
119 +Metadata Attribute may be reported at this point in the Metadataset.
120 120  )))
121 121  | |/localRepresentation|Associates a Representation that overrides any core representation specified for the Concept itself.
122 122  |Representation| |The representation of the Metadata Attribute.
123 123  
124 -== 7.4 Metadata Set ==
125 125  
126 -=== 7.4.1 Class Diagram ===
127 127  
126 +=== 7.4 Metadata Set ===
127 +
128 +==== 7.4.1 Class Diagram ====
129 +
128 128  [[image:1749246462791-735.jpeg]]
129 129  
130 130  **Figure 34: Relationship Class Diagram of the Metadata Set**
131 131  
132 -=== 7.4.2 Explanation of the Diagram ===
134 +==== 7.4.2 Explanation of the Diagram ====
133 133  
134 -==== 7.4.2.1 Narrative ====
136 +===== 7.4.2.1 Narrative =====
135 135  
136 136  Note that the MetadataSet must conform to the MetadataStructureDefinition associated to the Metadataflow or MetadataProvisionAgreement 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 MetadataStructureDefinition. In the actual MetadataSet, as exchanged, there must, of course, be a reference to the MetadataStructureDefinition and optionally a Metadataflow or a MetadataProvisionAgreement, but the MetadataStructureDefinition is not necessarily exchanged with the metadata. Note that the MetadataStructureDefinition classes are shown also but are not a part of the MetadataSet itself.
137 137  
... ... @@ -151,7 +151,7 @@
151 151  
152 152  The CodedMetadataAttributeValue contains a value for a Code specified as the Representation for a MetadataAttribute in the MetadataStructureDefinition.
153 153  
154 -==== 7.4.2.2 Definitions ====
156 +===== 7.4.2.2 Definitions =====
155 155  
156 156  |**Class**|**Feature**|**Description**
157 157  |MetadataSet| |Any organised collection of metadata.
... ... @@ -173,8 +173,11 @@
173 173  | |+containedObject|Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
174 174  |//MetadataAttributeVa lue//|(((
175 175  Abstract class
178 +
176 176  Sub classes are:
180 +
177 177  //UncodedMetadataAttrib uteValue//
182 +
178 178  CodedMetadataAttribut eValue
179 179  )))|The value for a Metadata Attribute.
180 180  | |(((