Skip to Content

Wiki source code of 4 Specific Item Schemes

Version 22.1 by Artur on 2025/05/22 14:56
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 == 4.1 Introduction ==
6
7 The structures that are an arrangement of objects into [[hierarchies>>doc:Glossary.Hierarchy.WebHome]] or lists based on characteristics, and which are maintained as a group inherit from //ItemScheme//. These concrete classes are:
8
9 Codelist
10 ConceptScheme
11 CategoryScheme
12 AgencyScheme, DataProviderScheme, MetadataProviderScheme, DataConsumerScheme, OrganisationUnitScheme, which all inherit from the abstract class //OrganisationScheme//
13 ReportingTaxonomy
14 TransformationScheme
15 RulesetScheme
16 UserDefinedOperatorScheme
17 NamePersonalisationScheme
18 CustomTypeScheme
19 VtlMappingScheme
20
21 Note that the [[VTL>>doc:Glossary.Validation and transformation language.WebHome]] related schemes (the last 6 of the above list) are detailed in a dedicated section below (section 15).
22
23 == 4.2 Inheritance View ==
24
25 The inheritance and relationship views are shown together in each of the diagrams in the specific sections below.
26
27 == 4.3 Codelist ==
28
29 === 4.3.1 Class Diagram ===
30
31 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_98388f74.jpg||height="674" width="433"]]
32
33 **Figure 16: Class diagram of the Codelist**
34
35 === 4.3.2 Explanation of the Diagram ===
36
37 ==== 4.3.2.1 Narrative ====
38
39 The Codelist inherits from the //ItemScheme// and therefore has the following [[attributes>>doc:Glossary.Attribute.WebHome]]:
40
41 id
42 uri
43 urn
44 version
45 validFrom
46 validTo
47 isExternalReference
48 serviceURL
49 structureURL
50 isPartial
51
52 The [[Code>>doc:Glossary.Code.WebHome]] inherits from //Item// and has the following [[attributes>>doc:Glossary.Attribute.WebHome]]:
53
54 id
55 uri
56 urn
57
58 Both Codelist and [[Code>>doc:Glossary.Code.WebHome]] have the association to InternationalString to support a multilingual name, an optional multi-lingual description, and an association to [[Annotation>>doc:Glossary.Annotation.WebHome]] to support notes (not shown).
59
60 Through the inheritance the Codelist comprise one or more [[Codes>>doc:Glossary.Code.WebHome]], and the [[Code>>doc:Glossary.Code.WebHome]] itself can have one or more child [[Codes>>doc:Glossary.Code.WebHome]] in the (inherited) [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] association. Note that a child [[Code>>doc:Glossary.Code.WebHome]] can have only one parent [[Code>>doc:Glossary.Code.WebHome]] in this association. A more complex Hierarhcy, which allows multiple parents is described later.
61
62 A partial Codelist (where isPartial is set to 'true') is identical to a Codelist and contains the [[Code>>doc:Glossary.Code.WebHome]] and associated names and descriptions, just as in a normal Codelist. However, its content is a subset of the full Codelist. The way this works is described in section 3.5.3.1 on //ItemScheme//.
63
64 ==== 4.3.2.2 Definitions ====
65
66 (% style="width:743.039px" %)
67 |**Class**|**Feature**|(% style="width:465px" %)**Description**
68 |Codelist|(((
69 Inherits from
70
71 //ItemScheme//
72 )))|(% style="width:465px" %)A list from which some statistical (% style="color:#e74c3c" %)concepts(%%) (coded (% style="color:#e74c3c" %)concepts(%%)) take their values.
73 |Code|(((
74 Inherits from
75
76 Item
77 )))|(% style="width:465px" %)A language independent set of letters, numbers or symbols that represent a (% style="color:#e74c3c" %)concept(%%) whose meaning is described in a natural language.
78 | |hierarchy|(% style="width:465px" %)Associates the parent and the child codes.
79 | |extends|(% style="width:465px" %)Associates a Codelist with any Codelists that it may extend.
80
81 === 4.3.3 Class Diagram – Codelist Extension ===
82
83 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_e758cbcf.jpg||height="546" width="559"]]
84
85 **Figure 17: Class diagram for Codelist Extension**
86
87 ==== 4.3.3.1 Narrative ====
88
89 A Codelist may extend other Codelists via the CodelistExtension class. The latter, via the sequence, indicates the order of precedence of the extended Codelists for conflict resolution of [[Codes>>doc:Glossary.Code.WebHome]]. Besides that, the prefix property is used to ensure uniqueness of inherited [[Codes>>doc:Glossary.Code.WebHome]] in the extending{{footnote}}The Codelist that extends 0..* Codelists is the 'extending' Codelist, while the Codelist(s) that are inherited is/are the 'extended' Codelist(s).{{/footnote}} Codelist in case conflicting [[Codes>>doc:Glossary.Code.WebHome]] must be included in the latter. Each CodelistExtension association may include one InclusiveCodeSelection or one ExclusiveCodeSelection; those allow including or excluding a specific selection of [[Codes>>doc:Glossary.Code.WebHome]] from the extended Codelists.
90
91 The [[code>>doc:Glossary.Code.WebHome]] selection classes may have MemberValues in order to specify the subset of the [[Codes>>doc:Glossary.Code.WebHome]] that should be included or excluded from the extended Codelist. A MemberValue may have a value that corresponds to a [[Code>>doc:Glossary.Code.WebHome]], including its children [[Codes>>doc:Glossary.Code.WebHome]] (via the cascadeValues property), or even include instances of the wildcard character ‘%’ in order to point to a set of [[Codes>>doc:Glossary.Code.WebHome]] with common parts in their identifiers.
92
93 ==== 4.3.3.2 Definitions ====
94
95 (((
96 (% style="width:753.039px" %)
97 |(% style="width:184px" %)**Class**|(% style="width:145px" %)**Feature**|(% style="width:421px" %)**Description**
98 |(% style="width:184px" %)CodelistExtension|(% style="width:145px" %) |(% style="width:421px" %)The association between Codelists that may extend other Codelists.
99 |(% style="width:184px" %) |(% style="width:145px" %)prefix|(% style="width:421px" %)A prefix to be used for a Codelist used in a extension, in order to avoid [[Code>>doc:Glossary.Code.WebHome]] Conflicts.
100 |(% style="width:184px" %) |(% style="width:145px" %)sequence|(% style="width:421px" %)The order that will be used when extending a Codelist, for resolving [[Code>>doc:Glossary.Code.WebHome]] conflicts. The latest Codelist used overrides any previous Codelist.
101 |(% style="width:184px" %)InclusiveCodeSelection|(% style="width:145px" %) |(% style="width:421px" %)The subset of [[Codes>>doc:Glossary.Code.WebHome]] to be included when extending a Codelist.
102 |(% style="width:184px" %)ExclusiveCodeSelection|(% style="width:145px" %) |(% style="width:421px" %)The subset of [[Codes>>doc:Glossary.Code.WebHome]] to be excluded when extending a Codelist.
103 |(% style="width:184px" %)MemberValue|(% style="width:145px" %)(((
104 Inherits from:
105
106 //SelectionValue//
107 )))|(% style="width:421px" %)A collection of values based on [[Codes>>doc:Glossary.Code.WebHome]] and their children.
108 |(% style="width:184px" %) |(% style="width:145px" %)cascadeValues|(% style="width:421px" %)A property to indicate if the child [[Codes>>doc:Glossary.Code.WebHome]] of the selected [[Code>>doc:Glossary.Code.WebHome]] shall be included in the selection. It is also possible to include children and exclude the [[Code>>doc:Glossary.Code.WebHome]] by using the 'excluderoot' value.
109 |(% style="width:184px" %) |(% style="width:145px" %)value|(% style="width:421px" %)The value of the [[Code>>doc:Glossary.Code.WebHome]] to include in the selection. It may include the ‘%’ character as a wildcard.
110 )))
111
112 === 4.3.4 Class Diagram – Geospatial Codelist ===
113
114 The geospatial support is implemented via an extension of the normal //Codelist//. This is illustrated in the following diagrams.
115
116 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_472b895.jpg||height="863" width="466"]]
117
118 **Figure 18: Inheritance for the GeoCodelist**
119
120 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_410255be.jpg||height="405" width="559"]]
121
122 **Figure 19: Class diagram for Geospatial Codelist**
123
124 ==== 4.3.4.1 Narrative ====
125
126 A //GeoCodelist// is a specialisation of Codelist that includes geospatial information, by comprising a set of special [[Codes>>doc:Glossary.Code.WebHome]], i.e., //GeoRefCode//s. A //GeoCodelist// may be implemented by any of the two following classes, via the geoType property:
127
128 GeographicCodelist
129 GeoGridCodelist
130
131 The former, i.e., GeographicCodelist, comprises a set of GeoFeatureSetCodes, by adding a value in the [[Code>>doc:Glossary.Code.WebHome]] that follows a pattern to represent a geo feature set.
132
133 The latter, i.e., GeoGridCodelist, comprises a set of GridCodes, which are related to the gridDefinition specified in the GeoGridCodelist.
134
135 ==== 4.3.4.2 Definitions ====
136
137 (% style="width:760.039px" %)
138 |(% colspan="2" %)**Class**|(% colspan="4" %)**Feature**|**Description**
139 |(% colspan="2" %)//GeoCodelist//|(% colspan="4" %)(((
140 Abstract Class Sub Classes:
141
142 GeographicCodelist GeoGridCodelist geoType
143 )))|(((
144 The abstract class that represents a special type of Codelist, which includes geospatial information.
145
146 The type of Geo Codelist that the Codelist will become.
147 )))
148 |(% colspan="2" %)//GeoRefCode//|(% colspan="4" %)(((
149 Abstract Class Sub Classes:
150 GeoFeatureSet
151 GeoGridCode
152 )))|The abstract class that represents a special type of [[Code>>doc:Glossary.Code.WebHome]], which includes geospatial information.
153 |(% colspan="2" %)GeographicCodelist|(% colspan="4" %) |A special Codelist that has been extended to add a geographical feature set to each of its items, typically, this would include all types of administrative geographies.
154 |(% colspan="2" %)GeoGridCodelist|(% colspan="4" %) |A [[code list>>doc:Glossary.Code list.WebHome]] that has defined a geographical grid composed of cells representing regular squared portions of the Earth.
155 |(% colspan="2" %) |(% colspan="4" %)gridDefinition|Contains a regular expression string corresponding to the grid definition for the GeoGrid Codelist.
156 |(% colspan="2" %)GeoFeatureSetCode|(% colspan="4" %) |A [[Code>>doc:Glossary.Code.WebHome]] that has a geo feature set.
157 |(% colspan="2" %) |(% colspan="4" %)value|The geo feature set of the [[Code>>doc:Glossary.Code.WebHome]], which represents a set of points defining a feature in a format defined a predefined pattern (see section 6).
158 |(% colspan="2" %)GeoGridCode|(% colspan="4" %) |A [[Code>>doc:Glossary.Code.WebHome]] that represents a Geo Grid Cell belonging in a specific grid definition.
159 |(% colspan="2" %) |(% colspan="4" %)geoCell|The value used to assign the [[Code>>doc:Glossary.Code.WebHome]] to one cell in the grid.
160
161 == 4.4 ValueList ==
162
163 === 4.4.1 Class Diagram ===
164
165 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_4d9e301b.jpg||height="695" width="526"]]
166
167 **Figure 20: Class diagram of the ValueList**
168
169 === 4.4.2 Explanation of the Diagram ===
170
171 ==== 4.4.2.1 Narrative ====
172
173 A ValueList inherits from //EnumeratedList// (and hence the //MaintenableArtefact//) and thus has the following [[attributes>>doc:Glossary.Attribute.WebHome]]:
174
175 id
176 uri
177 urn
178 version
179 validFrom
180 validTo
181 isExternalReference
182 registryURL
183 structureURL
184 repositoryURL
185
186 ValueItem inherits from //EnumeratedItem//, which adds an id, with relaxed (% style="color:#e74c3c" %)constraints(%%), to the former.
187
188 Through the inheritance from //NameableArtefact// the ValueList has the association to InternationalString to support a multi-lingual name, an optional multi-lingual description, and an association to [[Annotation>>doc:Glossary.Annotation.WebHome]] to support notes (not shown). Similarly, the ValueItem, inherits the association to InternationalString and to the [[Annotation>>doc:Glossary.Annotation.WebHome]] from the //EnumeratedItem//.
189
190 The ValueList can have one or more ValueItems.
191
192 ==== 4.4.2.2 Definitions ====
193
194 (% style="width:749.039px" %)
195 |**Class**|**Feature**|(% style="width:421px" %)**Description**
196 |ValueList|(((
197 Inherits from
198 //EnumeratedList//
199 )))|(% style="width:421px" %)A list from which some statistical (% style="color:#e74c3c" %)concepts(%%) (enumerated (% style="color:#e74c3c" %)concepts(%%)) take their values.
200 |ValueItem|(((
201 Inherits from
202 //EnumeratedItem//
203 )))|(% style="width:421px" %)A language independent set of letters, numbers or symbols that represent a (% style="color:#e74c3c" %)concept(%%) whose meaning is described in a natural language.
204
205 == 4.5 Concept Scheme and Concepts ==
206
207 === 4.5.1 Class Diagram - Inheritance ===
208
209 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_e6942837.jpg||height="717" width="457"]]
210
211 **Figure 21 Class diagram of the Concept Scheme**
212
213 === 4.5.2 Explanation of the Diagram ===
214
215 The ConceptScheme inherits from the //ItemScheme //and therefore has the following [[attributes>>doc:Glossary.Attribute.WebHome]]:
216
217 id
218 uri
219 urn
220 version
221 validFrom
222 validTo
223 isExternalReference
224 registryURL
225 structureURL
226 repositoryURL
227 isPartial
228
229 (% style="color:#e74c3c" %)Concept(%%) inherits from Item and has the following [[attributes>>doc:Glossary.Attribute.WebHome]]:
230
231 id
232 uri
233 urn
234
235 Through the inheritance from //NameableArtefact// both ConceptScheme and (% style="color:#e74c3c" %)Concept(%%) have the association to InternationalString to support a multi-lingual name, an optional multilingual description, and an association to [[Annotation>>doc:Glossary.Annotation.WebHome]] to support notes (not shown).
236
237 Through the inheritance from //ItemScheme// the ConceptScheme comprise one or more (% style="color:#e74c3c" %)Concepts(%%), and the (% style="color:#e74c3c" %)Concept(%%) itself can have one or more child (% style="color:#e74c3c" %)Concepts(%%) in the (inherited) [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] association. Note that a child (% style="color:#e74c3c" %)Concept(%%) can have only one parent (% style="color:#e74c3c" %)Concept(%%) in this association.
238
239 A partial ConceptScheme (where isPartial is set to “true”) is identical to a ConceptScheme and contains the (% style="color:#e74c3c" %)Concept(%%) and associated names and descriptions, just as in a normal ConceptScheme. However, its content is a subset of the full ConceptScheme. The way this works is described in section 3.5.3.1 on ItemScheme.
240
241 === 4.5.3 Class Diagram Relationship ===
242
243 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_d9b0bdf4.jpg||height="450" width="461"]]
244
245 **Figure 22: Relationship class diagram of the Concept Scheme**
246
247 === 4.5.4 Explanation of the diagram ===
248
249 ==== 4.5.4.1 Narrative ====
250
251 The ConceptScheme can have one or more (% style="color:#e74c3c" %)Concepts(%%). A (% style="color:#e74c3c" %)Concept(%%) can have zero or more child (% style="color:#e74c3c" %)Concepts(%%), thus supporting a [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] of (% style="color:#e74c3c" %)Concepts(%%). Note that a child (% style="color:#e74c3c" %)Concept(%%) can have only one parent (% style="color:#e74c3c" %)Concept(%%) in this association. The purpose of the [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] is to relate (% style="color:#e74c3c" %)concepts(%%) that have a semantic relationship: for example, a Reporting_Country and Vis_a_Vis_Country may both have Country as a parent (% style="color:#e74c3c" %)concept(%%), or a (% style="color:#e74c3c" %)CONTACT(%%) may have a PRIMARY_CONTACT as a child (% style="color:#e74c3c" %)concept(%%). It is not the purpose of such schemes to define reporting structures: these reporting structures are defined in the MetadataStructureDefinition.
252
253 The (% style="color:#e74c3c" %)Concept(%%) can be associated with a coreRepresentation. The coreRepresentation is the specification of the format and value domain of the (% style="color:#e74c3c" %)Concept(%%) when used on a structure like a DataStructureDefinition or a MetadataStructureDefinition, unless the specification of the [[Representation>>doc:Glossary.Representation.WebHome]] is overridden in the relevant structure definition. In a hierarchical ConceptScheme the [[Representation>>doc:Glossary.Representation.WebHome]] is inherited from the parent (% style="color:#e74c3c" %)Concept(%%) unless overridden at the (% style="color:#e74c3c" %)level(%%) of the child (% style="color:#e74c3c" %)Concept(%%).
254
255 The [[Representation>>doc:Glossary.Representation.WebHome]] is documented in more detail in the section on the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Base.
256
257 The (% style="color:#e74c3c" %)Concept(%%) may be related to a (% style="color:#e74c3c" %)concept(%%) described in terms of the ISO/IEC 11179 standard. The ISOConceptReference identifies this (% style="color:#e74c3c" %)concept(%%) and [[concept scheme>>doc:Glossary.Concept scheme.WebHome]] in which it is contained.
258
259 ==== 4.5.4.2 Definitions ====
260
261 (% style="width:765.039px" %)
262 |(% style="width:204px" %)**Class**|(% style="width:222px" %)**Feature**|(% style="width:337px" %)**Description**
263 |(% style="width:204px" %)ConceptScheme|(% style="width:222px" %)(((
264 Inherits from
265 //ItemScheme//
266 )))|(% style="width:337px" %)The descriptive information for an arrangement or division of (% style="color:#e74c3c" %)concepts(%%) into groups based on characteristics, which the objects have in common.
267 |(% style="width:204px" %)(% style="color:#e74c3c" %)Concept|(% style="width:222px" %)(((
268 Inherits from
269 //Item//
270 )))|(% style="width:337px" %)A (% style="color:#e74c3c" %)concept(%%) is a unit of knowledge created by a unique combination of characteristics.
271 |(% style="width:204px" %) |(% style="width:222px" %)/hierarchy|(% style="width:337px" %)Associates the parent and the child (% style="color:#e74c3c" %)concept(%%).
272 |(% style="width:204px" %) |(% style="width:222px" %)coreRepresentation|(% style="width:337px" %)Associates a Representation.
273 |(% style="width:204px" %) |(% style="width:222px" %)+ISOConcept|(% style="width:337px" %)Association to an ISO (% style="color:#e74c3c" %)concept(%%) reference.
274 |(% style="width:204px" %)ISOConceptReference|(% style="width:222px" %) |(% style="width:337px" %)The identity of an ISO (% style="color:#e74c3c" %)concept(%%) definition.
275 |(% style="width:204px" %) |(% style="width:222px" %)conceptAgency|(% style="width:337px" %)The [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]] of the [[concept scheme>>doc:Glossary.Concept scheme.WebHome]] containing the (% style="color:#e74c3c" %)concept(%%).
276 |(% style="width:204px" %) |(% style="width:222px" %)conceptSchemeID|(% style="width:337px" %)The identifier of the [[concept scheme>>doc:Glossary.Concept scheme.WebHome]].
277 |(% style="width:204px" %) |(% style="width:222px" %)conceptID|(% style="width:337px" %)The identifier of the (% style="color:#e74c3c" %)concept(%%).
278
279 == 4.6 Category Scheme ==
280
281 === 4.6.1 Context ===
282
283 This package defines the structure that supports the definition of and relationships between [[categories>>doc:Glossary.Category.WebHome]] in a [[category scheme>>doc:Glossary.Category scheme.WebHome]]. It is similar to the package for [[concept scheme>>doc:Glossary.Concept scheme.WebHome]]. An example of a [[category scheme>>doc:Glossary.Category scheme.WebHome]] is one which categorises data – sometimes known as a subject matter domain scheme or a data [[category scheme>>doc:Glossary.Category scheme.WebHome]]. Importantly, as will be seen later, the individual nodes in the scheme (the “[[categories>>doc:Glossary.Category.WebHome]]”) can be associated to any set of IdentiableArtefacts in a Categorisation.
284
285 === 4.6.2 Class diagram Inheritance ===
286
287 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_3a450acd.jpg||height="776" width="452"]]
288
289 **Figure 23 Inheritance Class diagram of the Category Scheme**
290
291 === 4.6.3 Explanation of the Diagram ===
292
293 ==== 4.6.3.1 Narrative ====
294
295 The [[categories>>doc:Glossary.Category.WebHome]] are modelled as a hierarchical //ItemScheme//. The CategoryScheme inherits from the //ItemScheme// and has the following [[attributes>>doc:Glossary.Attribute.WebHome]]:
296
297 id
298 uri
299 urn
300 version
301 validFrom
302 validTo
303 isExternalReference
304 structureURL
305 serviceURL
306 isPartial
307
308 [[Category>>doc:Glossary.Category.WebHome]] inherits from //Item// and has the following [[attributes>>doc:Glossary.Attribute.WebHome]]:
309
310 id
311 uri
312 urn
313
314 Both CategoryScheme and [[Category>>doc:Glossary.Category.WebHome]] have the association to InternationalString to support a multi-lingual name, an optional multi-lingual description, and an association to [[Annotation>>doc:Glossary.Annotation.WebHome]] to support notes (not shown on the model).
315
316 Through the inheritance the CategoryScheme comprise one or more [[Categorys>>doc:Glossary.Category.WebHome]], and the [[Category>>doc:Glossary.Category.WebHome]] itself can have one or more child [[Category>>doc:Glossary.Category.WebHome]] in the (inherited) [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] association. Note that a child [[Category>>doc:Glossary.Category.WebHome]] can have only one parent [[Category>>doc:Glossary.Category.WebHome]] in this association.
317
318 A partial CategoryScheme (where isPartial is set to “true”) is identical to a CategoryScheme and contains the [[Category>>doc:Glossary.Category.WebHome]] and associated names and descriptions, just as in a normal CategoryScheme. However, its content is a subset of the full CategoryScheme. The way this works is described in section 3.5.3.1 on ItemScheme.
319
320 === 4.6.4 Class diagram Relationship ===
321
322 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_3696e610.jpg||height="407" width="525"]]
323
324 **Figure 24: Relationship Class diagram of the Category Scheme**
325
326 The CategoryScheme can have one or more [[Categorys>>doc:Glossary.Category.WebHome]]. The [[Category>>doc:Glossary.Category.WebHome]] is Identifiable and has identity information. A [[Category>>doc:Glossary.Category.WebHome]] can have zero or more child [[Categorys>>doc:Glossary.Category.WebHome]], thus supporting a [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] of [[Categorys>>doc:Glossary.Category.WebHome]]. Any IdentifiableArtefact can be +categorisedBy a [[Category>>doc:Glossary.Category.WebHome]]. This is achieved by means of a Categorisation. Each Categorisation can associate one IdentifiableArtefact with one [[Category>>doc:Glossary.Category.WebHome]]. Multiple Categorisations can be used to build a set of IdentifiableArtefacts that are +categorisedBy the same [[Category>>doc:Glossary.Category.WebHome]]. Note that there is no navigation (i.e. no embedded reference) to the Categorisation from the [[Category>>doc:Glossary.Category.WebHome]]. From an implementation perspective this is necessary as Categorisation has no affect on the versioning of either the [[Category>>doc:Glossary.Category.WebHome]] or the IdentifiableArtefact.
327
328 ==== 4.6.4.1 Definitions ====
329
330 (% style="width:753.039px" %)
331 |**Class**|(% colspan="2" %)**Feature**|**Description**
332 |CategoryScheme|(% colspan="2" %)(((
333 Inherits from
334 //ItemScheme//
335 )))|The descriptive information for an arrangement or division of [[categories>>doc:Glossary.Category.WebHome]] into groups based on characteristics, which the objects have in common.
336 | |(% colspan="2" %)/items|Associates the [[categories>>doc:Glossary.Category.WebHome]].
337 |Category|(((
338 Inherits from
339 //Item//
340 )))|(% colspan="2" %)An item at any (% style="color:#e74c3c" %)level(%%) within a classification, typically tabulation [[categories>>doc:Glossary.Category.WebHome]], sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses.
341 | |/hierarchy|(% colspan="2" %)Associates the parent and the child [[Category>>doc:Glossary.Category.WebHome]].
342 |Categorisation|(((
343 Inherits from
344 //MaintainableArtefact//
345 )))|(% colspan="2" %)Associates an Identifable [[Artefact>>doc:Glossary.Artefact.WebHome]] with a [[Category>>doc:Glossary.Category.WebHome]].
346 | |+categorisedArtefact|(% colspan="2" %)Associates the Identifable [[Artefact>>doc:Glossary.Artefact.WebHome]].
347 | |+categorisedBy|(% colspan="2" %)Associates the [[Category>>doc:Glossary.Category.WebHome]].
348
349 == 4.7 Organisation Scheme ==
350
351 === 4.7.1 Class Diagram ===
352
353 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_e9f53aa7.jpg||height="470" width="588"]]
354
355 **Figure 25 The Organisation Scheme class diagram**
356
357 === 4.7.2 Explanation of the Diagram ===
358
359 ==== 4.7.2.1 Narrative ====
360
361 The //OrganisationScheme// is abstract. It contains //Organisation// which is also abstract. The //Organisation// can have child //Organisation//.
362
363 The //OrganisationScheme// can be one of five types:
364
365 1. AgencyScheme – contains Agency which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:Glossary.Hierarchy.WebHome]]). Note that the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] system of (Maintenance) Agency can be hierarchic and this is explained in more detail in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”.
366 1. DataProviderScheme – contains DataProvider which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:Glossary.Hierarchy.WebHome]]).
367 1. MetadataProviderScheme – contains MetadataProvider which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:Glossary.Hierarchy.WebHome]]).
368 1. DataConsumerScheme – contains DataConsumer which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:Glossary.Hierarchy.WebHome]]).
369 1. OrganisationUnitScheme – contains OrganisationUnit which does inherit the /[[hierarchy>>doc:Glossary.Hierarchy.WebHome]] association from Organisation.
370
371 [[Reference metadata>>doc:Glossary.Reference metadata.WebHome]] can be attached to the //Organisation// by means of the metadata attachment mechanism. This mechanism is explained in the [[Reference Metadata>>doc:Glossary.Reference metadata.WebHome]] section of this document (see section 7). This means that the model does not specify the specific [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] that can be attached to a DataProvider, MetadataProvider, DataConsumer, OrganisationUnit or Agency, except for limited (% style="color:#e74c3c" %)Contact(%%) information.
372
373 A partial //OrganisationScheme// (where isPartial is set to “true”) is identical to an //OrganisationScheme// and contains the //Organisation// and associated names and descriptions, just as in a normal //OrganisationScheme//. However, its content is a subset of the full //OrganisationScheme//. The way this works is described in section 3.5.3.1 on //ItemScheme//.
374
375 ==== 4.7.2.2 Definitions ====
376
377 (% style="width:763.039px" %)
378 |**Class**|(% style="width:246px" %)**Feature**|(% style="width:336px" %)**Description**
379 |//OrganisationScheme//|(% style="width:246px" %)(((
380 Abstract Class Inherits from
381 //ItemScheme//
382
383 Sub classes are:
384 AgencyScheme
385 DataProviderScheme
386 MetadataProviderScheme DataConsumerScheme
387 OrganisationUnitScheme
388 )))|(% style="width:336px" %)A maintained collection of Organisations.
389 | |(% style="width:246px" %)/items|(% style="width:336px" %)(((
390 Association to the Organisations in the scheme.
391 )))
392 |//Organisation//|(% style="width:246px" %)(((
393 Abstract Class
394 Inherits from //Item//
395
396 Sub classes are:
397 Agency
398 DataProvider
399 MetadataProvider DataConsumer
400 OrganisationUnit
401 )))|(% style="width:336px" %)An organisation is a unique framework of authority within which a person or persons act, or are designated to act, towards some purpose.
402 | |(% style="width:246px" %)+(% style="color:#e74c3c" %)contact|(% style="width:336px" %)Association to the (% style="color:#e74c3c" %)Contact(%%) information.
403 | |(% style="width:246px" %)/hierarchy|(% style="width:336px" %)Association to child Organisations.
404 |(%%)(% style="color:#e74c3c" %)Contact|(% style="width:246px" %) |(% style="width:336px" %)An instance of a role of an individual or an organization (or organization part or organization person) to whom an information item(s), a material object(s) and/or person(s) can be sent to or from in a specified context.
405 | |(% style="width:246px" %)name|(% style="width:336px" %)The designation of the (% style="color:#e74c3c" %)Contact(%%) person by a linguistic expression.
406 | |(% style="width:246px" %)organisationUnit|(% style="width:336px" %)The designation of the organisational structure by a linguistic expression, within which (% style="color:#e74c3c" %)Contact(%%) person works.
407 | |(% style="width:246px" %)responsibility|(% style="width:336px" %)The function of the (% style="color:#e74c3c" %)contact(%%) person with respect to the organisation role for which this person is the (% style="color:#e74c3c" %)Contact(%%).
408 | |(% style="width:246px" %)telephone|(% style="width:336px" %)The [[telephone number>>doc:Glossary.Contact phone number.WebHome]] of the (% style="color:#e74c3c" %)Contact(%%).
409 | |(% style="width:246px" %)fax|(% style="width:336px" %)The fax number of the (% style="color:#e74c3c" %)Contact(%%).
410 | |(% style="width:246px" %)email|(% style="width:336px" %)The Internet e-mail address of the (% style="color:#e74c3c" %)Contact(%%).
411 | |(% style="width:246px" %)X400|(% style="width:336px" %)The X400 address of the (% style="color:#e74c3c" %)Contact(%%).
412 | |(% style="width:246px" %)uri|(% style="width:336px" %)The URL address of the (% style="color:#e74c3c" %)Contact(%%).
413 |AgencyScheme|(% style="width:246px" %) |(% style="width:336px" %)A maintained collection of Maintenance Agencies.
414 | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the [[Maintenance Agency>>doc:Glossary.Maintenance agency.WebHome]] in the scheme.
415 |DataProviderScheme|(% style="width:246px" %) |(% style="width:336px" %)A maintained collection of [[Data Providers>>doc:Glossary.Data provider.WebHome]].
416 | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the [[Data Providers>>doc:Glossary.Data provider.WebHome]] in the scheme.
417 |MetadataProviderScheme|(% style="width:246px" %) |(% style="width:336px" %)A maintained collection of Metadata Providers.
418 | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the Metadata Providers in the scheme.
419 |DataConsumerScheme|(% style="width:246px" %) |(% style="width:336px" %)A maintained collection of [[Data Consumers>>doc:Glossary.Data consumer.WebHome]].
420 | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the [[Data Consumers>>doc:Glossary.Data consumer.WebHome]] in the scheme.
421 |OrganisationUnitScheme|(% style="width:246px" %) |(% style="width:336px" %)A maintained collection of Organisation Units.
422 | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the Organisation Units in the scheme.
423 |Agency|(% style="width:246px" %)(((
424 Inherits from
425 //Organisation//
426 )))|(% style="width:336px" %)Responsible agency for maintaining [[artefacts>>doc:Glossary.Artefact.WebHome]] such as statistical classifications, glossaries, [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] such as Data and [[Metadata Structure Definitions>>doc:Glossary.Metadata structure definition.WebHome]], (% style="color:#e74c3c" %)Concepts(%%) and [[Code>>doc:Glossary.Code.WebHome]] lists.
427 |DataProvider|(% style="width:246px" %)(((
428 Inherits from
429 //Organisation//
430 )))|(% style="width:336px" %)An organisation that produces data.
431 |MetadataProvider|(% style="width:246px" %)(((
432 Inherits from
433 //Organisation//
434 )))|(% style="width:336px" %)An organisation that produces reference metadata.
435 |DataConsumer|(% style="width:246px" %)(((
436 Inherits from
437 //Organisation//
438 )))|(% style="width:336px" %)An organisation using data as input for further processing.
439 |OrganisationUnit|(% style="width:246px" %)(((
440 Inherits from
441 //Organisation//
442 )))|(% style="width:336px" %)A designation in the organisational structure.
443 | |(% style="width:246px" %)/hierarchy|(% style="width:336px" %)Association to child Organisation Units
444
445 == 4.8 Reporting Taxonomy ==
446
447 === 4.8.1 Class Diagram ===
448
449 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_b041cf76.jpg||height="763" width="533"]]
450
451 **Figure 26: Class diagram of the Reporting Taxonomy**
452
453 === 4.8.2 Explanation of the Diagram ===
454
455 ==== 4.8.2.1 Narrative ====
456
457 In some data reporting environments, and in particular those in primary reporting, a report may comprise a variety of heterogeneous data, each described by a different //Structure//. Equally, a specific disseminated or published report may also comprise a variety of heterogeneous data. The definition of the set of linked sub reports is supported by the ReportingTaxonomy.
458
459 The ReportingTaxonomy is a specialised form of //ItemScheme//. Each ReportingCategory of the ReportingTaxonomy can link to one or more //StructureUsage// which itself can be one of [[Dataflow>>doc:Glossary.Dataflow.WebHome]], or [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], and one or more //Structure//, which itself can be one of DataStructureDefinition or MetadataStructureDefinition. It is expected that within a specific ReportingTaxonomy each [[Category>>doc:Glossary.Category.WebHome]] that is linked in this way will be linked to the same class (e.g. all [[Category>>doc:Glossary.Category.WebHome]] in the scheme will link to a [[Dataflow>>doc:Glossary.Dataflow.WebHome]]). Note that a ReportingCategory can have child ReportingCategory and in this way it is possible to define a hierarchical ReportingTaxonomy. It is possible in this taxonomy that some ReportingCategory are defined just to give a reporting structure. For instance:
460
461 Section 1
462
463 1. linked to Datafow_1
464 1. linked to Datafow_2
465
466 Section 2
467
468 1. linked to Datafow_3
469 1. linked to Datafow_4
470
471 Here, the nodes of Section 1 and Section 2 would not be linked to [[Dataflow>>doc:Glossary.Dataflow.WebHome]] but the other would be linked to a [[Dataflow>>doc:Glossary.Dataflow.WebHome]] (and hence the DataStructureDefinition).
472
473 A partial ReportingTaxonomy (where isPartial is set to “true”) is identical to a ReportingTaxonomy and contains the ReportingCategory and associated
474
475 names and descriptions, just as in a normal ReportingTaxonomy. However, its content is a sub set of the full ReportingTaxonomy The way this works is described in section 3.5.3.1 on //ItemScheme//.
476
477 ==== 4.8.2.2 Definitions ====
478
479 (% style="width:759.039px" %)
480 |(% style="width:177px" %)**Class**|(% style="width:152px" %)**Feature**|(% style="width:428px" %)**Description**
481 |(% style="width:177px" %)ReportingTaxonomy|(% style="width:152px" %)(((
482 Inherits from
483 //ItemScheme//
484 )))|(% style="width:428px" %)A scheme which defines the composition structure of a data report where each [[component>>doc:Glossary.Component.WebHome]] can be described by an independent [[Dataflow>>doc:Glossary.Dataflow.WebHome]] or Metadataflow.
485 |(% style="width:177px" %) |(% style="width:152px" %)/items|(% style="width:428px" %)Associates the Reporting Category
486 |(% style="width:177px" %)ReportingCategory|(% style="width:152px" %)(((
487 Inherits from
488 //Item//
489 )))|(% style="width:428px" %)A [[component>>doc:Glossary.Component.WebHome]] that gives structure to the report and links to data and metadata.
490 |(% style="width:177px" %) |(% style="width:152px" %)/hierarchy|(% style="width:428px" %)Associates child Reporting Category.
491 |(% style="width:177px" %) |(% style="width:152px" %)+flow|(% style="width:428px" %)Association to the data and [[metadata flows>>doc:Glossary.Metadataflow.WebHome]] that link to metadata about the provisioning and related data and [[metadata sets>>doc:Glossary.Metadata set.WebHome]], and the structures that define them.
492 |(% style="width:177px" %) |(% style="width:152px" %)+structure|(% style="width:428px" %)(((
493 Association to the [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] and [[Metadata Structure Definitions>>doc:Glossary.Metadata structure definition.WebHome]] which define the [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] describing the data and metadata that are contained at this part of the report.
494 )))
495
496 {{putFootnotes/}}