Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 5.5
edited by Helena
on 2025/05/22 11:25
Change comment: There is no comment for this version
To version 9.1
edited by Helena
on 2025/05/22 13:51
Change comment: There is no comment for this version

Summary

Details

Page properties
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 ===
... ... @@ -214,10 +214,8 @@
214 214  
215 215  * XHTMLAttributeValue – the content is XHTML
216 216  * TextAttributeValue – the content is textual and may contain the text in multiple languages
217 -* 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
218 218  
219 -MetadataStructureDefinition for the relevant ReportStructure
220 -
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,130 +224,106 @@
224 224  
225 225  ==== 7.4.2.2 Definitions ====
226 226  
227 -|**Class**|**Feature**|**Description**
228 -|MetadataSet| |Any organised collection of metadata.
229 -| |reportingBegin|A specific time period in a known system of time periods that identifies the start period of a report.
230 -| |reportingEnd|A specific time period in a known system of time periods that identifies the ebd period of a report.
231 -| |dataExtractionDate|A specific time period that identifies the date and time that the data are extracted from a data source.
232 -| |validFrom|Indicates the inclusive start time indicating the validity of the information in the data set.
233 -| |validTo|Indicates the inclusive end time indicating the validity of the information in the metadata set.
234 -| |publicationYear|Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
235 -| |publicationPeriod|Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
236 -| |setId|Provides an identification of the metadata set.
237 -| |action|Defines the action to be taken by the recipient system (update, replace, delete)
238 -| |+describedBy|Associates a Metadataflow Definition to the Metadata Set.
239 -| |+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.
240 -| |+publishedBy|Associates the Data Provider that reports/publishes the metadata.
241 -| |+describedBy|Reference to the Report Structure.
242 -|MetadataReport| |A set of values for Metadata Attributes defined in a Report Structure of a Metadata Structure Definition.
243 -| |+attachesTo|Associates the object key to which metadata is to be attached.
244 -| |+target|Associates the Metadata Target that defines the target object to which the metadata are to be associated.
245 -| |+metadata|Associates the Reported Attribute values which are to be associated with the object or objects identified by the Target Object Key.
246 -|TargetObjectKey| |Identifies the key of the object to which the metadata are to be attached.
247 -| |+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" %)(((
248 248  Associates the Metadata Target that identifies the object type and the component structure of the Target Object Key.
249 249  
250 250  Note that this is a conceptual association showing the link to the MSD construct.
251 251  )))
252 -| |+keyValues|Associates the Target Object Values of the Target Object Key.
253 -|//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" %)(((
254 254  Abstract class
255 -
256 256  Sub classes are
257 -
258 258  TargetDataKey
259 -
260 -TargetIdentifiableObject TargetDataSet
261 -
258 +TargetIdentifiableObject
259 +TargetDataSet
262 262  TargetReportPeriod
263 -)))|The key of an individual object of the type specified in the Metadata Target of the Metadata Structure Definition.
264 -| |+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" %)(((
265 265  Associates the Target Object for which this value is provided.
266 266  
267 267  Note that this is a conceptual association showing the link to the MSD construct.
268 268  )))
269 -|TargetDataKey|(((
267 +|(% style="width:166px" %)TargetDataKey|(% style="width:227px" %)(((
270 270  Inherits from
271 -
272 272  //TargetObjectValue//
273 -)))|The identification of the components and the values that form the data or metadata key.
274 -|ComponentValue| |Collectively contain the identification of the components and the values that form the data key.
275 -|value| |The key value.
276 -| |+valueFor|Associates the Component for which the value is declared.
277 -|TimeDimensionValue| |Contains identification of the Time Dimension and the value.
278 -|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" %)(((
279 279  Inherits from
280 -
281 -//TargetObjectValue    //
282 -)))|Specifies the identification of an Identifiable object.
283 -|StructureRef| |Contains the identification of an Identifiable object.
284 -| |structureType|The object type of the target object.
285 -|(((
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" %)(((
286 286  Maintainable
287 -
288 288  ArtefactRef
289 -
290 290  Identifiable
291 -
292 292  ArtefactRef
293 -)))| |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.
294 -| |+containedObject|Association to a contained object in a hierarchy of Identifiable Objects such as a Transition in a Process Step.
295 -|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" %)(((
296 296  Inherits from
297 -
298 298  //TargetObjectValue//
299 -)))|Contains the identification of a Data Set
300 -|TargetReportPeriod|(((
291 +)))|(% style="width:716px" %)Contains the identification of a Data Set
292 +|(% style="width:166px" %)TargetReportPeriod|(% style="width:227px" %)(((
301 301  Inherits from
302 -
303 303  //TargetObjectValue//
304 -)))|Contains the period covered by the Metadata Report.
305 -|//ReportedAttribute//|(((
295 +)))|(% style="width:716px" %)Contains the period covered by the Metadata Report.
296 +|(% style="width:166px" %)//ReportedAttribute//|(% style="width:227px" %)(((
306 306  Abstract class Sub classes are:
307 -
308 308  //NonEnumeratedAttributeValue//
309 -
310 -EnumeratedAttributeValue//    //
311 -)))|The value for a Metadata Attribute.
312 -| |+valueFor|(((
299 +EnumeratedAttributeValue
300 +)))|(% style="width:716px" %)The value for a Metadata Attribute.
301 +|(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
313 313  Association to the Metadata Attribute in the Metadata Structure Definition that identifies the Concept and allowed Representation for the Reported Attribute.
314 -
315 315  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.
316 316  )))
317 -| |+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.
318 -|//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" %)(((
319 319  Inherits from
320 -
321 321  //ReportedAttribute//
322 -
323 323  Sub class:
324 -
325 -//XHTMLAttributeValue//
326 -
327 -//TextAttributeValue//
328 -
329 -//OtherNonEnumerated//
330 -
331 -//AttributeValue//
332 -)))|The content of a Reported Attribute where this is textual.
333 -|XHTMLAttributeValue| |This contains XHTML.
334 -| |value|The string value of the XHTML.
335 -|TextAttributeValue| |This value of a Reported Attribute where the content is humanreadable text.
336 -| |text|The string value is text. This can be present in multiple language versions.
337 -|OtherNonEnumerated AttributeValue| |The value of a Reported Attribute where the content is not of humanreadable text.
338 -| |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.
339 -|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" %)(((
340 340  Inherits from
341 -
342 342  //MetadataAttributeValue//
343 -)))|The content of a Reported Attribute that is taken from a Code in a Code list.
344 -| |value|The Code value of the Reported Attribute.
345 -| |+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" %)(((
346 346  Association to a Code in the Code list specified in the Representation of the Metadata Attribute for which this Reported Attribute is the value
347 -
348 348  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.
349 349  )))
350 -
351 -
352 -
353 -
1747903167692-628.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +59.7 KB
Content