Changes for page 3 SDMX Base Package
Last modified by Helena K. on 2026/06/08 16:18
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -80,9 +80,9 @@ 80 80 Base inheritance sub classes are: 81 81 //MaintainableArtefact// 82 82 )))|(% style="width:543px" %)Provides versioning information for all derived objects. 83 -| |(% style="width:262px" %)(% id="confict-imterms-15" style="color: #9b59b6"%)[[version>>doc:sdmx:Glossary2\.1.Version.WebHome]]|(% style="width:543px" %)A[[version>>doc:sdmx:Glossary2\.1.Version.WebHome]]string following [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules.84 -| |(% style="width:262px" %)(% id="confict-imterms-16" style="color:#9b59b6" %)validFrom|(% style="width:543px" %)Date from which the [[version>>doc:sdmx:Glossary2\.1.Version.WebHome]]is valid85 -| |(% style="width:262px" %)(% id="confict-imterms-17" style="color:#9b59b6" %)validTo|(% style="width:543px" %)Date from which [[version>>doc:sdmx:Glossary2\.1.Version.WebHome]]is superseded83 +| |(% style="width:262px" %)(% id="confict-imterms-15" style="color: rgb(155, 89, 182); color: rgb(231, 76, 60)" %)version|(% style="width:543px" %)A (% style="color:#e74c3c" %)version(%%) string following [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules. 84 +| |(% style="width:262px" %)(% id="confict-imterms-16" style="color:#9b59b6" %)validFrom|(% style="width:543px" %)Date from which the (% style="color:#e74c3c" %)version(%%) is valid 85 +| |(% style="width:262px" %)(% id="confict-imterms-17" style="color:#9b59b6" %)validTo|(% style="width:543px" %)Date from which (% style="color:#e74c3c" %)version(%%) is superseded 86 86 |//MaintainableArtefact//|(% style="width:262px" %)((( 87 87 Inherits from 88 88 ... ... @@ -120,24 +120,24 @@ 120 120 121 121 ==== 3.4.2.1 Narrative ==== 122 122 123 -The FacetType and FacetValueType enumerations are used to specify the valid format of the content of a non-enumerated (% id="confict-imterms-20" style="color:#9b59b6" %) [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]](%%) or the usage of a (% id="confict-imterms-21" style="color:#9b59b6" %)[[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]](%%) when specified for use on a (% id="confict-imterms-22" style="color:#9b59b6" %)//[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]//(%%) on a (% id="confict-imterms-23" style="color:#9b59b6" %)//Structure//(%%) (such as a (% id="confict-imterms-24" style="color:#9b59b6" %)[[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]](%%) in a DataStructureDefinition). The description of the various types can be found in the chapter on (% id="confict-imterms-25" style="color:#9b59b6" %)ConceptScheme(%%) (section 4.5).123 +The FacetType and FacetValueType enumerations are used to specify the valid format of the content of a non-enumerated (% id="confict-imterms-20" style="color:#9b59b6" %)Concept(%%) or the usage of a (% id="confict-imterms-21" style="color:#9b59b6" %)Concept(%%) when specified for use on a (% id="confict-imterms-22" style="color:#9b59b6" %)//Component//(%%) on a (% id="confict-imterms-23" style="color:#9b59b6" %)//Structure//(%%) (such as a (% id="confict-imterms-24" style="color:#9b59b6" %)Dimension(%%) in a DataStructureDefinition). The description of the various types can be found in the chapter on (% id="confict-imterms-25" style="color:#9b59b6" %)ConceptScheme(%%) (section 4.5). 124 124 125 125 The ActionType enumeration is used to specify the (% id="confict-imterms-26" style="color:#9b59b6" %)action(%%) that a receiving system should take when processing the content that is the object of the (% id="confict-imterms-27" style="color:#9b59b6" %)action(%%). It is enumerated as follows: 126 126 127 -* Append: Data or metadata is an [[incremental update>>doc:sdmx:Glossary2\.1.Incremental update.WebHome]]for an existing data/[[metadata set>>doc:sdmx:Glossary2\.1.Metadata set.WebHome]] or the provision of new data or documentation ([[attribute>>doc:sdmx:Glossary2\.1.Attribute.WebHome]]values) formerly absent. If any of the supplied data or metadata is already present, it will not replace that data or metadata. This corresponds to the "Update" (% id="confict-imterms-28" style="color:#9b59b6" %)value(%%) found in (% id="confict-imterms-29" %)version(%%) 1.0 of the[[SDMX>>doc:sdmx:Glossary2\.1.Statistical data and metadata exchange.WebHome]]Technical Standards.127 +* Append: Data or metadata is an incremental update for an existing data/metadata set or the provision of new data or documentation (attribute values) formerly absent. If any of the supplied data or metadata is already present, it will not replace that data or metadata. This corresponds to the "Update" (% id="confict-imterms-28" style="color:#9b59b6" %)value(%%) found in (% id="confict-imterms-29" style="color:#9b59b6" %)version(%%) 1.0 of the SDMX Technical Standards. 128 128 * Replace: Data/metadata is to be replaced and may also include additional data/metadata to be appended. 129 129 * Delete: Data/Metadata is to be deleted. 130 130 * Information: Data and metadata are for information purposes. 131 131 132 -The ToValueType data (% id="confict-imterms-30" style="color:#9b59b6" %)type(%%) contains the [[attributes>>doc:sdmx:Glossary2\.1.Attribute.WebHome]]tosupport transformations defined in the StructureMap (see Section 0).132 +The ToValueType data (% id="confict-imterms-30" style="color:#9b59b6" %)type(%%) contains the attributes to support transformations defined in the StructureMap (see Section 0). 133 133 134 -The ConstraintRoleType data (% id="confict-imterms-31" style="color:#9b59b6" %)type(%%) contains the [[attributes>>doc:sdmx:Glossary2\.1.Attribute.WebHome]] that identify the purpose of a[[Constraint>>doc:sdmx:Glossary2\.1.Constraint.WebHome]](allowableContent, actualContent).134 +The ConstraintRoleType data (% id="confict-imterms-31" style="color:#9b59b6" %)type(%%) contains the attributes that identify the purpose of a Constraint (allowableContent, actualContent). 135 135 136 -The ComponentRoleType data (% id="confict-imterms-32" style="color:#9b59b6" %)type(%%) contains the predefined (% id="confict-imterms-33" style="color:#9b59b6" %) [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]](%%) roles that can be assigned to any (% id="confict-imterms-34" style="color:#9b59b6" %)[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]](%%).136 +The ComponentRoleType data (% id="confict-imterms-32" style="color:#9b59b6" %)type(%%) contains the predefined (% id="confict-imterms-33" style="color:#9b59b6" %)Concept(%%) roles that can be assigned to any (% id="confict-imterms-34" style="color:#9b59b6" %)Component(%%). 137 137 138 -The CascadeValues data (% id="confict-imterms-35" style="color:#9b59b6" %)type(%%) contains the possible values for a (% id="confict-imterms-36" style="color:#9b59b6" %)MemberValue(%%) within a CubeRegion, in order to enable cascading to all children [[Codes>>doc:sdmx:Glossary2\.1.Code.WebHome]] of a selected (% id="confict-imterms-37" style="color:#9b59b6" %)[[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]](%%), while including/excluding the latter in the selection.138 +The CascadeValues data (% id="confict-imterms-35" style="color:#9b59b6" %)type(%%) contains the possible values for a (% id="confict-imterms-36" style="color:#9b59b6" %)MemberValue(%%) within a CubeRegion, in order to enable cascading to all children Codes of a selected (% id="confict-imterms-37" style="color:#9b59b6" %)Code(%%), while including/excluding the latter in the selection. 139 139 140 -The VersionType data types provides the details for versioning according to [[SDMX>>doc:sdmx:Glossary2\.1.Statistical data and metadata exchange.WebHome]]versioning rules, as explained in[[SDMX>>doc:sdmx:Glossary2\.1.Statistical data andmetadata exchange.WebHome]] Standards Section 6, paragraph “4.3 Versioning”.140 +The VersionType data types provides the details for versioning according to SDMX versioning rules, as explained in SDMX Standards Section 6, paragraph “4.3 Versioning”. 141 141 142 142 == 3.5 The Item Scheme Pattern == 143 143 ... ... @@ -145,27 +145,27 @@ 145 145 146 146 The (% id="confict-imterms-38" style="color:#9b59b6" %)Item(%%) Scheme is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example. 147 147 148 -The //ItemScheme// is the basis for (% id="confict-imterms-39" style="color:#9b59b6" %)CategoryScheme(%%), (% id="confict-imterms-40" style="color:#9b59b6" %) [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]](%%), (% id="confict-imterms-41" style="color:#9b59b6" %)ConceptScheme(%%), (% id="confict-imterms-42" style="color:#9b59b6" %)ReportingTaxonomy(%%), //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme.148 +The //ItemScheme// is the basis for (% id="confict-imterms-39" style="color:#9b59b6" %)CategoryScheme(%%), (% id="confict-imterms-40" style="color:#9b59b6" %)Codelist(%%), (% id="confict-imterms-41" style="color:#9b59b6" %)ConceptScheme(%%), (% id="confict-imterms-42" style="color:#9b59b6" %)ReportingTaxonomy(%%), //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme. 149 149 150 150 === 3.5.2 Class Diagram === 151 151 152 152 [[image:image39.png]] 153 153 154 -**Figure 13 The (% id="confict-imterms-43" %)Item(%%) Scheme pattern** 154 +**Figure 13 The (% id="confict-imterms-43" style="color:#9b59b6" %)Item(%%) Scheme pattern** 155 155 156 156 === 3.5.3 Explanation of the Diagram === 157 157 158 158 ==== 3.5.3.1 Narrative ==== 159 159 160 -The //ItemScheme// is an abstract class which defines a set of (% id="confict-imterms-44" style="color:#9b59b6" %)//Item//(%%) (this class is also abstract). Its main purpose is to define a mechanism which can be used to create taxonomies which can classify other parts of the [[SDMX Information Model>>doc:sdmx:Glossary 2\.1.SDMXInformationModel.WebHome]]. Itis derived from //MaintainableArtefact// which gives it the ability to be annotated, have identity, naming, versioning and be associated with an (% id="confict-imterms-45" style="color:#9b59b6" %)Agency(%%). An example of a concrete class is a (% id="confict-imterms-46" style="color:#9b59b6" %)ConceptScheme(%%). The associated[[Concepts>>doc:sdmx:Glossary2\.1.Concept.WebHome]]are (% id="confict-imterms-47" style="color:#9b59b6" %)//Item//(%%)s.160 +The //ItemScheme// is an abstract class which defines a set of (% id="confict-imterms-44" style="color:#9b59b6" %)//Item//(%%) (this class is also abstract). Its main purpose is to define a mechanism which can be used to create taxonomies which can classify other parts of the SDMX Information Model. It is derived from //MaintainableArtefact// which gives it the ability to be annotated, have identity, naming, versioning and be associated with an (% id="confict-imterms-45" style="color:#9b59b6" %)Agency(%%). An example of a concrete class is a (% id="confict-imterms-46" style="color:#9b59b6" %)ConceptScheme(%%). The associated Concepts are (% id="confict-imterms-47" style="color:#9b59b6" %)//Item//(%%)s. 161 161 162 -In an exchange environment an //ItemScheme// is allowed to contain a sub-set of the (% id="confict-imterms-48" style="color:#9b59b6" %)//Item//(%%)s in the maintained //ItemScheme//. If such an ItemScheme is disseminated with a sub-set of the (% id="confict-imterms-49" style="color:#9b59b6" %)//Item//(%%)s then the fact that this is a sub-set is denoted by setting the (% id="confict-imterms-50" style="color:#9b59b6" %)isPartial(%%) [[attribute>>doc:sdmx:Glossary2\.1.Attribute.WebHome]]to"true".162 +In an exchange environment an //ItemScheme// is allowed to contain a sub-set of the (% id="confict-imterms-48" style="color:#9b59b6" %)//Item//(%%)s in the maintained //ItemScheme//. If such an ItemScheme is disseminated with a sub-set of the (% id="confict-imterms-49" style="color:#9b59b6" %)//Item//(%%)s then the fact that this is a sub-set is denoted by setting the (% id="confict-imterms-50" style="color:#9b59b6" %)isPartial(%%) attribute to "true". 163 163 164 -A “partial” //ItemScheme// cannot be maintained independently in its partial form i.e., it cannot contain (% id="confict-imterms-51" style="color:#9b59b6" %)//Item//(%%)s that are not present in the full //ItemScheme// and the content of any one (% id="confict-imterms-52" style="color:#9b59b6" %)//Item//(%%)// //(e.g., names and descriptions) cannot deviate from the content in the full //ItemScheme//. Furthermore, the (% id="confict-imterms-53" style="color:#9b59b6" %)id(%%) of the //ItemScheme// where (% id="confict-imterms-54" style="color:#9b59b6" %)isPartial(%%) is set to "true" is the same as the (% id="confict-imterms-55" style="color:#9b59b6" %)id(%%) of the full //ItemScheme// (agencyId, (% id="confict-imterms-56" style="color:#9b59b6" %)id(%%), (% id="confict-imterms-57" style="color:#9b59b6" %) [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]](%%)). This is important as this is the (% id="confict-imterms-58" style="color:#9b59b6" %)id(%%) that that is referenced in other structures (e.g., a (% id="confict-imterms-59" style="color:#9b59b6" %)[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]](%%) referenced in a[[DSD>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]) and this (% id="confict-imterms-60" style="color:#9b59b6" %)id(%%) is always the same, regardless of whether the disseminated //ItemScheme// is the full //ItemScheme// or a partial //ItemScheme//.164 +A “partial” //ItemScheme// cannot be maintained independently in its partial form i.e., it cannot contain (% id="confict-imterms-51" style="color:#9b59b6" %)//Item//(%%)s that are not present in the full //ItemScheme// and the content of any one (% id="confict-imterms-52" style="color:#9b59b6" %)//Item//(%%)// //(e.g., names and descriptions) cannot deviate from the content in the full //ItemScheme//. Furthermore, the (% id="confict-imterms-53" style="color:#9b59b6" %)id(%%) of the //ItemScheme// where (% id="confict-imterms-54" style="color:#9b59b6" %)isPartial(%%) is set to "true" is the same as the (% id="confict-imterms-55" style="color:#9b59b6" %)id(%%) of the full //ItemScheme// (agencyId, (% id="confict-imterms-56" style="color:#9b59b6" %)id(%%), (% id="confict-imterms-57" style="color:#9b59b6" %)version(%%)). This is important as this is the (% id="confict-imterms-58" style="color:#9b59b6" %)id(%%) that that is referenced in other structures (e.g., a (% id="confict-imterms-59" style="color:#9b59b6" %)Codelist(%%) referenced in a DSD) and this (% id="confict-imterms-60" style="color:#9b59b6" %)id(%%) is always the same, regardless of whether the disseminated //ItemScheme// is the full //ItemScheme// or a partial //ItemScheme//. 165 165 166 -The purpose of a partial //ItemScheme// is to support the exchange and dissemination of a subset //ItemScheme// without the need to maintain multiple //ItemScheme//s which contain the same (% id="confict-imterms-61" style="color:#9b59b6" %)//Item//(%%)s. For instance, when a (% id="confict-imterms-62" style="color:#9b59b6" %) [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]](%%) is used in a DataStructureDefinition it is sometimes the case that only a sub-set of the[[Codes>>doc:sdmx:Glossary2\.1.Code.WebHome]]in a (% id="confict-imterms-63" style="color:#9b59b6" %)[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]](%%) are relevant. In this case a partial (% id="confict-imterms-64" style="color:#9b59b6" %)[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]](%%) can be constructed using the[[Constraint>>doc:sdmx:Glossary2\.1.Constraint.WebHome]] mechanism explained later in this document.166 +The purpose of a partial //ItemScheme// is to support the exchange and dissemination of a subset //ItemScheme// without the need to maintain multiple //ItemScheme//s which contain the same (% id="confict-imterms-61" style="color:#9b59b6" %)//Item//(%%)s. For instance, when a (% id="confict-imterms-62" style="color:#9b59b6" %)Codelist(%%) is used in a DataStructureDefinition it is sometimes the case that only a sub-set of the Codes in a (% id="confict-imterms-63" style="color:#9b59b6" %)Codelist(%%) are relevant. In this case a partial (% id="confict-imterms-64" style="color:#9b59b6" %)Codelist(%%) can be constructed using the Constraint mechanism explained later in this document. 167 167 168 -(% id="confict-imterms-65" style="color:#9b59b6" %)//Item//(%%) inherits from //NameableArtefact// which gives it the ability to be annotated and have identity, and therefore has (% id="confict-imterms-66" style="color:#9b59b6" %)id(%%), (% id="confict-imterms-67" style="color:#9b59b6" %)uri(%%) and (% id="confict-imterms-68" style="color:#9b59b6" %)urn(%%) [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]], a name and a description in the form of an InternationalString. Unlike the parent //ItemScheme//, the (% id="confict-imterms-69" style="color:#9b59b6" %)//Item//(%%) itself is not a //MaintainableArtefact// and therefore cannot have an independent (% id="confict-imterms-70" style="color:#9b59b6" %)Agency(%%) (i.e., it implicitly has the same agencyId as the //ItemScheme//).168 +(% id="confict-imterms-65" style="color:#9b59b6" %)//Item//(%%) inherits from //NameableArtefact// which gives it the ability to be annotated and have identity, and therefore has (% id="confict-imterms-66" style="color:#9b59b6" %)id(%%), (% id="confict-imterms-67" style="color:#9b59b6" %)uri(%%) and (% id="confict-imterms-68" style="color:#9b59b6" %)urn(%%) attributes, a name and a description in the form of an InternationalString. Unlike the parent //ItemScheme//, the (% id="confict-imterms-69" style="color:#9b59b6" %)//Item//(%%) itself is not a //MaintainableArtefact// and therefore cannot have an independent (% id="confict-imterms-70" style="color:#9b59b6" %)Agency(%%) (i.e., it implicitly has the same agencyId as the //ItemScheme//). 169 169 170 170 The (% id="confict-imterms-71" style="color:#9b59b6" %)//Item//(%%) can be hierarchic and so one (% id="confict-imterms-72" style="color:#9b59b6" %)//Item//(%%) can have child (% id="confict-imterms-73" style="color:#9b59b6" %)//Item//(%%)s. The restriction of the hierarchic association is that a child (% id="confict-imterms-74" style="color:#9b59b6" %)//Item//(%%) can have only parent (% id="confict-imterms-75" style="color:#9b59b6" %)//Item//(%%). 171 171