Changes for page 4 Specific Item Schemes

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

From version 14.1
edited by Helena
on 2025/05/15 10:36
Change comment: There is no comment for this version
To version 17.2
edited by Helena
on 2025/05/16 23:13
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,33 +4,21 @@
4 4  
5 5  == 4.1 Introduction ==
6 6  
7 -The structures that are an arrangement of objects into hierarchies or lists based on characteristics, and which are maintained as a group inherit from //ItemScheme//. These concrete classes are:
7 +The structures that are an arrangement of objects into [[hierarchies>>doc:xwiki:Glossary.Hierarchy.WebHome]] or lists based on characteristics, and which are maintained as a group inherit from //ItemScheme//. These concrete classes are:
8 8  
9 9  Codelist
10 -
11 11  ConceptScheme
12 -
13 13  CategoryScheme
14 -
15 -AgencyScheme, DataProviderScheme, MetadataProviderScheme,
16 -
17 -DataConsumerScheme, OrganisationUnitScheme, which all inherit from the abstract class //OrganisationScheme//
18 -
12 +AgencyScheme, DataProviderScheme, MetadataProviderScheme, DataConsumerScheme, OrganisationUnitScheme, which all inherit from the abstract class //OrganisationScheme//
19 19  ReportingTaxonomy
20 -
21 21  TransformationScheme
22 -
23 23  RulesetScheme
24 -
25 25  UserDefinedOperatorScheme
26 -
27 27  NamePersonalisationScheme
28 -
29 29  CustomTypeScheme
30 -
31 31  VtlMappingScheme
32 32  
33 -Note that the VTL related schemes (the last 6 of the above list) are detailed in a dedicated section below (section 15).
21 +Note that the [[VTL>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] related schemes (the last 6 of the above list) are detailed in a dedicated section below (section 15).
34 34  
35 35  == 4.2 Inheritance View ==
36 36  
... ... @@ -48,19 +48,30 @@
48 48  
49 49  ==== 4.3.2.1 Narrative ====
50 50  
51 -The Codelist inherits from the //ItemScheme// and therefore has the following attributes: id uri urn version validFrom validTo isExternalReference serviceURL structureURL isPartial
39 +The Codelist inherits from the //ItemScheme// and therefore has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]:
52 52  
53 -The Code inherits from //Item// and has the following attributes:
41 +id
42 +uri
43 +urn
44 +version
45 +validFrom
46 +validTo
47 +isExternalReference
48 +serviceURL
49 +structureURL
50 +isPartial
54 54  
55 -id uri urn
52 +The [[Code>>doc:xwiki:Glossary.Code.WebHome]] inherits from //Item// and has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]:
56 56  
57 -Both Codelist and Code have the association to InternationalString to support a multilingual name, an optional multi-lingual description, and an association to Annotation to support notes (not shown).
54 +id
55 +uri
56 +urn
58 58  
59 -Through the inheritance the Codelist comprise one or more Codes, and the Code itself can have one or more child Codes in the (inherited) hierarchy association. Note that a child Code can have only one parent Code in this association. A more complex Hierarhcy, which allows multiple parents is described later.
58 +Both Codelist and [[Code>>doc:xwiki:Glossary.Code.WebHome]] have the association to InternationalString to support a multilingual name, an optional multi-lingual description, and an association to [[Annotation>>doc:xwiki:Glossary.Annotation.WebHome]] to support notes (not shown).
60 60  
61 -A partial Codelist (where isPartial is set to 'true') is identical to a Codelist and contains the Code 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
60 +Through the inheritance the Codelist comprise one or more [[Codes>>doc:xwiki:Glossary.Code.WebHome]], and the [[Code>>doc:xwiki:Glossary.Code.WebHome]] itself can have one or more child [[Codes>>doc:xwiki:Glossary.Code.WebHome]] in the (inherited) [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] association. Note that a child [[Code>>doc:xwiki:Glossary.Code.WebHome]] can have only one parent [[Code>>doc:xwiki:Glossary.Code.WebHome]] in this association. A more complex Hierarhcy, which allows multiple parents is described later.
62 62  
63 -//ItemScheme//.
62 +A partial Codelist (where isPartial is set to 'true') is identical to a Codelist and contains the [[Code>>doc:xwiki: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//.
64 64  
65 65  ==== 4.3.2.2 Definitions ====
66 66  
... ... @@ -70,12 +70,12 @@
70 70  Inherits from
71 71  
72 72  //ItemScheme//
73 -)))|(% style="width:465px" %)A list from which some statistical concepts (coded concepts) take their values.
72 +)))|(% style="width:465px" %)A list from which some statistical (% style="color:#2ecc71" %)concepts(%%) (coded (% style="color:#2ecc71" %)concepts(%%)) take their values.
74 74  |Code|(((
75 75  Inherits from
76 76  
77 77  Item
78 -)))|(% style="width:465px" %)A language independent set of letters, numbers or symbols that represent a concept whose meaning is described in a natural language.
77 +)))|(% style="width:465px" %)A language independent set of letters, numbers or symbols that represent a (% style="color:#2ecc71" %)concept(%%) whose meaning is described in a natural language.
79 79  | |hierarchy|(% style="width:465px" %)Associates the parent and the child codes.
80 80  | |extends|(% style="width:465px" %)Associates a Codelist with any Codelists that it may extend.
81 81  
... ... @@ -87,34 +87,32 @@
87 87  
88 88  ==== 4.3.3.1 Narrative ====
89 89  
90 -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. Besides that, the prefix property is used to ensure uniqueness of inherited Codes in the extending^^[[(% class="wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^ Codelist in case conflicting Codes 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 from the extended Codelists.
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:xwiki:Glossary.Code.WebHome]]. Besides that, the prefix property is used to ensure uniqueness of inherited [[Codes>>doc:xwiki: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:xwiki: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:xwiki:Glossary.Code.WebHome]] from the extended Codelists.
91 91  
92 -The code selection classes may have MemberValues in order to specify the subset of the Codes that should be included or excluded from the extended Codelist. A MemberValue may have a value that corresponds to a ,,Code,,, including its children ,,Code,,s (via the ,,cascadeValues,, property), or even include instances of the wildcard character ‘%’ in order to point to a set of ,,Code,,s with common parts in their identifiers.
91 +The [[code>>doc:xwiki:Glossary.Code.WebHome]] selection classes may have MemberValues in order to specify the subset of the [[Codes>>doc:xwiki: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:xwiki:Glossary.Code.WebHome]], including its children [[Codes>>doc:xwiki: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:xwiki:Glossary.Code.WebHome]] with common parts in their identifiers.
93 93  
94 94  ==== 4.3.3.2 Definitions ====
95 95  
96 -:
97 -
98 98  (((
99 99  (% style="width:753.039px" %)
100 100  |(% style="width:184px" %)**Class**|(% style="width:145px" %)**Feature**|(% style="width:421px" %)**Description**
101 101  |(% style="width:184px" %)CodelistExtension|(% style="width:145px" %) |(% style="width:421px" %)The association between Codelists that may extend other Codelists.
102 -|(% 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 Conflicts.
103 -|(% style="width:184px" %) |(% style="width:145px" %)sequence|(% style="width:421px" %)The order that will be used when extending a Codelist, for resolving Code conflicts. The latest Codelist used overrides any previous Codelist.
104 -|(% style="width:184px" %)InclusiveCodeSelection|(% style="width:145px" %) |(% style="width:421px" %)The subset of Codes to be included when extending a Codelist.
105 -|(% style="width:184px" %)ExclusiveCodeSelection|(% style="width:145px" %) |(% style="width:421px" %)The subset of Codes to be excluded when extending a Codelist.
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:xwiki: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:xwiki: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:xwiki: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:xwiki:Glossary.Code.WebHome]] to be excluded when extending a Codelist.
106 106  |(% style="width:184px" %)MemberValue|(% style="width:145px" %)(((
107 107  Inherits from:
108 108  
109 109  //SelectionValue//
110 -)))|(% style="width:421px" %)A collection of values based on Codes and their children.
111 -|(% style="width:184px" %) |(% style="width:145px" %)cascadeValues|(% style="width:421px" %)A property to indicate if the child Codes of the selected Code shall be included in the selection. It is also possible to include children and exclude the Code by using the 'excluderoot' value.
112 -|(% style="width:184px" %) |(% style="width:145px" %)value|(% style="width:421px" %)The value of the Code to include in the selection. It may include the ‘%’ character as a wildcard.
107 +)))|(% style="width:421px" %)A collection of values based on [[Codes>>doc:xwiki: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:xwiki:Glossary.Code.WebHome]] of the selected [[Code>>doc:xwiki:Glossary.Code.WebHome]] shall be included in the selection. It is also possible to include children and exclude the [[Code>>doc:xwiki: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:xwiki:Glossary.Code.WebHome]] to include in the selection. It may include the ‘%’ character as a wildcard.
113 113  )))
114 114  
115 115  === 4.3.4 Class Diagram – Geospatial Codelist ===
116 116  
117 -The geospatial support is implemented via an extension of the normal ,,Codelist,,. This is illustrated in the following diagrams.
114 +The geospatial support is implemented via an extension of the normal //Codelist//. This is illustrated in the following diagrams.
118 118  
119 119  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_472b895.jpg||height="863" width="466"]]
120 120  
... ... @@ -126,13 +126,12 @@
126 126  
127 127  ==== 4.3.4.1 Narrative ====
128 128  
129 -A //GeoCodelist// is a specialisation of Codelist that includes geospatial information, by comprising a set of special Codes, i.e., //GeoRefCode//s. A //GeoCodelist// may be implemented by any of the two following classes, via the geoType property:
126 +A //GeoCodelist// is a specialisation of Codelist that includes geospatial information, by comprising a set of special [[Codes>>doc:xwiki:Glossary.Code.WebHome]], i.e., //GeoRefCode//s. A //GeoCodelist// may be implemented by any of the two following classes, via the geoType property:
130 130  
131 131  GeographicCodelist
132 -
133 133  GeoGridCodelist
134 134  
135 -The former, i.e., GeographicCodelist, comprises a set of GeoFeatureSetCodes, by adding a value in the Code that follows a pattern to represent a geo feature set.
131 +The former, i.e., GeographicCodelist, comprises a set of GeoFeatureSetCodes, by adding a value in the [[Code>>doc:xwiki:Glossary.Code.WebHome]] that follows a pattern to represent a geo feature set.
136 136  
137 137  The latter, i.e., GeoGridCodelist, comprises a set of GridCodes, which are related to the gridDefinition specified in the GeoGridCodelist.
138 138  
... ... @@ -151,9 +151,7 @@
151 151  )))
152 152  |(% colspan="2" %)//GeoRefCode//|(% colspan="4" %)(((
153 153  Abstract Class Sub Classes:
154 -
155 155  GeoFeatureSet
156 -
157 157  GeoGridCode
158 158  )))|The abstract class that represents a special type of Code, which includes geospatial information.
159 159  |(% 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.
... ... @@ -176,13 +176,22 @@
176 176  
177 177  ==== 4.4.2.1 Narrative ====
178 178  
179 -A ValueList inherits from //EnumeratedList// (and hence the //MaintenableArtefact//) and thus has the following attributes:
173 +A ValueList inherits from //EnumeratedList// (and hence the //MaintenableArtefact//) and thus has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]:
180 180  
181 -id// //uri// //urn// //version// //validFrom// //validTo// //isExternalReference registryURL structureURL repositoryURL
175 +id
176 +uri
177 +urn
178 +version
179 +validFrom
180 +validTo
181 +isExternalReference
182 +registryURL
183 +structureURL
184 +repositoryURL
182 182  
183 -ValueItem inherits from //EnumeratedItem//, which adds an id, with relaxed constraints, to the former.
186 +ValueItem inherits from //EnumeratedItem//, which adds an id, with relaxed (% style="color:#2ecc71" %)constraints(%%), to the former.
184 184  
185 -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 to support notes (not shown). Similarly, the ValueItem, inherits the association to InternationalString and to the Annotation from the //EnumeratedItem//.
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:xwiki:Glossary.Annotation.WebHome]] to support notes (not shown). Similarly, the ValueItem, inherits the association to InternationalString and to the [[Annotation>>doc:xwiki:Glossary.Annotation.WebHome]] from the //EnumeratedItem//.
186 186  
187 187  The ValueList can have one or more ValueItems.
188 188  
... ... @@ -211,16 +211,32 @@
211 211  
212 212  === 4.5.2 Explanation of the Diagram ===
213 213  
214 -The ConceptScheme inherits from the //ItemScheme //and therefore has the following attributes: id uri urn version validFrom validTo isExternalReference registryURL structureURL repositoryURL isPartial Concept inherits from Item and has the following attributes:
217 +The ConceptScheme inherits from the //ItemScheme //and therefore has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]:
215 215  
216 -id uri urn
219 +id
220 +uri
221 +urn
222 +version
223 +validFrom
224 +validTo
225 +isExternalReference
226 +registryURL
227 +structureURL
228 +repositoryURL
229 +isPartial
217 217  
218 -Through the inheritance from //NameableArtefact// both ConceptScheme and Concept have the association to InternationalString to support a multi-lingual name, an optional multilingual description, and an association to Annotation to support notes (not shown).
231 +(% style="color:#2ecc71" %)Concept(%%) inherits from Item and has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]:
219 219  
220 -Through the inheritance from //ItemScheme// the ConceptScheme comprise one or more Concepts, and the Concept itself can have one or more child Concepts in the (inherited) hierarchy association. Note that a child Concept can have only one parent Concept in this association.
233 +id
234 +uri
235 +urn
221 221  
222 -A partial ConceptScheme (where isPartial is set to “true”) is identical to a ConceptScheme and contains the 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.
237 +Through the inheritance from //NameableArtefact// both ConceptScheme and (% style="color:#2ecc71" %)Concept(%%) have the association to InternationalString to support a multi-lingual name, an optional multilingual description, and an association to [[Annotation>>doc:xwiki:Glossary.Annotation.WebHome]] to support notes (not shown).
223 223  
239 +Through the inheritance from //ItemScheme// the ConceptScheme comprise one or more (% style="color:#2ecc71" %)Concepts(%%), and the (% style="color:#2ecc71" %)Concept(%%) itself can have one or more child (% style="color:#2ecc71" %)Concepts(%%) in the (inherited) [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] association. Note that a child (% style="color:#2ecc71" %)Concept(%%) can have only one parent (% style="color:#2ecc71" %)Concept(%%) in this association.
240 +
241 +A partial ConceptScheme (where isPartial is set to “true”) is identical to a ConceptScheme and contains the (% style="color:#2ecc71" %)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.
242 +
224 224  === 4.5.3 Class Diagram Relationship ===
225 225  
226 226  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_d9b0bdf4.jpg||height="450" width="461"]]
... ... @@ -231,13 +231,13 @@
231 231  
232 232  ==== 4.5.4.1 Narrative ====
233 233  
234 -The ConceptScheme can have one or more Concepts. A Concept can have zero or more child Concepts, thus supporting a hierarchy of Concepts. Note that a child Concept can have only one parent Concept in this association. The purpose of the hierarchy is to relate concepts that have a semantic relationship: for example, a Reporting_Country and Vis_a_Vis_Country may both have Country as a parent concept, or a CONTACT may have a PRIMARY_CONTACT as a child concept. It is not the purpose of such schemes to define reporting structures: these reporting structures are defined in the MetadataStructureDefinition.
253 +The ConceptScheme can have one or more (% style="color:#2ecc71" %)Concepts(%%). A (% style="color:#2ecc71" %)Concept(%%) can have zero or more child (% style="color:#2ecc71" %)Concepts(%%), thus supporting a [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] of (% style="color:#2ecc71" %)Concepts(%%). Note that a child (% style="color:#2ecc71" %)Concept(%%) can have only one parent (% style="color:#2ecc71" %)Concept(%%) in this association. The purpose of the [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] is to relate (% style="color:#2ecc71" %)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:#2ecc71" %)concept(%%), or a (% style="color:#2ecc71" %)CONTACT(%%) may have a PRIMARY_CONTACT as a child (% style="color:#2ecc71" %)concept(%%). It is not the purpose of such schemes to define reporting structures: these reporting structures are defined in the MetadataStructureDefinition.
235 235  
236 -The Concept can be associated with a coreRepresentation. The coreRepresentation is the specification of the format and value domain of the Concept when used on a structure like a DataStructureDefinition or a MetadataStructureDefinition, unless the specification of the Representation is overridden in the relevant structure definition. In a hierarchical ConceptScheme the Representation is inherited from the parent Concept unless overridden at the level of the child Concept.
255 +The (% style="color:#2ecc71" %)Concept(%%) can be associated with a coreRepresentation. The coreRepresentation is the specification of the format and value domain of the (% style="color:#2ecc71" %)Concept(%%) when used on a structure like a DataStructureDefinition or a MetadataStructureDefinition, unless the specification of the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] is overridden in the relevant structure definition. In a hierarchical ConceptScheme the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] is inherited from the parent (% style="color:#2ecc71" %)Concept(%%) unless overridden at the (% style="color:#2ecc71" %)level(%%) of the child (% style="color:#2ecc71" %)Concept(%%).
237 237  
238 -The Representation is documented in more detail in the section on the SDMX Base.
257 +The [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] is documented in more detail in the section on the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base.
239 239  
240 -The Concept may be related to a concept described in terms of the ISO/IEC 11179 standard. The ISOConceptReference identifies this concept and concept scheme in which it is contained.
259 +The (% style="color:#2ecc71" %)Concept(%%) may be related to a (% style="color:#2ecc71" %)concept(%%) described in terms of the ISO/IEC 11179 standard. The ISOConceptReference identifies this (% style="color:#2ecc71" %)concept(%%) and [[concept scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]] in which it is contained.
241 241  
242 242  ==== 4.5.4.2 Definitions ====
243 243  
... ... @@ -245,12 +245,10 @@
245 245  |(% style="width:204px" %)**Class**|(% style="width:222px" %)**Feature**|(% style="width:337px" %)**Description**
246 246  |(% style="width:204px" %)ConceptScheme|(% style="width:222px" %)(((
247 247  Inherits from
248 -
249 249  //ItemScheme//
250 250  )))|(% style="width:337px" %)The descriptive information for an arrangement or division of concepts into groups based on characteristics, which the objects have in common.
251 251  |(% style="width:204px" %)Concept|(% style="width:222px" %)(((
252 252  Inherits from
253 -
254 254  //Item//
255 255  )))|(% style="width:337px" %)A concept is a unit of knowledge created by a unique combination of characteristics.
256 256  |(% style="width:204px" %) |(% style="width:222px" %)/hierarchy|(% style="width:337px" %)Associates the parent and the child concept.
... ... @@ -265,7 +265,7 @@
265 265  
266 266  === 4.6.1 Context ===
267 267  
268 -This package defines the structure that supports the definition of and relationships between categories in a category scheme. It is similar to the package for concept scheme. An example of a category scheme is one which categorises data – sometimes known as a subject matter domain scheme or a data category scheme. Importantly, as will be seen later, the individual nodes in the scheme (the “categories”) can be associated to any set of IdentiableArtefacts in a Categorisation.
285 +This package defines the structure that supports the definition of and relationships between [[categories>>doc:xwiki:Glossary.Category.WebHome]] in a [[category scheme>>doc:xwiki:Glossary.Category scheme.WebHome]]. It is similar to the package for [[concept scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]]. An example of a [[category scheme>>doc:xwiki:Glossary.Category scheme.WebHome]] is one which categorises data – sometimes known as a subject matter domain scheme or a data [[category scheme>>doc:xwiki:Glossary.Category scheme.WebHome]]. Importantly, as will be seen later, the individual nodes in the scheme (the “[[categories>>doc:xwiki:Glossary.Category.WebHome]]”) can be associated to any set of IdentiableArtefacts in a Categorisation.
269 269  
270 270  === 4.6.2 Class diagram Inheritance ===
271 271  
... ... @@ -277,19 +277,30 @@
277 277  
278 278  ==== 4.6.3.1 Narrative ====
279 279  
280 -The categories are modelled as a hierarchical //ItemScheme//. The CategoryScheme inherits from the //ItemScheme// and has the following attributes:
297 +The [[categories>>doc:xwiki:Glossary.Category.WebHome]] are modelled as a hierarchical //ItemScheme//. The CategoryScheme inherits from the //ItemScheme// and has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]:
281 281  
282 -id uri urn version validFrom validTo isExternalReference structureURL serviceURL isPartial
299 +id
300 +uri
301 +urn
302 +version
303 +validFrom
304 +validTo
305 +isExternalReference
306 +structureURL
307 +serviceURL
308 +isPartial
283 283  
284 -Category inherits from //Item// and has the following attributes:
310 +[[Category>>doc:xwiki:Glossary.Category.WebHome]] inherits from //Item// and has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]:
285 285  
286 -id uri urn
312 +id
313 +uri
314 +urn
287 287  
288 -Both CategoryScheme and Category have the association to InternationalString to support a multi-lingual name, an optional multi-lingual description, and an association to Annotation to support notes (not shown on the model).
316 +Both CategoryScheme and [[Category>>doc:xwiki: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:xwiki:Glossary.Annotation.WebHome]] to support notes (not shown on the model).
289 289  
290 -Through the inheritance the CategoryScheme comprise one or more Categorys, and the Category itself can have one or more child Category in the (inherited) hierarchy association. Note that a child Category can have only one parent Category in this association.
318 +Through the inheritance the CategoryScheme comprise one or more [[Categorys>>doc:xwiki:Glossary.Category.WebHome]], and the [[Category>>doc:xwiki:Glossary.Category.WebHome]] itself can have one or more child [[Category>>doc:xwiki:Glossary.Category.WebHome]] in the (inherited) [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] association. Note that a child [[Category>>doc:xwiki:Glossary.Category.WebHome]] can have only one parent [[Category>>doc:xwiki:Glossary.Category.WebHome]] in this association.
291 291  
292 -A partial CategoryScheme (where isPartial is set to “true”) is identical to a CategoryScheme and contains the Category 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.
320 +A partial CategoryScheme (where isPartial is set to “true”) is identical to a CategoryScheme and contains the [[Category>>doc:xwiki: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.
293 293  
294 294  === 4.6.4 Class diagram Relationship ===
295 295  
... ... @@ -297,7 +297,7 @@
297 297  
298 298  **Figure 24: Relationship Class diagram of the Category Scheme**
299 299  
300 -The CategoryScheme can have one or more Categorys. The Category is Identifiable and has identity information. A Category can have zero or more child Categorys, thus supporting a hierarchy of Categorys. Any IdentifiableArtefact can be +categorisedBy a Category. This is achieved by means of a Categorisation. Each Categorisation can associate one IdentifiableArtefact with one Category. Multiple Categorisations can be used to build a set of IdentifiableArtefacts that are +categorisedBy the same Category. Note that there is no navigation (i.e. no embedded reference) to the Categorisation from the Category. From an implementation perspective this is necessary as Categorisation has no affect on the versioning of either the Category or the IdentifiableArtefact.
328 +The CategoryScheme can have one or more [[Categorys>>doc:xwiki:Glossary.Category.WebHome]]. The [[Category>>doc:xwiki:Glossary.Category.WebHome]] is Identifiable and has identity information. A [[Category>>doc:xwiki:Glossary.Category.WebHome]] can have zero or more child [[Categorys>>doc:xwiki:Glossary.Category.WebHome]], thus supporting a [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] of [[Categorys>>doc:xwiki:Glossary.Category.WebHome]]. Any IdentifiableArtefact can be +categorisedBy a [[Category>>doc:xwiki:Glossary.Category.WebHome]]. This is achieved by means of a Categorisation. Each Categorisation can associate one IdentifiableArtefact with one [[Category>>doc:xwiki:Glossary.Category.WebHome]]. Multiple Categorisations can be used to build a set of IdentifiableArtefacts that are +categorisedBy the same [[Category>>doc:xwiki:Glossary.Category.WebHome]]. Note that there is no navigation (i.e. no embedded reference) to the Categorisation from the [[Category>>doc:xwiki:Glossary.Category.WebHome]]. From an implementation perspective this is necessary as Categorisation has no affect on the versioning of either the [[Category>>doc:xwiki:Glossary.Category.WebHome]] or the IdentifiableArtefact.
301 301  
302 302  ==== 4.6.4.1 Definitions ====
303 303  
... ... @@ -305,19 +305,16 @@
305 305  |**Class**|(% colspan="2" %)**Feature**|**Description**
306 306  |CategoryScheme|(% colspan="2" %)(((
307 307  Inherits from
308 -
309 309  //ItemScheme//
310 310  )))|The descriptive information for an arrangement or division of categories into groups based on characteristics, which the objects have in common.
311 311  | |(% colspan="2" %)/items|Associates the categories.
312 312  |Category|(((
313 313  Inherits from
314 -
315 315  //Item//
316 316  )))|(% colspan="2" %)An item at any level within a classification, typically tabulation categories, sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses.
317 317  | |/hierarchy|(% colspan="2" %)Associates the parent and the child Category.
318 318  |Categorisation|(((
319 319  Inherits from
320 -
321 321  //MaintainableArtefact//
322 322  )))|(% colspan="2" %)Associates an Identifable Artefact with a Category.
323 323  | |+categorisedArtefact|(% colspan="2" %)Associates the Identifable Artefact.
... ... @@ -339,13 +339,13 @@
339 339  
340 340  The //OrganisationScheme// can be one of five types:
341 341  
342 -1. AgencyScheme – contains Agency which is restricted to a flat list of agencies (i.e., there is no hierarchy). Note that the SDMX system of (Maintenance) Agency can be hierarchic and this is explained in more detail in the SDMX Standards Section 6 “Technical Notes”.
343 -1. DataProviderScheme – contains DataProvider which is restricted to a flat list of agencies (i.e., there is no hierarchy).
344 -1. MetadataProviderScheme – contains MetadataProvider which is restricted to a flat list of agencies (i.e., there is no hierarchy).
345 -1. DataConsumerScheme – contains DataConsumer which is restricted to a flat list of agencies (i.e., there is no hierarchy).
346 -1. OrganisationUnitScheme – contains OrganisationUnit which does inherit the /hierarchy association from Organisation.
367 +1. AgencyScheme – contains Agency which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]]). Note that the [[SDMX>>doc:xwiki: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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”.
368 +1. DataProviderScheme – contains DataProvider which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]]).
369 +1. MetadataProviderScheme – contains MetadataProvider which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]]).
370 +1. DataConsumerScheme – contains DataConsumer which is restricted to a flat list of agencies (i.e., there is no [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]]).
371 +1. OrganisationUnitScheme – contains OrganisationUnit which does inherit the /[[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] association from Organisation.
347 347  
348 -Reference metadata can be attached to the //Organisation// by means of the metadata attachment mechanism. This mechanism is explained in the Reference Metadata section of this document (see section 7). This means that the model does not specify the specific reference metadata that can be attached to a DataProvider, MetadataProvider, DataConsumer, OrganisationUnit or Agency, except for limited Contact information.
373 +[[Reference metadata>>doc:xwiki: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:xwiki:Glossary.Reference metadata.WebHome]] section of this document (see section 7). This means that the model does not specify the specific [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] that can be attached to a DataProvider, MetadataProvider, DataConsumer, OrganisationUnit or Agency, except for limited (% style="color:#2ecc71" %)Contact(%%) information.
349 349  
350 350  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//.
351 351  
... ... @@ -355,39 +355,25 @@
355 355  |**Class**|(% style="width:246px" %)**Feature**|(% style="width:336px" %)**Description**
356 356  |//OrganisationScheme//|(% style="width:246px" %)(((
357 357  Abstract Class Inherits from
358 -
359 359  //ItemScheme//
360 360  
361 361  Sub classes are:
362 -
363 363  AgencyScheme
364 -
365 365  DataProviderScheme
366 -
367 367  MetadataProviderScheme DataConsumerScheme
368 -
369 369  OrganisationUnitScheme
370 370  )))|(% style="width:336px" %)A maintained collection of Organisations.
371 371  | |(% style="width:246px" %)/items|(% style="width:336px" %)(((
372 -Association to the
373 -
374 -Organisations in the scheme.
392 +Association to the Organisations in the scheme.
375 375  )))
376 376  |//Organisation//|(% style="width:246px" %)(((
377 377  Abstract Class
396 +Inherits from //Item//
378 378  
379 -Inherits from
380 -
381 -//Item//
382 -
383 383  Sub classes are:
384 -
385 385  Agency
386 -
387 387  DataProvider
388 -
389 389  MetadataProvider DataConsumer
390 -
391 391  OrganisationUnit
392 392  )))|(% 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.
393 393  | |(% style="width:246px" %)+contact|(% style="width:336px" %)Association to the Contact information.
... ... @@ -413,27 +413,22 @@
413 413  | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the Organisation Units in the scheme.
414 414  |Agency|(% style="width:246px" %)(((
415 415  Inherits from
416 -
417 417  //Organisation//
418 418  )))|(% style="width:336px" %)Responsible agency for maintaining artefacts such as statistical classifications, glossaries, structural metadata such as Data and Metadata Structure Definitions, Concepts and Code lists.
419 419  |DataProvider|(% style="width:246px" %)(((
420 420  Inherits from
421 -
422 422  //Organisation//
423 423  )))|(% style="width:336px" %)An organisation that produces data.
424 424  |MetadataProvider|(% style="width:246px" %)(((
425 425  Inherits from
426 -
427 427  //Organisation//
428 428  )))|(% style="width:336px" %)An organisation that produces reference metadata.
429 429  |DataConsumer|(% style="width:246px" %)(((
430 430  Inherits from
431 -
432 432  //Organisation//
433 433  )))|(% style="width:336px" %)An organisation using data as input for further processing.
434 434  |OrganisationUnit|(% style="width:246px" %)(((
435 435  Inherits from
436 -
437 437  //Organisation//
438 438  )))|(% style="width:336px" %)A designation in the organisational structure.
439 439  | |(% style="width:246px" %)/hierarchy|(% style="width:336px" %)Association to child Organisation Units
... ... @@ -452,7 +452,7 @@
452 452  
453 453  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.
454 454  
455 -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, or Metadataflow, and one or more //Structure//, which itself can be one of DataStructureDefinition or MetadataStructureDefinition. It is expected that within a specific ReportingTaxonomy each Category that is linked in this way will be linked to the same class (e.g. all Category in the scheme will link to a Dataflow). 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:
461 +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:xwiki:Glossary.Dataflow.WebHome]], or [[Metadataflow>>doc:xwiki: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:xwiki:Glossary.Category.WebHome]] that is linked in this way will be linked to the same class (e.g. all [[Category>>doc:xwiki:Glossary.Category.WebHome]] in the scheme will link to a [[Dataflow>>doc:xwiki: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:
456 456  
457 457  Section 1
458 458  
... ... @@ -464,10 +464,12 @@
464 464  1. linked to Datafow_3
465 465  1. linked to Datafow_4
466 466  
467 -Here, the nodes of Section 1 and Section 2 would not be linked to Dataflow but the other would be linked to a Dataflow (and hence the DataStructureDefinition).
473 +Here, the nodes of Section 1 and Section 2 would not be linked to [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] but the other would be linked to a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] (and hence the DataStructureDefinition).
468 468  
469 -A partial ReportingTaxonomy (where isPartial is set to “true”) is identical to a ReportingTaxonomy and contains the ReportingCategory and associated 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//.
475 +A partial ReportingTaxonomy (where isPartial is set to “true”) is identical to a ReportingTaxonomy and contains the ReportingCategory and associated
470 470  
477 +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//.
478 +
471 471  ==== 4.8.2.2 Definitions ====
472 472  
473 473  (% style="width:759.039px" %)
... ... @@ -474,19 +474,17 @@
474 474  |(% style="width:177px" %)**Class**|(% style="width:152px" %)**Feature**|(% style="width:428px" %)**Description**
475 475  |(% style="width:177px" %)ReportingTaxonomy|(% style="width:152px" %)(((
476 476  Inherits from
477 -
478 478  //ItemScheme//
479 479  )))|(% style="width:428px" %)A scheme which defines the composition structure of a data report where each component can be described by an independent Dataflow or Metadataflow.
480 480  |(% style="width:177px" %) |(% style="width:152px" %)/items|(% style="width:428px" %)Associates the Reporting Category
481 481  |(% style="width:177px" %)ReportingCategory|(% style="width:152px" %)(((
482 482  Inherits from
483 -
484 484  //Item//
485 485  )))|(% style="width:428px" %)A component that gives structure to the report and links to data and metadata.
486 486  |(% style="width:177px" %) |(% style="width:152px" %)/hierarchy|(% style="width:428px" %)Associates child Reporting Category.
487 487  |(% style="width:177px" %) |(% style="width:152px" %)+flow|(% style="width:428px" %)Association to the data and metadata flows that link to metadata about the provisioning and related data and metadata sets, and the structures that define them.
488 488  |(% style="width:177px" %) |(% style="width:152px" %)+structure|(% style="width:428px" %)(((
489 -Association to the Data Structure
490 -
491 -Definition and Metadata Structure Definitions which define the structural metadata describing the data and metadata that are contained at this part of the report.
495 +Association to the Data Structure Definition and Metadata Structure Definitions which define the structural metadata describing the data and metadata that are contained at this part of the report.
492 492  )))
497 +
498 +{{putFootnotes/}}