Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 4.1
edited by Helena
on 2025/05/15 09:59
Change comment: There is no comment for this version
To version 5.11
edited by Helena
on 2025/05/16 13:54
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,4 +1,6 @@
1 -= 7 Metadata Structure Definition and Metadata Set =
1 +{{box title="**Contents**"}}
2 +{{toc/}}
3 +{{/box}}
2 2  
3 3  == 7.1 Context ==
4 4  
... ... @@ -40,7 +40,6 @@
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)
43 -
44 44  //Structure// (concrete class is MetadataStructureDefinition)
45 45  
46 46  MetadataProvisionAgreement
... ... @@ -89,38 +89,37 @@
89 89  
90 90  ==== 7.3.4.2 Definitions ====
91 91  
92 -:
93 -
94 94  (((
95 -|**Class**|**Feature**|**Description**
96 -|//StructureUsage//||See “SDMX Base”.
94 +(% style="width:838.294px" %)
95 +|**Class**|**Feature**|(% style="width:446px" %)**Description**
96 +|//StructureUsage//| |(% style="width:446px" %)See “SDMX Base”.
97 97  |Metadataflow|(((
98 98  Inherits from:
99 99  
100 100  //StructureUsage//
101 -)))|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.
102 -||/structure|Associates a Metadata Structure Definition.
103 -|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.
104 -|MetadataProvider||See Organisation Scheme.
105 -|IdentifiableObjectSe lection||A list or wildcarded expression resolving into Identifiable Objects that metadata will refer to.
101 +)))|(% style="width:446px" %)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.
102 +| |/structure|(% style="width:446px" %)Associates a Metadata Structure Definition.
103 +|MetadataProvisionAgr eement| |(% style="width:446px" %)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.
104 +|MetadataProvider| |(% style="width:446px" %)See Organisation Scheme.
105 +|IdentifiableObjectSe lection| |(% style="width:446px" %)A list or wildcarded expression resolving into Identifiable Objects that metadata will refer to.
106 106  |MetadataStructureDef inition|(((
107 107  Inherits from:
108 108  
109 109  //MaintainableArtefact//
110 -)))|A collection of metadata concepts and their structure when used to collect or disseminate reference metadata.
110 +)))|(% style="width:446px" %)A collection of metadata concepts and their structure when used to collect or disseminate reference metadata.
111 111  |MetadataAttributeDes criptor|(((
112 112  Inherits from:
113 113  
114 -//ComponentList     //
115 -)))|Defines a set of concepts that comprises the Metadata Attributes to be reported.
116 -||/components|An association to the Metadata Attributes relevant to the Metadata Attribute Descriptor.
117 -|MetadataAttribute||Identifies a Concept for which a value may be reported in a Metadata Set.
118 -||/hierarchy|Association to one or more child Metadata Attribute.
119 -||/conceptIdentity|An association to the concept which defines the semantic of the attribute.
120 -||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.
121 -||minOccurs maxOccurs|Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadataset.
122 -||/localRepresentation|Associates a Representation that overrides any core representation specified for the Concept itself.
123 -|Representation||The representation of the Metadata Attribute.
114 +//ComponentList //
115 +)))|(% style="width:446px" %)Defines a set of concepts that comprises the Metadata Attributes to be reported.
116 +| |/components|(% style="width:446px" %)An association to the Metadata Attributes relevant to the Metadata Attribute Descriptor.
117 +|MetadataAttribute| |(% style="width:446px" %)Identifies a Concept for which a value may be reported in a Metadata Set.
118 +| |/hierarchy|(% style="width:446px" %)Association to one or more child Metadata Attribute.
119 +| |/conceptIdentity|(% style="width:446px" %)An association to the concept which defines the semantic of the attribute.
120 +| |isPresentational|(% style="width:446px" %)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.
121 +| |minOccurs maxOccurs|(% style="width:446px" %)Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadataset.
122 +| |/localRepresentation|(% style="width:446px" %)Associates a Representation that overrides any core representation specified for the Concept itself.
123 +|Representation| |(% style="width:446px" %)The representation of the Metadata Attribute.
124 124  )))
125 125  
126 126  == 7.4 Metadata Set ==
... ... @@ -137,10 +137,8 @@
137 137  
138 138  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.
139 139  
140 -A MetadataProvider is maintaining one or more MetadataSets, as the latter is a
140 +A MetadataProvider is maintaining one or more MetadataSets, as the latter is a //MaintainableArtefact//.
141 141  
142 -//MaintainableArtefact//.
143 -
144 144  A MetadataSet comprises a set of //MetadataAttributeValue//s and a set of TargetIdentifiableObjects, which must be part of those specified in the relevant Metadataflow or MetadataProvisionAgreement.
145 145  
146 146  The MetadataStructureDefinition specifies which MetadataAttributes are expected as //MetadataAttributeValue//s. The TargetIdentifiableObjects point to the //IdentifiableArtefact//s for which the //MetadataAttributeValue//s are reported.
... ... @@ -157,68 +157,51 @@
157 157  
158 158  ==== 7.4.2.2 Definitions ====
159 159  
160 -|**Class**|**Feature**|**Description**
161 -|MetadataSet||Any organised collection of metadata.
162 -||reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
163 -||reportingEnd|A specific time period in a known system of time periods that identifies the end period of a report.
164 -||publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
165 -||publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
166 -||action|Defines the action to be taken by the recipient system (information, append, replace, delete)
167 -||+describedBy|Associates a Metadataflow or a Metadata Provision Agreement to the Metadata Set.
168 -
169 -:
170 -
171 -(((
172 -|**Class**|**Feature**|**Description**
173 -||+structuredBy|(((
174 -Associates the Metadata
175 -
176 -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)
177 -
178 -Metadataflow or the Metadata Provision Agreement.
158 +(% style="width:912.294px" %)
159 +|**Class**|**Feature**|(% style="width:483px" %)**Description**
160 +|MetadataSet| |(% style="width:483px" %)Any organised collection of metadata.
161 +| |reportingBegin|(% style="width:483px" %)A specific time period in a known system of time periods that identifies the start period of a report.
162 +| |reportingEnd|(% style="width:483px" %)A specific time period in a known system of time periods that identifies the end period of a report.
163 +| |publicationYear|(% style="width:483px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
164 +| |publicationPeriod|(% style="width:483px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
165 +| |action|(% style="width:483px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
166 +| |+describedBy|(% style="width:483px" %)Associates a Metadataflow or a Metadata Provision Agreement to the Metadata Set.
167 +| |+structuredBy|(% style="width:482px" %)(((
168 +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.
179 179  )))
180 -||+publishedBy|Associates the Data Provider that reports/publishes the metadata.
181 -||+attachesTo|Associates the target identifiable objects to which metadata is to be attached.
182 -||+metadata|Associates the Metadata Attribute values which are to be associated with the object or objects identified by the Target Identifiable Objects(s).
183 -|TargetIdentifiableO bject||Specifies the identification of an Identifiable object.
184 -||+valueFor|(((
185 -Associates the Target
186 -
187 -Identifiable Object being a part of the Identifiable Object Selection specified in the Dataflow or Metadata Provision Agreement.
170 +|(% style="width:188px" %) |(% style="width:241px" %)+publishedBy|(% style="width:482px" %)Associates the Data Provider that reports/publishes the metadata.
171 +|(% style="width:188px" %) |(% style="width:241px" %)+attachesTo|(% style="width:482px" %)Associates the target identifiable objects to which metadata is to be attached.
172 +|(% style="width:188px" %) |(% style="width:241px" %)+metadata|(% style="width:482px" %)Associates the Metadata Attribute values which are to be associated with the object or objects identified by the Target Identifiable Objects(s).
173 +|(% style="width:188px" %)TargetIdentifiableO bject|(% style="width:241px" %) |(% style="width:482px" %)Specifies the identification of an Identifiable object.
174 +|(% style="width:188px" %) |(% style="width:241px" %)+valueFor|(% style="width:482px" %)(((
175 +Associates the Target Identifiable Object being a part of the Identifiable Object Selection specified in the Dataflow or Metadata Provision Agreement.
188 188  )))
189 -|StructureRef||Contains the identification of an Identifiable object.
190 -||structureType|The object type of the target object.
191 -|IdentifiableArtefac tRef||Identification of the target object.
192 -||+containedObject|Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
193 -|//MetadataAttributeVa lue//|(((
177 +|(% style="width:188px" %)StructureRef|(% style="width:241px" %) |(% style="width:482px" %)Contains the identification of an Identifiable object.
178 +|(% style="width:188px" %) |(% style="width:241px" %)structureType|(% style="width:482px" %)The object type of the target object.
179 +|(% style="width:188px" %)IdentifiableArtefactRef|(% style="width:241px" %) |(% style="width:482px" %)Identification of the target object.
180 +|(% style="width:188px" %) |(% style="width:241px" %)+containedObject|(% style="width:482px" %)Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
181 +|(% style="width:188px" %)//MetadataAttributeValue//|(% style="width:241px" %)(((
194 194  Abstract class Sub classes are:
195 195  
196 -//UncodedMetadataAttrib uteValue//
184 +//UncodedMetadataAttributeValue//
197 197  
198 198  CodedMetadataAttribut eValue
199 -)))|The value for a Metadata Attribute.
200 -||(((
187 +)))|(% style="width:482px" %)The value for a Metadata Attribute.
188 +|(% style="width:188px" %) |(% style="width:241px" %)(((
201 201  +valueFor
202 202  
203 -(inherited from the
204 -
205 -//AttributeValue//)
206 -)))|(((
207 -Association to the Metadata
208 -
209 -Attribute in the Metadata Structure Definition that identifies the Concept and allowed Representation for the Metadata Attribute value.
210 -
191 +(inherited from the //AttributeValue//)
192 +)))|(% style="width:482px" %)(((
193 +Association to the Metadata Attribute in the Metadata Structure Definition that identifies the Concept and allowed Representation for the Metadata Attribute value.
211 211  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.
212 212  )))
213 -||+child|(((
214 -Association to a child Metadata Attribute value consistent with the hierarchy defined in the MSD for the Metadata Attribute
215 -
216 -for which this child is a Metadata Attribute value.
196 +|(% style="width:188px" %) |(% style="width:241px" %)+child|(% style="width:482px" %)(((
197 +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.
217 217  )))
218 -|//UncodedMetadataAttr ibuteValue//|(((
199 +|(% style="width:188px" %)//UncodedMetadataAttributeValue//|(% style="width:241px" %)(((
219 219  Inherits from
220 220  
221 -//MetadataAttributeValu e//
202 +//MetadataAttributeValue//
222 222  
223 223  Sub class:
224 224  
... ... @@ -229,23 +229,21 @@
229 229  OtherUncodedAttribute
230 230  
231 231  Value
232 -)))|The content of a Metadata Attribute value where this is textual.
233 -|XHTMLAttributeValue||This contains XHTML
234 -||value|The string value of the XHTML
235 -|TextAttributeValue||This value of a Metadata Attribute value where the content is human-readable text.
236 -||text|The string value is text. This can be present in multiple language versions.
237 -|OtherUncodedAttribu teValue||The value of a Metadata Attribute value where the content is not of humanreadable text.
238 -||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.
239 -||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).
240 -|CodedMetadataAttrib uteValue|(((
213 +)))|(% style="width:482px" %)The content of a Metadata Attribute value where this is textual.
214 +|(% style="width:188px" %)XHTMLAttributeValue|(% style="width:241px" %) |(% style="width:482px" %)This contains XHTML
215 +|(% style="width:188px" %) |(% style="width:241px" %)value|(% style="width:482px" %)The string value of the XHTML
216 +|(% style="width:188px" %)TextAttributeValue|(% style="width:241px" %) |(% style="width:482px" %)This value of a Metadata Attribute value where the content is human-readable text.
217 +|(% style="width:188px" %) |(% style="width:241px" %)text|(% style="width:482px" %)The string value is text. This can be present in multiple language versions.
218 +|(% style="width:188px" %)OtherUncodedAttributeValue|(% style="width:241px" %) |(% style="width:482px" %)The value of a Metadata Attribute value where the content is not of humanreadable text.
219 +|(% style="width:188px" %) |(% style="width:241px" %)value|(% style="width:482px" %)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.
220 +|(% style="width:188px" %) |(% style="width:241px" %)startTime|(% style="width:482px" %)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).
221 +|(% style="width:188px" %)CodedMetadataAttributeValue|(% style="width:241px" %)(((
241 241  Inherits from
242 242  
243 -//MetadataAttributeValu e//
244 -)))|The content of a Metadata Attribute value that is taken from a Code in a Code list.
245 -||value|The Code value of the Metadata Attribute value.
246 -||+value|(((
224 +//MetadataAttributeValue//
225 +)))|(% style="width:482px" %)The content of a Metadata Attribute value that is taken from a Code in a Code list.
226 +|(% style="width:188px" %) |(% style="width:241px" %)value|(% style="width:482px" %)The Code value of the Metadata Attribute value.
227 +|(% style="width:188px" %) |(% style="width:241px" %)+value|(% style="width:482px" %)(((
247 247  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.
248 -
249 249  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.
250 250  )))
251 -)))
SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_79dd798f.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +145.6 KB
Content