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}} | ||
![]() |
2.1 | 4 | |
5 | == {{id name="_Toc370987"/}}4.1 Introduction == | ||
6 | |||
![]() |
11.1 | 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: |
![]() |
2.1 | 8 | |
![]() |
3.3 | 9 | * Codelist |
10 | * ConceptScheme | ||
11 | * CategoryScheme | ||
![]() |
2.1 | 12 | * AgencyScheme, DataProviderScheme, DataConsumerScheme, OrganisationUnitScheme which all inherit from the abstract class //OrganisationScheme// |
![]() |
3.3 | 13 | * Reporting Taxonomy |
![]() |
2.1 | 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 | |||
![]() |
3.7 | 23 | [[image:1747732337979-971.png]] |
24 | |||
![]() |
2.1 | 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 | |||
![]() |
11.1 | 31 | The Codelist inherits from the //ItemScheme// and therefore has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: |
![]() |
2.1 | 32 | |
33 | * id | ||
34 | * uri | ||
35 | * urn | ||
36 | * version | ||
![]() |
3.2 | 37 | * validFrom |
38 | * validTo | ||
![]() |
2.1 | 39 | * isExternalReference |
40 | * serviceURL | ||
41 | * structureURL | ||
42 | * final | ||
43 | * isPartial | ||
44 | |||
![]() |
11.1 | 45 | The [[Code>>doc:sdmx:Glossary.Code.WebHome]] inherits from //Item// and has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: |
![]() |
2.1 | 46 | |
47 | * id | ||
48 | * uri | ||
49 | * urn | ||
50 | |||
![]() |
11.1 | 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). |
![]() |
2.1 | 52 | |
![]() |
11.1 | 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. |
![]() |
2.1 | 54 | |
![]() |
11.1 | 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//. |
![]() |
2.1 | 56 | |
57 | ==== 4.3.2.2 Definitions ==== | ||
58 | |||
59 | ((( | ||
![]() |
3.5 | 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" %)((( | ||
![]() |
2.1 | 63 | Inherits from |
64 | //ItemScheme// | ||
![]() |
11.1 | 65 | )))|(% style="width:598px" %)A list from which some statistical (% style="color:#e74c3c" %)concepts(%%) (coded (% style="color:#e74c3c" %)concepts(%%)) take their values. |
66 | |(% style="width:132px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]|(% style="width:172px" %)((( | ||
![]() |
2.1 | 67 | Inherits from |
68 | //Item// | ||
![]() |
11.1 | 69 | )))|(% style="width:598px" %)A language independent set of letters, numbers or symbols that represent a (% style="color:#e74c3c" %)concept(%%) 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]]. | ||
![]() |
2.1 | 71 | ))) |
72 | |||
73 | == {{id name="_Toc370992"/}}4.4 Concept Scheme and Concepts == | ||
74 | |||
75 | === {{id name="_Toc370993"/}}4.4.1 Class Diagram - Inheritance === | ||
76 | |||
![]() |
3.7 | 77 | [[image:1747732287949-594.png]] |
78 | |||
![]() |
2.1 | 79 | **Figure 16 Class diagram of the Concept Scheme** |
80 | |||
81 | === {{id name="_Toc370994"/}}4.4.2 Explanation of the Diagram === | ||
82 | |||
![]() |
11.1 | 83 | The ConceptScheme inherits from the //ItemScheme //and therefore has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: |
![]() |
2.1 | 84 | |
![]() |
3.3 | 85 | * id |
86 | * uri | ||
87 | * urn | ||
88 | * version | ||
89 | * validFrom | ||
90 | * validTo | ||
![]() |
2.1 | 91 | * isExternalReference |
92 | * registryURL | ||
93 | * structureURL | ||
94 | * repositoryURL | ||
![]() |
3.3 | 95 | * final |
96 | * isPartial | ||
![]() |
2.1 | 97 | |
![]() |
11.1 | 98 | (% style="color:#e74c3c" %)Concept(%%) inherits from Item and has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: |
![]() |
2.1 | 99 | |
100 | * id | ||
101 | * uri | ||
102 | * urn | ||
103 | |||
![]() |
11.1 | 104 | 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 multi-lingual description, and an association to [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] to support notes (not shown). |
![]() |
2.1 | 105 | |
![]() |
11.1 | 106 | 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. |
![]() |
2.1 | 107 | |
![]() |
11.1 | 108 | 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 sub set of the full ConceptScheme. |
![]() |
2.1 | 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 | |||
![]() |
3.7 | 114 | [[image:1747732242162-856.png]] |
![]() |
3.4 | 115 | |
![]() |
11.1 | 116 | **Figure 17: Relationship class diagram of the [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]** |
![]() |
2.1 | 117 | |
118 | === {{id name="_Toc370996"/}}4.4.4 Explanation of the diagram === | ||
119 | |||
120 | ==== 4.4.4.1 Narrative ==== | ||
121 | |||
![]() |
11.1 | 122 | 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. |
![]() |
2.1 | 123 | |
![]() |
11.1 | 124 | The (% style="color:#e74c3c" %)Concept(%%) can be associated with a coreRepresentation. The coreRepresentation isthe 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(%%). |
![]() |
2.1 | 125 | |
![]() |
11.1 | 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(%%) 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(%%). This allows a different format for each [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. This is covered in more detail in 5.3. |
![]() |
2.1 | 127 | |
![]() |
11.1 | 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. |
![]() |
2.1 | 129 | |
![]() |
11.1 | 130 | 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. |
![]() |
2.1 | 131 | |
132 | ==== 4.4.4.2 Definitions ==== | ||
133 | |||
134 | ((( | ||
![]() |
3.4 | 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" %)((( | ||
![]() |
2.1 | 138 | Inherits from |
139 | |||
140 | //ItemScheme// | ||
![]() |
11.1 | 141 | )))|(% style="width:522px" %)The descriptive information for an arrangement or division of (% style="color:#e74c3c" %)concepts(%%) into groups based on characteristics, which the objects have in common. |
142 | |(% style="width:195px" %)(% style="color:#e74c3c" %)Concept|(% style="width:210px" %)((( | ||
![]() |
2.1 | 143 | Inherits from |
144 | |||
145 | //Item// | ||
![]() |
11.1 | 146 | )))|(% style="width:522px" %)A (% style="color:#e74c3c" %)concept(%%) 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(%%). | ||
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(%%) reference. | ||
150 | |(% style="width:195px" %)ISOConceptReference|(% style="width:210px" %) |(% style="width:522px" %)The identity of an ISO (% style="color:#e74c3c" %)concept(%%) 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(%%). | ||
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(%%). | ||
![]() |
2.1 | 154 | ))) |
155 | |||
156 | == {{id name="_Toc370997"/}}4.5 Category Scheme == | ||
157 | |||
158 | === {{id name="_Toc370998"/}}4.5.1 Context === | ||
159 | |||
![]() |
11.1 | 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. |
![]() |
2.1 | 161 | |
162 | === {{id name="_Toc370999"/}}4.5.2 Class diagram - Inheritance === | ||
163 | |||
![]() |
7.1 | 164 | (% class="wikigeneratedid" id="H" %) |
165 | [[image:1747732448450-721.png]] | ||
![]() |
2.1 | 166 | |
![]() |
3.9 | 167 | (% class="wikigeneratedid" id="HFigure18InheritanceClassdiagramoftheCategoryScheme" %) |
![]() |
11.1 | 168 | **Figure 18 Inheritance Class diagram of the [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]** |
![]() |
3.9 | 169 | |
![]() |
2.1 | 170 | === {{id name="_Toc371000"/}}4.5.3 Explanation of the Diagram === |
171 | |||
172 | ==== 4.5.3.1 Narrative ==== | ||
173 | |||
![]() |
11.1 | 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]]: |
![]() |
2.1 | 175 | |
![]() |
3.4 | 176 | * id |
![]() |
2.1 | 177 | * uri |
178 | * urn | ||
179 | * version | ||
180 | * validFrom | ||
181 | * validTo | ||
182 | * isExternalReference | ||
183 | * structureURL | ||
184 | * serviceURL | ||
185 | * final | ||
![]() |
3.4 | 186 | * isPartial |
![]() |
2.1 | 187 | |
![]() |
11.1 | 188 | [[Category>>doc:sdmx:Glossary.Category.WebHome]] inherits from //Item// and has the following [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: |
![]() |
2.1 | 189 | |
190 | * //id// | ||
191 | * //uri// | ||
192 | * //urn// | ||
193 | |||
![]() |
11.1 | 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). |
![]() |
2.1 | 195 | |
![]() |
11.1 | 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. |
![]() |
2.1 | 197 | |
![]() |
11.1 | 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. |
![]() |
2.1 | 199 | |
200 | === {{id name="_Toc371001"/}}4.5.4 Class diagram - Relationship === | ||
201 | |||
![]() |
3.9 | 202 | [[image:1747732486733-495.png]] |
203 | |||
![]() |
11.1 | 204 | **Figure 19: Relationship Class diagram of the [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]** |
![]() |
2.1 | 205 | |
![]() |
11.1 | 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. |
![]() |
2.1 | 207 | |
208 | ==== 4.5.4.1 Definitions ==== | ||
209 | |||
210 | ((( | ||
![]() |
3.5 | 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" %)((( | ||
![]() |
2.1 | 214 | Inherits from |
215 | //ItemScheme// | ||
![]() |
11.1 | 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" %)((( | ||
![]() |
2.1 | 219 | Inherits from |
220 | //Item// | ||
![]() |
11.1 | 221 | )))|(% style="width:577px" %)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. |
222 | |(% style="width:171px" %) |(% style="width:213px" %)/hierarchy|(% style="width:577px" %)Associates the parent and the child [[Category>>doc:sdmx:Glossary.Category.WebHome]]. | ||
![]() |
3.5 | 223 | |(% style="width:171px" %)Categorisation|(% style="width:213px" %)((( |
![]() |
2.1 | 224 | Inherits from |
225 | MaintainableArtefact | ||
![]() |
11.1 | 226 | )))|(% style="width:577px" %)Associates anIdentifableArtefact with a [[Category>>doc:sdmx:Glossary.Category.WebHome]]. |
![]() |
3.5 | 227 | |(% style="width:171px" %) |(% style="width:213px" %)+categorisedArtefact|(% style="width:577px" %)Associates the IdentifableArtefact. |
![]() |
11.1 | 228 | |(% style="width:171px" %) |(% style="width:213px" %)+categorisedBy|(% style="width:577px" %)Associates the [[Category>>doc:sdmx:Glossary.Category.WebHome]]. |
![]() |
2.1 | 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 | |||
![]() |
3.5 | 237 | (% class="wikigeneratedid" id="HFigure20TheOrganisationSchemeclassdiagram" %) |
238 | **Figure 20 The Organisation Scheme class diagram** | ||
![]() |
2.1 | 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 | |||
![]() |
11.1 | 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. | ||
![]() |
2.1 | 252 | |
![]() |
11.1 | 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 (% style="color:#e74c3c" %)Contact(%%) information. |
![]() |
2.1 | 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 | |||
![]() |
3.6 | 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" %)((( | ||
![]() |
2.1 | 262 | Abstract Class Inherits from |
263 | //ItemScheme// | ||
264 | Sub classes are: | ||
265 | AgencyScheme | ||
266 | DataProviderScheme | ||
267 | DataConsumerScheme | ||
268 | OrganisationUnitScheme | ||
![]() |
3.6 | 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" %)((( | ||
![]() |
2.1 | 272 | Inherits from |
273 | //Item// | ||
274 | Sub classes are: | ||
275 | Agency | ||
276 | DataProvider | ||
277 | DataConsumer | ||
278 | OrganisationUnit | ||
![]() |
3.6 | 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. |
![]() |
11.1 | 280 | |(% style="width:181px" %) |(% style="width:217px" %)+contact|(% style="width:429px" %)Association to the (% style="color:#e74c3c" %)Contact(%%) information. |
![]() |
3.6 | 281 | |(% style="width:181px" %) |(% style="width:217px" %)/hierarchy|(% style="width:429px" %)Association to child Organisations. |
![]() |
11.1 | 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 (% style="color:#e74c3c" %)Contact(%%) 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 (% style="color:#e74c3c" %)Contact(%%) person works. | ||
285 | |(% style="width:181px" %) |(% style="width:217px" %)responsibility|(% style="width:429px" %)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(%%). | ||
286 | |(% style="width:181px" %) |(% style="width:217px" %)telephone|(% style="width:429px" %)The [[telephone number>>doc:sdmx:Glossary.Contact phone number.WebHome]] of the (% style="color:#e74c3c" %)Contact(%%). | ||
287 | |(% style="width:181px" %) |(% style="width:217px" %)fax|(% style="width:429px" %)The fax number of the (% style="color:#e74c3c" %)Contact(%%). | ||
288 | |(% style="width:181px" %) |(% style="width:217px" %)email|(% style="width:429px" %)The Internet e-mail address of the (% style="color:#e74c3c" %)Contact(%%). | ||
289 | |(% style="width:181px" %) |(% style="width:217px" %)X400|(% style="width:429px" %)The X400 address of the (% style="color:#e74c3c" %)Contact(%%). | ||
290 | |(% style="width:181px" %) |(% style="width:217px" %)uri|(% style="width:429px" %)The URL address of the (% style="color:#e74c3c" %)Contact(%%). | ||
![]() |
3.6 | 291 | |(% style="width:181px" %)AgencyScheme|(% style="width:217px" %) |(% style="width:429px" %)A maintained collection of Maintenace Agencies. |
![]() |
11.1 | 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. | ||
![]() |
3.6 | 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" %)((( | ||
![]() |
2.1 | 300 | Inherits from |
301 | //Organisation// | ||
![]() |
11.1 | 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(%%) and [[Code>>doc:sdmx:Glossary.Code.WebHome]] lists. |
![]() |
3.6 | 303 | |(% style="width:181px" %)DataProvider|(% style="width:217px" %)((( |
![]() |
2.1 | 304 | Inherits from |
305 | //Organisation// | ||
![]() |
11.1 | 306 | )))|(% style="width:429px" %)An organisation that produces data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]. |
![]() |
3.6 | 307 | |(% style="width:181px" %)DataConsumer|(% style="width:217px" %)((( |
![]() |
2.1 | 308 | Inherits from |
309 | //Organisation// | ||
![]() |
3.6 | 310 | )))|(% style="width:429px" %)An organisation using data as input for further processing. |
311 | |(% style="width:181px" %)OrganisationUnit|(% style="width:217px" %)((( | ||
![]() |
2.1 | 312 | Inherits from |
![]() |
3.6 | 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 | ||
![]() |
2.1 | 316 | |
317 | == {{id name="_Toc371005"/}}4.7 Reporting Taxonomy == | ||
318 | |||
319 | === {{id name="_Toc371006"/}}4.7.1 Class Diagram === | ||
320 | |||
![]() |
4.1 | 321 | [[image:1747732548003-370.png]] |
![]() |
3.6 | 322 | |
![]() |
2.1 | 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 | |||
![]() |
11.1 | 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: |
![]() |
2.1 | 332 | |
333 | Section 1 | ||
334 | |||
![]() |
6.1 | 335 | 1. linked to DatafowDefinition_1 |
336 | 1. linked to DatafowDefinition_2 | ||
![]() |
2.1 | 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 | |||
![]() |
3.6 | 349 | (% style="width:1033.29px" %) |
350 | |**Class**|**Feature**|(% style="width:687px" %)**Description** | ||
![]() |
2.1 | 351 | |ReportingTaxonomy|((( |
352 | Inherits from | ||
![]() |
3.6 | 353 | //ItemScheme// |
![]() |
11.1 | 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]] | ||
![]() |
2.1 | 356 | |ReportingCategory|((( |
357 | Inherits from | ||
358 | //Item// | ||
![]() |
11.1 | 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. | ||
![]() |
3.6 | 362 | | |+structure|(% style="width:687px" %)((( |
![]() |
11.1 | 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. |
![]() |
2.1 | 364 | ))) |