Changes for page 3 SDMX Base Package
Last modified by Helena K. on 2026/06/08 16:18
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -xwiki:XWiki.he lena1 +xwiki:XWiki.arturkryazhev - Content
-
... ... @@ -4,13 +4,13 @@ 4 4 5 5 == 3.1 Introduction == 6 6 7 -The constructs in the [[SDMX>>doc: sdmx:Glossary2\.1.Statistical data and metadata exchange.WebHome]] Base package comprise the fundamental building blocks that support many of the other structures in the model. For this reason, many of the classes in this package are abstract (i.e., only derived sub-classes can exist in an implementation).7 +The constructs in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Base package comprise the fundamental building blocks that support many of the other structures in the model. For this reason, many of the classes in this package are abstract (i.e., only derived sub-classes can exist in an implementation). 8 8 9 -The motivation for establishing the [[SDMX>>doc: sdmx:Glossary2\.1.Statistical data and metadata exchange.WebHome]] Base package is as follows:9 +The motivation for establishing the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Base package is as follows: 10 10 11 11 it is accepted “Best Practise” to identify fundamental archetypes occurring in a model// //identification of commonly found structures or “patterns” leads to easier understanding// //identification of patterns encourages re-use 12 12 13 -Each of the class diagrams in this section views classes from the [[SDMX>>doc: sdmx:Glossary2\.1.Statistical data and metadata exchange.WebHome]] Base package from a different perspective. There are detailed views of specific patterns, plus overviews showing inheritance between classes, and relationships amongst classes.13 +Each of the class diagrams in this section views classes from the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Base package from a different perspective. There are detailed views of specific patterns, plus overviews showing inheritance between classes, and relationships amongst classes. 14 14 15 15 == 3.2 Base Structures - Identification, Versioning, and Maintenance == 16 16 ... ... @@ -24,19 +24,19 @@ 24 24 25 25 ==== 3.2.2.1 Narrative ==== 26 26 27 -This group of classes forms the nucleus of the administration facets of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] objects. They provide features which are reusable by derived classes to support horizontal functionality such as identity, versioning etc. 27 +This group of classes forms the nucleus of the administration [[facets>>doc:sdmx:Glossary 2\.1.Facet.WebHome]] of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] objects. They provide features which are reusable by derived classes to support horizontal functionality such as identity, versioning etc. 28 28 29 -All classes derived from the abstract class //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// may have Annotations (or notes): this supports the need to add notes to all [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] elements. The [[Annotation>>doc: IMElements.Annotation.WebHome]] is used to convey extra information to describe any [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] construct. This information may be in the form of a URL reference and/or a multilingual [[text>>doc:IMElements.text.WebHome]] (represented by the association to [[InternationalString>>doc:IMElements.InternationalString.WebHome]]).29 +All classes derived from the abstract class //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// may have [[Annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] (or notes): this supports the need to add notes to all [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] elements. The [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] is used to convey extra information to describe any [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] construct. This information may be in the form of a URL reference and/or a multilingual [[text>>doc:IMElements.text.WebHome]] (represented by the association to [[InternationalString>>doc:IMElements.InternationalString.WebHome]]). 30 30 31 31 The //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// is an abstract class that comprises the basic [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] needed for identification. Concrete classes based on //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// all inherit the ability to be uniquely identified. 32 32 33 -The (% style="background-color:#e74c3c" %)//NamableArtefact//(%%) is an abstract class that inherits from //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]] //and in addition the +[[description>>doc:IMElements.description.WebHome]] and +[[name>>doc:IMElements.name.WebHome]] roles support multilingual descriptions and names for all objects based on //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]//. The [[InternationalString>>doc:IMElements.InternationalString.WebHome]] supports the representation of a [[description>>doc:IMElements.description.WebHome]] in multiple locales ([[locale>>doc:IMElements.locale.WebHome]] is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.). The //[[LocalisedString>>doc:IMElements.LocalisedString.WebHome]]// supports the representation of a [[description>>doc:IMElements.description.WebHome]] in one [[locale>>doc:IMElements.locale.WebHome]]. 33 +The (% style="background-color:#e74c3c" %)//NamableArtefact//(%%) is an abstract class that inherits from //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]] //and in addition the +[[description>>doc:IMElements.description.WebHome]] and +[[name>>doc:IMElements.name.WebHome]] roles support multilingual descriptions and names for all objects based on //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]//. The [[InternationalString>>doc:IMElements.InternationalString.WebHome]] supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of a [[description>>doc:IMElements.description.WebHome]] in multiple locales ([[locale>>doc:IMElements.locale.WebHome]] is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.). The //[[LocalisedString>>doc:IMElements.LocalisedString.WebHome]]// supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of a [[description>>doc:IMElements.description.WebHome]] in one [[locale>>doc:IMElements.locale.WebHome]]. 34 34 35 35 //[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]// is an abstract class which inherits from //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// and adds versioning ability to all classes derived from it, as explained in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. 36 36 37 37 //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// further adds the ability for derived classes to be maintained via its association to an //[[Organisation>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.WebHome]]//, and adds locational information (i.e., from where the object can be retrieved). 38 38 39 -The inheritance chain from //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// through to //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// allows [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] classes to inherit the features they need, from simple annotation, through identity, naming, to versioning and maintenance. 39 +The inheritance chain from //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// through to //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// allows [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] classes to inherit the features they need, from simple [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]], through identity, naming, to versioning and maintenance. 40 40 41 41 ==== 3.2.2.2 Definitions ==== 42 42 ... ... @@ -45,15 +45,15 @@ 45 45 |//[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]//|(% style="width:262px" %)((( 46 46 Base inheritance sub classes are: 47 47 //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// 48 -)))|(% style="width:543px" %)Objects of classes derived from this can have attached annotations. 48 +)))|(% style="width:543px" %)Objects of classes derived from this can have attached [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]]. 49 49 |[[Annotation>>doc:IMElements.Annotation.WebHome]]|(% style="width:262px" %)// //|(% style="width:543px" %)Additional descriptive information attached to an object. 50 -| |(% style="width:262px" %)[[id>>doc:IMElements.id.WebHome]]|(% style="width:543px" %)Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object. 51 -| |(% style="width:262px" %)[[title>>doc:IMElements.title.WebHome]]|(% style="width:543px" %)A title used to identify an annotation. 52 -| |(% style="width:262px" %)[[type>>doc:IMElements.type.WebHome]]|(% style="width:543px" %)Specifies how the annotation is to be processed. 50 +| |(% style="width:262px" %)[[id>>doc:IMElements.id.WebHome]]|(% style="width:543px" %)Identifier for the [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]]. It can be used to disambiguate one [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] from another where there are several [[Annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] for the same annotated object. 51 +| |(% style="width:262px" %)[[title>>doc:IMElements.title.WebHome]]|(% style="width:543px" %)A [[title>>doc:sdmx:Glossary 2\.1.Title.WebHome]] used to identify an [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]]. 52 +| |(% style="width:262px" %)[[type>>doc:IMElements.type.WebHome]]|(% style="width:543px" %)Specifies how the [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] is to be processed. 53 53 | |(% style="width:262px" %)[[url>>doc:IMElements.url.WebHome]]|(% style="width:543px" %)A link to external descriptive text. 54 -| |(% style="width:262px" %)[[value>>doc:IMElements.value.WebHome]]|(% style="width:543px" %)A non-localised version of the Annotation content. 54 +| |(% style="width:262px" %)[[value>>doc:IMElements.value.WebHome]]|(% style="width:543px" %)A non-localised version of the [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] content. 55 55 | |(% style="width:262px" %)+[[url>>doc:IMElements.url.WebHome]]|(% style="width:543px" %)An International URI provides a set of links that are [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] specific, via this role. 56 -| |(% style="width:262px" %)+[[text>>doc:IMElements.text.WebHome]]|(% style="width:543px" %)An [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] provides the multilingual text content of the annotation via this role. 56 +| |(% style="width:262px" %)+[[text>>doc:IMElements.text.WebHome]]|(% style="width:543px" %)An [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] provides the multilingual text content of the [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] via this role. 57 57 |[[InternationalUri>>doc:IMElements.InternationalURI.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales. 58 58 |[[LocalisedUri>>doc:IMElements.LocalisedURI.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The Localised URI supports the link to an external description in one locale (locale is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.). 59 59 |//[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]//|(% style="width:262px" %)((( ... ... @@ -60,7 +60,7 @@ 60 60 Superclass is //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// 61 61 Base inheritance sub classes are: 62 62 //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// 63 -)))|(% style="width:543px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of [[Annotable Artefact>>doc:sdmx:Glossary 2\.1.Annotable artefact.WebHome]]. 63 +)))|(% style="width:543px" %)Provides identity to all derived classes. It also provides [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] to derived classes because it is a subclass of [[Annotable Artefact>>doc:sdmx:Glossary 2\.1.Annotable artefact.WebHome]]. 64 64 | |(% style="width:262px" %)[[id>>doc:IMElements.id.WebHome]]|(% style="width:543px" %)The unique identifier of the object. 65 65 | |(% style="width:262px" %)[[uri>>doc:IMElements.uri.WebHome]]|(% style="width:543px" %)Universal resource identifier that may or may not be resolvable. 66 66 | |(% style="width:262px" %)[[urn>>doc:IMElements.urn.WebHome]]|(% style="width:543px" %)Universal resource name – this is for use in registries: all registered objects have a urn. ... ... @@ -67,11 +67,11 @@ 67 67 |//[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]//|(% style="width:262px" %)((( 68 68 Superclass is //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// Base inheritance sub classes are: 69 69 //[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]// 70 -)))|(% style="width:543px" %)Provides a Name and Description to all derived classes in addition to identification and annotations. 70 +)))|(% style="width:543px" %)Provides a Name and Description to all derived classes in addition to identification and [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]]. 71 71 | |(% style="width:262px" %)+[[description>>doc:IMElements.description.WebHome]]|(% style="width:543px" %)A multi-lingual description is provided by this role via the [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] class. 72 72 | |(% style="width:262px" %)+[[name>>doc:IMElements.name.WebHome]]|(% style="width:543px" %)A multi-lingual name is provided by this role via the [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] class 73 -|[[InternationalString>>doc:IMElements.InternationalString.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] is a collection of Localised Strings and supports the representation of text in multiple locales. 74 -|[[LocalisedString>>doc:IMElements.LocalisedString.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The Localised String supports the representation of text in one locale (locale is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.). 73 +|[[InternationalString>>doc:IMElements.InternationalString.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] is a collection of Localised Strings and supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of text in multiple locales. 74 +|[[LocalisedString>>doc:IMElements.LocalisedString.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The Localised String supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of text in one locale (locale is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.). 75 75 | |(% style="width:262px" %)[[label>>doc:IMElements.label.WebHome]]|(% style="width:543px" %)Label of the string. 76 76 | |(% style="width:262px" %)[[locale>>doc:IMElements.locale.WebHome]]|(% style="width:543px" %)The geographic locale of the string e.g French, Canadian French. 77 77 |//[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]//|(% style="width:262px" %)((( ... ... @@ -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>>doc:IMElements.enumerated.WebHome]] [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] or the usage of a [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] when specified for use on a //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// on a //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]// (such as a [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]] in a [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]]). The [[description>>doc:IMElements.description.WebHome]] of the various types can be found in the chapter on [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]] (section 4.5).123 +The FacetType and FacetValueType enumerations are used to specify the valid format of the content of a [[non-enumerated>>doc:IMElements.nonEnumerated.WebHome]] [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] or the usage of a [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] when specified for use on a //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// on a //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]// (such as a [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]] in a [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]]). The [[description>>doc:IMElements.description.WebHome]] of the various types can be found in the chapter on [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]] (section 4.5). 124 124 125 -The ActionType enumeration is used to specify the [[action>>doc:IMElements.action.WebHome]]that a receiving system should take when processing the content that is the object of the[[action>>doc:IMElements.action.WebHome]].It is [[enumerated>>doc:IMElements.enumerated.WebHome]] as follows:125 +The ActionType enumeration is used to specify the action that a receiving system should take when processing the content that is the object of the action. It is [[enumerated>>doc:IMElements.enumerated.WebHome]] as follows: 126 126 127 -* Append: Data or [[metadata>>doc:IMElements.metadata.WebHome]]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>>doc:IMElements.metadata.WebHome]]is already present, it will not replace that data or[[metadata>>doc:IMElements.metadata.WebHome]].This corresponds to the "Update"[[value>>doc:IMElements.value.WebHome]]found in [[version>>doc:IMElements.version.WebHome]] 1.0 of the [[SDMX>>doc:sdmx:Glossary2\.1.Statistical data and metadata exchange.WebHome]] Technical Standards.128 -* Replace: Data/ [[metadata>>doc:IMElements.metadata.WebHome]]is to be replaced and may also include additional data/[[metadata>>doc:IMElements.metadata.WebHome]]to be appended.127 +* Append: Data or metadata is an [[incremental update>>doc:Glossary.Incremental update.WebHome]] for an existing data/[[metadata set>>doc:Glossary.Metadata set.WebHome]] or the provision of new data or documentation ([[attribute>>doc:Glossary.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" value found in [[version>>doc:IMElements.version.WebHome]] 1.0 of the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Technical Standards. 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 -* Information: Data and [[metadata>>doc:IMElements.metadata.WebHome]]are for information purposes.130 +* Information: Data and metadata are for information purposes. 131 131 132 -The ToValueType data [[type>>doc:IMElements.type.WebHome]] contains the [[attributes>>doc: sdmx:Glossary2\.1.Attribute.WebHome]] to support transformations defined in the StructureMap (see Section 0).132 +The ToValueType data [[type>>doc:IMElements.type.WebHome]] contains the [[attributes>>doc:Glossary.Attribute.WebHome]] to support transformations defined in the StructureMap (see Section 0). 133 133 134 -The ConstraintRoleType data [[type>>doc:IMElements.type.WebHome]] 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 [[type>>doc:IMElements.type.WebHome]] contains the [[attributes>>doc:Glossary.Attribute.WebHome]] that identify the purpose of a [[Constraint>>doc:Glossary.Constraint.WebHome]] (allowableContent, actualContent). 135 135 136 136 The ComponentRoleType data [[type>>doc:IMElements.type.WebHome]] contains the predefined [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] roles that can be assigned to any [[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]. 137 137 138 138 The CascadeValues data [[type>>doc:IMElements.type.WebHome]] contains the possible values for a [[MemberValue>>doc:IMElements.SelectionValue.MemberValue.WebHome]] within a CubeRegion, in order to enable cascading to all children Codes of a selected [[Code>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Code.WebHome]], 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 and metadata exchange.WebHome]] Standards Section 6, paragraph “4.3 Versioning”.140 +The VersionType data types provides the details for versioning according to [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6, paragraph “4.3 Versioning”. 141 141 142 142 == 3.5 The Item Scheme Pattern == 143 143 ... ... @@ -145,7 +145,7 @@ 145 145 146 146 The [[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]] 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>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is the basis for [[CategoryScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.CategoryScheme.WebHome]], [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]], [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]], [[ReportingTaxonomy>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ReportingTaxonomy.WebHome]], //[[OrganisationScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.WebHome]]//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme.148 +The //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is the basis for [[CategoryScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.CategoryScheme.WebHome]], Codelist, [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]], [[ReportingTaxonomy>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ReportingTaxonomy.WebHome]], //[[OrganisationScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.WebHome]]//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme. 149 149 150 150 === 3.5.2 Class Diagram === 151 151 ... ... @@ -157,15 +157,15 @@ 157 157 158 158 ==== 3.5.3.1 Narrative ==== 159 159 160 -The //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is an abstract class which defines a set of //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// (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:Glossary2\.1.SDMX Information Model.WebHome]]. It is derived from //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// which gives it the ability to be annotated, have identity, naming, versioning and be associated with an [[Agency>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.Agency.WebHome]]. An example of a concrete class is a [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]]. The associated Concepts are //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s.160 +The //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is an abstract class which defines a set of //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// (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:Glossary.SDMX Information Model.WebHome]]. It is derived from //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// which gives it the ability to be annotated, have identity, naming, versioning and be associated with an [[Agency>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.Agency.WebHome]]. An example of a concrete class is a [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]]. The associated Concepts are //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s. 161 161 162 -In an exchange environment an //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is allowed to contain a sub-set of the //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s in the maintained //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//. If such an [[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]] is disseminated with a sub-set of the //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s then the fact that this is a sub-set is denoted by setting the [[isPartial>>doc:IMElements.isPartial.WebHome]] [[attribute>>doc: sdmx:Glossary2\.1.Attribute.WebHome]] to "true".162 +In an exchange environment an //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is allowed to contain a sub-set of the //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s in the maintained //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//. If such an [[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]] is disseminated with a sub-set of the //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s then the fact that this is a sub-set is denoted by setting the [[isPartial>>doc:IMElements.isPartial.WebHome]] [[attribute>>doc:Glossary.Attribute.WebHome]] to "true". 163 163 164 -A “partial” //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// cannot be maintained independently in its partial form i.e., it cannot contain //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s that are not present in the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// and the content of any one //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]] //(e.g., names and descriptions) cannot deviate from the content in the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//. Furthermore, the [[id>>doc:IMElements.id.WebHome]] of the //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// where [[isPartial>>doc:IMElements.isPartial.WebHome]] is set to "true" is the same as the [[id>>doc:IMElements.id.WebHome]] of the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// (agencyId, [[id>>doc:IMElements.id.WebHome]], [[version>>doc:IMElements.version.WebHome]]). This is important as this is the [[id>>doc:IMElements.id.WebHome]] that that is referenced in other structures (e.g., a [[Codelist>>doc:sdmx:Glossary2\.1.Code list.WebHome]]referenced in a[[DSD>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]) and this [[id>>doc:IMElements.id.WebHome]] is always the same, regardless of whether the disseminated //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// or a partial //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//.164 +A “partial” //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// cannot be maintained independently in its partial form i.e., it cannot contain //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s that are not present in the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// and the content of any one //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]] //(e.g., names and descriptions) cannot deviate from the content in the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//. Furthermore, the [[id>>doc:IMElements.id.WebHome]] of the //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// where [[isPartial>>doc:IMElements.isPartial.WebHome]] is set to "true" is the same as the [[id>>doc:IMElements.id.WebHome]] of the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// (agencyId, [[id>>doc:IMElements.id.WebHome]], [[version>>doc:IMElements.version.WebHome]]). This is important as this is the [[id>>doc:IMElements.id.WebHome]] that that is referenced in other structures (e.g., a Codelist referenced in a DSD) and this [[id>>doc:IMElements.id.WebHome]] is always the same, regardless of whether the disseminated //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// or a partial //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//. 165 165 166 -The purpose of a partial //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is to support the exchange and dissemination of a subset //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// without the need to maintain multiple //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//s which contain the same //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s. For instance, when a [[Codelist>>doc:sdmx:Glossary2\.1.Code list.WebHome]]isused in a [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]] it is sometimes the case that only a sub-set of the Codes in a[[Codelist>>doc:sdmx:Glossary2\.1.Code list.WebHome]]are relevant. In this case a partial[[Codelist>>doc:sdmx:Glossary2\.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>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is to support the exchange and dissemination of a subset //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// without the need to maintain multiple //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//s which contain the same //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s. For instance, when a Codelist is used in a [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]] it is sometimes the case that only a sub-set of the Codes in a Codelist are relevant. In this case a partial Codelist can be constructed using the [[Constraint>>doc:Glossary.Constraint.WebHome]] mechanism explained later in this document. 167 167 168 -//[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// inherits from //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// which gives it the ability to be annotated and have identity, and therefore has [[id>>doc:IMElements.id.WebHome]], [[uri>>doc:IMElements.uri.WebHome]] and [[urn>>doc:IMElements.urn.WebHome]] [[attributes>>doc: sdmx:Glossary2\.1.Attribute.WebHome]], a [[name>>doc:IMElements.name.WebHome]] and a [[description>>doc:IMElements.description.WebHome]] in the form of an [[InternationalString>>doc:IMElements.InternationalString.WebHome]]. Unlike the [[parent>>doc:IMElements.parent.WebHome]] //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//, the //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// itself is not a //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// and therefore cannot have an independent [[Agency>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.Agency.WebHome]] (i.e., it implicitly has the same agencyId as the //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//).168 +//[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// inherits from //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// which gives it the ability to be annotated and have identity, and therefore has [[id>>doc:IMElements.id.WebHome]], [[uri>>doc:IMElements.uri.WebHome]] and [[urn>>doc:IMElements.urn.WebHome]] [[attributes>>doc:Glossary.Attribute.WebHome]], a [[name>>doc:IMElements.name.WebHome]] and a [[description>>doc:IMElements.description.WebHome]] in the form of an [[InternationalString>>doc:IMElements.InternationalString.WebHome]]. Unlike the [[parent>>doc:IMElements.parent.WebHome]] //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//, the //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// itself is not a //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// and therefore cannot have an independent [[Agency>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.Agency.WebHome]] (i.e., it implicitly has the same agencyId as the //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//). 169 169 170 170 The //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// can be hierarchic and so one //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// can have [[child>>doc:IMElements.child.WebHome]] //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s. The restriction of the hierarchic association is that a [[child>>doc:IMElements.child.WebHome]] //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// can have only [[parent>>doc:IMElements.parent.WebHome]] //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//. 171 171