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 3.1
edited by Helena
on 2025/05/22 10:31
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,4 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
1 += {{id name="_Toc371023"/}}7 Metadata Structure Definition and Metadata Set =
4 4  
5 5  == {{id name="_Toc371024"/}}7.1 Context ==
6 6  
... ... @@ -39,8 +39,8 @@
39 39  
40 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:
41 41  
42 -* //StructureUsage// (concrete class is MetadataflowDefinition)
43 -* //Structure// (concrete class is MetadataStructureDefinition)
40 +* //StructureUsage// (concrete class is MetadataflowDefinition)//  //
41 +* //Structure// (concrete class is MetadataStructureDefinition)//  //
44 44  
45 45  These classes also inherit the identity and versioning facets of //IdentifiableArtefact, NameableArtefact,// and //VersionableArtefact//.
46 46  
... ... @@ -72,8 +72,6 @@
72 72  
73 73  === {{id name="_Toc371032"/}}7.3.3 Class Diagram – Relationship ===
74 74  
75 -[[image:1747902064472-244.png]]
76 -
77 77  **Figure 28: Relationship class diagram of the Metadata Structure Definition**
78 78  
79 79  === {{id name="_Toc371033"/}}7.3.4 Explanation of the Diagram ===
... ... @@ -97,8 +97,10 @@
97 97  
98 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.
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).
96 +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
101 101  
98 +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).
99 +
102 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).
103 103  
104 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.
... ... @@ -115,83 +115,98 @@
115 115  
116 116  ==== 7.3.4.2 Definitions ====
117 117  
118 -(% style="width:1144.29px" %)
119 -|**Class**|**Feature**|(% style="width:704px" %)**Description**
120 -|StructureUsage| |(% style="width:704px" %)See “SDMX Base”.
116 +|**Class**|**Feature**|**Description**
117 +|StructureUsage| |See “SDMX Base”.
121 121  |Metadataflow Definition|(((
122 122  Inherits from:
120 +
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.
127 -| |/grouping|(% style="width:704px" %)An association to a Metadata Target or Report Structure.
122 +)))|Abstract concept (i.e. the structure without any metadata) of a flow of metadata that providers will provide for different reference periods.
123 +| |/structure|Associates a Metadata Structure Definition.
124 +|MetadataStructure Definition| |A collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata.
125 +| |/grouping|An association to a Metadata Target or Report Structure.
128 128  |MetadataTarget|(((
129 129  Inherits from
128 +
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.
130 +)))|A set of components that define a key of an object type to which metadata may be attached.
131 +| |/components|Associates the Target Object components that define the key of the Metadata Target.
133 133  |//TargetObject//|(((
134 134  Abstract Class
134 +
135 135  Sub Classes
136 +
136 136  DimensionDescriptorValues
138 +
137 137  Target
140 +
138 138  IdentifiableObjectTarget
142 +
139 139  DataSetTarget
144 +
140 140  ReportPeriodTarget
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.
146 +)))|
147 +| |/localRepresentation|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.
143 143  |DimensionDescriptor ValuesTarget|(((
144 144  Inherits from
145 145  
146 146  //TargetObject//
147 -)))|(% style="width:704px" %)The target object is the key of a data series.
152 +)))|The target object is the key of a data series.
148 148  |IdentifiableObject Target|(((
149 149  Inherits from
155 +
150 150  //TargetObject//
151 -)))|(% style="width:704px" %)The target object is a specified object type.
152 -| |objectType|(% style="width:704px" %)Identifies the object type.
157 +)))|The target object is a specified object type.
158 +| |objectType|Identifies the object type.
153 153  |DataSetTarget|(((
154 154  Inherits from
161 +
155 155  //TargetObject//
156 -)))|(% style="width:704px" %)The target object is a Data Set.
163 +)))|The target object is a Data Set.
157 157  |ReportPeriodTarget|(((
158 158  Inherits from
166 +
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.
168 +)))|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.
161 161  |ConstraintTarget|(((
162 162  Inherits from
171 +
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.
173 +)))|The target object is the data or reference metadata that is identified in the content of an Attachment Constraint.
165 165  |ReportStructure|(((
166 166  Inherits from:
176 +
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 -| |+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.
178 +)))|Defines a set of concepts that comprises the Metadata Attributes to be reported.
179 +| |/components|An association to the Metadata Attributes relevant to the Report Structure.
180 +| |+reportFor|Associates the Metadata Targets for which this Report Structure is used.
181 +|MetadataAttribute| |Identifies a Concept for which a value may be reported in a Metadata Set.
182 +| |/hierarchy|Association to one or more child Metadata Attribute.
183 +| |/conceptIdentity|An association to the concept which defines the semantic of the attribute.
184 +| |isPresentational|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.
185 +| |minOccurs maxOccurs|Specifies how many occurrences of the Metadata Attribute may be reported at this point in the Metadata Report.
186 +|ConceptUsage| |The use of a Concept as Metadata Attribute.
187 +| |concept|Association to a Concept in a ConceptScheme.
188 +| |/localRepresentation|Associates a Representation that overrides any core representation specified for the Concept itself.
189 +|Representation| |The representation of the Metadata Attribute.
180 180  
191 +
192 +
193 +
181 181  == {{id name="_Toc371034"/}}7.4 Metadata Set ==
182 182  
183 183  === {{id name="_Toc371035"/}}7.4.1 Class Diagram ===
184 184  
185 -[[image:1747902223404-649.png]]
186 -
187 187  **Figure 29: Relationship Class Diagram of the Metadata Set**
188 188  
189 189  === {{id name="_Toc371036"/}}7.4.2 Explanation of the Diagram ===
190 190  
191 -==== 7.4.2.1 Narrative ====
202 +**7.4.2.1 Narrative**
192 192  
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 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.
204 +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
194 194  
206 +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.
207 +
195 195  An organisation playing the role of DataProvider can be responsible for one or more MetadataSet.
196 196  
197 197  A MetadataSet comprises one or more MetadataReport, each of which must be for the same ReportStructure. It references both a MetadataTarget, defined in the MetadataStructureDefinition, and contains a TargetObjectKey and ReportedAttributes.
... ... @@ -202,14 +202,13 @@
202 202  
203 203  * TargetDataKey – this can contain:
204 204  ** a SeriesKey (set of dimension values)
205 -** a SeriesKey plus a value or values (giving time range) for the TimeDimension (TimeDimensionValue)
206 -** a value of values for the TimeDimension
207 -* TargetIdentifiableObject – this identifies any identifiable object (which includes both Maintainable and Identifiable objects
208 -* TargetDataSet – this identifies a DataSet
209 -* TargetReportPeriod – this specifies the report period for the Report
218 +** a SeriesKey plus a value or values (giving time range) for the
210 210  
211 -A simple text value for the //ReportedAttribute// uses the //NonEnumeratedAttributeValue //sub class of //ReportedAttribute// whilst a coded value uses the EnumeratedAttributeValue sub class.
220 +TimeDimension (TimeDimensionValue) o a value of values for the TimeDimension
212 212  
222 +* TargetIdentifiableObject -this identifies any identifiable object (which includes both Maintainable and Identifiable objects  TargetDataSet – this identifies a DataSet
223 +* 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.
224 +
213 213  The //NonEnumeratedAttributeValue// can be one of:
214 214  
215 215  * XHTMLAttributeValue – the content is XHTML
1747902064472-244.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -56.8 KB
Content
1747902223404-649.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -115.9 KB
Content
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,1 +1,0 @@
1 -8