Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 5.2
edited by Helena
on 2025/05/22 11:22
Change comment: There is no comment for this version
To version 10.1
edited by Artur
on 2025/05/22 14:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.helena
1 +xwiki:XWiki.arturkryazhev
Content
... ... @@ -29,6 +29,8 @@
29 29  
30 30  === {{id name="_Toc371027"/}}7.2.2 Class Diagram - Inheritance ===
31 31  
32 +[[image:1747903167692-628.png]]
33 +
32 32  **Figure 27: Inheritance class diagram of the Metadata Structure Definition**
33 33  
34 34  === {{id name="_Toc371028"/}}7.2.3 Explanation of the Diagram ===
... ... @@ -182,16 +182,16 @@
182 182  
183 183  === {{id name="_Toc371035"/}}7.4.1 Class Diagram ===
184 184  
187 +[[image:1747902223404-649.png]]
188 +
185 185  **Figure 29: Relationship Class Diagram of the Metadata Set**
186 186  
187 187  === {{id name="_Toc371036"/}}7.4.2 Explanation of the Diagram ===
188 188  
189 -**7.4.2.1 Narrative**
193 +==== 7.4.2.1 Narrative ====
190 190  
191 -Note that the MetadataSet must conform to the MetadataStructureDefinition associated to the MetadataflowDefinition 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
195 +Note that the MetadataSet must conform to the MetadataStructureDefinition associated to the MetadataflowDefinition 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 the ReportStructure, and optionally a MetadataflowDefinition, but the MetadataStructureDefinition is not necessarily exchanged with the metadata. Therefore, the MetadataStructureDefinition classes are shown in the grey areas, as these are not a part of the MetadataSet itself.
192 192  
193 -MetadataStructureDefinition. In the actual MetadataSet as exchanged there must, of course, be a reference to the MetadataStructureDefinition and the ReportStructure, and optionally a MetadataflowDefinition, but the MetadataStructureDefinition is not necessarily exchanged with the metadata. Therefore, the MetadataStructureDefinition classes are shown in the grey areas, as these are not a part of the MetadataSet itself.
194 -
195 195  An organisation playing the role of DataProvider can be responsible for one or more MetadataSet.
196 196  
197 197  A MetadataSet comprises one or more MetadataReport, each of which must be for the same ReportStructure. It references both a MetadataTarget, defined in the MetadataStructureDefinition, and contains a TargetObjectKey and ReportedAttributes.
... ... @@ -202,21 +202,20 @@
202 202  
203 203  * TargetDataKey – this can contain:
204 204  ** a SeriesKey (set of dimension values)
205 -** a SeriesKey plus a value or values (giving time range) for the
207 +** a SeriesKey plus a value or values (giving time range) for the TimeDimension (TimeDimensionValue)
208 +** a value of values for the TimeDimension
209 +* TargetIdentifiableObject – this identifies any identifiable object (which includes both Maintainable and Identifiable objects
210 +* TargetDataSet – this identifies a DataSet
211 +* TargetReportPeriod – this specifies the report period for the Report
206 206  
207 -TimeDimension (TimeDimensionValue) o a value of values for the TimeDimension
213 +A simple text value for the //ReportedAttribute// uses the //NonEnumeratedAttributeValue //sub class of //ReportedAttribute// whilst a coded value uses the EnumeratedAttributeValue sub class.
208 208  
209 -* TargetIdentifiableObject -this identifies any identifiable object (which includes both Maintainable and Identifiable objects  TargetDataSet – this identifies a DataSet
210 -* TargetReportPeriod – this specifies the report period for the Report A simple text value for the //ReportedAttribute// uses the //NonEnumeratedAttributeValue  //sub class of //ReportedAttribute// whilst a coded value uses the EnumeratedAttributeValue sub class.
211 -
212 212  The //NonEnumeratedAttributeValue// can be one of:
213 213  
214 214  * XHTMLAttributeValue – the content is XHTML
215 215  * TextAttributeValue – the content is textual and may contain the text in multiple languages
216 -* OtherNonEnumeratedAttributeValue – the content is a string value that must conform to the Representation specified for the MetadataAttribute in the
219 +* OtherNonEnumeratedAttributeValue – the content is a string value that must conform to the Representation specified for the MetadataAttribute in the MetadataStructureDefinition for the relevant ReportStructure
217 217  
218 -MetadataStructureDefinition for the relevant ReportStructure
219 -
220 220  The EnumeratedAttributeValue contains a value for a Code specified as the
221 221  
222 222  Representation for the MetadataAttribute in the MetadataStructureDefinition for the relevant ReportStructure.
... ... @@ -223,130 +223,106 @@
223 223  
224 224  ==== 7.4.2.2 Definitions ====
225 225  
226 -|**Class**|**Feature**|**Description**
227 -|MetadataSet| |Any organised collection of metadata.
228 -| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
229 -| |reportingEnd|A specific time period in a known system of time periods that identifies the ebd period of a report.
230 -| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
231 -| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
232 -| |validTo|Indicates the inclusive end time indicating the validity of the information in the metadata set.
233 -| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
234 -| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
235 -| |setId|Provides an identification of the metadata set.
236 -| |action|Defines the action to be taken by the recipient system (update, replace, delete)
237 -| |+describedBy|Associates a Metadataflow Definition to the Metadata Set.
238 -| |+structuredBy|Associates the Metadata Structure Definition that defines the structure of the Metadata Set. Note that the Metadata Structure Definition is the same as that associated (nonmandatory) to the Metadataflow Definition.
239 -| |+publishedBy|Associates the Data Provider that reports/publishes the metadata.
240 -| |+describedBy|Reference to the Report Structure.
241 -|MetadataReport| |A set of values for Metadata Attributes defined in a Report Structure of a Metadata Structure Definition.
242 -| |+attachesTo|Associates the object key to which metadata is to be attached.
243 -| |+target|Associates the Metadata Target that defines the target object to which the metadata are to be associated.
244 -| |+metadata|Associates the Reported Attribute values which are to be associated with the object or objects identified by the Target Object Key.
245 -|TargetObjectKey| |Identifies the key of the object to which the metadata are to be attached.
246 -| |+valueFor|(((
227 +(% style="width:1118.29px" %)
228 +|(% style="width:166px" %)**Class**|(% style="width:227px" %)**Feature**|(% style="width:716px" %)**Description**
229 +|(% style="width:166px" %)MetadataSet|(% style="width:227px" %) |(% style="width:716px" %)Any organised collection of metadata.
230 +|(% style="width:166px" %) |(% style="width:227px" %)reportingBegin|(% style="width:716px" %)A specific time period in a known system of time periods that identifies the start period of a report.
231 +|(% style="width:166px" %) |(% style="width:227px" %)reportingEnd|(% style="width:716px" %)A specific time period in a known system of time periods that identifies the ebd period of a report.
232 +|(% style="width:166px" %) |(% style="width:227px" %)dataExtractionDate|(% style="width:716px" %)A specific time period that identifies the date and time that the data are extracted from a data source.
233 +|(% style="width:166px" %) |(% style="width:227px" %)validFrom|(% style="width:716px" %)Indicates the inclusive start time indicating the validity of the information in the data set.
234 +|(% style="width:166px" %) |(% style="width:227px" %)validTo|(% style="width:716px" %)Indicates the inclusive end time indicating the validity of the information in the metadata set.
235 +|(% style="width:166px" %) |(% style="width:227px" %)publicationYear|(% style="width:716px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
236 +|(% style="width:166px" %) |(% style="width:227px" %)publicationPeriod|(% style="width:716px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
237 +|(% style="width:166px" %) |(% style="width:227px" %)setId|(% style="width:716px" %)Provides an identification of the metadata set.
238 +|(% style="width:166px" %) |(% style="width:227px" %)action|(% style="width:716px" %)Defines the action to be taken by the recipient system (update, replace, delete)
239 +|(% style="width:166px" %) |(% style="width:227px" %)+describedBy|(% style="width:716px" %)Associates a Metadataflow Definition to the Metadata Set.
240 +|(% style="width:166px" %) |(% style="width:227px" %)+structuredBy|(% style="width:716px" %)Associates the Metadata Structure Definition that defines the structure of the Metadata Set. Note that the Metadata Structure Definition is the same as that associated (nonmandatory) to the Metadataflow Definition.
241 +|(% style="width:166px" %) |(% style="width:227px" %)+publishedBy|(% style="width:716px" %)Associates the Data Provider that reports/publishes the metadata.
242 +|(% style="width:166px" %) |(% style="width:227px" %)+describedBy|(% style="width:716px" %)Reference to the Report Structure.
243 +|(% style="width:166px" %)MetadataReport|(% style="width:227px" %) |(% style="width:716px" %)A set of values for Metadata Attributes defined in a Report Structure of a Metadata Structure Definition.
244 +|(% style="width:166px" %) |(% style="width:227px" %)+attachesTo|(% style="width:716px" %)Associates the object key to which metadata is to be attached.
245 +|(% style="width:166px" %) |(% style="width:227px" %)+target|(% style="width:716px" %)Associates the Metadata Target that defines the target object to which the metadata are to be associated.
246 +|(% style="width:166px" %) |(% style="width:227px" %)+metadata|(% style="width:716px" %)Associates the Reported Attribute values which are to be associated with the object or objects identified by the Target Object Key.
247 +|(% style="width:166px" %)TargetObjectKey|(% style="width:227px" %) |(% style="width:716px" %)Identifies the key of the object to which the metadata are to be attached.
248 +|(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
247 247  Associates the Metadata Target that identifies the object type and the component structure of the Target Object Key.
248 248  
249 249  Note that this is a conceptual association showing the link to the MSD construct.
250 250  )))
251 -| |+keyValues|Associates the Target Object Values of the Target Object Key.
252 -|//TargetObjectValue//|(((
253 +|(% style="width:166px" %) |(% style="width:227px" %)+keyValues|(% style="width:716px" %)Associates the Target Object Values of the Target Object Key.
254 +|(% style="width:166px" %)//TargetObjectValue//|(% style="width:227px" %)(((
253 253  Abstract class
254 -
255 255  Sub classes are
256 -
257 257  TargetDataKey
258 -
259 -TargetIdentifiableObject TargetDataSet
260 -
258 +TargetIdentifiableObject
259 +TargetDataSet
261 261  TargetReportPeriod
262 -)))|The key of an individual object of the type specified in the Metadata Target of the Metadata Structure Definition.
263 -| |+valueFor|(((
261 +)))|(% style="width:716px" %)The key of an individual object of the type specified in the Metadata Target of the Metadata Structure Definition.
262 +|(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
264 264  Associates the Target Object for which this value is provided.
265 265  
266 266  Note that this is a conceptual association showing the link to the MSD construct.
267 267  )))
268 -|TargetDataKey|(((
267 +|(% style="width:166px" %)TargetDataKey|(% style="width:227px" %)(((
269 269  Inherits from
270 -
271 271  //TargetObjectValue//
272 -)))|The identification of the components and the values that form the data or metadata key.
273 -|ComponentValue| |Collectively contain the identification of the components and the values that form the data key.
274 -|value| |The key value.
275 -| |+valueFor|Associates the Component for which the value is declared.
276 -|TimeDimensionValue| |Contains identification of the Time Dimension and the value.
277 -|TargetIdentifiable Object|(((
270 +)))|(% style="width:716px" %)The identification of the components and the values that form the data or metadata key.
271 +|(% style="width:166px" %)ComponentValue|(% style="width:227px" %) |(% style="width:716px" %)Collectively contain the identification of the components and the values that form the data key.
272 +|(% style="width:166px" %)value|(% style="width:227px" %) |(% style="width:716px" %)The key value.
273 +|(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)Associates the Component for which the value is declared.
274 +|(% style="width:166px" %)TimeDimensionValue|(% style="width:227px" %) |(% style="width:716px" %)Contains identification of the Time Dimension and the value.
275 +|(% style="width:166px" %)TargetIdentifiable Object|(% style="width:227px" %)(((
278 278  Inherits from
279 -
280 -//TargetObjectValue    //
281 -)))|Specifies the identification of an Identifiable object.
282 -|StructureRef| |Contains the identification of an Identifiable object.
283 -| |structureType|The object type of the target object.
284 -|(((
277 +//TargetObjectValue//
278 +)))|(% style="width:716px" %)Specifies the identification of an Identifiable object.
279 +|(% style="width:166px" %)StructureRef|(% style="width:227px" %) |(% style="width:716px" %)Contains the identification of an Identifiable object.
280 +|(% style="width:166px" %) |(% style="width:227px" %)structureType|(% style="width:716px" %)The object type of the target object.
281 +|(% style="width:166px" %)(((
285 285  Maintainable
286 -
287 287  ArtefactRef
288 -
289 289  Identifiable
290 -
291 291  ArtefactRef
292 -)))| |Identification of the target object by means of its identifier constructs i.e agency ID, id, version for Maintainable Object plus, for Identifiable Object, the id.
293 -| |+containedObject|Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
294 -|TargetDataSet|(((
286 +)))|(% style="width:227px" %) |(% style="width:716px" %)Identification of the target object by means of its identifier constructs i.e agency ID, id, version for Maintainable Object plus, for Identifiable Object, the id.
287 +|(% style="width:166px" %) |(% style="width:227px" %)+containedObject|(% style="width:716px" %)Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
288 +|(% style="width:166px" %)TargetDataSet|(% style="width:227px" %)(((
295 295  Inherits from
296 -
297 297  //TargetObjectValue//
298 -)))|Contains the identification of a Data Set
299 -|TargetReportPeriod|(((
291 +)))|(% style="width:716px" %)Contains the identification of a Data Set
292 +|(% style="width:166px" %)TargetReportPeriod|(% style="width:227px" %)(((
300 300  Inherits from
301 -
302 302  //TargetObjectValue//
303 -)))|Contains the period covered by the Metadata Report.
304 -|//ReportedAttribute//|(((
295 +)))|(% style="width:716px" %)Contains the period covered by the Metadata Report.
296 +|(% style="width:166px" %)//ReportedAttribute//|(% style="width:227px" %)(((
305 305  Abstract class Sub classes are:
306 -
307 307  //NonEnumeratedAttributeValue//
308 -
309 -EnumeratedAttributeValue//    //
310 -)))|The value for a Metadata Attribute.
311 -| |+valueFor|(((
299 +EnumeratedAttributeValue
300 +)))|(% style="width:716px" %)The value for a Metadata Attribute.
301 +|(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
312 312  Association to the Metadata Attribute in the Metadata Structure Definition that identifies the Concept and allowed Representation for the Reported Attribute.
313 -
314 314  Note that this is a conceptual association showing the link to the MSD construct. The syntax for the Reported Attribute will state, in some form, the id of the Metadata Attribute.
315 315  )))
316 -| |+child|Association to a child Reported Attribute consistent with the hierarchy defined in the Report Structure for the Metadata Attribute for which this child is a Reported Attribute.
317 -|//NonEnumerated AttributeValue//|(((
305 +|(% style="width:166px" %) |(% style="width:227px" %)+child|(% style="width:716px" %)Association to a child Reported Attribute consistent with the hierarchy defined in the Report Structure for the Metadata Attribute for which this child is a Reported Attribute.
306 +|(% style="width:166px" %)//NonEnumerated AttributeValue//|(% style="width:227px" %)(((
318 318  Inherits from
319 -
320 320  //ReportedAttribute//
321 -
322 322  Sub class:
323 -
324 -//XHTMLAttributeValue//
325 -
326 -//TextAttributeValue//
327 -
328 -//OtherNonEnumerated//
329 -
330 -//AttributeValue//
331 -)))|The content of a Reported Attribute where this is textual.
332 -|XHTMLAttributeValue| |This contains XHTML.
333 -| |value|The string value of the XHTML.
334 -|TextAttributeValue| |This value of a Reported Attribute where the content is humanreadable text.
335 -| |text|The string value is text. This can be present in multiple language versions.
336 -|OtherNonEnumerated AttributeValue| |The value of a Reported Attribute where the content is not of humanreadable text.
337 -| |value|A text string that is consistent in format to that defined in the Representation of the Metadata Attribute for which this is a Reported Attribute.
338 -|EnumeratedAttribute Value|(((
310 +//XHTMLAttributeValue
311 +TextAttributeValue
312 +OtherNonEnumerated
313 +AttributeValue//
314 +)))|(% style="width:716px" %)The content of a Reported Attribute where this is textual.
315 +|(% style="width:166px" %)XHTMLAttributeValue|(% style="width:227px" %) |(% style="width:716px" %)This contains XHTML.
316 +|(% style="width:166px" %) |(% style="width:227px" %)value|(% style="width:716px" %)The string value of the XHTML.
317 +|(% style="width:166px" %)TextAttributeValue|(% style="width:227px" %) |(% style="width:716px" %)This value of a Reported Attribute where the content is humanreadable text.
318 +|(% style="width:166px" %) |(% style="width:227px" %)text|(% style="width:716px" %)The string value is text. This can be present in multiple language versions.
319 +|(% style="width:166px" %)OtherNonEnumerated AttributeValue|(% style="width:227px" %) |(% style="width:716px" %)The value of a Reported Attribute where the content is not of humanreadable text.
320 +|(% style="width:166px" %) |(% style="width:227px" %)value|(% style="width:716px" %)A text string that is consistent in format to that defined in the Representation of the Metadata Attribute for which this is a Reported Attribute.
321 +|(% style="width:166px" %)EnumeratedAttribute Value|(% style="width:227px" %)(((
339 339  Inherits from
340 -
341 341  //MetadataAttributeValue//
342 -)))|The content of a Reported Attribute that is taken from a Code in a Code list.
343 -| |value|The Code value of the Reported Attribute.
344 -| |+value|(((
324 +)))|(% style="width:716px" %)The content of a Reported Attribute that is taken from a Code in a Code list.
325 +|(% style="width:166px" %) |(% style="width:227px" %)value|(% style="width:716px" %)The Code value of the Reported Attribute.
326 +|(% style="width:166px" %) |(% style="width:227px" %)+value|(% style="width:716px" %)(((
345 345  Association to a Code in the Code list specified in the Representation of the Metadata Attribute for which this Reported Attribute is the value
346 -
347 347  Note that this shows the conceptual link to the Item that is the value. In reality, the value itself will be contained in the Enumerated Attribute Value.
348 348  )))
349 -
350 -
351 -
352 -
1747902223404-649.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +115.9 KB
Content
1747903167692-628.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +59.7 KB
Content