Changes for page 7 Metadata Structure Definition and Metadata Set
Last modified by Helena K. on 2026/06/08 17:06
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Attachments (0 modified, 3 added, 3 removed)
-
Objects (0 modified, 1 added, 1 removed)
Details
- Page properties
-
- Content
-
... ... @@ -21,15 +21,13 @@ 21 21 22 22 === 7.2.1 Introduction === 23 23 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 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 -packages. The diagram below shows the full inheritance tree for the classes concerned with the MetadataStructureDefinition, the MetadataProvisionAgreement, the Metadataflow and the MetadataSet. 27 - 28 28 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). 29 29 30 30 === 7.2.2 Class Diagram - Inheritance === 31 31 32 -[[image: image58.png]]30 +[[image:1749246462779-763.jpeg]]** ** 33 33 34 34 **Figure 32: Inheritance class diagram of the Metadata Structure Definition** 35 35 ... ... @@ -42,7 +42,9 @@ 42 42 The concrete classes in this part of the SDMX metamodel, which require to be maintained by Maintenance Agencies, all inherit from MaintainableArtefact. These are: 43 43 44 44 //StructureUsage// (concrete class is Metadataflow) 43 + 45 45 //Structure// (concrete class is MetadataStructureDefinition) 45 + 46 46 MetadataProvisionAgreement 47 47 48 48 These classes also inherit the identity and versioning facets of //IdentifiableArtefact//, //NameableArtefact// and //VersionableArtefact//. ... ... @@ -61,7 +61,7 @@ 61 61 62 62 === 7.3.3 Class Diagram – Relationship === 63 63 64 -[[image: image59.png]]64 +[[image:1749246462786-944.jpeg]] 65 65 66 66 **Figure 33: Relationship class diagram of the Metadata Structure Definition** 67 67 ... ... @@ -83,48 +83,51 @@ 83 83 84 84 The definition of the various types of Representation can be found in the specification of the Base constructs. Note that if the Representation is non-enumerated then the association is to the ExtendedFacet (which allows for XHTML as a FacetValueType). If the Representation is enumerated, then is must use a Codelist. 85 85 86 -The Metadataflow is linked to a MetadataStructureDefinition. The Metadataflow, in addition to the attributes inherited from the Base classes, it also has a list of IdentifiableObjectSelection constructs, which resolve into the IdentifiableArtefacts that the Metadatasets will refer to. The IdentifiableObjectSelection acts like a reference, but it may also include wildcarding part of the reference terms.86 +The Metadataflow is linked to a MetadataStructureDefinition. The Metadataflow, in addition to the attributes inherited from the Base classes, it also has a list of 87 87 88 +IdentifiableObjectSelection constructs, which resolve into the IdentifiableArtefacts that the Metadatasets will refer to. The IdentifiableObjectSelection acts like a reference, but it may also include wildcarding part of the reference terms. 89 + 88 88 The MetadataProvisionAgreement is linked to a Metadataflow. The former, like the Metadataflow, may have IdentifiableObjectSelection constructs to be used for specifying the proper targets for reference metadata. 89 89 90 90 ==== 7.3.4.2 Definitions ==== 91 91 92 -(% style="width:975.835px" %) 93 -|**Class**|**Feature**|(% style="width:574px" %)**Description** 94 -|//StructureUsage//| |(% style="width:574px" %)See “SDMX Base”. 94 +|**Class**|**Feature**|**Description** 95 +|//StructureUsage//| |See “SDMX Base”. 95 95 |Metadataflow|((( 96 96 Inherits from: 98 + 97 97 //StructureUsage// 98 -)))| (% style="width:574px" %)Abstract concept (i.e., the structure without any metadata) of a flow of metadata that providers will provide for different reference periods. Specifies possible targets for metadata, via the Identifiable Object Selection.99 -| |/structure| (% style="width:574px" %)Associates a Metadata Structure Definition.100 -|MetadataProvisionAgreement| | (% style="width:574px" %)Links the Metadata Provider to the relevant Structure Usage (i.e., Metadataflow) for which the provider supplies metadata. The agreement may constrain the scope of the metadata that can be provided, by means of a Constraint. Specifies possible targets for metadata, via the Identifiable Object Selection.101 -|MetadataProvider| | (% style="width:574px" %)See Organisation Scheme.102 -|IdentifiableObjectSelection| | (% style="width:574px" %)A list or wildcarded expression resolving into Identifiable Objects that metadata will refer to.103 -|MetadataStructureDefinition|((( 100 +)))|Abstract concept (i.e., the structure without any metadata) of a flow of metadata that providers will provide for different reference periods. Specifies possible targets for metadata, via the Identifiable Object Selection. 101 +| |/structure|Associates a Metadata Structure Definition. 102 +|MetadataProvisionAgr eement| |Links the Metadata Provider to the relevant Structure Usage (i.e., Metadataflow) for which the provider supplies metadata. The agreement may constrain the scope of the metadata that can be provided, by means of a Constraint. Specifies possible targets for metadata, via the Identifiable Object Selection. 103 +|MetadataProvider| |See Organisation Scheme. 104 +|IdentifiableObjectSe lection| |A list or wildcarded expression resolving into Identifiable Objects that metadata will refer to. 105 +|MetadataStructureDef inition|((( 104 104 Inherits from: 107 + 105 105 //MaintainableArtefact// 106 -)))| (% style="width:574px" %)A collection of metadata concepts and their structure when used to collect or disseminate reference metadata.107 -|MetadataAttributeDescriptor|((( 109 +)))|A collection of metadata concepts and their structure when used to collect or disseminate reference metadata. 110 +|MetadataAttributeDes criptor|((( 108 108 Inherits from: 109 109 110 110 //ComponentList// 111 -)))| (% style="width:574px" %)Defines a set of concepts that comprises the Metadata Attributes to be reported.112 -| |/components| (% style="width:574px" %)An association to the Metadata Attributes relevant to the Metadata Attribute Descriptor.113 -|MetadataAttribute|// //| (% style="width:574px" %)Identifies a Concept for which a value may be reported in a Metadata Set.114 -| |/hierarchy| (% style="width:574px" %)Association to one or more child Metadata Attribute.115 -| |/conceptIdentity| (% style="width:574px" %)An association to the concept which defines the semantic of the attribute.116 -| |isPresentational| (% style="width:574px" %)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.117 -| |minOccurs maxOccurs|( % style="width:574px" %)(((114 +)))|Defines a set of concepts that comprises the Metadata Attributes to be reported. 115 +| |/components|An association to the Metadata Attributes relevant to the Metadata Attribute Descriptor. 116 +|MetadataAttribute|// //|Identifies a Concept for which a value may be reported in a Metadata Set. 117 +| |/hierarchy|Association to one or more child Metadata Attribute. 118 +| |/conceptIdentity|An association to the concept which defines the semantic of the attribute. 119 +| |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. 120 +| |minOccurs maxOccurs|((( 118 118 Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadataset. 119 119 ))) 120 -| |/localRepresentation| (% style="width:574px" %)Associates a Representation that overrides any core representation specified for the Concept itself.121 -|Representation| | (% style="width:574px" %)The representation of the Metadata Attribute.123 +| |/localRepresentation|Associates a Representation that overrides any core representation specified for the Concept itself. 124 +|Representation| |The representation of the Metadata Attribute. 122 122 123 123 == 7.4 Metadata Set == 124 124 125 125 === 7.4.1 Class Diagram === 126 126 127 -[[image: image60.png]]130 +[[image:1749246462791-735.jpeg]] 128 128 129 129 **Figure 34: Relationship Class Diagram of the Metadata Set** 130 130 ... ... @@ -152,61 +152,71 @@ 152 152 153 153 ==== 7.4.2.2 Definitions ==== 154 154 155 -(% style="width:980.835px" %) 156 -|**Class**|**Feature**|(% style="width:515px" %)**Description** 157 -|MetadataSet| |(% style="width:515px" %)Any organised collection of metadata. 158 -| |reportingBegin|(% style="width:515px" %)A specific time period in a known system of time periods that identifies the start period of a report. 159 -| |reportingEnd|(% style="width:515px" %)A specific time period in a known system of time periods that identifies the end period of a report. 160 -| |publicationYear|(% style="width:515px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force. 161 -| |publicationPeriod|(% style="width:515px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force. 162 -| |action|(% style="width:515px" %)Defines the action to be taken by the recipient system (information, append, replace, delete) 163 -| |+describedBy|(% style="width:515px" %)Associates a Metadataflow or a Metadata Provision Agreement to the Metadata Set. 164 -| |+structuredBy|(% style="width:515px" %)Associates the Metadata Attribute Descriptor of the Metadata Structure Definition that defines the structure of the Metadata Set. Note that this dependency explains that the Metadataset is structures according to the Metadata Structure Definition of the linked (by the +describedBy) Metadataflow or the Metadata Provision Agreement. 165 -| |+publishedBy|(% style="width:515px" %)Associates the Data Provider that reports/publishes the metadata. 166 -| |+attachesTo|(% style="width:515px" %)Associates the target identifiable objects to which metadata is to be attached. 167 -| |+metadata|(% style="width:515px" %)Associates the Metadata Attribute values which are to be associated with the object or objects identified by the Target Identifiable Objects(s). 168 -|TargetIdentifiableObject| |(% style="width:515px" %)Specifies the identification of an Identifiable object. 169 -| |+valueFor|(% style="width:515px" %)Associates the Target Identifiable Object being a part of the Identifiable Object Selection specified in the Dataflow or Metadata Provision Agreement. 170 -|StructureRef| |(% style="width:515px" %)Contains the identification of an Identifiable object. 171 -| |structureType|(% style="width:515px" %)The object type of the target object. 172 -|IdentifiableArtefactRef| |(% style="width:515px" %)Identification of the target object. 173 -| |+containedObject|(% style="width:515px" %)Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step. 174 -|//MetadataAttributeValue//|((( 158 +|**Class**|**Feature**|**Description** 159 +|MetadataSet| |Any organised collection of metadata. 160 +| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report. 161 +| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report. 162 +| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force. 163 +| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force. 164 +| |action|Defines the action to be taken by the recipient system (information, append, replace, delete) 165 +| |+describedBy|Associates a Metadataflow or a Metadata Provision Agreement to the Metadata Set. 166 +| |+structuredBy|Associates the Metadata Attribute Descriptor of the Metadata Structure Definition that defines the structure of the Metadata Set. Note that this dependency explains that the Metadataset is structures according to the Metadata Structure Definition of the linked (by the +describedBy) Metadataflow or the Metadata Provision Agreement. 167 +| |+publishedBy|Associates the Data Provider that reports/publishes the metadata. 168 +| |+attachesTo|Associates the target identifiable objects to which metadata is to be attached. 169 +| |+metadata|Associates the Metadata Attribute values which are to be associated with the object or objects identified by the Target Identifiable Objects(s). 170 +|TargetIdentifiableO bject| |Specifies the identification of an Identifiable object. 171 +| |+valueFor|Associates the Target Identifiable Object being a part of the Identifiable Object Selection specified in the Dataflow or Metadata Provision Agreement. 172 +|StructureRef| |Contains the identification of an Identifiable object. 173 +| |structureType|The object type of the target object. 174 +|IdentifiableArtefac tRef| |Identification of the target object. 175 +| |+containedObject|Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step. 176 +|//MetadataAttributeVa lue//|((( 175 175 Abstract class 176 176 Sub classes are: 177 -//UncodedMetadataAttributeValue// 178 -CodedMetadataAttributeValue 179 -)))| (% style="width:515px" %)The value for a Metadata Attribute.179 +//UncodedMetadataAttrib uteValue// 180 +CodedMetadataAttribut eValue 181 +)))|The value for a Metadata Attribute. 180 180 | |((( 181 181 +valueFor 184 + 182 182 (inherited from the 186 + 183 183 //AttributeValue//) 184 -)))|( % style="width:515px" %)(((188 +)))|((( 185 185 Association to the Metadata Attribute in the Metadata Structure Definition that identifies the Concept and allowed Representation for the Metadata Attribute value. 190 + 186 186 Note that this is a conceptual association showing the link to the MSD construct. The syntax for the Metadata Attribute value will state, in some form, the id of the Metadata Attribute. 187 187 ))) 188 -| |+child| (% style="width:515px" %)Association to a child Metadata Attribute value consistent with the hierarchy defined in the MSD for the Metadata Attribute for which this child is a Metadata Attribute value.189 -|//UncodedMetadataAttributeValue//|((( 193 +| |+child|Association to a child Metadata Attribute value consistent with the hierarchy defined in the MSD for the Metadata Attribute for which this child is a Metadata Attribute value. 194 +|//UncodedMetadataAttr ibuteValue//|((( 190 190 Inherits from 191 -//MetadataAttributeValue// 196 + 197 +//MetadataAttributeValu e// 198 + 192 192 Sub class: 200 + 193 193 XHTMLAttributeValue 202 + 194 194 TextAttributeValue 195 -OtherUncodedAttributeValue 196 -)))|(% style="width:515px" %)The content of a Metadata Attribute value where this is textual. 197 -|XHTMLAttributeValue| |(% style="width:515px" %)This contains XHTML 198 -| |value|(% style="width:515px" %)The string value of the XHTML 199 -|TextAttributeValue| |(% style="width:515px" %)This value of a Metadata Attribute value where the content is human-readable text. 200 -| |text|(% style="width:515px" %)The string value is text. This can be present in multiple language versions. 201 -|OtherUncodedAttributeValue| |(% style="width:515px" %)The value of a Metadata Attribute value where the content is not of humanreadable text. 202 -| |value|(% style="width:515px" %)A text string that is consistent in format to that defined in the Representation of the Metadata Attribute for which this is a Metadata Attribute value. 203 -| |startTime|(% style="width:515px" %)This attribute is only used if the textFormat of the Metadata Attribute is of the Timespan type in the Metadata Structure Definition (in which case the value field takes a duration). 204 -|CodedMetadataAttributeValue|((( 204 + 205 +OtherUncodedAttribute 206 + 207 +Value 208 +)))|The content of a Metadata Attribute value where this is textual. 209 +|XHTMLAttributeValue| |This contains XHTML 210 +| |value|The string value of the XHTML 211 +|TextAttributeValue| |This value of a Metadata Attribute value where the content is human-readable text. 212 +| |text|The string value is text. This can be present in multiple language versions. 213 +|OtherUncodedAttribu teValue| |The value of a Metadata Attribute value where the content is not of humanreadable text. 214 +| |value|A text string that is consistent in format to that defined in the Representation of the Metadata Attribute for which this is a Metadata Attribute value. 215 +| |startTime|This attribute is only used if the textFormat of the Metadata Attribute is of the Timespan type in the Metadata Structure Definition (in which case the value field takes a duration). 216 +|CodedMetadataAttrib uteValue|((( 205 205 Inherits from 206 -//MetadataAttributeValue// 207 -)))|(% style="width:515px" %)The content of a Metadata Attribute value that is taken from a Code in a Code list. 208 -| |value|(% style="width:515px" %)The Code value of the Metadata Attribute value. 209 -| |+value|(% style="width:515px" %)((( 218 + 219 +//MetadataAttributeValu e// 220 +)))|The content of a Metadata Attribute value that is taken from a Code in a Code list. 221 +| |value|The Code value of the Metadata Attribute value. 222 +| |+value|((( 210 210 Association to a Code in the Code list specified in the Representation of the Metadata Attribute for which this Metadata Attribute value is the value. 211 211 212 212 Note that this shows the conceptual link to the Item that is the value. In reality, the value itself will be contained in the Coded Metadata Attribute Value.
- image58.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -123.2 KB - Content
- image59.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -65.8 KB - Content
- image60.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -97.4 KB - Content
- 1749246462779-763.jpeg
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +42.2 KB - Content
- 1749246462786-944.jpeg
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +35.1 KB - Content
- 1749246462791-735.jpeg
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +60.0 KB - Content
- SKMS.Methodology.Code.MethodologyClass[0]
-
- Index
-
... ... @@ -1,1 +1,0 @@ 1 -8
- SUZ.Methodology.Code.MethodologyClass[0]
-
- index
-
... ... @@ -1,0 +1,1 @@ 1 +8