Changes for page 4 Specific Item Schemes

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

From version 16.2
edited by Helena
on 2025/05/16 22:48
Change comment: There is no comment for this version
To version 14.1
edited by Helena
on 2025/05/15 10:36
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,21 +4,33 @@
4 4  
5 5  == 4.1 Introduction ==
6 6  
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:
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:
8 8  
9 9  Codelist
10 +
10 10  ConceptScheme
12 +
11 11  CategoryScheme
12 -AgencyScheme, DataProviderScheme, MetadataProviderScheme, DataConsumerScheme, OrganisationUnitScheme, which all inherit from the abstract class //OrganisationScheme//
14 +
15 +AgencyScheme, DataProviderScheme, MetadataProviderScheme,
16 +
17 +DataConsumerScheme, OrganisationUnitScheme, which all inherit from the abstract class //OrganisationScheme//
18 +
13 13  ReportingTaxonomy
20 +
14 14  TransformationScheme
22 +
15 15  RulesetScheme
24 +
16 16  UserDefinedOperatorScheme
26 +
17 17  NamePersonalisationScheme
28 +
18 18  CustomTypeScheme
30 +
19 19  VtlMappingScheme
20 20  
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).
33 +Note that the VTL related schemes (the last 6 of the above list) are detailed in a dedicated section below (section 15).
22 22  
23 23  == 4.2 Inheritance View ==
24 24  
... ... @@ -36,30 +36,19 @@
36 36  
37 37  ==== 4.3.2.1 Narrative ====
38 38  
39 -The Codelist inherits from the //ItemScheme// and therefore has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]:
51 +The Codelist inherits from the //ItemScheme// and therefore has the following attributes: id uri urn version validFrom validTo isExternalReference serviceURL structureURL isPartial
40 40  
41 -id
42 -uri
43 -urn
44 -version
45 -validFrom
46 -validTo
47 -isExternalReference
48 -serviceURL
49 -structureURL
50 -isPartial
53 +The Code inherits from //Item// and has the following attributes:
51 51  
52 -The [[Code>>doc:xwiki:Glossary.Code.WebHome]] inherits from //Item// and has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]:
55 +id uri urn
53 53  
54 -id
55 -uri
56 -urn
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).
57 57  
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).
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.
59 59  
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.
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
61 61  
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//.
63 +//ItemScheme//.
63 63  
64 64  ==== 4.3.2.2 Definitions ====
65 65  
... ... @@ -86,12 +86,14 @@
86 86  
87 87  ==== 4.3.3.1 Narrative ====
88 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. Besides that, the prefix property is used to ensure uniqueness of inherited Codes 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 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.
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.
90 90  
91 91  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.
92 92  
93 93  ==== 4.3.3.2 Definitions ====
94 94  
96 +:
97 +
95 95  (((
96 96  (% style="width:753.039px" %)
97 97  |(% style="width:184px" %)**Class**|(% style="width:145px" %)**Feature**|(% style="width:421px" %)**Description**
... ... @@ -111,7 +111,7 @@
111 111  
112 112  === 4.3.4 Class Diagram – Geospatial Codelist ===
113 113  
114 -The geospatial support is implemented via an extension of the normal //Codelist//. This is illustrated in the following diagrams.
117 +The geospatial support is implemented via an extension of the normal ,,Codelist,,. This is illustrated in the following diagrams.
115 115  
116 116  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_472b895.jpg||height="863" width="466"]]
117 117  
... ... @@ -126,6 +126,7 @@
126 126  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:
127 127  
128 128  GeographicCodelist
132 +
129 129  GeoGridCodelist
130 130  
131 131  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.
... ... @@ -147,7 +147,9 @@
147 147  )))
148 148  |(% colspan="2" %)//GeoRefCode//|(% colspan="4" %)(((
149 149  Abstract Class Sub Classes:
154 +
150 150  GeoFeatureSet
156 +
151 151  GeoGridCode
152 152  )))|The abstract class that represents a special type of Code, which includes geospatial information.
153 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.
... ... @@ -172,16 +172,7 @@
172 172  
173 173  A ValueList inherits from //EnumeratedList// (and hence the //MaintenableArtefact//) and thus has the following attributes:
174 174  
175 -id
176 -uri
177 -urn
178 -version
179 -validFrom
180 -validTo
181 -isExternalReference
182 -registryURL
183 -structureURL
184 -repositoryURL
181 +id// //uri// //urn// //version// //validFrom// //validTo// //isExternalReference registryURL structureURL repositoryURL
185 185  
186 186  ValueItem inherits from //EnumeratedItem//, which adds an id, with relaxed constraints, to the former.
187 187  
... ... @@ -214,26 +214,10 @@
214 214  
215 215  === 4.5.2 Explanation of the Diagram ===
216 216  
217 -The ConceptScheme inherits from the //ItemScheme //and therefore has the following attributes:
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:
218 218  
219 -id
220 -uri
221 -urn
222 -version
223 -validFrom
224 -validTo
225 -isExternalReference
226 -registryURL
227 -structureURL
228 -repositoryURL
229 -isPartial
216 +id uri urn
230 230  
231 -Concept inherits from Item and has the following attributes:
232 -
233 -id
234 -uri
235 -urn
236 -
237 237  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).
238 238  
239 239  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.
... ... @@ -264,10 +264,12 @@
264 264  |(% style="width:204px" %)**Class**|(% style="width:222px" %)**Feature**|(% style="width:337px" %)**Description**
265 265  |(% style="width:204px" %)ConceptScheme|(% style="width:222px" %)(((
266 266  Inherits from
248 +
267 267  //ItemScheme//
268 268  )))|(% style="width:337px" %)The descriptive information for an arrangement or division of concepts into groups based on characteristics, which the objects have in common.
269 269  |(% style="width:204px" %)Concept|(% style="width:222px" %)(((
270 270  Inherits from
253 +
271 271  //Item//
272 272  )))|(% style="width:337px" %)A concept is a unit of knowledge created by a unique combination of characteristics.
273 273  |(% style="width:204px" %) |(% style="width:222px" %)/hierarchy|(% style="width:337px" %)Associates the parent and the child concept.
... ... @@ -296,22 +296,11 @@
296 296  
297 297  The categories are modelled as a hierarchical //ItemScheme//. The CategoryScheme inherits from the //ItemScheme// and has the following attributes:
298 298  
299 -id
300 -uri
301 -urn
302 -version
303 -validFrom
304 -validTo
305 -isExternalReference
306 -structureURL
307 -serviceURL
308 -isPartial
282 +id uri urn version validFrom validTo isExternalReference structureURL serviceURL isPartial
309 309  
310 310  Category inherits from //Item// and has the following attributes:
311 311  
312 -id
313 -uri
314 -urn
286 +id uri urn
315 315  
316 316  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).
317 317  
... ... @@ -333,16 +333,19 @@
333 333  |**Class**|(% colspan="2" %)**Feature**|**Description**
334 334  |CategoryScheme|(% colspan="2" %)(((
335 335  Inherits from
308 +
336 336  //ItemScheme//
337 337  )))|The descriptive information for an arrangement or division of categories into groups based on characteristics, which the objects have in common.
338 338  | |(% colspan="2" %)/items|Associates the categories.
339 339  |Category|(((
340 340  Inherits from
314 +
341 341  //Item//
342 342  )))|(% colspan="2" %)An item at any level within a classification, typically tabulation categories, sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses.
343 343  | |/hierarchy|(% colspan="2" %)Associates the parent and the child Category.
344 344  |Categorisation|(((
345 345  Inherits from
320 +
346 346  //MaintainableArtefact//
347 347  )))|(% colspan="2" %)Associates an Identifable Artefact with a Category.
348 348  | |+categorisedArtefact|(% colspan="2" %)Associates the Identifable Artefact.
... ... @@ -380,12 +380,17 @@
380 380  |**Class**|(% style="width:246px" %)**Feature**|(% style="width:336px" %)**Description**
381 381  |//OrganisationScheme//|(% style="width:246px" %)(((
382 382  Abstract Class Inherits from
358 +
383 383  //ItemScheme//
384 384  
385 385  Sub classes are:
362 +
386 386  AgencyScheme
364 +
387 387  DataProviderScheme
366 +
388 388  MetadataProviderScheme DataConsumerScheme
368 +
389 389  OrganisationUnitScheme
390 390  )))|(% style="width:336px" %)A maintained collection of Organisations.
391 391  | |(% style="width:246px" %)/items|(% style="width:336px" %)(((
... ... @@ -395,12 +395,19 @@
395 395  )))
396 396  |//Organisation//|(% style="width:246px" %)(((
397 397  Abstract Class
398 -Inherits from //Item//
399 399  
379 +Inherits from
380 +
381 +//Item//
382 +
400 400  Sub classes are:
384 +
401 401  Agency
386 +
402 402  DataProvider
388 +
403 403  MetadataProvider DataConsumer
390 +
404 404  OrganisationUnit
405 405  )))|(% 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.
406 406  | |(% style="width:246px" %)+contact|(% style="width:336px" %)Association to the Contact information.
... ... @@ -426,22 +426,27 @@
426 426  | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the Organisation Units in the scheme.
427 427  |Agency|(% style="width:246px" %)(((
428 428  Inherits from
416 +
429 429  //Organisation//
430 430  )))|(% 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.
431 431  |DataProvider|(% style="width:246px" %)(((
432 432  Inherits from
421 +
433 433  //Organisation//
434 434  )))|(% style="width:336px" %)An organisation that produces data.
435 435  |MetadataProvider|(% style="width:246px" %)(((
436 436  Inherits from
426 +
437 437  //Organisation//
438 438  )))|(% style="width:336px" %)An organisation that produces reference metadata.
439 439  |DataConsumer|(% style="width:246px" %)(((
440 440  Inherits from
431 +
441 441  //Organisation//
442 442  )))|(% style="width:336px" %)An organisation using data as input for further processing.
443 443  |OrganisationUnit|(% style="width:246px" %)(((
444 444  Inherits from
436 +
445 445  //Organisation//
446 446  )))|(% style="width:336px" %)A designation in the organisational structure.
447 447  | |(% style="width:246px" %)/hierarchy|(% style="width:336px" %)Association to child Organisation Units
... ... @@ -482,17 +482,19 @@
482 482  |(% style="width:177px" %)**Class**|(% style="width:152px" %)**Feature**|(% style="width:428px" %)**Description**
483 483  |(% style="width:177px" %)ReportingTaxonomy|(% style="width:152px" %)(((
484 484  Inherits from
477 +
485 485  //ItemScheme//
486 486  )))|(% 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.
487 487  |(% style="width:177px" %) |(% style="width:152px" %)/items|(% style="width:428px" %)Associates the Reporting Category
488 488  |(% style="width:177px" %)ReportingCategory|(% style="width:152px" %)(((
489 489  Inherits from
483 +
490 490  //Item//
491 491  )))|(% style="width:428px" %)A component that gives structure to the report and links to data and metadata.
492 492  |(% style="width:177px" %) |(% style="width:152px" %)/hierarchy|(% style="width:428px" %)Associates child Reporting Category.
493 493  |(% 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.
494 494  |(% style="width:177px" %) |(% style="width:152px" %)+structure|(% style="width:428px" %)(((
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.
496 -)))
489 +Association to the Data Structure
497 497  
498 -{{putFootnotes/}}
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.
492 +)))