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