Wiki source code of 4 Specific Item Schemes
Last modified by Artur on 2025/07/14 10:19
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | {{box title="**Contents**"}} | ||
2 | {{toc/}} | ||
3 | {{/box}} | ||
4 | |||
5 | == {{id name="_Toc370987"/}}4.1 Introduction == | ||
6 | |||
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: | ||
8 | |||
9 | * Codelist | ||
10 | * ConceptScheme | ||
11 | * CategoryScheme | ||
12 | * AgencyScheme, DataProviderScheme, DataConsumerScheme, OrganisationUnitScheme which all inherit from the abstract class //OrganisationScheme// | ||
13 | * Reporting Taxonomy | ||
14 | |||
15 | == {{id name="_Toc370988"/}}4.2 Inheritance View == | ||
16 | |||
17 | The inheritance and relationship views are shown together in each of the diagrams in the specific sections below. | ||
18 | |||
19 | == {{id name="_Toc370989"/}}4.3 Codelist == | ||
20 | |||
21 | === {{id name="_Toc370990"/}}4.3.1 Class Diagram === | ||
22 | |||
23 | [[image:1747732337979-971.png]] | ||
24 | |||
25 | **Figure 15 Class diagram of the Codelist** | ||
26 | |||
27 | === {{id name="_Toc370991"/}}4.3.2 Explanation of the Diagram === | ||
28 | |||
29 | ==== 4.3.2.1 Narrative ==== | ||
30 | |||
31 | The Codelist inherits from the //ItemScheme// and therefore has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
32 | |||
33 | * id | ||
34 | * uri | ||
35 | * urn | ||
36 | * version | ||
37 | * validFrom | ||
38 | * validTo | ||
39 | * isExternalReference | ||
40 | * serviceURL | ||
41 | * structureURL | ||
42 | * final | ||
43 | * isPartial | ||
44 | |||
45 | The [[Code>>doc:sdmx:Glossary.Code.WebHome]] inherits from //Item// and has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
46 | |||
47 | * id | ||
48 | * uri | ||
49 | * urn | ||
50 | |||
51 | Both Codelist and [[Code>>doc:sdmx:Glossary.Code.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). | ||
52 | |||
53 | 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 HierachicalCodelist which allow multiple parents and multiple [[hierarchies>>doc:sdmx:Glossary.Hierarchy.WebHome]] is described later. | ||
54 | |||
55 | 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 [[code list>>doc:sdmx:Glossary.Code list.WebHome]]. However, its content is a sub set of the full Codelist. The way this works is described in section 3.5.3.1 on //ItemScheme//. | ||
56 | |||
57 | ==== 4.3.2.2 Definitions ==== | ||
58 | |||
59 | ((( | ||
60 | (% style="width:905.294px" %) | ||
61 | |(% style="width:132px" %)**Class**|(% style="width:172px" %)**Feature**|(% style="width:598px" %)**Description** | ||
62 | |(% style="width:132px" %)Codelist|(% style="width:172px" %)((( | ||
63 | Inherits from | ||
64 | //ItemScheme// | ||
65 | )))|(% style="width:598px" %)A list from which some statistical (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) (coded (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%)) take their values. | ||
66 | |(% style="width:132px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]|(% style="width:172px" %)((( | ||
67 | Inherits from | ||
68 | //Item// | ||
69 | )))|(% style="width:598px" %)A language independent set of letters, numbers or symbols that represent a (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) whose meaning is described in a natural language. | ||
70 | |(% style="width:132px" %) |(% style="width:172px" %)/hierarchy|(% style="width:598px" %)Associates the parent and the child [[codes>>doc:sdmx:Glossary.Code.WebHome]]. | ||
71 | ))) | ||
72 | |||
73 | == {{id name="_Toc370992"/}}4.4 Concept Scheme and Concepts == | ||
74 | |||
75 | === {{id name="_Toc370993"/}}4.4.1 Class Diagram - Inheritance === | ||
76 | |||
77 | [[image:1747732287949-594.png]] | ||
78 | |||
79 | **Figure 16 Class diagram of the Concept Scheme** | ||
80 | |||
81 | === {{id name="_Toc370994"/}}4.4.2 Explanation of the Diagram === | ||
82 | |||
83 | The ConceptScheme inherits from the //ItemScheme //and therefore has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
84 | |||
85 | * id | ||
86 | * uri | ||
87 | * urn | ||
88 | * version | ||
89 | * validFrom | ||
90 | * validTo | ||
91 | * isExternalReference | ||
92 | * registryURL | ||
93 | * structureURL | ||
94 | * repositoryURL | ||
95 | * final | ||
96 | * isPartial | ||
97 | |||
98 | (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) inherits from Item and has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
99 | |||
100 | * id | ||
101 | * uri | ||
102 | * urn | ||
103 | |||
104 | Through the inheritance from //NameableArtefact// both ConceptScheme and (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.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). | ||
105 | |||
106 | Through the inheritance from //ItemScheme// the ConceptScheme comprise one or more (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%), and the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) itself can have one or more child (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) in the (inherited) [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] association. Note that a child (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) can have only one parent (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) in this association. | ||
107 | |||
108 | A partial ConceptScheme (where isPartial is set to “true”) is identical to a ConceptScheme and contains the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) and associated names and descriptions, just as in a normal ConceptScheme. However, its content is a sub set of the full ConceptScheme. | ||
109 | |||
110 | The way this works is described in section 3.5.3.1 on ItemScheme. | ||
111 | |||
112 | === {{id name="_Toc370995"/}}4.4.3 Class Diagram - Relationship === | ||
113 | |||
114 | [[image:1747732242162-856.png]] | ||
115 | |||
116 | **Figure 17: Relationship class diagram of the [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]** | ||
117 | |||
118 | === {{id name="_Toc370996"/}}4.4.4 Explanation of the diagram === | ||
119 | |||
120 | ==== 4.4.4.1 Narrative ==== | ||
121 | |||
122 | The ConceptScheme can have one or more (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%). A (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) can have zero or more child (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%), thus supporting a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%). Note that a child (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) can have only one parent (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) in this association. The purpose of the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] is to relate (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) 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>>doc:sdmx:Glossary.Concept.WebHome]](%%), or a [[CONTACT >>doc:Glossary.Contact.WebHome]]may have a PRIMARY_CONTACT as a child (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%). It is not the purpose of such schemes to define reporting structures: these reporting structures are defined in the MetadataStructureDefinition. | ||
123 | |||
124 | The (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) can be associated with a coreRepresentation. The coreRepresentation isthe specification of the format and value domain of the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) 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>>doc:sdmx:Glossary.Concept.WebHome]](%%) unless overridden at the [[level>>doc:Glossary.Level.WebHome]] of the child (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%). | ||
125 | |||
126 | Note that the ConceptScheme is used as the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] of the MeasureDimension in a DataStructureDefinition (see 5.3.2). Each (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) in this ConceptScheme is a specific [[measure>>doc:sdmx:Glossary.Measure.WebHome]], each of which can be given a coreRepresentation. Thus the valid format of the observation for each [[measure>>doc:sdmx:Glossary.Measure.WebHome]] when reported in a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] for the MeasureDimension is specified in the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%). This allows a different format for each [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. This is covered in more detail in 5.3. | ||
127 | |||
128 | 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. | ||
129 | |||
130 | The (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) may be related to a (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) described in terms of the ISO/IEC 11179 standard. The ISOConceptReference identifies this (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) and [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] in which it is contained. | ||
131 | |||
132 | ==== 4.4.4.2 Definitions ==== | ||
133 | |||
134 | ((( | ||
135 | (% style="width:931.294px" %) | ||
136 | |(% style="width:195px" %)**Class**|(% style="width:210px" %)**Feature**|(% style="width:522px" %)**Description** | ||
137 | |(% style="width:195px" %)ConceptScheme|(% style="width:210px" %)((( | ||
138 | Inherits from | ||
139 | |||
140 | //ItemScheme// | ||
141 | )))|(% style="width:522px" %)The descriptive information for an arrangement or division of (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) into groups based on characteristics, which the objects have in common. | ||
142 | |(% style="width:195px" %)(% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]]|(% style="width:210px" %)((( | ||
143 | Inherits from | ||
144 | |||
145 | //Item// | ||
146 | )))|(% style="width:522px" %)A (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) is a unit of knowledge created by a unique combination of characteristics. | ||
147 | |(% style="width:195px" %) |(% style="width:210px" %)/hierarchy|(% style="width:522px" %)Associates the parent and the child (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%). | ||
148 | |(% style="width:195px" %) |(% style="width:210px" %)coreRepresentation|(% style="width:522px" %)Associates a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
149 | |(% style="width:195px" %) |(% style="width:210px" %)+ISOConcept|(% style="width:522px" %)Association to an ISO (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) reference. | ||
150 | |(% style="width:195px" %)ISOConceptReference|(% style="width:210px" %) |(% style="width:522px" %)The identity of an ISO (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) definition. | ||
151 | |(% style="width:195px" %) |(% style="width:210px" %)conceptAgency|(% style="width:522px" %)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>>doc:sdmx:Glossary.Concept.WebHome]](%%). | ||
152 | |(% style="width:195px" %) |(% style="width:210px" %)conceptSchemeID|(% style="width:522px" %)The identifier of the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]. | ||
153 | |(% style="width:195px" %) |(% style="width:210px" %)conceptID|(% style="width:522px" %)The identifier of the (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%). | ||
154 | ))) | ||
155 | |||
156 | == {{id name="_Toc370997"/}}4.5 Category Scheme == | ||
157 | |||
158 | === {{id name="_Toc370998"/}}4.5.1 Context === | ||
159 | |||
160 | 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. | ||
161 | |||
162 | === {{id name="_Toc370999"/}}4.5.2 Class diagram - Inheritance === | ||
163 | |||
164 | (% class="wikigeneratedid" id="H" %) | ||
165 | [[image:1747732448450-721.png]] | ||
166 | |||
167 | (% class="wikigeneratedid" id="HFigure18InheritanceClassdiagramoftheCategoryScheme" %) | ||
168 | **Figure 18 Inheritance Class diagram of the [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]** | ||
169 | |||
170 | === {{id name="_Toc371000"/}}4.5.3 Explanation of the Diagram === | ||
171 | |||
172 | ==== 4.5.3.1 Narrative ==== | ||
173 | |||
174 | 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]]: | ||
175 | |||
176 | * id | ||
177 | * uri | ||
178 | * urn | ||
179 | * version | ||
180 | * validFrom | ||
181 | * validTo | ||
182 | * isExternalReference | ||
183 | * structureURL | ||
184 | * serviceURL | ||
185 | * final | ||
186 | * isPartial | ||
187 | |||
188 | [[Category>>doc:sdmx:Glossary.Category.WebHome]] inherits from //Item// and has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
189 | |||
190 | * //id// | ||
191 | * //uri// | ||
192 | * //urn// | ||
193 | |||
194 | 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). | ||
195 | |||
196 | 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. | ||
197 | |||
198 | 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 sub set of the full CategoryScheme. The way this works is described in section 3.5.3.1 on ItemScheme. | ||
199 | |||
200 | === {{id name="_Toc371001"/}}4.5.4 Class diagram - Relationship === | ||
201 | |||
202 | [[image:1747732486733-495.png]] | ||
203 | |||
204 | **Figure 19: Relationship Class diagram of the [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]** | ||
205 | |||
206 | 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 affect on the versioning of either the [[Category>>doc:sdmx:Glossary.Category.WebHome]] or the IdentifiableArtefact. | ||
207 | |||
208 | ==== 4.5.4.1 Definitions ==== | ||
209 | |||
210 | ((( | ||
211 | (% style="width:965.294px" %) | ||
212 | |(% style="width:171px" %)**Class**|(% style="width:213px" %)**Feature**|(% style="width:577px" %)**Description** | ||
213 | |(% style="width:171px" %)CategoryScheme|(% style="width:213px" %)((( | ||
214 | Inherits from | ||
215 | //ItemScheme// | ||
216 | )))|(% style="width:577px" %)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. | ||
217 | |(% style="width:171px" %) |(% style="width:213px" %)/items|(% style="width:577px" %)Associates the [[categories>>doc:sdmx:Glossary.Category.WebHome]]. | ||
218 | |(% style="width:171px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]|(% style="width:213px" %)((( | ||
219 | Inherits from | ||
220 | //Item// | ||
221 | )))|(% style="width:577px" %)An item at any [[level>>doc:Glossary.Level.WebHome]] within a classification, typically tabulation [[categories>>doc:sdmx:Glossary.Category.WebHome]], sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses. | ||
222 | |(% style="width:171px" %) |(% style="width:213px" %)/hierarchy|(% style="width:577px" %)Associates the parent and the child [[Category>>doc:sdmx:Glossary.Category.WebHome]]. | ||
223 | |(% style="width:171px" %)Categorisation|(% style="width:213px" %)((( | ||
224 | Inherits from | ||
225 | MaintainableArtefact | ||
226 | )))|(% style="width:577px" %)Associates anIdentifableArtefact with a [[Category>>doc:sdmx:Glossary.Category.WebHome]]. | ||
227 | |(% style="width:171px" %) |(% style="width:213px" %)+categorisedArtefact|(% style="width:577px" %)Associates the IdentifableArtefact. | ||
228 | |(% style="width:171px" %) |(% style="width:213px" %)+categorisedBy|(% style="width:577px" %)Associates the [[Category>>doc:sdmx:Glossary.Category.WebHome]]. | ||
229 | ))) | ||
230 | |||
231 | == {{id name="_Toc371002"/}}4.6 Organisation Scheme == | ||
232 | |||
233 | === {{id name="_Toc371003"/}}4.6.1 Class Diagram === | ||
234 | |||
235 | [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_dcd0149.png||height="456" width="580"]] | ||
236 | |||
237 | (% class="wikigeneratedid" id="HFigure20TheOrganisationSchemeclassdiagram" %) | ||
238 | **Figure 20 The Organisation Scheme class diagram** | ||
239 | |||
240 | === {{id name="_Toc371004"/}}4.6.2 Explanation of the Diagram === | ||
241 | |||
242 | ==== 4.6.2.1 Narrative ==== | ||
243 | |||
244 | The //OrganisationScheme// is abstract. It contains //Organisation// which is also abstract. The Organisation can have child Organisation. | ||
245 | |||
246 | The //OrganisationScheme// can be one of four types: | ||
247 | |||
248 | 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 separate document “Technical Notes”. | ||
249 | 1. DataProviderScheme – contains DataProvider which is restricted to a flat list of agencies (i.e. there is no [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]). | ||
250 | 1. DataConsumerScheme – contains DataConsumer which is restricted to a flat list of agencies (i.e. there is no [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]). | ||
251 | 1. OrganisationUnitScheme – contains OrganisationUnit which does inherit the /[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] association from Organisation. | ||
252 | |||
253 | [[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, DataConsumer,OrganisationUnit or Agency, except for limited [[Contact >>doc:Glossary.Contact.WebHome]]information. | ||
254 | |||
255 | A partial //OrganisationScheme// (where isPartial is set to “true”) is identical to a //OrganisationScheme// and contains the Organisation and associated names and descriptions, just as in a normal //OrganisationScheme// However, its content is a sub set of the full //OrganisationScheme//. The way this works is described in section 3.5.3.1 on ItemScheme. | ||
256 | |||
257 | ==== 4.6.2.2 Definitions ==== | ||
258 | |||
259 | (% style="width:845.294px" %) | ||
260 | |(% style="width:181px" %)**Class**|(% style="width:217px" %)**Feature**|(% style="width:429px" %)**Description** | ||
261 | |(% style="width:181px" %)//OrganisationScheme//|(% style="width:217px" %)((( | ||
262 | Abstract Class Inherits from | ||
263 | //ItemScheme// | ||
264 | Sub classes are: | ||
265 | AgencyScheme | ||
266 | DataProviderScheme | ||
267 | DataConsumerScheme | ||
268 | OrganisationUnitScheme | ||
269 | )))|(% style="width:429px" %)A maintained collection of Organisations. | ||
270 | |(% style="width:181px" %) |(% style="width:217px" %)/items|(% style="width:429px" %)Association to the Organisations in the scheme. | ||
271 | |(% style="width:181px" %)//Organisation//|(% style="width:217px" %)((( | ||
272 | Inherits from | ||
273 | //Item// | ||
274 | Sub classes are: | ||
275 | Agency | ||
276 | DataProvider | ||
277 | DataConsumer | ||
278 | OrganisationUnit | ||
279 | )))|(% style="width:429px" %)An organisation is a unique framework of authority within which a person or persons act, or are designated to act, towards some purpose. | ||
280 | |(% style="width:181px" %) |(% style="width:217px" %)+contact|(% style="width:429px" %)Association to the [[Contact>>doc:Glossary.Contact.WebHome]] information. | ||
281 | |(% style="width:181px" %) |(% style="width:217px" %)/hierarchy|(% style="width:429px" %)Association to child Organisations. | ||
282 | |(% style="width:181px" %)(% style="color:#e74c3c" %)Contact|(% style="width:217px" %) |(% style="width:429px" %)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. | ||
283 | |(% style="width:181px" %) |(% style="width:217px" %)name|(% style="width:429px" %)The designation of the [[Contact>>doc:Glossary.Contact.WebHome]] person by a linguistic expression. | ||
284 | |(% style="width:181px" %) |(% style="width:217px" %)organisationUnit|(% style="width:429px" %)The designation of the organisational structure by a linguistic expression, within which [[Contact>>doc:Glossary.Contact.WebHome]] person works. | ||
285 | |(% style="width:181px" %) |(% style="width:217px" %)responsibility|(% style="width:429px" %)The function of the contact person with respect to the organisation role for which this person is the [[Contact>>doc:Glossary.Contact.WebHome]]. | ||
286 | |(% style="width:181px" %) |(% style="width:217px" %)telephone|(% style="width:429px" %)The [[telephone number>>doc:sdmx:Glossary.Contact phone number.WebHome]] of the [[Contact>>doc:Glossary.Contact.WebHome]]. | ||
287 | |(% style="width:181px" %) |(% style="width:217px" %)fax|(% style="width:429px" %)The fax number of the [[Contact>>doc:Glossary.Contact.WebHome]]. | ||
288 | |(% style="width:181px" %) |(% style="width:217px" %)email|(% style="width:429px" %)The Internet e-mail address of the [[Contact>>doc:Glossary.Contact.WebHome]]. | ||
289 | |(% style="width:181px" %) |(% style="width:217px" %)X400|(% style="width:429px" %)The X400 address of the [[Contact>>doc:Glossary.Contact.WebHome]]. | ||
290 | |(% style="width:181px" %) |(% style="width:217px" %)uri|(% style="width:429px" %)The URL address of the [[Contact>>doc:Glossary.Contact.WebHome]]. | ||
291 | |(% style="width:181px" %)AgencyScheme|(% style="width:217px" %) |(% style="width:429px" %)A maintained collection of Maintenace Agencies. | ||
292 | |(% style="width:181px" %) |(% style="width:217px" %)/items|(% style="width:429px" %)Association to the [[Maintenance Agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] in the scheme. | ||
293 | |(% style="width:181px" %)DataProviderScheme|(% style="width:217px" %) |(% style="width:429px" %)A maintained collection of [[Data Providers>>doc:sdmx:Glossary.Data provider.WebHome]]. | ||
294 | |(% style="width:181px" %) |(% style="width:217px" %)/items|(% style="width:429px" %)Association to the [[Data Providers>>doc:sdmx:Glossary.Data provider.WebHome]] in the scheme. | ||
295 | |(% style="width:181px" %)DataConsumerScheme|(% style="width:217px" %) |(% style="width:429px" %)A maintained collection of [[Data Consumers>>doc:sdmx:Glossary.Data consumer.WebHome]]. | ||
296 | |(% style="width:181px" %) |(% style="width:217px" %)/items|(% style="width:429px" %)Association to the [[Data Consumers>>doc:sdmx:Glossary.Data consumer.WebHome]] in the scheme. | ||
297 | |(% style="width:181px" %)OrganisationUnitScheme|(% style="width:217px" %) |(% style="width:429px" %)A maintained collection of Organisation Units. | ||
298 | |(% style="width:181px" %) |(% style="width:217px" %)/items|(% style="width:429px" %)Association to the Organisation Units in the scheme. | ||
299 | |(% style="width:181px" %)Agency|(% style="width:217px" %)((( | ||
300 | Inherits from | ||
301 | //Organisation// | ||
302 | )))|(% style="width:429px" %)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>>doc:sdmx:Glossary.Concept.WebHome]](%%) and [[Code lists>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
303 | |(% style="width:181px" %)DataProvider|(% style="width:217px" %)((( | ||
304 | Inherits from | ||
305 | //Organisation// | ||
306 | )))|(% style="width:429px" %)An organisation that produces data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]. | ||
307 | |(% style="width:181px" %)DataConsumer|(% style="width:217px" %)((( | ||
308 | Inherits from | ||
309 | //Organisation// | ||
310 | )))|(% style="width:429px" %)An organisation using data as input for further processing. | ||
311 | |(% style="width:181px" %)OrganisationUnit|(% style="width:217px" %)((( | ||
312 | Inherits from | ||
313 | //Organisation// | ||
314 | )))|(% style="width:429px" %)A designation in the organisational structure. | ||
315 | |(% style="width:181px" %) |(% style="width:217px" %)/hierarchy|(% style="width:429px" %)Association to child Organisation Units | ||
316 | |||
317 | == {{id name="_Toc371005"/}}4.7 Reporting Taxonomy == | ||
318 | |||
319 | === {{id name="_Toc371006"/}}4.7.1 Class Diagram === | ||
320 | |||
321 | [[image:1747732548003-370.png]] | ||
322 | |||
323 | **Figure 21: Class diagram of the Reporting Taxonomy** | ||
324 | |||
325 | === {{id name="_Toc371007"/}}4.7.2 Explanation of the Diagram === | ||
326 | |||
327 | ==== 4.7.2.1 Narrative ==== | ||
328 | |||
329 | 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. | ||
330 | |||
331 | 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 DataflowDefinition, or MetadataflowDefinition, 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 DataflowDefinition). 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: | ||
332 | |||
333 | Section 1 | ||
334 | |||
335 | 1. linked to DatafowDefinition_1 | ||
336 | 1. linked to DatafowDefinition_2 | ||
337 | |||
338 | Section 2 | ||
339 | |||
340 | 1. linked toDatafowDefinition_3 | ||
341 | 1. linked to DatafowDefinition_4 | ||
342 | |||
343 | Here, the nodes of Section 1 and Section 2 would not be linked to DataflowDefinition but the other would be linked to a DataflowDefinition (and hence the DataStructureDefinition). | ||
344 | |||
345 | 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. | ||
346 | |||
347 | ==== 4.7.2.2 Definitions ==== | ||
348 | |||
349 | (% style="width:1033.29px" %) | ||
350 | |**Class**|**Feature**|(% style="width:687px" %)**Description** | ||
351 | |ReportingTaxonomy|((( | ||
352 | Inherits from | ||
353 | //ItemScheme// | ||
354 | )))|(% style="width:687px" %)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]] Definition or Metdataflow Definition. | ||
355 | | |items|(% style="width:687px" %)Associates the Reporting [[Category>>doc:sdmx:Glossary.Category.WebHome]] | ||
356 | |ReportingCategory|((( | ||
357 | Inherits from | ||
358 | //Item// | ||
359 | )))|(% style="width:687px" %)A [[component>>doc:sdmx:Glossary.Component.WebHome]] that gives structure to the report and links to data and metadata. | ||
360 | | |hierarchy|(% style="width:687px" %)Associates child Reporting [[Category>>doc:sdmx:Glossary.Category.WebHome]]. | ||
361 | | |+flow|(% style="width:687px" %)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. | ||
362 | | |+structure|(% style="width:687px" %)((( | ||
363 | 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. | ||
364 | ))) |