Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 5.6
edited by Helena
on 2025/05/22 11:26
Change comment: There is no comment for this version
To version 13.1
edited by Artur
on 2025/05/27 15:51
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
... ... @@ -4,31 +4,33 @@
4 4  
5 5  == {{id name="_Toc371024"/}}7.1 Context ==
6 6  
7 -The SDMX metamodel allows metadata:
7 +The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] metamodel allows metadata:
8 8  
9 9  1. To be exchanged without the need to embed it within the object that it is describing.
10 -1. To be stored separately from the object that it describes, yet be linked to it (for example, an organisation has a metadata repository which supports the dissemination of metadata resulting from metadata requests generated by systems or services that have access to the object for which the metadata pertains. This is common in web dissemination where additional metadata is available for viewing (and eventually downloading) by clicking on an “information” icon next to the object to which the metadata is attached).
10 +1. To be stored separately from the object that it describes, yet be linked to it (for example, an organisation has a [[metadata repository>>doc:sdmx:Glossary.Metadata repository.WebHome]] which supports the dissemination of metadata resulting from metadata requests generated by systems or services that have access to the object for which the metadata pertains. This is common in web dissemination where additional metadata is available for viewing (and eventually downloading) by clicking on an “information” icon next to the object to which the metadata is attached).
11 11  1. To be indexed to aid searching (example: a registry service can process a metadata report and extract structural information that allows it to catalogue the metadata in a way that will enable users to query for it).
12 12  1. To be reported according to a defined structure.
13 13  
14 14  In order to achieve this, the following structures are modelled:
15 15  
16 -* metadata structure definition which has the following components:
16 +* [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] which has the following [[components>>doc:sdmx:Glossary.Component.WebHome]]:
17 17  ** the object types to which the metadata are to be associated (attached)
18 -** the components that, together, comprise a unique key of the object type to which the metadata are to be associated
19 -** the reporting structure comprising the metadata attributes that can be attached to the various object types (these attributes can be structured in a hierarchy), together with any constraints that may apply (e.g. association to a code list that contains valid values for the attribute when reported in a metadata set)
20 -* the metadata set, which contains reported metadata
18 +** the [[components>>doc:sdmx:Glossary.Component.WebHome]] that, together, comprise a unique key of the object type to which the metadata are to be associated
19 +** the reporting structure comprising the metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that can be attached to the various object types (these [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be structured in a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]), together with any (% style="color:#e74c3c" %)constraints(%%) that may apply (e.g. association to a [[code list>>doc:sdmx:Glossary.Code list.WebHome]] that contains valid values for the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] when reported in a [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]])
20 +* the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]], which contains reported metadata
21 21  
22 22  == {{id name="_Toc371025"/}}7.2 Inheritance ==
23 23  
24 24  === {{id name="_Toc371026"/}}7.2.1 Introduction ===
25 25  
26 -As with the Data Structure Definition Structure, many of the constructs in this layer of the model inherit from the SDMX Base layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual packages. The diagram below shows the full inheritance tree for the classes concerned with the MetadataStructureDefinition and the MetadataSet.
26 +As with the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] Structure, many of the constructs in this layer of the model inherit from the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual packages. The diagram below shows the full inheritance tree for the classes concerned with the MetadataStructureDefinition and the MetadataSet.
27 27  
28 -There are very few additional classes in the MetadataStructureDefinition package that do not themselves inherit from classes in the SDMX Base. In other words, the SDMX Base gives most of the structure of this sub model both in terms of associations and in terms of attributes. The relationship diagrams shown in this section show clearly when these associations are inherited from the SDMX Base (see the Appendix “A Short Guide to UML in the SDMX Information Model” to see the diagrammatic notation used to depict this). It is important to note that SDMX base structures used for the MetadataStructureDefinition are the same as those used for the DataStructureDefinition and so, even though the usage is slightly different, the underlying way of defining a MetadataStructureDefinition is similar to that used for defining a DataStructureDefinition.
28 +There are very few additional classes in the MetadataStructureDefinition package that do not themselves inherit from classes in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base. In other words, the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base gives most of the structure of this sub model both in terms of associations and in terms of [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. The relationship diagrams shown in this section show clearly when these associations are inherited from the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base (see the Appendix “A Short Guide to UML in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]” to see the diagrammatic notation used to depict this). It is important to note that [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] base structures used for the MetadataStructureDefinition are the same as those used for the DataStructureDefinition and so, even though the usage is slightly different, the underlying way of defining a MetadataStructureDefinition is similar to that used for defining a DataStructureDefinition.
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 ===
... ... @@ -37,19 +37,19 @@
37 37  
38 38  It is important to the understanding of the relationship class diagrams presented in this section to identify the concrete classes that inherit from the abstract classes.
39 39  
40 -The concrete classes in this part of the SDMX metamodel which require to be maintained by Maintenance Agencies all inherit from MaintainableArtefact. These are:
42 +The concrete classes in this part of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require to be maintained by [[Maintenance Agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] all inherit from MaintainableArtefact. These are:
41 41  
42 42  * //StructureUsage// (concrete class is MetadataflowDefinition)
43 43  * //Structure// (concrete class is MetadataStructureDefinition)
44 44  
45 -These classes also inherit the identity and versioning facets of //IdentifiableArtefact, NameableArtefact,// and //VersionableArtefact//.
47 +These classes also inherit the identity and versioning [[facets>>doc:sdmx:Glossary.Facet.WebHome]] of //IdentifiableArtefact, NameableArtefact,// and //VersionableArtefact//.
46 46  
47 -A //Structure// contains several lists of components. The concrete classes which inherit from //ComponentList// and in themselves are sub components of the MetadataStructureDefinition are:
49 +A //Structure// contains several lists of [[components>>doc:sdmx:Glossary.Component.WebHome]]. The concrete classes which inherit from //ComponentList// and in themselves are sub [[components>>doc:sdmx:Glossary.Component.WebHome]] of the MetadataStructureDefinition are:
48 48  
49 49  * MetadataTarget
50 50  * ReportStructure
51 51  
52 -//ComponentList// contains Components. The classes that inherit from //Component// are:
54 +//ComponentList// contains [[Components>>doc:sdmx:Glossary.Component.WebHome]]. The classes that inherit from //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// are:
53 53  
54 54  * Sub Classes of //TargetObject//
55 55  * MetadataAttribute
... ... @@ -80,56 +80,56 @@
80 80  
81 81  ==== 7.3.4.1 Narrative ====
82 82  
83 -In brief a MetadataStructureDefinition (MSD) defines:
85 +In brief a MetadataStructureDefinition ([[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]) defines:
84 84  
85 -* The MetadataTarget which defines the components (//TargetObject//) and their Representation which are valid for this MetadataStructureDefinition, and which are the metadata target object of one or more ReportStructure
86 -* The ReportStructures comprising the MetadataAttributes that can be associated with the object type identified in the referenced MetadataTargets, and hierarchical structure of the attributes
87 +* The MetadataTarget which defines the [[components>>doc:sdmx:Glossary.Component.WebHome]] (//TargetObject//) and their [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] which are valid for this MetadataStructureDefinition, and which are the metadata target object of one or more ReportStructure
88 +* The ReportStructures comprising the MetadataAttributes that can be associated with the object type identified in the referenced MetadataTargets, and hierarchical structure of the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]
87 87  
88 88  The MetadataTarget comprises one or more //TargetObject//s//.// The combination of //TargetObject//s// //identifies a specific object type to which metadata can be attached in a MetadataSet.
89 89  
90 90  The //TargetObject// is one of the following:
91 91  
92 -* DimensionDescriptorValuesTarget - this allows the specification of a full or partial key (as used in a dataset) to be specified in a MetadataSet as the target object
94 +* DimensionDescriptorValuesTarget - this allows the specification of a full or partial key (as used in a [[dataset>>doc:sdmx:Glossary.Data set.WebHome]]) to be specified in a MetadataSet as the target object
93 93  * IdentifiableObjectTarget – this defines a specific object type, which can be any IdentifiableArtefact
94 -* DataSetTarget – this specifies that the target object is a DataSet
96 +* DataSetTarget – this specifies that the target object is a [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]
95 95  * ReportPeriodTarget - this specifies that the report period must be present in the MetadataSet
96 -* ConstraintContentTarget – this specifies that target object is the content of an AttachmentConstraint i.e. the part of the data set or metadata set identified by the content of an AttachmentConstraint
98 +* ConstraintContentTarget – this specifies that target object is the content of an AttachmentConstraint i.e. the part of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] identified by the content of an AttachmentConstraint
97 97  
98 -The valid content of a //TargetObject// when reported in a MetadataSet is defined in the Representation. This can be an enumerated representation (i.e. a reference to one of the sub clases of ItemScheme – these are Codelist, ConceptScheme, //OrganisationScheme,// CategoryScheme, or ReportingTaxonomy) or nonenumerated.
100 +The valid content of a //TargetObject// when reported in a MetadataSet is defined in the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]]. This can be an enumerated [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (i.e. a reference to one of the sub clases of ItemScheme – these are Codelist, ConceptScheme, //OrganisationScheme,// CategoryScheme, or ReportingTaxonomy) or nonenumerated.
99 99  
100 -Thus a single MetadataStructureDefinition can be defined for a discrete set of related object types. For example, a single definition can be constructed to define the metadata that can be attached to any part of a Data Structure Definition, or that can be attached to any artefact concerned with the reporting of quality metadata (such as data provider and (data) category). The MetadataTarget specifies the identification properties of a specific object type to which metadata can be attached in a MetadataSet. For example, in a DataStructureDefinition the MetadataTarget might be a Dimension, and therefore the //TargetObject//s are those that uniquely identify a Dimension. This will include both the DataStructureDefinition and he Dimension both of these are an //IdentifiableArtefact //and will use the// //IdentitifableObjectTarget) as both //TargetObject//s are required in order to identify uniquely a Dimension).
102 +Thus a single MetadataStructureDefinition can be defined for a discrete set of related object types. For example, a single definition can be constructed to define the metadata that can be attached to any part of a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], or that can be attached to any [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] concerned with the reporting of quality metadata (such as [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] and (data) [[category>>doc:sdmx:Glossary.Category.WebHome]]). The MetadataTarget specifies the identification properties of a specific object type to which metadata can be attached in a MetadataSet. For example, in a DataStructureDefinition the MetadataTarget might be a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], and therefore the //TargetObject//s are those that uniquely identify a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This will include both the DataStructureDefinition and he [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] both of these are an //IdentifiableArtefact //and will use the// //IdentitifableObjectTarget) as both //TargetObject//s are required in order to identify uniquely a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]).
101 101  
102 -The ReportStructure comprises a set of MetadataAttributes - these can be defined as a hierarchy. Each MetadataAttribute// //identifies a Concept that is reported or disseminated in a MetadataSet (/conceptIdentity) that uses this MetadataStructureDefinition. Different MetadataAttributes in the same ReportStructure can use Concepts from different ConceptSchemes. Note that a MetadataAttribute does not link to a Concept that defines its role in this MetadataStructureDefinition (i.e. the MetadataAttribute does not play a role).
104 +The ReportStructure comprises a set of MetadataAttributes - these can be defined as a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. Each MetadataAttribute// //identifies a (% style="color:#e74c3c" %)Concept(%%) that is reported or disseminated in a MetadataSet (/conceptIdentity) that uses this MetadataStructureDefinition. Different MetadataAttributes in the same ReportStructure can use (% style="color:#e74c3c" %)Concepts(%%) from different ConceptSchemes. Note that a MetadataAttribute does not link to a (% style="color:#e74c3c" %)Concept(%%) that defines its role in this MetadataStructureDefinition (i.e. the MetadataAttribute does not play a role).
103 103  
104 -The MetadataAttribute can be specified as having multiple occurrences and/or specified as being mandatory (minOccurs=1 or more) or conditional (minOccurs=0). A hierarchical ReportStructure can be defined by specifying a hierarchy for a MetadataAttribute.
106 +The MetadataAttribute can be specified as having multiple occurrences and/or specified as being mandatory (minOccurs=1 or more) or conditional (minOccurs=0). A hierarchical ReportStructure can be defined by specifying a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] for a MetadataAttribute.
105 105  
106 106  The ReportStructure is associated to one or more of the MetadataTargets which specify to which object the MetadataAttributes specified in the ReportStructure are attached when reported in a MetadataSet.
107 107  
108 108  It can be seen from this that the specification of the object types to which a MetadataAttribute can be attached is indirect: the MetadataAttributes are defined in a ReportStructure which itself is attached to one or more MetadataTarget and the actual object is identified by the //TargetObject//s comprising the MetadataTarget. This gives a flexible mechanism by which the actual object types need not be defined in concrete terms in the model, but are defined dynamically in the MetadataStructureDefinition, in much the same way as the keys to which data observation are “attached” in a DataStructureDefinition. In this way the MetadataStructureDefinition can be used to define any set of MetadataAttributes and any set of object types to which they can be attached.
109 109  
110 -Each MetadataAttribute can have a Representation specified (using the /localRepresentation association). If this is not specified in the MetadataStructureDefinition then the Representation is taken from that defined for the Concept (the coreRepresentation association).
112 +Each MetadataAttribute can have a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] specified (using the /localRepresentation association). If this is not specified in the MetadataStructureDefinition then the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] is taken from that defined for the (% style="color:#e74c3c" %)Concept(%%) (the coreRepresentation association).
111 111  
112 -The definition of the various types of Representation can be found in the specification of the Base constructs. Note that if the Representation is non-enumerated then the association is to the ExtendedFacet (which allows for xhtml as a FacetValueType). If the Representation is enumerated then is must use a Codelist.
114 +The definition of the various types of [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] can be found in the specification of the Base constructs. Note that if the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] is non-enumerated then the association is to the ExtendedFacet (which allows for xhtml as a FacetValueType). If the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] is enumerated then is must use a Codelist.
113 113  
114 -The MetadataStructureDefinition is linked to a MetadataflowDefinition. The MetadataflowDefinition does not have any attributes in addition to those inherited from the Base classes.
116 +The MetadataStructureDefinition is linked to a MetadataflowDefinition. The MetadataflowDefinition does not have any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in addition to those inherited from the Base classes.
115 115  
116 116  ==== 7.3.4.2 Definitions ====
117 117  
118 118  (% style="width:1144.29px" %)
119 119  |**Class**|**Feature**|(% style="width:704px" %)**Description**
120 -|StructureUsage| |(% style="width:704px" %)See “SDMX Base”.
121 -|Metadataflow Definition|(((
122 +|StructureUsage| |(% style="width:704px" %)See “[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base”.
123 +|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition|(((
122 122  Inherits from:
123 123  //StructureUsage//
124 -)))|(% style="width:704px" %)Abstract concept (i.e. the structure without any metadata) of a flow of metadata that providers will provide for different reference periods.
125 -| |/structure|(% style="width:704px" %)Associates a Metadata Structure Definition.
126 -|MetadataStructure Definition| |(% style="width:704px" %)A collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata.
126 +)))|(% style="width:704px" %)Abstract (% style="color:#e74c3c" %)concept(%%) (i.e. the structure without any metadata) of a flow of metadata that providers will provide for different reference periods.
127 +| |/structure|(% style="width:704px" %)Associates a [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].
128 +|MetadataStructure Definition| |(% style="width:704px" %)A collection of metadata (% style="color:#e74c3c" %)concepts(%%), their structure and usage when used to collect or disseminate [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]].
127 127  | |/grouping|(% style="width:704px" %)An association to a Metadata Target or Report Structure.
128 128  |MetadataTarget|(((
129 129  Inherits from
130 130  //ComponentList//
131 -)))|(% style="width:704px" %)A set of components that define a key of an object type to which metadata may be attached.
132 -| |/components|(% style="width:704px" %)Associates the Target Object components that define the key of the Metadata Target.
133 +)))|(% style="width:704px" %)A set of [[components>>doc:sdmx:Glossary.Component.WebHome]] that define a key of an object type to which metadata may be attached.
134 +| |/[[components>>doc:sdmx:Glossary.Component.WebHome]]|(% style="width:704px" %)Associates the Target Object [[components>>doc:sdmx:Glossary.Component.WebHome]] that define the key of the Metadata Target.
133 133  |//TargetObject//|(((
134 134  Abstract Class
135 135  Sub Classes
... ... @@ -139,7 +139,7 @@
139 139  DataSetTarget
140 140  ReportPeriodTarget
141 141  )))|(% style="width:704px" %)
142 -| |/localRepresentation|(% style="width:704px" %)Associates a Representation to the Target Object that must be respected when the object is identified in a Metadata Set. This may be enumerated or nonenumerated.
144 +| |/localRepresentation|(% style="width:704px" %)Associates a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] to the Target Object that must be respected when the object is identified in a [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]]. This may be enumerated or nonenumerated.
143 143  |DimensionDescriptor ValuesTarget|(((
144 144  Inherits from
145 145  
... ... @@ -153,30 +153,30 @@
153 153  |DataSetTarget|(((
154 154  Inherits from
155 155  //TargetObject//
156 -)))|(% style="width:704px" %)The target object is a Data Set.
158 +)))|(% style="width:704px" %)The target object is a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]].
157 157  |ReportPeriodTarget|(((
158 158  Inherits from
159 159  //TargetObject//
160 -)))|(% style="width:704px" %)The target is a report period. Note that this does not describe the use of an object, but rather serves as a unique metadata key for metadata reports. Metadata reports attached to a particular object may vary over time, and this time identifier component can be used to disambiguate the reports, much like the time dimension disambiguates observations in a data series.
162 +)))|(% style="width:704px" %)The target is a report period. Note that this does not describe the use of an object, but rather serves as a unique metadata key for metadata reports. Metadata reports attached to a particular object may vary over time, and this time identifier [[component>>doc:sdmx:Glossary.Component.WebHome]] can be used to disambiguate the reports, much like the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] disambiguates observations in a data series.
161 161  |ConstraintTarget|(((
162 162  Inherits from
163 163  //TargetObject//
164 -)))|(% style="width:704px" %)The target object is the data or reference metadata that is identified in the content of an Attachment Constraint.
166 +)))|(% style="width:704px" %)The target object is the data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] that is identified in the content of an Attachment Constraint.
165 165  |ReportStructure|(((
166 166  Inherits from:
167 167  //ComponentList//
168 -)))|(% style="width:704px" %)Defines a set of concepts that comprises the Metadata Attributes to be reported.
169 -| |/components|(% style="width:704px" %)An association to the Metadata Attributes relevant to the Report Structure.
170 +)))|(% style="width:704px" %)Defines a set of (% style="color:#e74c3c" %)concepts(%%) that comprises the Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] to be reported.
171 +| |/[[components>>doc:sdmx:Glossary.Component.WebHome]]|(% style="width:704px" %)An association to the Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] relevant to the Report Structure.
170 170  | |+reportFor|(% style="width:704px" %)Associates the Metadata Targets for which this Report Structure is used.
171 -|MetadataAttribute| |(% style="width:704px" %)Identifies a Concept for which a value may be reported in a Metadata Set.
172 -| |/hierarchy|(% style="width:704px" %)Association to one or more child Metadata Attribute.
173 -| |/conceptIdentity|(% style="width:704px" %)An association to the concept which defines the semantic of the attribute.
174 -| |isPresentational|(% style="width:704px" %)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 using this Report Structure.
175 -| |minOccurs maxOccurs|(% style="width:704px" %)Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadata Report.
176 -|ConceptUsage| |(% style="width:704px" %)The use of a Concept as Metadata Attribute.
177 -| |concept|(% style="width:704px" %)Association to a Concept in a ConceptScheme.
178 -| |/localRepresentation|(% style="width:704px" %)Associates a Representation that overrides any core representation specified for the Concept itself.
179 -|Representation| |(% style="width:704px" %)The representation of the Metadata Attribute.
173 +|MetadataAttribute| |(% style="width:704px" %)Identifies a (% style="color:#e74c3c" %)Concept(%%) for which a value may be reported in a [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]].
174 +| |/[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]|(% style="width:704px" %)Association to one or more child Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
175 +| |/conceptIdentity|(% style="width:704px" %)An association to the (% style="color:#e74c3c" %)concept(%%) which defines the semantic of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
176 +| |isPresentational|(% style="width:704px" %)Indication that the Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is present for structural purposes (i.e. it has child [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and that no value for this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is expected to be reported in a [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]] using this Report Structure.
177 +| |minOccurs maxOccurs|(% style="width:704px" %)Specifies how many occurrences of the Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] may be reported at this point in the Metadata Report.
178 +|ConceptUsage| |(% style="width:704px" %)The use of a (% style="color:#e74c3c" %)Concept(%%) as Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
179 +| |(%%)(% style="color:#e74c3c" %)concept|(% style="width:704px" %)Association to a (% style="color:#e74c3c" %)Concept(%%) in a ConceptScheme.
180 +| |/localRepresentation|(% style="width:704px" %)Associates a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] that overrides any core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] specified for the (% style="color:#e74c3c" %)Concept(%%) itself.
181 +|[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]| |(% style="width:704px" %)The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
180 180  
181 181  == {{id name="_Toc371034"/}}7.4 Metadata Set ==
182 182  
... ... @@ -201,11 +201,11 @@
201 201  The TargetObjectValue can be one of:
202 202  
203 203  * TargetDataKey – this can contain:
204 -** a SeriesKey (set of dimension values)
206 +** a SeriesKey (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values)
205 205  ** a SeriesKey plus a value or values (giving time range) for the TimeDimension (TimeDimensionValue)
206 206  ** a value of values for the TimeDimension
207 207  * TargetIdentifiableObject – this identifies any identifiable object (which includes both Maintainable and Identifiable objects
208 -* TargetDataSet – this identifies a DataSet
210 +* TargetDataSet – this identifies a [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]
209 209  * TargetReportPeriod – this specifies the report period for the Report
210 210  
211 211  A simple text value for the //ReportedAttribute// uses the //NonEnumeratedAttributeValue //sub class of //ReportedAttribute// whilst a coded value uses the EnumeratedAttributeValue sub class.
... ... @@ -214,39 +214,37 @@
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 MetadataStructureDefinition for the relevant ReportStructure
219 +* OtherNonEnumeratedAttributeValue – the content is a string value that must conform to the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] specified for the MetadataAttribute in the MetadataStructureDefinition for the relevant ReportStructure
218 218  
219 -The EnumeratedAttributeValue contains a value for a Code specified as the
221 +The EnumeratedAttributeValue contains a value for a [[Code>>doc:sdmx:Glossary.Code.WebHome]] specified as the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] for the MetadataAttribute in the MetadataStructureDefinition for the relevant ReportStructure.
220 220  
221 -Representation for the MetadataAttribute in the MetadataStructureDefinition for the relevant ReportStructure.
222 -
223 223  ==== 7.4.2.2 Definitions ====
224 224  
225 225  (% style="width:1118.29px" %)
226 226  |(% style="width:166px" %)**Class**|(% style="width:227px" %)**Feature**|(% style="width:716px" %)**Description**
227 227  |(% style="width:166px" %)MetadataSet|(% style="width:227px" %) |(% style="width:716px" %)Any organised collection of metadata.
228 -|(% 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.
229 -|(% 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.
230 -|(% 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.
231 -|(% 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.
232 -|(% 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.
228 +|(% style="width:166px" %) |(% style="width:227px" %)reportingBegin|(% style="width:716px" %)A specific [[time period>>doc:sdmx:Glossary.Time period.WebHome]] in a known system of [[time periods>>doc:sdmx:Glossary.Time period.WebHome]] that identifies the start period of a report.
229 +|(% style="width:166px" %) |(% style="width:227px" %)reportingEnd|(% style="width:716px" %)A specific [[time period>>doc:sdmx:Glossary.Time period.WebHome]] in a known system of [[time periods>>doc:sdmx:Glossary.Time period.WebHome]] that identifies the ebd period of a report.
230 +|(% style="width:166px" %) |(% style="width:227px" %)dataExtractionDate|(% style="width:716px" %)A specific [[time period>>doc:sdmx:Glossary.Time period.WebHome]] that identifies the date and time that the data are extracted from a data source.
231 +|(% 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>>doc:sdmx:Glossary.Data set.WebHome]].
232 +|(% 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>>doc:sdmx:Glossary.Metadata set.WebHome]].
233 233  |(% 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.
234 234  |(% 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.
235 -|(% style="width:166px" %) |(% style="width:227px" %)setId|(% style="width:716px" %)Provides an identification of the metadata set.
235 +|(% style="width:166px" %) |(% style="width:227px" %)setId|(% style="width:716px" %)Provides an identification of the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].
236 236  |(% style="width:166px" %) |(% style="width:227px" %)action|(% style="width:716px" %)Defines the action to be taken by the recipient system (update, replace, delete)
237 -|(% style="width:166px" %) |(% style="width:227px" %)+describedBy|(% style="width:716px" %)Associates a Metadataflow Definition to the Metadata Set.
238 -|(% 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.
239 -|(% style="width:166px" %) |(% style="width:227px" %)+publishedBy|(% style="width:716px" %)Associates the Data Provider that reports/publishes the metadata.
237 +|(% style="width:166px" %) |(% style="width:227px" %)+describedBy|(% style="width:716px" %)Associates a [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition to the [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]].
238 +|(% style="width:166px" %) |(% style="width:227px" %)+structuredBy|(% style="width:716px" %)Associates the [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] that defines the structure of the [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]]. Note that the [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] is the same as that associated (nonmandatory) to the [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition.
239 +|(% style="width:166px" %) |(% style="width:227px" %)+publishedBy|(% style="width:716px" %)Associates the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] that reports/publishes the metadata.
240 240  |(% style="width:166px" %) |(% style="width:227px" %)+describedBy|(% style="width:716px" %)Reference to the Report Structure.
241 -|(% 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.
241 +|(% style="width:166px" %)MetadataReport|(% style="width:227px" %) |(% style="width:716px" %)A set of values for Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] defined in a Report Structure of a [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].
242 242  |(% style="width:166px" %) |(% style="width:227px" %)+attachesTo|(% style="width:716px" %)Associates the object key to which metadata is to be attached.
243 243  |(% 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.
244 -|(% 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.
244 +|(% style="width:166px" %) |(% style="width:227px" %)+metadata|(% style="width:716px" %)Associates the Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values which are to be associated with the object or objects identified by the Target Object Key.
245 245  |(% style="width:166px" %)TargetObjectKey|(% style="width:227px" %) |(% style="width:716px" %)Identifies the key of the object to which the metadata are to be attached.
246 246  |(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
247 -Associates the Metadata Target that identifies the object type and the component structure of the Target Object Key.
247 +Associates the Metadata Target that identifies the object type and the [[component>>doc:sdmx:Glossary.Component.WebHome]] structure of the Target Object Key.
248 248  
249 -Note that this is a conceptual association showing the link to the MSD construct.
249 +Note that this is a conceptual association showing the link to the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] construct.
250 250  )))
251 251  |(% style="width:166px" %) |(% style="width:227px" %)+keyValues|(% style="width:716px" %)Associates the Target Object Values of the Target Object Key.
252 252  |(% style="width:166px" %)//TargetObjectValue//|(% style="width:227px" %)(((
... ... @@ -256,20 +256,20 @@
256 256  TargetIdentifiableObject
257 257  TargetDataSet
258 258  TargetReportPeriod
259 -)))|(% style="width:716px" %)The key of an individual object of the type specified in the Metadata Target of the Metadata Structure Definition.
259 +)))|(% style="width:716px" %)The key of an individual object of the type specified in the Metadata Target of the [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].
260 260  |(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
261 261  Associates the Target Object for which this value is provided.
262 262  
263 -Note that this is a conceptual association showing the link to the MSD construct.
263 +Note that this is a conceptual association showing the link to the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] construct.
264 264  )))
265 265  |(% style="width:166px" %)TargetDataKey|(% style="width:227px" %)(((
266 266  Inherits from
267 267  //TargetObjectValue//
268 -)))|(% style="width:716px" %)The identification of the components and the values that form the data or metadata key.
269 -|(% 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.
268 +)))|(% style="width:716px" %)The identification of the [[components>>doc:sdmx:Glossary.Component.WebHome]] and the values that form the data or metadata key.
269 +|(% style="width:166px" %)ComponentValue|(% style="width:227px" %) |(% style="width:716px" %)Collectively contain the identification of the [[components>>doc:sdmx:Glossary.Component.WebHome]] and the values that form the data key.
270 270  |(% style="width:166px" %)value|(% style="width:227px" %) |(% style="width:716px" %)The key value.
271 -|(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)Associates the Component for which the value is declared.
272 -|(% style="width:166px" %)TimeDimensionValue|(% style="width:227px" %) |(% style="width:716px" %)Contains identification of the Time Dimension and the value.
271 +|(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)Associates the [[Component>>doc:sdmx:Glossary.Component.WebHome]] for which the value is declared.
272 +|(% style="width:166px" %)TimeDimensionValue|(% style="width:227px" %) |(% style="width:716px" %)Contains identification of the Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] and the value.
273 273  |(% style="width:166px" %)TargetIdentifiable Object|(% style="width:227px" %)(((
274 274  Inherits from
275 275  //TargetObjectValue//
... ... @@ -278,70 +278,50 @@
278 278  |(% style="width:166px" %) |(% style="width:227px" %)structureType|(% style="width:716px" %)The object type of the target object.
279 279  |(% style="width:166px" %)(((
280 280  Maintainable
281 -
282 282  ArtefactRef
283 -
284 284  Identifiable
285 -
286 286  ArtefactRef
287 -)))|(% 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.
288 -|(% 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.
284 +)))|(% style="width:227px" %) |(% style="width:716px" %)Identification of the target object by means of its identifier constructs i.e agency ID, id, (% style="color:#e74c3c" %)version(%%) for Maintainable Object plus, for Identifiable Object, the id.
285 +|(% style="width:166px" %) |(% style="width:227px" %)+containedObject|(% style="width:716px" %)Association to a contained object in a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of Identifiable Objects such as a Transition in a Process Step.
289 289  |(% style="width:166px" %)TargetDataSet|(% style="width:227px" %)(((
290 290  Inherits from
291 -
292 292  //TargetObjectValue//
293 -)))|(% style="width:716px" %)Contains the identification of a Data Set
289 +)))|(% style="width:716px" %)Contains the identification of a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]]
294 294  |(% style="width:166px" %)TargetReportPeriod|(% style="width:227px" %)(((
295 295  Inherits from
296 -
297 297  //TargetObjectValue//
298 298  )))|(% style="width:716px" %)Contains the period covered by the Metadata Report.
299 299  |(% style="width:166px" %)//ReportedAttribute//|(% style="width:227px" %)(((
300 300  Abstract class Sub classes are:
301 -
302 302  //NonEnumeratedAttributeValue//
303 -
304 -EnumeratedAttributeValue//    //
305 -)))|(% style="width:716px" %)The value for a Metadata Attribute.
297 +EnumeratedAttributeValue
298 +)))|(% style="width:716px" %)The value for a Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
306 306  |(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
307 -Association to the Metadata Attribute in the Metadata Structure Definition that identifies the Concept and allowed Representation for the Reported Attribute.
308 -
309 -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.
300 +Association to the Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in the [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] that identifies the (% style="color:#e74c3c" %)Concept(%%) and allowed [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] for the Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
301 +Note that this is a conceptual association showing the link to the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] construct. The syntax for the Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will state, in some form, the id of the Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
310 310  )))
311 -|(% 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.
303 +|(% style="width:166px" %) |(% style="width:227px" %)+child|(% style="width:716px" %)Association to a child Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] consistent with the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] defined in the Report Structure for the Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for which this child is a Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
312 312  |(% style="width:166px" %)//NonEnumerated AttributeValue//|(% style="width:227px" %)(((
313 313  Inherits from
314 -
315 315  //ReportedAttribute//
316 -
317 317  Sub class:
318 -
319 -//XHTMLAttributeValue//
320 -
321 -//TextAttributeValue//
322 -
323 -//OtherNonEnumerated//
324 -
325 -//AttributeValue//
326 -)))|(% style="width:716px" %)The content of a Reported Attribute where this is textual.
308 +//XHTMLAttributeValue
309 +TextAttributeValue
310 +OtherNonEnumerated
311 +AttributeValue//
312 +)))|(% style="width:716px" %)The content of a Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] where this is textual.
327 327  |(% style="width:166px" %)XHTMLAttributeValue|(% style="width:227px" %) |(% style="width:716px" %)This contains XHTML.
328 328  |(% style="width:166px" %) |(% style="width:227px" %)value|(% style="width:716px" %)The string value of the XHTML.
329 -|(% style="width:166px" %)TextAttributeValue|(% style="width:227px" %) |(% style="width:716px" %)This value of a Reported Attribute where the content is humanreadable text.
315 +|(% style="width:166px" %)TextAttributeValue|(% style="width:227px" %) |(% style="width:716px" %)This value of a Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] where the content is humanreadable text.
330 330  |(% style="width:166px" %) |(% style="width:227px" %)text|(% style="width:716px" %)The string value is text. This can be present in multiple language versions.
331 -|(% 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.
332 -|(% 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.
317 +|(% style="width:166px" %)OtherNonEnumerated AttributeValue|(% style="width:227px" %) |(% style="width:716px" %)The value of a Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] where the content is not of humanreadable text.
318 +|(% style="width:166px" %) |(% style="width:227px" %)value|(% style="width:716px" %)A text string that is consistent in format to that defined in the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] of the Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for which this is a Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
333 333  |(% style="width:166px" %)EnumeratedAttribute Value|(% style="width:227px" %)(((
334 334  Inherits from
335 -
336 336  //MetadataAttributeValue//
337 -)))|(% style="width:716px" %)The content of a Reported Attribute that is taken from a Code in a Code list.
338 -|(% style="width:166px" %) |(% style="width:227px" %)value|(% style="width:716px" %)The Code value of the Reported Attribute.
322 +)))|(% style="width:716px" %)The content of a Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that is taken from a [[Code>>doc:sdmx:Glossary.Code.WebHome]] in a [[Code list>>doc:sdmx:Glossary.Code list.WebHome]].
323 +|(% style="width:166px" %) |(% style="width:227px" %)value|(% style="width:716px" %)The [[Code>>doc:sdmx:Glossary.Code.WebHome]] value of the Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
339 339  |(% style="width:166px" %) |(% style="width:227px" %)+value|(% style="width:716px" %)(((
340 -Association to a Code in the Code list specified in the Representation of the Metadata Attribute for which this Reported Attribute is the value
341 -
342 -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.
325 +Association to a [[Code>>doc:sdmx:Glossary.Code.WebHome]] in the [[Code list>>doc:sdmx:Glossary.Code list.WebHome]] specified in the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] of the Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for which this Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the value
326 +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>>doc:sdmx:Glossary.Attribute.WebHome]] Value.
343 343  )))
344 -
345 -
346 -
347 -
1747903167692-628.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +59.7 KB
Content