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

From version 5.5
edited by Helena
on 2025/05/15 10:44
Change comment: There is no comment for this version
To version 5.1
edited by Helena
on 2025/05/15 09:59
Change comment: There is no comment for this version

Summary

Details

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