Changes for page 7 Metadata Structure Definition and Metadata Set

Summary

• Page properties (2 modified, 0 added, 0 removed)
• Attachments (0 modified, 3 added, 3 removed)
  • 1749246462779-763.jpeg
  • 1749246462786-944.jpeg
  • 1749246462791-735.jpeg
  • image58.png
  • image59.png
  • image60.png
• Objects (0 modified, 1 added, 1 removed)
  • SUZ.Methodology.Code.MethodologyClass[0]
  • SKMS.Methodology.Code.MethodologyClass[0]

Details

Page properties

Tags

...	...	@@ -1,0 +1,1 @@
	1	+Attribute|Codelist|Constraint|Data Provider|Data Structure Definition|Hierarchy|Identifiable Artefact|Language|Maintenance agency|Metadata Set|Metadata Structure Definition|Metadata repository|Provision Agreement|Reference metadata|Reference period|SDMX Information Model|Statistical Data and Metadata eXchange|Structural metadata|Time period

Content

...	...	@@ -4,30 +4,32 @@
4	4
5	5	== 7.1 Context ==
6	6
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:
	7	+Besides the possibility to extend the [[components>>doc:IMElements.components.WebHome]] of Data Structure Definitions by [[metadata>>doc:IMElements.metadata.WebHome]] attributes defined in Metadata Structure Definitions, the SDMX metamodel allows [[metadata>>doc:IMElements.metadata.WebHome]] to describe any identifiable artefact. These [[metadata>>doc:IMElements.metadata.WebHome]] can be:
8	8
9	9	1. Exchanged without the need to embed it within the object that it is describing.
10		-1. Stored separately from the object that it describes, yet be linked to it (for example, an organisation has a metadata repository which supports the dissemination of metadata resulting from metadata requests generated by systems or services that have access to the object for which the metadata pertains. This is common in web dissemination where additional metadata is available for viewing (and eventually downloading) by clicking on an “information” icon next to the object to which the metadata is attached).
	10	+1. Stored separately from the object that it describes, yet be linked to it (for example, an organisation has a metadata repository which supports the dissemination of [[metadata>>doc:IMElements.metadata.WebHome]] resulting from [[metadata>>doc:IMElements.metadata.WebHome]] requests generated by systems or services that have access to the object for which the [[metadata>>doc:IMElements.metadata.WebHome]] pertains. This is common in web dissemination where additional [[metadata>>doc:IMElements.metadata.WebHome]] is available for viewing (and eventually downloading) by clicking on an “information” icon next to the object to which the [[metadata>>doc:IMElements.metadata.WebHome]] is attached).
11	11	1. Versioned and maintained like structural metadata, but from Metadata Providers than Agencies.
12		-1. Reported according to a defined structure.
	12	+1. Reported according to a defined [[structure>>doc:IMElements.structure.WebHome]].
13	13
14	14	In order to achieve this, the following structures are modelled:
15	15
16		-* The Metadata Structure Definition which comprises the metadata attributes that can be attached to the various object types (these attributes can be structured in a hierarchy), together with any constraints that may apply (e.g., association to a code list that contains valid values for the attribute when reported in a metadata set),
17		-* The Metadataflow and/or Metadata Provision Agreement, which contains the objects to which the metadata are to be associated (attached),
18		-* The Metadata Set, which contains reported metadata.
	16	+* The Metadata Structure Definition which comprises the [[metadata>>doc:IMElements.metadata.WebHome]] attributes that can be attached to the various object types (these attributes can be structured in a hierarchy), together with any constraints that may apply (e.g., association to a code list that contains valid values for the attribute when reported in a metadata set),
	17	+* The [[Metadataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Metadataflow.WebHome]] and/or Metadata Provision Agreement, which contains the objects to which the [[metadata>>doc:IMElements.metadata.WebHome]] are to be associated (attached),
	18	+* The Metadata Set, which contains reported [[metadata>>doc:IMElements.metadata.WebHome]].
19	19
20	20	== 7.2 Inheritance ==
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 packages. The diagram below shows the full inheritance tree for the classes concerned with the MetadataStructureDefinition, the MetadataProvisionAgreement, the Metadataflow and the MetadataSet.
	24	+As with the Data Structure Definition [[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]], 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
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	+
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	28	=== 7.2.2 Class Diagram - Inheritance ===
29	29
30		-[[image:1749246462779-763.jpeg]]** **
	32	+[[image:image58.png]]
31	31
32	32	**Figure 32: Inheritance class diagram of the Metadata Structure Definition**
33	33
...	...	@@ -59,7 +59,7 @@
59	59
60	60	=== 7.3.3 Class Diagram – Relationship ===
61	61
62		-[[image:1749246462786-944.jpeg]]
	64	+[[image:image59.png]]
63	63
64	64	**Figure 33: Relationship class diagram of the Metadata Structure Definition**
65	65
...	...	@@ -81,51 +81,48 @@
81	81
82	82	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.
83	83
84		-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
	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.
85	85
86		-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.
87		-
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		-|**Class**|**Feature**|**Description**
93		-|//StructureUsage//| |See “SDMX Base”.
	92	+(% style="width:975.835px" %)
	93	+|**Class**|**Feature**|(% style="width:574px" %)**Description**
	94	+|//StructureUsage//| |(% style="width:574px" %)See “SDMX Base”.
94	94	|Metadataflow|(((
95	95	Inherits from:
96		-
97	97	//StructureUsage//
98		-)))|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|Associates a Metadata Structure Definition.
100		-|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.
101		-|MetadataProvider| |See Organisation Scheme.
102		-|IdentifiableObjectSe lection| |A list or wildcarded expression resolving into Identifiable Objects that metadata will refer to.
103		-|MetadataStructureDef inition|(((
	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|(((
104	104	Inherits from:
105		-
106	106	//MaintainableArtefact//
107		-)))|A collection of metadata concepts and their structure when used to collect or disseminate reference metadata.
108		-|MetadataAttributeDes criptor|(((
	106	+)))|(% style="width:574px" %)A collection of metadata concepts and their structure when used to collect or disseminate reference metadata.
	107	+|MetadataAttributeDescriptor|(((
109	109	Inherits from:
110	110
111	111	//ComponentList//
112		-)))|Defines a set of concepts that comprises the Metadata Attributes to be reported.
113		-| |/components|An association to the Metadata Attributes relevant to the Metadata Attribute Descriptor.
114		-|MetadataAttribute|// //|Identifies a Concept for which a value may be reported in a Metadata Set.
115		-| |/hierarchy|Association to one or more child Metadata Attribute.
116		-| |/conceptIdentity|An association to the concept which defines the semantic of the attribute.
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		-| |minOccurs maxOccurs|(((
	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" %)(((
119	119	Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadataset.
120	120	)))
121		-| |/localRepresentation|Associates a Representation that overrides any core representation specified for the Concept itself.
122		-|Representation| |The representation of the Metadata Attribute.
	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	123
124	124	== 7.4 Metadata Set ==
125	125
126	126	=== 7.4.1 Class Diagram ===
127	127
128		-[[image:1749246462791-735.jpeg]]
	127	+[[image:image60.png]]
129	129
130	130	**Figure 34: Relationship Class Diagram of the Metadata Set**
131	131
...	...	@@ -153,71 +153,61 @@
153	153
154	154	==== 7.4.2.2 Definitions ====
155	155
156		-|**Class**|**Feature**|**Description**
157		-|MetadataSet| |Any organised collection of metadata.
158		-| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
159		-| |reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
160		-| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
161		-| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
162		-| |action|Defines the action to be taken by the recipient system (information, append, replace, delete)
163		-| |+describedBy|Associates a Metadataflow or a Metadata Provision Agreement to the Metadata Set.
164		-| |+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.
165		-| |+publishedBy|Associates the Data Provider that reports/publishes the metadata.
166		-| |+attachesTo|Associates the target identifiable objects to which metadata is to be attached.
167		-| |+metadata|Associates the Metadata Attribute values which are to be associated with the object or objects identified by the Target Identifiable Objects(s).
168		-|TargetIdentifiableO bject| |Specifies the identification of an Identifiable object.
169		-| |+valueFor|Associates the Target Identifiable Object being a part of the Identifiable Object Selection specified in the Dataflow or Metadata Provision Agreement.
170		-|StructureRef| |Contains the identification of an Identifiable object.
171		-| |structureType|The object type of the target object.
172		-|IdentifiableArtefac tRef| |Identification of the target object.
173		-| |+containedObject|Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
174		-|//MetadataAttributeVa lue//|(((
	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//|(((
175	175	Abstract class
176	176	Sub classes are:
177		-//UncodedMetadataAttrib uteValue//
178		-CodedMetadataAttribut eValue
179		-)))|The value for a Metadata Attribute.
	177	+//UncodedMetadataAttributeValue//
	178	+CodedMetadataAttributeValue
	179	+)))|(% style="width:515px" %)The value for a Metadata Attribute.
180	180	| |(((
181	181	+valueFor
182		-
183	183	(inherited from the
184		-
185	185	//AttributeValue//)
186		-)))|(((
	184	+)))|(% style="width:515px" %)(((
187	187	Association to the Metadata Attribute in the Metadata Structure Definition that identifies the Concept and allowed Representation for the Metadata Attribute value.
188		-
189	189	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.
190	190	)))
191		-| |+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.
192		-|//UncodedMetadataAttr ibuteValue//|(((
	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	193	Inherits from
194		-
195		-//MetadataAttributeValu e//
196		-
	191	+//MetadataAttributeValue//
197	197	Sub class:
198		-
199	199	XHTMLAttributeValue
200		-
201	201	TextAttributeValue
202		-
203		-OtherUncodedAttribute
204		-
205		-Value
206		-)))|The content of a Metadata Attribute value where this is textual.
207		-|XHTMLAttributeValue| |This contains XHTML
208		-| |value|The string value of the XHTML
209		-|TextAttributeValue| |This value of a Metadata Attribute value where the content is human-readable text.
210		-| |text|The string value is text. This can be present in multiple language versions.
211		-|OtherUncodedAttribu teValue| |The value of a Metadata Attribute value where the content is not of humanreadable text.
212		-| |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.
213		-| |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).
214		-|CodedMetadataAttrib uteValue|(((
	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|(((
215	215	Inherits from
216		-
217		-//MetadataAttributeValu e//
218		-)))|The content of a Metadata Attribute value that is taken from a Code in a Code list.
219		-| |value|The Code value of the Metadata Attribute value.
220		-| |+value|(((
	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" %)(((
221	221	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.
222	222
223	223	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.

1749246462779-763.jpeg

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.helena

Size

...	...	@@ -1,1 +1,0 @@
1		-42.2 KB

Content

1749246462786-944.jpeg

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.helena

Size

...	...	@@ -1,1 +1,0 @@
1		-35.1 KB

Content

1749246462791-735.jpeg

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.helena

Size

...	...	@@ -1,1 +1,0 @@
1		-60.0 KB

Content

image58.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+xwiki:XWiki.helena

Size

...	...	@@ -1,0 +1,1 @@
	1	+123.2 KB

Content

image59.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+xwiki:XWiki.helena

Size

...	...	@@ -1,0 +1,1 @@
	1	+65.8 KB

Content

image60.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+xwiki:XWiki.helena

Size

...	...	@@ -1,0 +1,1 @@
	1	+97.4 KB

Content

SUZ.Methodology.Code.MethodologyClass[0]

index

...	...	@@ -1,1 +1,0 @@
1		-8

SKMS.Methodology.Code.MethodologyClass[0]

Index

...	...	@@ -1,0 +1,1 @@
	1	+8