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
-
... ... @@ -24,75 +24,75 @@ 24 24 25 25 ==== 3.2.2.1 Narrative ==== 26 26 27 -This group of classes forms the nucleus of the administration [[facets>>doc:sdmx:Glossary2\.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.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. 28 28 29 -All classes derived from the abstract class //AnnotableArtefact // 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:Glossary2\.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 (represented by the association to InternationalString).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 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 -The //IdentifiableArtefact// is an abstract class that comprises the basic [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] needed for identification. Concrete classes based on //IdentifiableArtefact// all inherit the ability to be uniquely identified. 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 //and in addition the +description and +name roles support multilingual descriptions and names for all objects based on //NameableArtefact//. The InternationalString supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]]of a descriptioninmultiple locales (locale is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.). The //LocalisedString// supports the[[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]]of a descriptioninone locale.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]]. 34 34 35 -//VersionableArtefact// is an abstract class which inherits from //NameableArtefact// 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”. 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 -//MaintainableArtefact// further adds the ability for derived classes to be maintained via its association to an //Organisation//, and adds locational information (i.e., from where the object can be retrieved). 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// through to //MaintainableArtefact// 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.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. 40 40 41 41 ==== 3.2.2.2 Definitions ==== 42 42 43 43 (% style="width:973.835px" %) 44 44 |**Class**|(% style="width:262px" %)**Feature**|(% style="width:543px" %)**Description** 45 -|//AnnotableArtefact//|(% style="width:262px" %)((( 45 +|//[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]//|(% style="width:262px" %)((( 46 46 Base inheritance sub classes are: 47 -//IdentifiableArtefact// 48 -)))|(% style="width:543px" %)Objects of classes derived from this can have attached [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]].49 -|[[Annotation>>doc: sdmx:Glossary 2\.1.Annotation.WebHome]]|(% style="width:262px" %)// //|(% style="width:543px" %)Additional descriptive information attached to an object.50 -| |(% style="width:262px" %)id|(% style="width:543px" %)Identifier for the [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]].It can be used to disambiguate one[[Annotation>>doc:sdmx:Glossary2\.1.Annotation.WebHome]]from another where there are several[[Annotations>>doc:sdmx:Glossary2\.1.Annotation.WebHome]]for the same annotated object.51 -| |(% style="width:262px" %)[[title>>doc: sdmx:Glossary 2\.1.Title.WebHome]]|(% style="width:543px" %)A[[title>>doc:sdmx:Glossary2\.1.Title.WebHome]]used to identify an[[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]].52 -| |(% style="width:262px" %)type|(% style="width:543px" %)Specifies how the [[annotation>>doc:sdmx:Glossary2\.1.Annotation.WebHome]] is to be processed.53 -| |(% style="width:262px" %)url|(% style="width:543px" %)A link to external descriptive text. 54 -| |(% style="width:262px" %)value|(% style="width:543px" %)A non-localised version of the [[Annotation>>doc:sdmx:Glossary2\.1.Annotation.WebHome]]content.55 -| |(% style="width:262px" %)+url|(% 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|(% style="width:543px" %)An [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] provides the multilingual text content of the [[annotation>>doc:sdmx:Glossary2\.1.Annotation.WebHome]]via this role.57 -|InternationalUri|(% 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 -|LocalisedUri|(% 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 -|//IdentifiableArtefact//|(% style="width:262px" %)((( 60 -Superclass is //AnnotableArtefact// 47 +//[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// 48 +)))|(% style="width:543px" %)Objects of classes derived from this can have attached annotations. 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. 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. 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. 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 +|[[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 +|//[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]//|(% style="width:262px" %)((( 60 +Superclass is //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// 61 61 Base inheritance sub classes are: 62 -//NameableArtefact// 63 -)))|(% style="width:543px" %)Provides identity to all derived classes. It also provides [[annotations>>doc:sdmx:Glossary2\.1.Annotation.WebHome]]toderived classes because it is a subclass of [[Annotable Artefact>>doc:sdmx:Glossary 2\.1.Annotable artefact.WebHome]].64 -| |(% style="width:262px" %)id|(% style="width:543px" %)The unique identifier of the object. 65 -| |(% style="width:262px" %)uri|(% style="width:543px" %)Universal resource identifier that may or may not be resolvable. 66 -| |(% style="width:262px" %)urn|(% style="width:543px" %)Universal resource name – this is for use in registries: all registered objects have a urn. 67 -|//NameableArtefact//|(% style="width:262px" %)((( 68 -Superclass is //IdentifiableArtefact// Base inheritance sub classes are: 69 -//VersionableArtefact// 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 -| |(% style="width:262px" %)+description|(% 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 -| |(% style="width:262px" %)+name|(% 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|(% 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:Glossary2\.1.Representation.WebHome]] of text in multiple locales.74 -|LocalisedString|(% style="width:262px" %) |(% style="width:543px" %)The Localised String supports the [[representation>>doc:sdmx:Glossary2\.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 -| |(% style="width:262px" %)label|(% style="width:543px" %)Label of the string. 76 -| |(% style="width:262px" %)locale|(% style="width:543px" %)The geographic locale of the string e.g French, Canadian French. 77 -|//VersionableArtefact//|(% style="width:262px" %)((( 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]]. 64 +| |(% style="width:262px" %)[[id>>doc:IMElements.id.WebHome]]|(% style="width:543px" %)The unique identifier of the object. 65 +| |(% style="width:262px" %)[[uri>>doc:IMElements.uri.WebHome]]|(% style="width:543px" %)Universal resource identifier that may or may not be resolvable. 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 +|//[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]//|(% style="width:262px" %)((( 68 +Superclass is //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// Base inheritance sub classes are: 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. 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 +| |(% 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.). 75 +| |(% style="width:262px" %)[[label>>doc:IMElements.label.WebHome]]|(% style="width:543px" %)Label of the string. 76 +| |(% style="width:262px" %)[[locale>>doc:IMElements.locale.WebHome]]|(% style="width:543px" %)The geographic locale of the string e.g French, Canadian French. 77 +|//[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]//|(% style="width:262px" %)((( 78 78 Superclass is 79 -//NameableArtefact// 79 +//[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// 80 80 Base inheritance sub classes are: 81 -//MaintainableArtefact// 81 +//[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// 82 82 )))|(% style="width:543px" %)Provides versioning information for all derived objects. 83 -| |(% style="width:262px" %)[[version>>doc: sdmx:Glossary 2\.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" %)validFrom|(% style="width:543px" %)Date from which the [[version>>doc:sdmx:Glossary2\.1.Version.WebHome]] is valid85 -| |(% style="width:262px" %)validTo|(% style="width:543px" %)Date from which [[version>>doc:sdmx:Glossary2\.1.Version.WebHome]] is superseded86 -|//MaintainableArtefact//|(% style="width:262px" %)((( 83 +| |(% style="width:262px" %)[[version>>doc:IMElements.version.WebHome]]|(% style="width:543px" %)A version string following [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules. 84 +| |(% style="width:262px" %)[[validFrom>>doc:IMElements.validFrom.WebHome]]|(% style="width:543px" %)Date from which the version is valid 85 +| |(% style="width:262px" %)[[validTo>>doc:IMElements.validTo.WebHome]]|(% style="width:543px" %)Date from which version is superseded 86 +|//[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]//|(% style="width:262px" %)((( 87 87 Inherits from 88 88 89 -//VersionableArtefact// 89 +//[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]// 90 90 )))|(% style="width:543px" %)An abstract class to group together primary [[structural metadata>>doc:sdmx:Glossary 2\.1.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] that are maintained by an Agency. 91 -| |(% style="width:262px" %)[[isExternalReference>>doc: sdmx:Glossary 2\.1.isExternalReference.WebHome]]|(% style="width:543px" %)If set to “true” it indicates that the content of the object is held externally.92 -| |(% style="width:262px" %)structureURL|(% style="width:543px" %)The URL of an [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] document containing the external object. 93 -| |(% style="width:262px" %)serviceURL|(% style="width:543px" %)The URL of an [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]]-compliant web service from which the external object can be retrieved. 94 -| |(% style="width:262px" %)+maintainer|(% style="width:543px" %)Association to the [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]] responsible for maintaining the [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. 95 -|Agency|(% style="width:262px" %) |(% style="width:543px" %)See section on “Organisations” 91 +| |(% style="width:262px" %)[[isExternalReference>>doc:IMElements.isExternalReference.WebHome]]|(% style="width:543px" %)If set to “true” it indicates that the content of the object is held externally. 92 +| |(% style="width:262px" %)[[structureURL>>doc:IMElements.structureURL.WebHome]]|(% style="width:543px" %)The URL of an [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] document containing the external object. 93 +| |(% style="width:262px" %)[[serviceURL>>doc:IMElements.serviceURL.WebHome]]|(% style="width:543px" %)The URL of an [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]]-compliant web service from which the external object can be retrieved. 94 +| |(% style="width:262px" %)+[[maintainer>>doc:IMElements.maintainer.WebHome]]|(% style="width:543px" %)Association to the [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]] responsible for maintaining the [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. 95 +|[[Agency>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.Agency.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)See section on “Organisations” 96 96 97 97 == 3.3 Basic Inheritance == 98 98 ... ... @@ -120,22 +120,22 @@ 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 [[Concept>>doc:sd mx:Glossary 2\.1.Concept.WebHome]] or the usage of a [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] when specified for use on a //[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]// on a //Structure// (such as a [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] in a DataStructureDefinition). The description of the various types can be found in the chapter on ConceptScheme (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.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). 124 124 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 as follows: 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: 126 126 127 -* Append: Data or metadata is an [[incremental update>>doc:sdmx:Glossary 2\.1.Incremental update.WebHome]] for an existing data/[[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]] or the provision of new data or documentation ([[attribute>>doc:sdmx:Glossary 2\.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" value found in (%id="confict-imterms-29" %)version(%%)1.0 of the [[SDMX>>doc:sdmx:Glossary 2\.1.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. 127 +* Append: Data or [[metadata>>doc:IMElements.metadata.WebHome]] is an [[incremental update>>doc:sdmx:Glossary 2\.1.Incremental update.WebHome]] for an existing data/[[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]] or the provision of new data or documentation ([[attribute>>doc:sdmx:Glossary 2\.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:Glossary 2\.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. 129 129 * Delete: Data/Metadata is to be deleted. 130 -* Information: Data and metadata are for information purposes. 130 +* Information: Data and [[metadata>>doc:IMElements.metadata.WebHome]] are for information purposes. 131 131 132 -The ToValueType data type contains the [[attributes>>doc:sdmx:Glossary 2\.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:sdmx:Glossary 2\.1.Attribute.WebHome]] to support transformations defined in the StructureMap (see Section 0). 133 133 134 -The ConstraintRoleType data type contains the [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] that identify the purpose of a [[Constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] (allowableContent, actualContent). 134 +The ConstraintRoleType data [[type>>doc:IMElements.type.WebHome]] contains the [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] that identify the purpose of a [[Constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] (allowableContent, actualContent). 135 135 136 -The ComponentRoleType data type contains the predefined [[Concept>>doc:sd mx:Glossary 2\.1.Concept.WebHome]] roles that can be assigned to any [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]].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 -The CascadeValues data type contains the possible values for a MemberValue within a CubeRegion, in order to enable cascading to all children [[Codes>>doc:sdmx:Glossary2\.1.Code.WebHome]] of a selected [[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]], while including/excluding the latter in the selection.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 140 The VersionType data types provides the details for versioning according to [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Standards Section 6, paragraph “4.3 Versioning”. 141 141 ... ... @@ -143,45 +143,45 @@ 143 143 144 144 === 3.5.1 Context === 145 145 146 -The Item Scheme is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example. 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// is the basis for CategoryScheme, Codelist, ConceptScheme, ReportingTaxonomy, //OrganisationScheme//, 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>>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. 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 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 //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 Agency. An example of a concrete class is a ConceptScheme. The associated Concepts are //Item//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:sdmx:Glossary 2\.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. 161 161 162 -In an exchange environment an //ItemScheme// is allowed to contain a sub-set of the //Item//s in the maintained //ItemScheme//. If such an ItemScheme is disseminated with a sub-set of the //Item//s then the fact that this is a sub-set is denoted by setting the isPartial attribute 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:sdmx:Glossary 2\.1.Attribute.WebHome]] to "true". 163 163 164 -A “partial” //ItemScheme// cannot be maintained independently in its partial form i.e., it cannot contain //Item//s that are not present in the full //ItemScheme// and the content of any one //Item //(e.g., names and descriptions) cannot deviate from the content in the full //ItemScheme//. Furthermore, the id of the //ItemScheme// where isPartial is set to "true" is the same as the id of the full //ItemScheme// (agencyId, id, version). This is important as this is the id that that is referenced in other structures (e.g., a Codelist referenced in a DSD) and this id is always the same, regardless of whether the disseminated //ItemScheme// is the full //ItemScheme// or a partial //ItemScheme//. 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:Glossary 2\.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]]//. 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 //Item//s. For instance, when a Codelist is used in a DataStructureDefinition 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 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>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] 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>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] are relevant. In this case a partial [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] can be constructed using the [[Constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] mechanism explained later in this document. 167 167 168 -//Item// inherits from //NameableArtefact// which gives it the ability to be annotated and have identity, and therefore has id, uri and urn attributes, a name and a description in the form of an InternationalString. Unlike the parent //ItemScheme//, the //Item// itself is not a //MaintainableArtefact// and therefore cannot have an independent Agency (i.e., it implicitly has the same agencyId as the //ItemScheme//). 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:Glossary 2\.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]]//). 169 169 170 -The //Item// can be hierarchic and so one //Item// can have child //Item//s. The restriction of the hierarchic association is that a child //Item// can have only parent //Item//. 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 172 172 ==== 3.5.3.2 Definitions ==== 173 173 174 174 (% style="width:989.835px" %) 175 175 |**Class**|(% style="width:297px" %)**Feature**|(% style="width:583px" %)**Description** 176 -|//ItemScheme//|(% style="width:297px" %)((( 176 +|//[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//|(% style="width:297px" %)((( 177 177 Inherits from: 178 -//MaintainableArtefact// 178 +//[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// 179 179 Direct sub classes are: 180 -CategoryScheme 181 -ConceptScheme 182 -Codelist 183 -ReportingTaxonomy 184 -//OrganisationScheme// 180 +[[CategoryScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.CategoryScheme.WebHome]] 181 +[[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]] 182 +[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] 183 +[[ReportingTaxonomy>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ReportingTaxonomy.WebHome]] 184 +//[[OrganisationScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.WebHome]]// 185 185 TransformationScheme 186 186 CustomTypeScheme NamePersonalisationScheme 187 187 RulesetScheme ... ... @@ -188,17 +188,17 @@ 188 188 VtlMappingScheme 189 189 UserDefinedOperatorScheme 190 190 )))|(% style="width:583px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common. 191 -| |(% style="width:297px" %)isPartial|(% style="width:583px" %)Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme. 191 +| |(% style="width:297px" %)[[isPartial>>doc:IMElements.isPartial.WebHome]]|(% style="width:583px" %)Denotes whether the [[Item Scheme>>doc:sdmx:Glossary 2\.1.Item scheme.WebHome]] contains a subset of the full set of Items in the maintained scheme. 192 192 | |(% style="width:297px" %)/items|(% style="width:583px" %)Association to the Items in the scheme. 193 -|//Item//|(% style="width:297px" %)((( 193 +|//[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//|(% style="width:297px" %)((( 194 194 Inherits from: 195 -//NameableArtefact// 195 +//[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// 196 196 Direct sub classes are 197 -Category 198 -Concept 199 -Code 200 -ReportingCategory 201 -//Organisation// 197 +[[Category>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Category.WebHome]] 198 +[[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] 199 +[[Code>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Code.WebHome]] 200 +[[ReportingCategory>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.ReportingCategory.WebHome]] 201 +//[[Organisation>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.WebHome]]// 202 202 Transformation 203 203 CustomType 204 204 NamePersonalisation ... ... @@ -206,15 +206,15 @@ 206 206 VtlMapping 207 207 UserDefinedOperator 208 208 )))|(% style="width:583px" %)((( 209 -The Item is an item of content in an Item Scheme. This may be a node in a taxonomy or ontology, a code in a code list etc. Node that at the conceptual level the Organisation is not hierarchic. 209 +The Item is an item of content in an [[Item Scheme>>doc:sdmx:Glossary 2\.1.Item scheme.WebHome]]. This may be a node in a taxonomy or ontology, a code in a [[code list>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] etc. Node that at the conceptual level the Organisation is not hierarchic. 210 210 ))) 211 -| |(% style="width:297px" %)hierarchy|(% style="width:583px" %)This allows an Item optionally to have one or more child Items 211 +| |(% style="width:297px" %)[[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]]|(% style="width:583px" %)This allows an Item optionally to have one or more child Items 212 212 213 213 == 3.6 The Structure Pattern == 214 214 215 215 === 3.6.1 Context === 216 216 217 -The Structure Pattern is a basic architectural pattern which allows the specification of complex tabular structures which are often found in statistical data (such as Data (% id="confict-imterms-88" %)Structure(%%)Definition, and Metadata(% id="confict-imterms-89" %)Structure(%%)Definition). A Structure is a set of ordered lists. A pattern to underpin this tabular structure has been developed, so that commonalities between these structure definitions can be supported by common software and common syntax structures.217 +The [[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]] Pattern is a basic architectural pattern which allows the specification of complex tabular structures which are often found in statistical data (such as Data [[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]] Definition, and Metadata [[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]] Definition). A [[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]] is a set of ordered lists. A pattern to underpin this tabular [[structure>>doc:IMElements.structure.WebHome]] has been developed, so that commonalities between these [[structure>>doc:IMElements.structure.WebHome]] definitions can be supported by common software and common syntax structures. 218 218 219 219 === 3.6.2 Class Diagrams === 220 220 ... ... @@ -230,89 +230,89 @@ 230 230 231 231 ==== 3.6.3.1 Narrative ==== 232 232 233 -The //Structure// is an abstract class which contains a set of one or more //ComponentList//(s) (this class is also abstract). An example of a concrete //Structure// is DataStructureDefinition. 233 +The //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]// is an abstract class which contains a set of one or more //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]//(s) (this class is also abstract). An example of a concrete //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]// is [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]]. 234 234 235 -The //ComponentList// is a list of one or more //Component//(s//)//. The //ComponentList// has several concrete descriptor classes based on it: DimensionDescriptor, GroupDimensionDescriptor, MeasureDescriptor, and AttributeDescriptor of the DataStructureDefinition and MetadataAttributeDescriptor of the MetadataStructureDefinition. 235 +The //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]// is a list of one or more //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]//(s//)//. The //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]// has several concrete descriptor classes based on it: [[DimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.DimensionDescriptor.WebHome]], [[GroupDimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.GroupDimensionDescriptor.WebHome]], [[MeasureDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MeasureDescriptor.WebHome]], and [[AttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.AttributeDescriptor.WebHome]] of the [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]] and [[MetadataAttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MetadataAttributeDescriptor.WebHome]] of the [[MetadataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.MetadataStructureDefinition.WebHome]]. 236 236 237 -The //Component// is contained in a //ComponentList//. The type of //Component// in a //ComponentList// is dependent on the concrete class of the ComponentList as follows: 237 +The //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// is contained in a //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]//. The [[type>>doc:IMElements.type.WebHome]] of //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// in a //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]// is dependent on the concrete class of the [[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]] as follows: 238 238 239 -DimensionDescriptor: Dimension, TimeDimension 240 -GroupDimensionDescriptor: Dimension, TimeDimension 241 -MeasureDescriptor: Measure 242 -AttributeDescriptor: DataAttribute, MetadataAttributeRef 243 -MetadataAttributeDescriptor: MetadataAttribute 239 +[[DimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.DimensionDescriptor.WebHome]]: [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]], [[TimeDimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.TimeDimension.WebHome]] 240 +[[GroupDimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.GroupDimensionDescriptor.WebHome]]: [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]], [[TimeDimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.TimeDimension.WebHome]] 241 +[[MeasureDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MeasureDescriptor.WebHome]]: [[Measure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.Measure.WebHome]] 242 +[[AttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.AttributeDescriptor.WebHome]]: [[DataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.DataAttribute.WebHome]], MetadataAttributeRef 243 +[[MetadataAttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MetadataAttributeDescriptor.WebHome]]: [[MetadataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.MetadataAttribute.WebHome]] 244 244 245 -Each //Component// takes its semantic (and possibly also its representation) from a Concept in a ConceptScheme. This is represented by the conceptIdentity association to Concept. 245 +Each //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// takes its semantic (and possibly also its representation) from a [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] in a [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]]. This is represented by the [[conceptIdentity>>doc:IMElements.conceptIdentity.WebHome]] association to [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]]. 246 246 247 -The //Component// may also have a localRepresentation. This allows a concrete class, such as Dimension, to specify its representation which is local to the //Structure// in which it is contained (for Dimension this will be DataStructureDefinition), and thus overrides any coreRepresentation specified for the Concept. 247 +The //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// may also have a [[localRepresentation>>doc:IMElements.localRepresentation.WebHome]]. This allows a concrete class, such as [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]], to specify its representation which is local to the //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]// in which it is contained (for [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]] this will be [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]]), and thus overrides any [[coreRepresentation>>doc:IMElements.coreRepresentation.WebHome]] specified for the [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]]. 248 248 249 -The Representation can be enumerated or non-enumerated. The valid content of an enumerated representation is specified either in an //ItemScheme// which can be one of Codelist, ValueList or //GeoCodelist//. The valid content of a non-enumerated representation is specified as one or more Facet(s) (for example, these may specify minimum and maximum values). For any Attribute this is achieved by one of more 249 +The [[Representation>>doc:IMElements.Representation.WebHome]] can be [[enumerated>>doc:IMElements.enumerated.WebHome]] or non-[[enumerated>>doc:IMElements.enumerated.WebHome]]. The valid content of an [[enumerated>>doc:IMElements.enumerated.WebHome]] representation is specified either in an //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// which can be one of [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]], [[ValueList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.EnumeratedList.ValueList.WebHome]] or //[[GeoCodelist>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.Codelist.GeoCodelist.WebHome]]//. The valid content of a non-[[enumerated>>doc:IMElements.enumerated.WebHome]] representation is specified as one or more Facet(s) (for example, these may specify minimum and maximum values). For any [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] this is achieved by one of more 250 250 251 251 ExtendedFacet(s), which allow the additional representation of XHTML. 252 252 253 -The types of representation that are valid for specific components is expressed in the model as a constraint on the association: 253 +The types of representation that are valid for specific [[components>>doc:IMElements.components.WebHome]] is expressed in the model as a [[constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] on the association: 254 254 255 -* The Dimension, DataAttribute, Measure, MetadataAttribute may be enumerated and, if so, use an //EnumeratedList//. 256 -* The Dimension and Measure may be non-enumerated and, if so, use one or more Facet(s), note that the FacetValueType applicable to the TimeDimension is restricted to those that represent time. 257 -* The MetadataAttribute and DataAttribute may be non-enumerated and, if so, use one or more ExtendedFacet(s). 255 +* The [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]], [[DataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.DataAttribute.WebHome]], [[Measure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.Measure.WebHome]], [[MetadataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.MetadataAttribute.WebHome]] may be [[enumerated>>doc:IMElements.enumerated.WebHome]] and, if so, use an //[[EnumeratedList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.EnumeratedList.WebHome]]//. 256 +* The [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]] and [[Measure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.Measure.WebHome]] may be non-[[enumerated>>doc:IMElements.enumerated.WebHome]] and, if so, use one or more Facet(s), note that the FacetValueType applicable to the [[TimeDimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.TimeDimension.WebHome]] is restricted to those that represent time. 257 +* The [[MetadataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.MetadataAttribute.WebHome]] and [[DataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.DataAttribute.WebHome]] may be non-[[enumerated>>doc:IMElements.enumerated.WebHome]] and, if so, use one or more ExtendedFacet(s). 258 258 259 -The //Structure// may be used by one or more //StructureUsage//(s). An example of this, in terms of concrete classes, is that a Dataflow (sub class of //StructureUsage//) may use a particular DataStructureDefinition (sub class of //Structure//), and similar constructs apply for the Metadataflow (link to MetadataStructureDefinition). 259 +The //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]// may be used by one or more //[[StructureUsage>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.WebHome]]//(s). An example of this, in terms of concrete classes, is that a [[Dataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Dataflow.WebHome]] (sub class of //[[StructureUsage>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.WebHome]]//) may use a particular [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]] (sub class of //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]//), and similar constructs apply for the [[Metadataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Metadataflow.WebHome]] (link to [[MetadataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.MetadataStructureDefinition.WebHome]]). 260 260 261 261 ==== 3.6.3.2 Definitions ==== 262 262 263 263 (% style="width:1368.29px" %) 264 264 |**Class**|**Feature**|(% style="width:897px" %)**Description** 265 -|StructureUsage|((( 265 +|[[StructureUsage>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.WebHome]]|((( 266 266 Inherits from: 267 -//MaintainableArtefact// 267 +//[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// 268 268 Sub classes are: 269 -Dataflow 270 -Metadataflow 271 -)))|(% style="width:897px" %)An artefact whose components are described by a Structure. In concrete terms (sub-classes) an example would be a Dataflow which is linked to a given structure – in this case the Data Structure Definition. 272 -| |structure|(% style="width:897px" %)An association to a Structure specifying the structure of the artefact. 273 -|Structure|((( 269 +[[Dataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Dataflow.WebHome]] 270 +[[Metadataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Metadataflow.WebHome]] 271 +)))|(% style="width:897px" %)An [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] whose components are described by a Structure. In concrete terms (sub-classes) an example would be a Dataflow which is linked to a given structure – in this case the [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. 272 +| |[[structure>>doc:IMElements.structure.WebHome]]|(% style="width:897px" %)An association to a Structure specifying the structure of the [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. 273 +|[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]|((( 274 274 Inherits from: 275 -//MaintainableArtefact// 275 +//[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// 276 276 Sub classes are: 277 -DataStructureDefinition MetadataStructureDefinition 278 -)))|(% style="width:897px" %)Abstract specification of a list of lists to define a complex tabular structure. A concrete example of this would be statistical concepts, code lists, and their organisation in a data or metadata structure definition, defined by a centre institution, usually for the exchange of statistical information with its partners. 279 -| |grouping|(% style="width:897px" %)A composite association to one or more component lists. 280 -|//ComponentList//|((( 277 +[[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]] [[MetadataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.MetadataStructureDefinition.WebHome]] 278 +)))|(% style="width:897px" %)Abstract specification of a list of lists to define a complex tabular structure. A concrete example of this would be statistical concepts, [[code lists>>doc:sdmx:Glossary 2\.1.Code list.WebHome]], and their organisation in a data or [[metadata structure definition>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]], defined by a centre institution, usually for the exchange of statistical information with its partners. 279 +| |[[grouping>>doc:IMElements.grouping.WebHome]]|(% style="width:897px" %)A composite association to one or more component lists. 280 +|//[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]//|((( 281 281 Inherits from: 282 -//IdentifiableArtefact// 282 +//[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// 283 283 Sub classes are: 284 -DimensionDescriptor 285 -GroupDimensionDescriptor 286 -MeasureDescriptor 287 -AttributeDescriptor MetadataAttributeDescriptor 288 -)))|(% style="width:897px" %)An abstract definition of a list of components. A concrete example is a Dimension Descriptor, which defines the list of Dimensions in a Data Structure Definition. 289 -| |components|(% style="width:897px" %)An aggregate association to one or more components which make up the list. 290 -|//Component//|((( 284 +[[DimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.DimensionDescriptor.WebHome]] 285 +[[GroupDimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.GroupDimensionDescriptor.WebHome]] 286 +[[MeasureDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MeasureDescriptor.WebHome]] 287 +[[AttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.AttributeDescriptor.WebHome]] [[MetadataAttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MetadataAttributeDescriptor.WebHome]] 288 +)))|(% style="width:897px" %)An abstract definition of a list of components. A concrete example is a Dimension Descriptor, which defines the list of Dimensions in a [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. 289 +| |[[components>>doc:IMElements.components.WebHome]]|(% style="width:897px" %)An aggregate association to one or more components which make up the list. 290 +|//[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]//|((( 291 291 Inherits from: 292 -//IdentifiableArtefact// 292 +//[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// 293 293 Sub classes are: 294 -Measure 295 -//AttributeComponent 296 -DimensionComponent// 294 +[[Measure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.Measure.WebHome]] 295 +//[[AttributeComponent>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.WebHome]] 296 +[[DimensionComponent>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.WebHome]]// 297 297 )))|(% style="width:897px" %)A Component is an abstract super class used to define qualitative and quantitative data and metadata items that belong to a Component List and hence a Structure. Component is refined through its sub-classes. 298 -| |conceptIdentity|(% style="width:897px" %)Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component. 299 -| |localRepresentation|(% style="width:897px" %)((( 298 +| |[[conceptIdentity>>doc:IMElements.conceptIdentity.WebHome]]|(% style="width:897px" %)Association to a Concept in a [[Concept Scheme>>doc:sdmx:Glossary 2\.1.Concept scheme.WebHome]] that identifies and defines the semantic of the Component. 299 +| |[[localRepresentation>>doc:IMElements.localRepresentation.WebHome]]|(% style="width:897px" %)((( 300 300 Association to the Representation of the Component if this is different from the coreRepresentation of the Concept, which the Component uses (ConceptUsage). 301 301 ))) 302 -|Representation| |(% style="width:897px" %)The allowable value or format for Component or Concept 303 -| |+enumerated|(% style="width:897px" %)Association to an enumerated list that contains the allowable content for the Component when reported in a data or metadata set. The type of enumerated list that is allowed for any concrete Component is shown in the constraints on the association. 304 -| |+nonEnumerated|(% style="width:897px" %)Association to a set of Facets that define the allowable format for the content of the Component when reported in a data or metadata set. 305 -|Facet| |(% style="width:897px" %)Defines the format for the content of the Component when reported in a data or metadata set. 306 -| |facetType|(% style="width:897px" %)A specific content type, which is constrained by the Facet Type enumeration. 307 -| |facetValueType|(% style="width:897px" %)The format of the value of a Component when reported in a data or metadata set. This is constrained by the Facet Value Type enumeration. 308 -| |+itemSchemeFacet|(% style="width:897px" %)Defines the format of the identifiers in an Item Scheme used by a Component. Typically, this would define the number of characters (length) of the identifier. 309 -|ExtendedFacet| |(% style="width:897px" %)This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute and a Data Attribute. 302 +|[[Representation>>doc:IMElements.Representation.WebHome]]| |(% style="width:897px" %)The allowable value or format for Component or Concept 303 +| |+[[enumerated>>doc:IMElements.enumerated.WebHome]]|(% style="width:897px" %)Association to an enumerated list that contains the allowable content for the Component when reported in a data or [[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]]. The type of enumerated list that is allowed for any concrete Component is shown in the [[constraints>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] on the association. 304 +| |+[[nonEnumerated>>doc:IMElements.nonEnumerated.WebHome]]|(% style="width:897px" %)Association to a set of Facets that define the allowable format for the content of the Component when reported in a data or [[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]]. 305 +|[[Facet>>doc:IMElements.Facet.WebHome]]| |(% style="width:897px" %)Defines the format for the content of the Component when reported in a data or [[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]]. 306 +| |[[facetType>>doc:IMElements.facetType.WebHome]]|(% style="width:897px" %)A specific content type, which is constrained by the Facet Type enumeration. 307 +| |[[facetValueType>>doc:IMElements.facetValueType.WebHome]]|(% style="width:897px" %)The format of the value of a Component when reported in a data or [[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]]. This is constrained by the Facet Value Type enumeration. 308 +| |+itemSchemeFacet|(% style="width:897px" %)Defines the format of the identifiers in an [[Item Scheme>>doc:sdmx:Glossary 2\.1.Item scheme.WebHome]] used by a Component. Typically, this would define the number of characters (length) of the identifier. 309 +|[[ExtendedFacet>>doc:IMElements.ExtendedFacet.WebHome]]| |(% style="width:897px" %)This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] and a Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]. 310 310 311 -The specification of the content and use of the sub classes to //ComponentList// and //Component// can be found in the section in which they are used (DataStructureDefinition and MetadataStructureDefinition). Moreover, the FacetType SentinelValues is explained in the datastructure representation diagram (see 5.3.2.2), since it only concerns DataStructureDefinitions. 311 +The specification of the content and use of the sub classes to //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]// and //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// can be found in the section in which they are used ([[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]] and [[MetadataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.MetadataStructureDefinition.WebHome]]). Moreover, the FacetType SentinelValues is explained in the datastructure representation diagram (see 5.3.2.2), since it only concerns DataStructureDefinitions. 312 312 313 313 ==== 3.6.3.3 Representation Constructs ==== 314 314 315 -The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms: 315 +The majority of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms: 316 316 317 317 |(% style="width:198px" %)((( 318 318 **SDMX Facet Value Type** ... ... @@ -324,11 +324,11 @@ 324 324 |(% style="width:198px" %)Integer|(% style="width:204px" %)xsd:int|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int32|(% style="width:817px" %)int 325 325 |(% style="width:198px" %)Long|(% style="width:204px" %)xsd.long|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int64|(% style="width:817px" %)long 326 326 |(% style="width:198px" %)Short|(% style="width:204px" %)xsd:short|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int16|(% style="width:817px" %)short 327 -|(% style="width:198px" %)Decimal|(% style="width:204px" %)xsd:decimal|(% style="width:209px" %)number|(% style="width:187px" %)System.Decimal|(% style="width:817px" %)java.math.BigDecimal 327 +|(% style="width:198px" %)[[Decimal>>doc:sdmx:Glossary 2\.1.Decimals.WebHome]]|(% style="width:204px" %)xsd:decimal|(% style="width:209px" %)number|(% style="width:187px" %)System.Decimal|(% style="width:817px" %)java.math.BigDecimal 328 328 |(% style="width:198px" %)Float|(% style="width:204px" %)xsd:float|(% style="width:209px" %)number|(% style="width:187px" %)System.Single|(% style="width:817px" %)float 329 329 |(% style="width:198px" %)Double|(% style="width:204px" %)xsd:double|(% style="width:209px" %)number|(% style="width:187px" %)System.Double|(% style="width:817px" %)double 330 330 |(% style="width:198px" %)Boolean|(% style="width:204px" %)xsd:boolean|(% style="width:209px" %)boolean|(% style="width:187px" %)System.Boolean|(% style="width:817px" %)boolean 331 -|(% style="width:198px" %)URI|(% style="width:204px" %)xsd:anyURI|(% style="width:209px" %)string:uri|(% style="width:187px" %)System.Uri|(% style="width:817px" %)Java.net.URI or java.lang.String 331 +|(% style="width:198px" %)URI|(% style="width:204px" %)xsd:anyURI|(% style="width:209px" %)string:[[uri>>doc:IMElements.uri.WebHome]]|(% style="width:187px" %)System.Uri|(% style="width:817px" %)Java.net.URI or java.lang.String 332 332 |(% style="width:198px" %)DateTime|(% style="width:204px" %)xsd:dateTime|(% style="width:209px" %)string:datetime|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar 333 333 |(% style="width:198px" %)Time|(% style="width:204px" %)xsd:time|(% style="width:209px" %)string:time|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar 334 334 |(% style="width:198px" %)GregorianYear|(% style="width:204px" %)xsd:gYear|(% style="width:209px" %)string{{footnote}}In the JSON schemas, more complex data types are complemented with regular expressions, whenever no direct mapping to a standard type exists.{{/footnote}}|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar ... ... @@ -337,25 +337,25 @@ 337 337 |(% style="width:198px" %)Day, MonthDay, Month|(% style="width:204px" %)xsd:g*|(% style="width:209px" %)string|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar 338 338 |(% style="width:198px" %)Duration|(% style="width:204px" %)xsd:duration|(% style="width:209px" %)string|(% style="width:187px" %)System.TimeSpan|(% style="width:817px" %)javax.xml.datatype.Dur ation 339 339 340 -There are also a number of SDMX data types which do not have these direct correspondences, often because they are composite representations or restrictions of a broader data type. These are detailed in Section 6 of the standards. 340 +There are also a number of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] data types which do not have these direct correspondences, often because they are composite representations or restrictions of a broader data [[type>>doc:IMElements.type.WebHome]]. These are detailed in Section 6 of the standards. 341 341 342 -The Representation is composed of Facets, each of which conveys characteristic information related to the definition of a value domain. Often a set of Facets are needed to convey the required semantic. For example, a sequence is defined by a minimum of two Facets: one to define the start value, and one to define the interval. 342 +The [[Representation>>doc:IMElements.Representation.WebHome]] is composed of Facets, each of which conveys characteristic information related to the definition of a [[value>>doc:IMElements.value.WebHome]] domain. Often a set of Facets are needed to convey the required semantic. For example, a [[sequence>>doc:IMElements.sequence.WebHome]] is defined by a minimum of two Facets: one to define the start [[value>>doc:IMElements.value.WebHome]], and one to define the interval. 343 343 344 344 (% style="width:981.835px" %) 345 -|(% style="width:107px" %)**Facet Type**|(% style="width:872px" %)**Explanation**346 -|(% style="width:107px" %)isSequence|(% style="width:872px" %)The isSequence facet indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue,and endValue facet or the timeInterval, startTime, and endTime, facets. If this attribute holds a value of true, a start value or time and a numeric or time interval must be supplied. If an end value is not given, then the sequence continues indefinitely. 347 -|(% style="width:107px" %)interval|(% style="width:872px" %)The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true. 348 -|(% style="width:107px" %)startValue|(% style="width:872px" %)The startValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet isused for a numeric sequence and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed. 349 -|(% style="width:107px" %)endValue|(% style="width:872px" %)The endValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric sequence and indicates that ending point (if any) of the sequence. 350 -|(% style="width:107px" %)timeInterval|(% style="width:872px" %)The timeInterval facet indicates the permitted duration in a time sequence. In order for this to be used, the isSequence facet must have a value of true. 351 -|(% style="width:107px" %)startTime|(% style="width:872px" %)The startTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). Thisnattribute is used for a time sequence and indicates the start time of thensequence. This value is mandatory for a time sequence to be expressed. 352 -|(% style="width:107px" %)endTime|(% style="width:872px" %)The endTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). This facet is used for a time sequence and indicates that ending point (if any) ofnthe sequence. 353 -|(% style="width:107px" %)minLength|(% style="width:872px" %)The minLength facet specifies the minimum and length of the value in characters. 354 -|(% style="width:107px" %)maxLength|(% style="width:872px" %)The maxLength facet specifies the maximum length of the value in characters. 355 -|(% style="width:107px" %)minValue|(% style="width:872px" %)The minValue facet is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g., this facet is used with an integer data type), the value is assumed to be inclusive. 356 -|(% style="width:107px" %)maxValue|(% style="width:872px" %)The maxValue facet is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g., this facet is used with an integer data type), the value is assumed to be inclusive. 357 -|(% style="width:107px" %)Decimals|(% style="width:872px" %)The decimals facet indicates the number of characters allowed after the decimal separator. 358 -|(% style="width:107px" %)pattern|(% style="width:872px" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema). 345 +|(% style="width:107px" %)**Facet Type**|(% style="width:872px" %)**Explanation** 346 +|(% style="width:107px" %)isSequence|(% style="width:872px" %)The isSequence facet indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue,and endValue facet or the timeInterval, [[startTime>>doc:IMElements.startTime.WebHome]], and endTime, facets. If this [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] holds a [[value>>doc:IMElements.value.WebHome]] of true, a start [[value>>doc:IMElements.value.WebHome]] or time and a numeric or time interval must be supplied. If an end [[value>>doc:IMElements.value.WebHome]] is not given, then the [[sequence>>doc:IMElements.sequence.WebHome]] continues indefinitely. 347 +|(% style="width:107px" %)interval|(% style="width:872px" %)The interval [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] specifies the permitted interval (increment) in a [[sequence>>doc:IMElements.sequence.WebHome]]. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] must have a [[value>>doc:IMElements.value.WebHome]] of true. 348 +|(% style="width:107px" %)startValue|(% style="width:872px" %)The startValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet isused for a numeric [[sequence>>doc:IMElements.sequence.WebHome]] and indicates the starting point of the [[sequence>>doc:IMElements.sequence.WebHome]]. This [[value>>doc:IMElements.value.WebHome]] is mandatory for a numeric [[sequence>>doc:IMElements.sequence.WebHome]] to be expressed. 349 +|(% style="width:107px" %)endValue|(% style="width:872px" %)The endValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric [[sequence>>doc:IMElements.sequence.WebHome]] and indicates that ending point (if any) of the [[sequence>>doc:IMElements.sequence.WebHome]]. 350 +|(% style="width:107px" %)timeInterval|(% style="width:872px" %)The timeInterval facet indicates the permitted duration in a time [[sequence>>doc:IMElements.sequence.WebHome]]. In order for this to be used, the isSequence facet must have a [[value>>doc:IMElements.value.WebHome]] of true. 351 +|(% style="width:107px" %)[[startTime>>doc:IMElements.startTime.WebHome]]|(% style="width:872px" %)The [[startTime>>doc:IMElements.startTime.WebHome]] facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). Thisnattribute is used for a time [[sequence>>doc:IMElements.sequence.WebHome]] and indicates the start time of thensequence. This [[value>>doc:IMElements.value.WebHome]] is mandatory for a time [[sequence>>doc:IMElements.sequence.WebHome]] to be expressed. 352 +|(% style="width:107px" %)endTime|(% style="width:872px" %)The endTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). This facet is used for a time [[sequence>>doc:IMElements.sequence.WebHome]] and indicates that ending point (if any) ofnthe [[sequence>>doc:IMElements.sequence.WebHome]]. 353 +|(% style="width:107px" %)minLength|(% style="width:872px" %)The minLength facet specifies the minimum and length of the [[value>>doc:IMElements.value.WebHome]] in characters. 354 +|(% style="width:107px" %)maxLength|(% style="width:872px" %)The maxLength facet specifies the maximum length of the [[value>>doc:IMElements.value.WebHome]] in characters. 355 +|(% style="width:107px" %)minValue|(% style="width:872px" %)The minValue facet is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid [[value>>doc:IMElements.value.WebHome]] will be greater than or equal to the [[value>>doc:IMElements.value.WebHome]] specified here. If the inclusive and exclusive data [[type>>doc:IMElements.type.WebHome]] is not specified (e.g., this facet is used with an integer data [[type>>doc:IMElements.type.WebHome]]), the [[value>>doc:IMElements.value.WebHome]] is assumed to be inclusive. 356 +|(% style="width:107px" %)maxValue|(% style="width:872px" %)The maxValue facet is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid [[value>>doc:IMElements.value.WebHome]] will be less than or equal to the [[value>>doc:IMElements.value.WebHome]] specified here. If the inclusive and exclusive data [[type>>doc:IMElements.type.WebHome]] is not specified (e.g., this facet is used with an integer data [[type>>doc:IMElements.type.WebHome]]), the [[value>>doc:IMElements.value.WebHome]] is assumed to be inclusive. 357 +|(% style="width:107px" %)[[Decimals>>doc:sdmx:Glossary 2\.1.Decimals.WebHome]]|(% style="width:872px" %)The [[decimals>>doc:sdmx:Glossary 2\.1.Decimals.WebHome]] facet indicates the number of characters allowed after the [[decimal>>doc:sdmx:Glossary 2\.1.Decimals.WebHome]] separator. 358 +|(% style="width:107px" %)pattern|(% style="width:872px" %)The pattern [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema). 359 359 360 360 ---- 361 361