Skip to Content

Wiki source code of 13 Data Provisioning

Version 10.1 by Artur on 2025/05/22 14:46
Hide last authors
Helena 4.2 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Helena 2.1 4
5 == 13.1 Class Diagram ==
6
7 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_23ca059c.gif||alt="Shape32" height="753" width="617"]]
8
9 **Figure 44: Relationship and inheritance class diagram of data/metadata provisioning**
10
11 == 13.2 Explanation of the Diagram ==
12
13 === 13.2.1 Narrative ===
14
Helena 7.1 15 This sub model links many [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] in the [[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]] and is pivotal to an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metadata registry, as all of the [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] in this sub model must be accessible to an application that is responsible for data and metadata registration or for an application that requires access to the data or metadata.
Helena 2.1 16
Helena 7.1 17 Whilst a registry contains all of the metadata depicted on the diagram above, the classes in the grey shaded area are specific to a registry-based scenario where [[data sources>>doc:xwiki:Glossary.Data source.WebHome]] (either physical data and [[metadata sets>>doc:xwiki:Glossary.Metadata set.WebHome]] or databases and [[metadata repositories>>doc:xwiki:Glossary.Metadata repository.WebHome]]) are registered. More details on how these classes are used in a registry scenario can be found in the [[SDMX Registry>>doc:xwiki:Glossary.SDMX Registry.WebHome]] Interface document. (Section 5 of the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Standards).
Helena 2.1 18
Helena 7.1 19 A ProvisionAgreement / MetadataProvisionAgreement links the [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] that defines how data / metadata are structured and classified (//StructureUsage//) to the DataProvider / MetadataProvider. By means of a data or metadata registration, it references the //Datasource// (this can be data or metadata), whether this be an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] conformant file on a website (SimpleDatasource) or a database service capable of supporting an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] query and responding with an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] conformant document (//QueryDatasource//).
Helena 2.1 20
Helena 7.1 21 The //StructureUsage//, which has concrete classes of [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] identifies the corresponding DataStructureDefinition or MetadataStructureDefinition, and, via Categorisation, can link to one or more Category(s) in a CategoryScheme such as a subject matter domain scheme, by which the //StructureUsage// can be classified. This can assist in drilling down from subject matter domains to find the data or metadata that may be relevant.
Helena 2.1 22
Artur 10.1 23 The SimpleDatasource links to the actual [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]] or MetadataSet on a website (this is shown on the diagram as a dependency called “references”). The sourceURL is obtained during the registration process of the [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]] or the MetadataSet. Additional information about the content of the SimpleDatasource is stored in the registry in terms of a (% style="color:#e74c3c" %)//Constraint//(%%) (see 12.3) for the Registration.
Helena 2.1 24
Helena 7.1 25 The //QueryDatasource// is an abstract class that represents a [[data source>>doc:xwiki:Glossary.Data source.WebHome]], which can understand an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] RESTful query (RESTDatasource) and respond appropriately. Each of these different //Datasource//s inherit the dataURL from //Datasource//, and the //QueryDatasource// has an additional URL, the specURL, to locate the specification of the service (i.e., the open API specification for RESTDatasource), which describes how to access it. All other supported protocols are assumed to use the SimpleDatasource URL.
Helena 2.1 26
Helena 7.1 27 The diagram below shows in schematic way the essential navigation through the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] that eventually link to a data or metadata registration{{footnote}}Provider Scheme, Provider, Provision Agreement and Registered source refer both to data and reference metadata.{{/footnote}}.
Helena 2.1 28
29 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_39d2fe45.jpg||height="360" width="592"]]
30
31 **Figure 45: Schematic of the linking of structural metadata to data and metadata registration**
32
33 === 13.2.2 Definitions ===
34
Helena 5.1 35 (% style="width:965.294px" %)
36 |**Class**|(% style="width:232px" %)**Feature**|(% style="width:508px" %)**Description**
37 |//StructureUsage//|(% style="width:232px" %)(((
Helena 2.1 38 Abstract class:
39 Sub classes are:
40 Dataflow
41 Metadataflow
Helena 5.1 42 )))|(% style="width:508px" %)This is described in the Base.
Helena 7.1 43 | |(% style="width:232px" %)controlledBy|(% style="width:508px" %)Association to the [[Provision Agreements>>doc:xwiki:Glossary.Provision agreement.WebHome]] that comprise the metadata related to the provision of data.
Helena 5.1 44 |DataProvider|(% style="width:232px" %) |(% style="width:508px" %)See Organisation Scheme.
Helena 7.1 45 | |(% style="width:232px" %)hasAgreement|(% style="width:508px" %)Association to the [[Provision Agreements>>doc:xwiki:Glossary.Provision agreement.WebHome]] for which the provider supplies data or metadata.
46 | |(% style="width:232px" %)+source|(% style="width:508px" %)Association to a [[data source>>doc:xwiki:Glossary.Data source.WebHome]], which can process a data query.
Helena 5.1 47 |MetadataProvider|(% style="width:232px" %) |(% style="width:508px" %)See Organisation Scheme.
Helena 7.1 48 | |(% style="width:232px" %)hasAgreement|(% style="width:508px" %)Association to the Metadata [[Provision Agreements>>doc:xwiki:Glossary.Provision agreement.WebHome]] for which the provider supplies data or metadata.
Helena 5.1 49 | |(% style="width:232px" %)+source|(% style="width:508px" %)Association to a metadata source, which can process a metadata query.
Helena 7.1 50 |ProvisionAgreement|(% style="width:232px" %) |(% style="width:508px" %)Links the [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]] to the relevant Structure Usage (i.e., the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]) for which the provider supplies data. The agreement may constrain the scope of the data that can be provided, by means of a DataConstraint.
51 | |(% style="width:232px" %)+source|(% style="width:508px" %)Association to a [[data source>>doc:xwiki:Glossary.Data source.WebHome]], which can process a data query.
52 |MetadataProvisionAgreement|(% style="width:232px" %) |(% style="width:508px" %)Links the Metadata Provider to the relevant Structure Usage (i.e., the [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]]) for which the provider supplies metadata. The agreement may constrain the scope of the metadata that can be provided, by means of a MetadataConstraint.
53 | |(% style="width:232px" %)+source|(% style="width:508px" %)Association to [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] source, which can process a metadata query.
Helena 5.1 54 |//Datasource//|(% style="width:232px" %)(((
Helena 2.1 55 Abstract class
56 Sub classes are: SimpleDatasource //QueryDatasource//
Helena 7.1 57 )))|(% style="width:508px" %)Identification of the location or service from where data or [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] can be obtained.
58 | |(% style="width:232px" %)+sourceURL|(% style="width:508px" %)The URL of the data or [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] source (a file or a web service).
59 |SimpleDatasource|(% style="width:232px" %) |(% style="width:508px" %)An [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] dataset / metadataset accessible as a file at a URL.
Helena 5.1 60 |//QueryDatasource//|(% style="width:232px" %)(((
Helena 2.1 61 Abstract class Inherits from:
62 //Datasource//
63 Sub classes are:
Helena 5.1 64 RESTDatasource
Helena 7.1 65 )))|(% style="width:508px" %)A data or [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] source, which can process a data or metadata query.
66 |RESTDatasource|(% style="width:232px" %) |(% style="width:508px" %)A data or [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] source that is accessible via a RESTful web services interface.
Helena 5.1 67 | |(% style="width:232px" %)+specificationURL|(% style="width:508px" %)Association to the URL for the specification of the web service.
Helena 7.1 68 |Registration|(% style="width:232px" %) |(% style="width:508px" %)This is not detailed here but is shown as the link between the [[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]] and the Registry Service API. It denotes a data or metadata registration document.
Helena 2.1 69
Helena 5.1 70 ----
71
72 {{putFootnotes/}}