Wiki source code of 4 Specific Item Schemes
Hide last authors
author | version | line-number | content |
---|---|---|---|
![]() |
13.2 | 1 | {{box title="**Contents**"}} |
2 | {{toc/}} | ||
3 | {{/box}} | ||
![]() |
2.1 | 4 | |
5 | == 4.1 Introduction == | ||
6 | |||
![]() |
16.2 | 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: |
![]() |
2.1 | 8 | |
9 | Codelist | ||
10 | ConceptScheme | ||
11 | CategoryScheme | ||
![]() |
15.2 | 12 | AgencyScheme, DataProviderScheme, MetadataProviderScheme, DataConsumerScheme, OrganisationUnitScheme, which all inherit from the abstract class //OrganisationScheme// |
![]() |
2.1 | 13 | ReportingTaxonomy |
14 | TransformationScheme | ||
15 | RulesetScheme | ||
16 | UserDefinedOperatorScheme | ||
17 | NamePersonalisationScheme | ||
18 | CustomTypeScheme | ||
19 | VtlMappingScheme | ||
20 | |||
![]() |
16.2 | 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). |
![]() |
2.1 | 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 | |||
![]() |
16.2 | 39 | The Codelist inherits from the //ItemScheme// and therefore has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]: |
![]() |
2.1 | 40 | |
![]() |
15.3 | 41 | id |
42 | uri | ||
43 | urn | ||
44 | version | ||
45 | validFrom | ||
46 | validTo | ||
47 | isExternalReference | ||
48 | serviceURL | ||
49 | structureURL | ||
50 | isPartial | ||
51 | |||
![]() |
16.2 | 52 | The [[Code>>doc:xwiki:Glossary.Code.WebHome]] inherits from //Item// and has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]: |
![]() |
2.1 | 53 | |
![]() |
15.3 | 54 | id |
55 | uri | ||
56 | urn | ||
![]() |
2.1 | 57 | |
![]() |
16.2 | 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). |
![]() |
2.1 | 59 | |
![]() |
16.2 | 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. |
![]() |
2.1 | 61 | |
![]() |
16.2 | 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//. |
![]() |
2.1 | 63 | |
64 | ==== 4.3.2.2 Definitions ==== | ||
65 | |||
![]() |
13.2 | 66 | (% style="width:743.039px" %) |
67 | |**Class**|**Feature**|(% style="width:465px" %)**Description** | ||
![]() |
2.1 | 68 | |Codelist|((( |
69 | Inherits from | ||
70 | |||
71 | //ItemScheme// | ||
![]() |
17.2 | 72 | )))|(% style="width:465px" %)A list from which some statistical (% style="color:#2ecc71" %)concepts(%%) (coded (% style="color:#2ecc71" %)concepts(%%)) take their values. |
![]() |
2.1 | 73 | |Code|((( |
74 | Inherits from | ||
75 | |||
76 | Item | ||
![]() |
17.2 | 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. |
![]() |
13.2 | 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. | ||
![]() |
2.1 | 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 | |||
![]() |
16.3 | 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. |
![]() |
2.1 | 90 | |
![]() |
16.3 | 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. |
![]() |
2.1 | 92 | |
93 | ==== 4.3.3.2 Definitions ==== | ||
94 | |||
95 | ((( | ||
![]() |
13.3 | 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. | ||
![]() |
17.2 | 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. | ||
![]() |
13.3 | 103 | |(% style="width:184px" %)MemberValue|(% style="width:145px" %)((( |
![]() |
2.1 | 104 | Inherits from: |
105 | |||
106 | //SelectionValue// | ||
![]() |
17.2 | 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. | ||
![]() |
2.1 | 110 | ))) |
111 | |||
112 | === 4.3.4 Class Diagram – Geospatial Codelist === | ||
113 | |||
![]() |
15.5 | 114 | The geospatial support is implemented via an extension of the normal //Codelist//. This is illustrated in the following diagrams. |
![]() |
2.1 | 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 | |||
![]() |
16.3 | 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: |
![]() |
2.1 | 127 | |
128 | GeographicCodelist | ||
129 | GeoGridCodelist | ||
130 | |||
![]() |
16.3 | 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. |
![]() |
2.1 | 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 | |||
![]() |
13.3 | 137 | (% style="width:760.039px" %) |
![]() |
2.1 | 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, which includes geospatial information. | ||
![]() |
13.3 | 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 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 that has a geo feature set. | ||
157 | |(% colspan="2" %) |(% colspan="4" %)value|The geo feature set of the Code, 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 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 to one cell in the grid. | ||
![]() |
2.1 | 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 | |||
![]() |
16.3 | 173 | A ValueList inherits from //EnumeratedList// (and hence the //MaintenableArtefact//) and thus has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]: |
![]() |
2.1 | 174 | |
![]() |
15.6 | 175 | id |
176 | uri | ||
177 | urn | ||
178 | version | ||
179 | validFrom | ||
180 | validTo | ||
181 | isExternalReference | ||
182 | registryURL | ||
183 | structureURL | ||
184 | repositoryURL | ||
![]() |
2.1 | 185 | |
![]() |
16.3 | 186 | ValueItem inherits from //EnumeratedItem//, which adds an id, with relaxed (% style="color:#2ecc71" %)constraints(%%), to the former. |
![]() |
2.1 | 187 | |
![]() |
16.3 | 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//. |
![]() |
2.1 | 189 | |
190 | The ValueList can have one or more ValueItems. | ||
191 | |||
192 | ==== 4.4.2.2 Definitions ==== | ||
193 | |||
![]() |
14.1 | 194 | (% style="width:749.039px" %) |
195 | |**Class**|**Feature**|(% style="width:421px" %)**Description** | ||
![]() |
2.1 | 196 | |ValueList|((( |
197 | Inherits from | ||
198 | |||
199 | //EnumeratedList// | ||
![]() |
14.1 | 200 | )))|(% style="width:421px" %)A list from which some statistical concepts (enumerated concepts) take their values. |
![]() |
2.1 | 201 | |ValueItem|((( |
202 | Inherits from | ||
203 | |||
204 | //EnumeratedItem// | ||
![]() |
14.1 | 205 | )))|(% style="width:421px" %)A language independent set of letters, numbers or symbols that represent a concept whose meaning is described in a natural language. |
![]() |
2.1 | 206 | |
207 | == 4.5 Concept Scheme and Concepts == | ||
208 | |||
209 | === 4.5.1 Class Diagram - Inheritance === | ||
210 | |||
211 | [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_e6942837.jpg||height="717" width="457"]] | ||
212 | |||
213 | **Figure 21 Class diagram of the Concept Scheme** | ||
214 | |||
215 | === 4.5.2 Explanation of the Diagram === | ||
216 | |||
![]() |
16.3 | 217 | The ConceptScheme inherits from the //ItemScheme //and therefore has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]: |
![]() |
2.1 | 218 | |
![]() |
15.7 | 219 | id |
220 | uri | ||
221 | urn | ||
222 | version | ||
223 | validFrom | ||
224 | validTo | ||
225 | isExternalReference | ||
226 | registryURL | ||
227 | structureURL | ||
228 | repositoryURL | ||
229 | isPartial | ||
![]() |
2.1 | 230 | |
![]() |
16.3 | 231 | (% style="color:#2ecc71" %)Concept(%%) inherits from Item and has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]: |
![]() |
15.7 | 232 | |
233 | id | ||
234 | uri | ||
235 | urn | ||
236 | |||
![]() |
16.3 | 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). |
![]() |
2.1 | 238 | |
![]() |
16.3 | 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. |
![]() |
2.1 | 240 | |
![]() |
16.3 | 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. |
![]() |
2.1 | 242 | |
243 | === 4.5.3 Class Diagram Relationship === | ||
244 | |||
245 | [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_d9b0bdf4.jpg||height="450" width="461"]] | ||
246 | |||
247 | **Figure 22: Relationship class diagram of the Concept Scheme** | ||
248 | |||
249 | === 4.5.4 Explanation of the diagram === | ||
250 | |||
251 | ==== 4.5.4.1 Narrative ==== | ||
252 | |||
![]() |
16.3 | 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. |
![]() |
2.1 | 254 | |
![]() |
16.3 | 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(%%). |
![]() |
2.1 | 256 | |
![]() |
16.3 | 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. |
![]() |
2.1 | 258 | |
![]() |
16.3 | 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. |
![]() |
2.1 | 260 | |
261 | ==== 4.5.4.2 Definitions ==== | ||
262 | |||
![]() |
14.1 | 263 | (% style="width:765.039px" %) |
264 | |(% style="width:204px" %)**Class**|(% style="width:222px" %)**Feature**|(% style="width:337px" %)**Description** | ||
265 | |(% style="width:204px" %)ConceptScheme|(% style="width:222px" %)((( | ||
![]() |
2.1 | 266 | Inherits from |
267 | //ItemScheme// | ||
![]() |
14.1 | 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 | |(% style="width:204px" %)Concept|(% style="width:222px" %)((( | ||
![]() |
2.1 | 270 | Inherits from |
271 | //Item// | ||
![]() |
14.1 | 272 | )))|(% style="width:337px" %)A concept is a unit of knowledge created by a unique combination of characteristics. |
273 | |(% style="width:204px" %) |(% style="width:222px" %)/hierarchy|(% style="width:337px" %)Associates the parent and the child concept. | ||
274 | |(% style="width:204px" %) |(% style="width:222px" %)coreRepresentation|(% style="width:337px" %)Associates a Representation. | ||
275 | |(% style="width:204px" %) |(% style="width:222px" %)+ISOConcept|(% style="width:337px" %)Association to an ISO concept reference. | ||
276 | |(% style="width:204px" %)ISOConceptReference|(% style="width:222px" %) |(% style="width:337px" %)The identity of an ISO concept definition. | ||
277 | |(% style="width:204px" %) |(% style="width:222px" %)conceptAgency|(% style="width:337px" %)The maintenance agency of the concept scheme containing the concept. | ||
278 | |(% style="width:204px" %) |(% style="width:222px" %)conceptSchemeID|(% style="width:337px" %)The identifier of the concept scheme. | ||
279 | |(% style="width:204px" %) |(% style="width:222px" %)conceptID|(% style="width:337px" %)The identifier of the concept. | ||
![]() |
2.1 | 280 | |
281 | == 4.6 Category Scheme == | ||
282 | |||
283 | === 4.6.1 Context === | ||
284 | |||
![]() |
16.3 | 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. |
![]() |
2.1 | 286 | |
287 | === 4.6.2 Class diagram Inheritance === | ||
288 | |||
289 | [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_3a450acd.jpg||height="776" width="452"]] | ||
290 | |||
291 | **Figure 23 Inheritance Class diagram of the Category Scheme** | ||
292 | |||
293 | === 4.6.3 Explanation of the Diagram === | ||
294 | |||
295 | ==== 4.6.3.1 Narrative ==== | ||
296 | |||
![]() |
16.3 | 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]]: |
![]() |
2.1 | 298 | |
![]() |
15.9 | 299 | id |
300 | uri | ||
301 | urn | ||
302 | version | ||
303 | validFrom | ||
304 | validTo | ||
305 | isExternalReference | ||
306 | structureURL | ||
307 | serviceURL | ||
308 | isPartial | ||
![]() |
2.1 | 309 | |
![]() |
16.3 | 310 | [[Category>>doc:xwiki:Glossary.Category.WebHome]] inherits from //Item// and has the following [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]: |
![]() |
2.1 | 311 | |
![]() |
15.9 | 312 | id |
313 | uri | ||
314 | urn | ||
![]() |
2.1 | 315 | |
![]() |
16.3 | 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). |
![]() |
2.1 | 317 | |
![]() |
16.3 | 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. |
![]() |
2.1 | 319 | |
![]() |
16.3 | 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. |
![]() |
2.1 | 321 | |
322 | === 4.6.4 Class diagram Relationship === | ||
323 | |||
324 | [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_3696e610.jpg||height="407" width="525"]] | ||
325 | |||
326 | **Figure 24: Relationship Class diagram of the Category Scheme** | ||
327 | |||
![]() |
16.3 | 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. |
![]() |
2.1 | 329 | |
330 | ==== 4.6.4.1 Definitions ==== | ||
331 | |||
![]() |
14.1 | 332 | (% style="width:753.039px" %) |
![]() |
2.1 | 333 | |**Class**|(% colspan="2" %)**Feature**|**Description** |
334 | |CategoryScheme|(% colspan="2" %)((( | ||
335 | Inherits from | ||
336 | //ItemScheme// | ||
337 | )))|The descriptive information for an arrangement or division of categories into groups based on characteristics, which the objects have in common. | ||
![]() |
13.2 | 338 | | |(% colspan="2" %)/items|Associates the categories. |
![]() |
2.1 | 339 | |Category|((( |
340 | Inherits from | ||
341 | //Item// | ||
342 | )))|(% colspan="2" %)An item at any level within a classification, typically tabulation categories, sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses. | ||
![]() |
13.2 | 343 | | |/hierarchy|(% colspan="2" %)Associates the parent and the child Category. |
![]() |
2.1 | 344 | |Categorisation|((( |
345 | Inherits from | ||
346 | //MaintainableArtefact// | ||
347 | )))|(% colspan="2" %)Associates an Identifable Artefact with a Category. | ||
![]() |
13.2 | 348 | | |+categorisedArtefact|(% colspan="2" %)Associates the Identifable Artefact. |
349 | | |+categorisedBy|(% colspan="2" %)Associates the Category. | ||
![]() |
2.1 | 350 | |
351 | == 4.7 Organisation Scheme == | ||
352 | |||
353 | === 4.7.1 Class Diagram === | ||
354 | |||
355 | [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_e9f53aa7.jpg||height="470" width="588"]] | ||
356 | |||
357 | **Figure 25 The Organisation Scheme class diagram** | ||
358 | |||
359 | === 4.7.2 Explanation of the Diagram === | ||
360 | |||
361 | ==== 4.7.2.1 Narrative ==== | ||
362 | |||
363 | The //OrganisationScheme// is abstract. It contains //Organisation// which is also abstract. The //Organisation// can have child //Organisation//. | ||
364 | |||
365 | The //OrganisationScheme// can be one of five types: | ||
366 | |||
![]() |
16.3 | 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. | ||
![]() |
2.1 | 372 | |
![]() |
16.3 | 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. |
![]() |
2.1 | 374 | |
375 | 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//. | ||
376 | |||
377 | ==== 4.7.2.2 Definitions ==== | ||
378 | |||
![]() |
14.1 | 379 | (% style="width:763.039px" %) |
380 | |**Class**|(% style="width:246px" %)**Feature**|(% style="width:336px" %)**Description** | ||
381 | |//OrganisationScheme//|(% style="width:246px" %)((( | ||
![]() |
2.1 | 382 | Abstract Class Inherits from |
383 | //ItemScheme// | ||
384 | |||
385 | Sub classes are: | ||
386 | AgencyScheme | ||
387 | DataProviderScheme | ||
388 | MetadataProviderScheme DataConsumerScheme | ||
389 | OrganisationUnitScheme | ||
![]() |
14.1 | 390 | )))|(% style="width:336px" %)A maintained collection of Organisations. |
391 | | |(% style="width:246px" %)/items|(% style="width:336px" %)((( | ||
![]() |
16.4 | 392 | Association to the Organisations in the scheme. |
![]() |
2.1 | 393 | ))) |
![]() |
14.1 | 394 | |//Organisation//|(% style="width:246px" %)((( |
![]() |
2.1 | 395 | Abstract Class |
![]() |
15.10 | 396 | Inherits from //Item// |
![]() |
2.1 | 397 | |
398 | Sub classes are: | ||
399 | Agency | ||
400 | DataProvider | ||
401 | MetadataProvider DataConsumer | ||
402 | OrganisationUnit | ||
![]() |
14.1 | 403 | )))|(% 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. |
404 | | |(% style="width:246px" %)+contact|(% style="width:336px" %)Association to the Contact information. | ||
405 | | |(% style="width:246px" %)/hierarchy|(% style="width:336px" %)Association to child Organisations. | ||
406 | |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. | ||
407 | | |(% style="width:246px" %)name|(% style="width:336px" %)The designation of the Contact person by a linguistic expression. | ||
408 | | |(% style="width:246px" %)organisationUnit|(% style="width:336px" %)The designation of the organisational structure by a linguistic expression, within which Contact person works. | ||
409 | | |(% style="width:246px" %)responsibility|(% style="width:336px" %)The function of the contact person with respect to the organisation role for which this person is the Contact. | ||
410 | | |(% style="width:246px" %)telephone|(% style="width:336px" %)The telephone number of the Contact. | ||
411 | | |(% style="width:246px" %)fax|(% style="width:336px" %)The fax number of the Contact. | ||
412 | | |(% style="width:246px" %)email|(% style="width:336px" %)The Internet e-mail address of the Contact. | ||
413 | | |(% style="width:246px" %)X400|(% style="width:336px" %)The X400 address of the Contact. | ||
414 | | |(% style="width:246px" %)uri|(% style="width:336px" %)The URL address of the Contact. | ||
415 | |AgencyScheme|(% style="width:246px" %) |(% style="width:336px" %)A maintained collection of Maintenance Agencies. | ||
416 | | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the Maintenance Agency in the scheme. | ||
417 | |DataProviderScheme|(% style="width:246px" %) |(% style="width:336px" %)A maintained collection of Data Providers. | ||
418 | | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the Data Providers in the scheme. | ||
419 | |MetadataProviderScheme|(% style="width:246px" %) |(% style="width:336px" %)A maintained collection of Metadata Providers. | ||
420 | | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the Metadata Providers in the scheme. | ||
421 | |DataConsumerScheme|(% style="width:246px" %) |(% style="width:336px" %)A maintained collection of Data Consumers. | ||
422 | | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the Data Consumers in the scheme. | ||
423 | |OrganisationUnitScheme|(% style="width:246px" %) |(% style="width:336px" %)A maintained collection of Organisation Units. | ||
424 | | |(% style="width:246px" %)/items|(% style="width:336px" %)Association to the Organisation Units in the scheme. | ||
425 | |Agency|(% style="width:246px" %)((( | ||
![]() |
2.1 | 426 | Inherits from |
427 | //Organisation// | ||
![]() |
14.1 | 428 | )))|(% 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. |
429 | |DataProvider|(% style="width:246px" %)((( | ||
![]() |
2.1 | 430 | Inherits from |
431 | //Organisation// | ||
![]() |
14.1 | 432 | )))|(% style="width:336px" %)An organisation that produces data. |
433 | |MetadataProvider|(% style="width:246px" %)((( | ||
![]() |
2.1 | 434 | Inherits from |
435 | //Organisation// | ||
![]() |
14.1 | 436 | )))|(% style="width:336px" %)An organisation that produces reference metadata. |
437 | |DataConsumer|(% style="width:246px" %)((( | ||
![]() |
2.1 | 438 | Inherits from |
439 | //Organisation// | ||
![]() |
14.1 | 440 | )))|(% style="width:336px" %)An organisation using data as input for further processing. |
441 | |OrganisationUnit|(% style="width:246px" %)((( | ||
![]() |
2.1 | 442 | Inherits from |
![]() |
13.2 | 443 | //Organisation// |
![]() |
14.1 | 444 | )))|(% style="width:336px" %)A designation in the organisational structure. |
445 | | |(% style="width:246px" %)/hierarchy|(% style="width:336px" %)Association to child Organisation Units | ||
![]() |
2.1 | 446 | |
447 | == 4.8 Reporting Taxonomy == | ||
448 | |||
449 | === 4.8.1 Class Diagram === | ||
450 | |||
451 | [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_b041cf76.jpg||height="763" width="533"]] | ||
452 | |||
453 | **Figure 26: Class diagram of the Reporting Taxonomy** | ||
454 | |||
455 | === 4.8.2 Explanation of the Diagram === | ||
456 | |||
457 | ==== 4.8.2.1 Narrative ==== | ||
458 | |||
459 | 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. | ||
460 | |||
![]() |
16.4 | 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: |
![]() |
2.1 | 462 | |
463 | Section 1 | ||
464 | |||
465 | 1. linked to Datafow_1 | ||
466 | 1. linked to Datafow_2 | ||
467 | |||
468 | Section 2 | ||
469 | |||
470 | 1. linked to Datafow_3 | ||
471 | 1. linked to Datafow_4 | ||
472 | |||
![]() |
16.4 | 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). |
![]() |
2.1 | 474 | |
![]() |
16.4 | 475 | A partial ReportingTaxonomy (where isPartial is set to “true”) is identical to a ReportingTaxonomy and contains the ReportingCategory and associated |
![]() |
2.1 | 476 | |
![]() |
16.4 | 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 | |||
![]() |
2.1 | 479 | ==== 4.8.2.2 Definitions ==== |
480 | |||
![]() |
14.1 | 481 | (% style="width:759.039px" %) |
482 | |(% style="width:177px" %)**Class**|(% style="width:152px" %)**Feature**|(% style="width:428px" %)**Description** | ||
483 | |(% style="width:177px" %)ReportingTaxonomy|(% style="width:152px" %)((( | ||
![]() |
2.1 | 484 | Inherits from |
![]() |
13.2 | 485 | //ItemScheme// |
![]() |
14.1 | 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 | |(% style="width:177px" %) |(% style="width:152px" %)/items|(% style="width:428px" %)Associates the Reporting Category | ||
488 | |(% style="width:177px" %)ReportingCategory|(% style="width:152px" %)((( | ||
![]() |
2.1 | 489 | Inherits from |
490 | //Item// | ||
![]() |
14.1 | 491 | )))|(% style="width:428px" %)A component that gives structure to the report and links to data and metadata. |
492 | |(% style="width:177px" %) |(% style="width:152px" %)/hierarchy|(% style="width:428px" %)Associates child Reporting Category. | ||
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 | |(% style="width:177px" %) |(% style="width:152px" %)+structure|(% style="width:428px" %)((( | ||
![]() |
15.1 | 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. |
![]() |
2.1 | 496 | ))) |
![]() |
15.4 | 497 | |
498 | {{putFootnotes/}} |