Changes for page 7 Metadata Structure Definition and Metadata Set

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

From 1.1 to 2.1 From 5.1 to 6.1

From version 2.1

edited by Helena
on 2025/06/07 00:55

Change comment: There is no comment for this version

To version 5.1

edited by Helena
on 2025/06/08 11:42

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- SUZ.Methodology.Code.MethodologyClass[0]

Details

Page properties

Content

@@ -1,5 +1,9 @@
--=== 7.1 Context ===
++{{box title="**Contents**"}}
++{{toc/}}
++{{/box}}
++== 7.1 Context ==
++
  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:
 . Exchanged without the need to embed it within the object that it is describing.
@@ -13,23 +13,23 @@
  * The Metadataflow and/or Metadata Provision Agreement, which contains the objects to which the metadata are to be associated (attached),
  * The Metadata Set, which contains reported metadata.
--=== 7.2 Inheritance ===
++== 7.2 Inheritance ==
--==== 7.2.1 Introduction ====
++=== 7.2.1 Introduction ===
  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.
  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).
--==== 7.2.2 Class Diagram - Inheritance ====
++=== 7.2.2 Class Diagram - Inheritance ===
  [[image:1749246462779-763.jpeg]]** **
  **Figure 32: Inheritance class diagram of the Metadata Structure Definition**
--==== 7.2.3 Explanation of the Diagram ====
++=== 7.2.3 Explanation of the Diagram ===
--===== 7.2.3.1 Narrative =====
++==== 7.2.3.1 Narrative ====
  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.
@@ -36,9 +36,7 @@
  The concrete classes in this part of the SDMX metamodel, which require to be maintained by Maintenance Agencies, all inherit from MaintainableArtefact. These are:
  //StructureUsage// (concrete class is Metadataflow)
--
  //Structure// (concrete class is MetadataStructureDefinition)
--
  MetadataProvisionAgreement
  These classes also inherit the identity and versioning facets of //IdentifiableArtefact//, //NameableArtefact// and //VersionableArtefact//.
@@ -45,25 +45,25 @@
  A //Structure// may contain several lists of components. In this case the MetadataStructureDefinition acts as a list and contains //Component//s, i.e., MetadataAttributes.
--=== 7.3 Metadata Structure Definition ===
++== 7.3 Metadata Structure Definition ==
--==== 7.3.1 Introduction ====
++=== 7.3.1 Introduction ===
  The diagrams and explanations in the rest of this section show how these concrete classes are related in order to support the required functionality.
--==== 7.3.2 Structures Already Described ====
++=== 7.3.2 Structures Already Described ===
  The MetadataStructureDefinition only contains MetadataAttributes, since target objects are contained in Metadataflow and MetadataProvisionAgreement, since SDMX 3.0.
--==== 7.3.3 Class Diagram – Relationship ====
++=== 7.3.3 Class Diagram – Relationship ===
  [[image:1749246462786-944.jpeg]]
  **Figure 33: Relationship class diagram of the Metadata Structure Definition**
--==== 7.3.4 Explanation of the Diagram ====
++=== 7.3.4 Explanation of the Diagram ===
--===== 7.3.4.1 Narrative =====
++==== 7.3.4.1 Narrative ====
  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.
@@ -87,53 +87,48 @@
  ==== 7.3.4.2 Definitions ====
--|**Class**|**Feature**|**Description**
--|//StructureUsage//| |See “SDMX Base”.
++(% style="width:975.835px" %)
++|**Class**|**Feature**|(% style="width:574px" %)**Description**
++|//StructureUsage//| |(% style="width:574px" %)See “SDMX Base”.
  |Metadataflow|(((
  Inherits from:
--
  //StructureUsage//
--)))|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.
--| |/structure|Associates a Metadata Structure Definition.
--|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.
--|MetadataProvider| |See Organisation Scheme.
--|IdentifiableObjectSe lection| |A list or wildcarded expression resolving into Identifiable Objects that metadata will refer to.
--|MetadataStructureDef inition|(((
++)))|(% 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.
++| |/structure|(% style="width:574px" %)Associates a Metadata Structure Definition.
++|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.
++|MetadataProvider| |(% style="width:574px" %)See Organisation Scheme.
++|IdentifiableObjectSelection| |(% style="width:574px" %)A list or wildcarded expression resolving into Identifiable Objects that metadata will refer to.
++|MetadataStructureDefinition|(((
  Inherits from:
--
  //MaintainableArtefact//
--)))|A collection of metadata concepts and their structure when used to collect or disseminate reference metadata.
--|MetadataAttributeDes criptor|(((
++)))|(% style="width:574px" %)A collection of metadata concepts and their structure when used to collect or disseminate reference metadata.
++|MetadataAttributeDescriptor|(((
  Inherits from:
  //ComponentList//
--)))|Defines a set of concepts that comprises the Metadata Attributes to be reported.
--| |/components|An association to the Metadata Attributes relevant to the Metadata Attribute Descriptor.
--|MetadataAttribute|// //|Identifies a Concept for which a value may be reported in a Metadata Set.
--| |/hierarchy|Association to one or more child Metadata Attribute.
--| |/conceptIdentity|An association to the concept which defines the semantic of the attribute.
--| |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.
--| |minOccurs maxOccurs|(((
--Specifies how many occurrences of the
--
--Metadata Attribute may be reported at this point in the Metadataset.
++)))|(% style="width:574px" %)Defines a set of concepts that comprises the Metadata Attributes to be reported.
++| |/components|(% style="width:574px" %)An association to the Metadata Attributes relevant to the Metadata Attribute Descriptor.
++|MetadataAttribute|// //|(% style="width:574px" %)Identifies a Concept for which a value may be reported in a Metadata Set.
++| |/hierarchy|(% style="width:574px" %)Association to one or more child Metadata Attribute.
++| |/conceptIdentity|(% style="width:574px" %)An association to the concept which defines the semantic of the attribute.
++| |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.
++| |minOccurs maxOccurs|(% style="width:574px" %)(((
++Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadataset.
  )))
--| |/localRepresentation|Associates a Representation that overrides any core representation specified for the Concept itself.
--|Representation| |The representation of the Metadata Attribute.
++| |/localRepresentation|(% style="width:574px" %)Associates a Representation that overrides any core representation specified for the Concept itself.
++|Representation| |(% style="width:574px" %)The representation of the Metadata Attribute.
++== 7.4 Metadata Set ==
++=== 7.4.1 Class Diagram ===
--=== 7.4 Metadata Set ===
--
--==== 7.4.1 Class Diagram ====
--
  [[image:1749246462791-735.jpeg]]
  **Figure 34: Relationship Class Diagram of the Metadata Set**
--==== 7.4.2 Explanation of the Diagram ====
++=== 7.4.2 Explanation of the Diagram ===
--===== 7.4.2.1 Narrative =====
++==== 7.4.2.1 Narrative ====
  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.
@@ -153,76 +153,64 @@
  The CodedMetadataAttributeValue contains a value for a Code specified as the Representation for a MetadataAttribute in the MetadataStructureDefinition.
--===== 7.4.2.2 Definitions =====
++==== 7.4.2.2 Definitions ====
--|**Class**|**Feature**|**Description**
--|MetadataSet| |Any organised collection of metadata.
--| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
--| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
--| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
--| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
--| |action|Defines the action to be taken by the recipient system (information, append, replace, delete)
--| |+describedBy|Associates a Metadataflow or a Metadata Provision Agreement to the Metadata Set.
--| |+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.
--| |+publishedBy|Associates the Data Provider that reports/publishes the metadata.
--| |+attachesTo|Associates the target identifiable objects to which metadata is to be attached.
--| |+metadata|Associates the Metadata Attribute values which are to be associated with the object or objects identified by the Target Identifiable Objects(s).
--|TargetIdentifiableO bject| |Specifies the identification of an Identifiable object.
--| |+valueFor|Associates the Target Identifiable Object being a part of the Identifiable Object Selection specified in the Dataflow or Metadata Provision Agreement.
--|StructureRef| |Contains the identification of an Identifiable object.
--| |structureType|The object type of the target object.
--|IdentifiableArtefac tRef| |Identification of the target object.
--| |+containedObject|Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
--|//MetadataAttributeVa lue//|(((
++(% style="width:980.835px" %)
++|**Class**|**Feature**|(% style="width:515px" %)**Description**
++|MetadataSet| |(% style="width:515px" %)Any organised collection of metadata.
++| |reportingBegin|(% style="width:515px" %)A specific time period in a known system of time periods that identifies the start period of a report.
++| |reportingEnd|(% style="width:515px" %)A specific time period in a known system of time periods that identifies the end period of a report.
++| |publicationYear|(% style="width:515px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
++| |publicationPeriod|(% style="width:515px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
++| |action|(% style="width:515px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
++| |+describedBy|(% style="width:515px" %)Associates a Metadataflow or a Metadata Provision Agreement to the Metadata Set.
++| |+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.
++| |+publishedBy|(% style="width:515px" %)Associates the Data Provider that reports/publishes the metadata.
++| |+attachesTo|(% style="width:515px" %)Associates the target identifiable objects to which metadata is to be attached.
++| |+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).
++|TargetIdentifiableObject| |(% style="width:515px" %)Specifies the identification of an Identifiable object.
++| |+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.
++|StructureRef| |(% style="width:515px" %)Contains the identification of an Identifiable object.
++| |structureType|(% style="width:515px" %)The object type of the target object.
++|IdentifiableArtefactRef| |(% style="width:515px" %)Identification of the target object.
++| |+containedObject|(% style="width:515px" %)Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
++|//MetadataAttributeValue//|(((
  Abstract class
--
  Sub classes are:
--
  //UncodedMetadataAttrib uteValue//
--
  CodedMetadataAttribut eValue
--)))|The value for a Metadata Attribute.
++)))|(% style="width:515px" %)The value for a Metadata Attribute.
  | |(((
  +valueFor
--
  (inherited from the
--
  //AttributeValue//)
--)))|(((
++)))|(% style="width:515px" %)(((
  Association to the Metadata Attribute in the Metadata Structure Definition that identifies the Concept and allowed Representation for the Metadata Attribute value.
--
  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.
  )))
--| |+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.
--|//UncodedMetadataAttr ibuteValue//|(((
++| |+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.
++|//UncodedMetadataAttributeValue//|(((
  Inherits from
--
--//MetadataAttributeValu e//
--
++//MetadataAttributeValue//
  Sub class:
--
  XHTMLAttributeValue
--
  TextAttributeValue
--
  OtherUncodedAttribute
--
  Value
--)))|The content of a Metadata Attribute value where this is textual.
--|XHTMLAttributeValue| |This contains XHTML
--| |value|The string value of the XHTML
--|TextAttributeValue| |This value of a Metadata Attribute value where the content is human-readable text.
--| |text|The string value is text. This can be present in multiple language versions.
--|OtherUncodedAttribu teValue| |The value of a Metadata Attribute value where the content is not of humanreadable text.
--| |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.
--| |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).
--|CodedMetadataAttrib uteValue|(((
++)))|(% style="width:515px" %)The content of a Metadata Attribute value where this is textual.
++|XHTMLAttributeValue| |(% style="width:515px" %)This contains XHTML
++| |value|(% style="width:515px" %)The string value of the XHTML
++|TextAttributeValue| |(% style="width:515px" %)This value of a Metadata Attribute value where the content is human-readable text.
++| |text|(% style="width:515px" %)The string value is text. This can be present in multiple language versions.
++|OtherUncodedAttributeValue| |(% style="width:515px" %)The value of a Metadata Attribute value where the content is not of humanreadable text.
++| |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.
++| |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).
++|CodedMetadataAttributeValue|(((
  Inherits from
--
--//MetadataAttributeValu e//
--)))|The content of a Metadata Attribute value that is taken from a Code in a Code list.
--| |value|The Code value of the Metadata Attribute value.
--| |+value|(((
++//MetadataAttributeValue//
++)))|(% style="width:515px" %)The content of a Metadata Attribute value that is taken from a Code in a Code list.
++| |value|(% style="width:515px" %)The Code value of the Metadata Attribute value.
++| |+value|(% style="width:515px" %)(((
  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.
  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.

SUZ.Methodology.Code.MethodologyClass[0]

index

@@ -1,1 +1,1 @@
--15
++8