Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 7.1
edited by Helena
on 2025/05/22 11:39
Change comment: There is no comment for this version
To version 5.4
edited by Helena
on 2025/05/22 11:23
Change comment: There is no comment for this version

Summary

Details

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