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