Last modified by Artur on 2025/09/10 11:19

Hide last authors
Helena 5.1 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Helena 2.1 4
5 == {{id name="_Toc371024"/}}7.1 Context ==
6
Helena 10.2 7 The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] metamodel allows metadata:
Helena 2.1 8
9 1. To be exchanged without the need to embed it within the object that it is describing.
Helena 10.2 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).
Helena 2.1 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 1. To be reported according to a defined structure.
13
14 In order to achieve this, the following structures are modelled:
15
Helena 10.2 16 * [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] which has the following [[components>>doc:sdmx:Glossary.Component.WebHome]]:
Helena 2.1 17 ** the object types to which the metadata are to be associated (attached)
Helena 10.2 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
Helena 2.1 21
22 == {{id name="_Toc371025"/}}7.2 Inheritance ==
23
24 === {{id name="_Toc371026"/}}7.2.1 Introduction ===
25
Helena 10.2 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.
Helena 2.1 27
Helena 10.2 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.
Helena 2.1 29
30 === {{id name="_Toc371027"/}}7.2.2 Class Diagram - Inheritance ===
31
Helena 7.1 32 [[image:1747903167692-628.png]]
33
Helena 2.1 34 **Figure 27: Inheritance class diagram of the Metadata Structure Definition**
35
36 === {{id name="_Toc371028"/}}7.2.3 Explanation of the Diagram ===
37
38 ==== 7.2.3.1 Narrative ====
39
40 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.
41
Helena 10.2 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:
Helena 2.1 43
Helena 5.2 44 * //StructureUsage// (concrete class is MetadataflowDefinition)
45 * //Structure// (concrete class is MetadataStructureDefinition)
Helena 2.1 46
Helena 10.2 47 These classes also inherit the identity and versioning [[facets>>doc:sdmx:Glossary.Facet.WebHome]] of //IdentifiableArtefact, NameableArtefact,// and //VersionableArtefact//.
Helena 2.1 48
Helena 10.2 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:
Helena 2.1 50
51 * MetadataTarget
52 * ReportStructure
53
Helena 10.2 54 //ComponentList// contains [[Components>>doc:sdmx:Glossary.Component.WebHome]]. The classes that inherit from //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// are:
Helena 2.1 55
56 * Sub Classes of //TargetObject//
57 * MetadataAttribute
58
59 == {{id name="_Toc371029"/}}7.3 Metadata Structure Definition ==
60
61 === {{id name="_Toc371030"/}}7.3.1 Introduction ===
62
63 The diagrams and explanations in the rest of this section show how these concrete classes are related so as to support the functionality required.
64
65 === {{id name="_Toc371031"/}}7.3.2 Structures Already Described ===
66
67 The MetadataStructureDefinition makes use of the following //ItemScheme// structures either as explicit concrete classes in the model, or as possible lists which comprise the value domain of a TargetObject.
68
69 * CategoryScheme
70 * ConceptScheme
71 * Codelist
72 * //OrganisationScheme//
73 * Reporting Taxonomy
74
75 === {{id name="_Toc371032"/}}7.3.3 Class Diagram – Relationship ===
76
Helena 5.2 77 [[image:1747902064472-244.png]]
78
Helena 2.1 79 **Figure 28: Relationship class diagram of the Metadata Structure Definition**
80
81 === {{id name="_Toc371033"/}}7.3.4 Explanation of the Diagram ===
82
83 ==== 7.3.4.1 Narrative ====
84
Helena 10.2 85 In brief a MetadataStructureDefinition ([[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]) defines:
Helena 2.1 86
Helena 10.2 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]]
Helena 2.1 89
90 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.
91
92 The //TargetObject// is one of the following:
93
Helena 10.2 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
Helena 2.1 95 * IdentifiableObjectTarget – this defines a specific object type, which can be any IdentifiableArtefact
Helena 10.2 96 * DataSetTarget – this specifies that the target object is a [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]
Helena 2.1 97 * ReportPeriodTarget - this specifies that the report period must be present in the MetadataSet
Helena 10.2 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
Helena 2.1 99
Helena 10.2 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.
Helena 2.1 101
Helena 10.2 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]]).
Helena 2.1 103
Elena 13.2 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>>doc:sdmx:Glossary.Concept.WebHome]](%%) 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>>doc:sdmx:Glossary.Concept.WebHome]](%%) from different ConceptSchemes. Note that a MetadataAttribute does not link to a (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) that defines its role in this MetadataStructureDefinition (i.e. the MetadataAttribute does not play a role).
Helena 2.1 105
Helena 10.2 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.
Helena 2.1 107
108 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.
109
110 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.
111
Elena 13.2 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>>doc:sdmx:Glossary.Concept.WebHome]](%%) (the coreRepresentation association).
Helena 2.1 113
Helena 10.2 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.
Helena 2.1 115
Helena 10.2 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.
Helena 2.1 117
118 ==== 7.3.4.2 Definitions ====
119
Helena 5.2 120 (% style="width:1144.29px" %)
121 |**Class**|**Feature**|(% style="width:704px" %)**Description**
Helena 10.2 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|(((
Helena 2.1 124 Inherits from:
125 //StructureUsage//
Elena 13.2 126 )))|(% style="width:704px" %)Abstract с[[oncept>>path:/xwiki/wiki/sdmx/view/Glossary/Concept/]] (i.e. the structure without any metadata) of a flow of metadata that providers will provide for different reference periods.
Helena 10.2 127 | |/structure|(% style="width:704px" %)Associates a [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].
Elena 13.2 128 |MetadataStructure Definition| |(% style="width:704px" %)A collection of metadata [[concepts>>path:/xwiki/wiki/sdmx/view/Glossary/Concept/]], their structure and usage when used to collect or disseminate [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]].
Helena 5.2 129 | |/grouping|(% style="width:704px" %)An association to a Metadata Target or Report Structure.
Helena 2.1 130 |MetadataTarget|(((
131 Inherits from
132 //ComponentList//
Helena 10.2 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.
Helena 2.1 135 |//TargetObject//|(((
136 Abstract Class
137 Sub Classes
138 DimensionDescriptorValues
139 Target
140 IdentifiableObjectTarget
141 DataSetTarget
142 ReportPeriodTarget
Helena 5.2 143 )))|(% style="width:704px" %)
Helena 10.2 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.
Helena 2.1 145 |DimensionDescriptor ValuesTarget|(((
146 Inherits from
147
148 //TargetObject//
Helena 5.2 149 )))|(% style="width:704px" %)The target object is the key of a data series.
Helena 2.1 150 |IdentifiableObject Target|(((
151 Inherits from
152 //TargetObject//
Helena 5.2 153 )))|(% style="width:704px" %)The target object is a specified object type.
154 | |objectType|(% style="width:704px" %)Identifies the object type.
Helena 2.1 155 |DataSetTarget|(((
156 Inherits from
157 //TargetObject//
Helena 10.2 158 )))|(% style="width:704px" %)The target object is a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]].
Helena 2.1 159 |ReportPeriodTarget|(((
160 Inherits from
161 //TargetObject//
Helena 10.2 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.
Helena 2.1 163 |ConstraintTarget|(((
164 Inherits from
165 //TargetObject//
Helena 10.2 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.
Helena 2.1 167 |ReportStructure|(((
168 Inherits from:
169 //ComponentList//
Elena 13.2 170 )))|(% style="width:704px" %)Defines a set of [[concepts>>path:/xwiki/wiki/sdmx/view/Glossary/Concept/]] that comprises the Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] to be reported.
Helena 10.2 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.
Helena 5.2 172 | |+reportFor|(% style="width:704px" %)Associates the Metadata Targets for which this Report Structure is used.
Elena 13.2 173 |MetadataAttribute| |(% style="width:704px" %)Identifies a [[Concept>>path:/xwiki/wiki/sdmx/view/Glossary/Concept/]] for which a value may be reported in a [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]].
Helena 10.2 174 | |/[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]|(% style="width:704px" %)Association to one or more child Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
Elena 13.2 175 | |/conceptIdentity|(% style="width:704px" %)An association to the [[concepts>>path:/xwiki/wiki/sdmx/view/Glossary/Concept/]] which defines the semantic of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
Helena 10.2 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.
Elena 13.2 178 |ConceptUsage| |(% style="width:704px" %)The use of a [[Concept>>path:/xwiki/wiki/sdmx/view/Glossary/Concept/]] as Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
179 | |[[concept>>path:/xwiki/wiki/sdmx/view/Glossary/Concept/]]|(% style="width:704px" %)Association to a [[Concept>>path:/xwiki/wiki/sdmx/view/Glossary/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 [[Concept>>path:/xwiki/wiki/sdmx/view/Glossary/Concept/]] itself.
Helena 10.2 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]].
Helena 2.1 182
183 == {{id name="_Toc371034"/}}7.4 Metadata Set ==
184
185 === {{id name="_Toc371035"/}}7.4.1 Class Diagram ===
186
Helena 5.3 187 [[image:1747902223404-649.png]]
188
Helena 2.1 189 **Figure 29: Relationship Class Diagram of the Metadata Set**
190
191 === {{id name="_Toc371036"/}}7.4.2 Explanation of the Diagram ===
192
Helena 5.4 193 ==== 7.4.2.1 Narrative ====
Helena 2.1 194
Helena 5.5 195 Note that the MetadataSet must conform to the MetadataStructureDefinition associated to the MetadataflowDefinition for which this MetadataSet is an “instance of metadata”. Whilst the model shows the association to the classes of the MetadataStructureDefinition, this is for conceptual purposes to show the link to the MetadataStructureDefinition. In the actual MetadataSet as exchanged there must, of course, be a reference to the MetadataStructureDefinition and the ReportStructure, and optionally a MetadataflowDefinition, but the MetadataStructureDefinition is not necessarily exchanged with the metadata. Therefore, the MetadataStructureDefinition classes are shown in the grey areas, as these are not a part of the MetadataSet itself.
Helena 2.1 196
197 An organisation playing the role of DataProvider can be responsible for one or more MetadataSet.
198
199 A MetadataSet comprises one or more MetadataReport, each of which must be for the same ReportStructure. It references both a MetadataTarget, defined in the MetadataStructureDefinition, and contains a TargetObjectKey and ReportedAttributes.
200
201 The identified ReportStructure specifies which MetadataAttributes are expected as //ReportedAttribute//s. The identified MetadataTarget specifies the expected content of the TargetObjectKey i.e. it specifies the information required to identify the object for which the //ReportedAttribute//s are reported.
202
203 The TargetObjectValue can be one of:
204
205 * TargetDataKey – this can contain:
Helena 10.2 206 ** a SeriesKey (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values)
Helena 5.5 207 ** a SeriesKey plus a value or values (giving time range) for the TimeDimension (TimeDimensionValue)
208 ** a value of values for the TimeDimension
209 * TargetIdentifiableObject – this identifies any identifiable object (which includes both Maintainable and Identifiable objects
Helena 10.2 210 * TargetDataSet – this identifies a [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]
Helena 5.5 211 * TargetReportPeriod – this specifies the report period for the Report
Helena 2.1 212
Helena 5.5 213 A simple text value for the //ReportedAttribute// uses the //NonEnumeratedAttributeValue //sub class of //ReportedAttribute// whilst a coded value uses the EnumeratedAttributeValue sub class.
Helena 2.1 214
215 The //NonEnumeratedAttributeValue// can be one of:
216
217 * XHTMLAttributeValue – the content is XHTML
218 * TextAttributeValue – the content is textual and may contain the text in multiple languages
Helena 10.2 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
Helena 2.1 220
Helena 10.2 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.
Helena 2.1 222
223 ==== 7.4.2.2 Definitions ====
224
Helena 5.6 225 (% style="width:1118.29px" %)
226 |(% style="width:166px" %)**Class**|(% style="width:227px" %)**Feature**|(% style="width:716px" %)**Description**
227 |(% style="width:166px" %)MetadataSet|(% style="width:227px" %) |(% style="width:716px" %)Any organised collection of metadata.
Helena 10.2 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]].
Helena 5.6 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 |(% 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.
Helena 10.2 235 |(% style="width:166px" %) |(% style="width:227px" %)setId|(% style="width:716px" %)Provides an identification of the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].
Helena 5.6 236 |(% style="width:166px" %) |(% style="width:227px" %)action|(% style="width:716px" %)Defines the action to be taken by the recipient system (update, replace, delete)
Helena 10.2 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.
Helena 5.6 240 |(% style="width:166px" %) |(% style="width:227px" %)+describedBy|(% style="width:716px" %)Reference to the Report Structure.
Helena 10.2 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]].
Helena 5.6 242 |(% style="width:166px" %) |(% style="width:227px" %)+attachesTo|(% style="width:716px" %)Associates the object key to which metadata is to be attached.
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.
Helena 10.2 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.
Helena 5.6 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 |(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
Helena 10.2 247 Associates the Metadata Target that identifies the object type and the [[component>>doc:sdmx:Glossary.Component.WebHome]] structure of the Target Object Key.
Helena 2.1 248
Helena 10.2 249 Note that this is a conceptual association showing the link to the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] construct.
Helena 2.1 250 )))
Helena 5.6 251 |(% style="width:166px" %) |(% style="width:227px" %)+keyValues|(% style="width:716px" %)Associates the Target Object Values of the Target Object Key.
252 |(% style="width:166px" %)//TargetObjectValue//|(% style="width:227px" %)(((
Helena 2.1 253 Abstract class
254 Sub classes are
255 TargetDataKey
Helena 5.6 256 TargetIdentifiableObject
257 TargetDataSet
Helena 2.1 258 TargetReportPeriod
Helena 10.2 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]].
Helena 5.6 260 |(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
Helena 2.1 261 Associates the Target Object for which this value is provided.
262
Helena 10.2 263 Note that this is a conceptual association showing the link to the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] construct.
Helena 2.1 264 )))
Helena 5.6 265 |(% style="width:166px" %)TargetDataKey|(% style="width:227px" %)(((
Helena 2.1 266 Inherits from
267 //TargetObjectValue//
Helena 10.2 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.
Helena 5.6 270 |(% style="width:166px" %)value|(% style="width:227px" %) |(% style="width:716px" %)The key value.
Helena 10.2 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.
Helena 5.6 273 |(% style="width:166px" %)TargetIdentifiable Object|(% style="width:227px" %)(((
Helena 2.1 274 Inherits from
Helena 5.6 275 //TargetObjectValue//
276 )))|(% style="width:716px" %)Specifies the identification of an Identifiable object.
277 |(% style="width:166px" %)StructureRef|(% style="width:227px" %) |(% style="width:716px" %)Contains the identification of an Identifiable object.
278 |(% style="width:166px" %) |(% style="width:227px" %)structureType|(% style="width:716px" %)The object type of the target object.
279 |(% style="width:166px" %)(((
Helena 2.1 280 Maintainable
281 ArtefactRef
282 Identifiable
283 ArtefactRef
Elena 13.2 284 )))|(% style="width:227px" %) |(% style="width:716px" %)Identification of the target object by means of its identifier constructs i.e agency ID, id, [[version>>doc:Glossary.Version.WebHome]] for Maintainable Object plus, for Identifiable Object, the id.
Helena 10.2 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.
Helena 5.6 286 |(% style="width:166px" %)TargetDataSet|(% style="width:227px" %)(((
Helena 2.1 287 Inherits from
288 //TargetObjectValue//
Helena 10.2 289 )))|(% style="width:716px" %)Contains the identification of a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]]
Helena 5.6 290 |(% style="width:166px" %)TargetReportPeriod|(% style="width:227px" %)(((
Helena 2.1 291 Inherits from
292 //TargetObjectValue//
Helena 5.6 293 )))|(% style="width:716px" %)Contains the period covered by the Metadata Report.
294 |(% style="width:166px" %)//ReportedAttribute//|(% style="width:227px" %)(((
Helena 2.1 295 Abstract class Sub classes are:
296 //NonEnumeratedAttributeValue//
Helena 5.7 297 EnumeratedAttributeValue
Helena 10.2 298 )))|(% style="width:716px" %)The value for a Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
Helena 5.6 299 |(% style="width:166px" %) |(% style="width:227px" %)+valueFor|(% style="width:716px" %)(((
Elena 13.2 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 [[Concept>>path:/xwiki/wiki/sdmx/view/Glossary/Concept/]] and allowed [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] for the Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
Helena 10.2 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]].
Helena 2.1 302 )))
Helena 10.2 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]].
Helena 5.6 304 |(% style="width:166px" %)//NonEnumerated AttributeValue//|(% style="width:227px" %)(((
Helena 2.1 305 Inherits from
306 //ReportedAttribute//
307 Sub class:
Helena 6.1 308 //XHTMLAttributeValue
309 TextAttributeValue
310 OtherNonEnumerated
311 AttributeValue//
Helena 10.2 312 )))|(% style="width:716px" %)The content of a Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] where this is textual.
Helena 5.6 313 |(% style="width:166px" %)XHTMLAttributeValue|(% style="width:227px" %) |(% style="width:716px" %)This contains XHTML.
314 |(% style="width:166px" %) |(% style="width:227px" %)value|(% style="width:716px" %)The string value of the XHTML.
Helena 10.2 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.
Helena 5.6 316 |(% style="width:166px" %) |(% style="width:227px" %)text|(% style="width:716px" %)The string value is text. This can be present in multiple language versions.
Helena 10.2 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]].
Helena 5.6 319 |(% style="width:166px" %)EnumeratedAttribute Value|(% style="width:227px" %)(((
Helena 2.1 320 Inherits from
321 //MetadataAttributeValue//
Helena 10.2 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]].
Helena 5.6 324 |(% style="width:166px" %) |(% style="width:227px" %)+value|(% style="width:716px" %)(((
Helena 10.2 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.
Helena 2.1 327 )))