Changes for page 3 SDMX Base Package
Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -xwiki:XWiki. helena1 +xwiki:XWiki.elenasemanticproorg - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Annotation|Artefact|Attribute|Code|Code list|Component|Concept scheme|Data structure definition|Dataflow|Decimals|Dimension|Facet|Incremental update|International string|Item scheme|Maintenance agency|Measure|Metadata set|Metadata structure definition|Metadataflow|Representation|SDMX Information Model|SDMX-ML|Statistical data and metadata exchange|Structural metadata|Title - Content
-
... ... @@ -4,253 +4,222 @@ 4 4 5 5 == 3.1 Introduction == 6 6 7 -The constructs in the SDMX 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:sdmx: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 Base package is as follows: 9 +The motivation for establishing the [[SDMX>>doc:sdmx: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 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:sdmx: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 -== =3.2 Base Structures - Identification, Versioning, and Maintenance ===15 +== 3.2 Base Structures - Identification, Versioning, and Maintenance == 16 16 17 -=== =3.2.1 Class Diagram ====17 +=== 3.2.1 Class Diagram === 18 18 19 19 [[image:1749246130522-547.jpeg]] 20 20 21 21 **Figure 10: SDMX Identification, Maintenance and Versioning** 22 22 23 -=== ==3.2.2 Explanation of the Diagram =====23 +=== 3.2.2 Explanation of the Diagram === 24 24 25 -==== ==3.2.2.1 Narrative ======25 +==== 3.2.2.1 Narrative ==== 26 26 27 -This group of classes forms the nucleus of the administration facets of SDMX 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.Facet.WebHome]] of [[SDMX>>doc:sdmx:Glossary.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 (or notes): this supports the need to add notes to all SDMX-ML elements. The Annotation is used to convey extra information to describe any SDMX 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// may have [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] (or notes): this supports the need to add notes to all [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] elements. The [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is used to convey extra information to describe any [[SDMX>>doc:sdmx:Glossary.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). 30 30 31 -The //IdentifiableArtefact// is an abstract class that comprises the basic attributes needed for identification. Concrete classes based on //IdentifiableArtefact// all inherit the ability to be uniquely identified. 31 +The //IdentifiableArtefact// is an abstract class that comprises the basic [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] needed for identification. Concrete classes based on //IdentifiableArtefact// all inherit the ability to be uniquely identified. 32 32 33 -The //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 of a description in multiple locales (locale is similar to language but includes geographic variations such as Canadian French, US English etc.). The //LocalisedString// supports the representation of a description in one locale. 33 +The //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.Representation.WebHome]] of a description in multiple locales (locale is similar to language but includes geographic variations such as Canadian French, US English etc.). The //LocalisedString// supports the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a description in one locale. 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 versioning rules in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. 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.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. 36 36 37 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). 38 38 39 -The inheritance chain from //AnnotableArtefact// through to //MaintainableArtefact// allows SDMX classes to inherit the features they need, from simple annotation, through identity, naming, to versioning and maintenance. 39 +The inheritance chain from //AnnotableArtefact// through to //MaintainableArtefact// allows [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] classes to inherit the features they need, from simple [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]], through identity, naming, to versioning and maintenance. 40 40 41 -==== ==3.2.2.2 Definitions ======41 +==== 3.2.2.2 Definitions ==== 42 42 43 -|**Class**|**Feature**|**Description** 44 -|//AnnotableArtefact//|((( 43 +(% style="width:973.835px" %) 44 +|**Class**|(% style="width:262px" %)**Feature**|(% style="width:543px" %)**Description** 45 +|//AnnotableArtefact//|(% style="width:262px" %)((( 45 45 Base inheritance sub classes are: 46 - 47 47 //IdentifiableArtefact// 48 -)))|Objects of classes derived from this can have attached annotations. 49 -|Annotation|// //|Additional descriptive information attached to an object. 50 -| |id|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 -| |title|A title used to identify an annotation. 52 -| |type|Specifies how the annotation is to be processed. 53 -| |url|A link to external descriptive text. 54 -| |value|A non-localised version of the Annotation content. 55 -| |+url|An International URI provides a set of links that are language specific, via this role. 56 -| |+text|An International String provides the multilingual text content of the annotation via this role. 57 -|InternationalUri| |The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales. 58 -|LocalisedUri| |The Localised URI supports the link to an external description in one locale (locale is similar to language but includes geographic variations such as Canadian French, US English etc.). 59 -|//IdentifiableArtefact//|((( 60 -Superclass is 61 - 62 -//AnnotableArtefact// 63 - 48 +)))|(% style="width:543px" %)Objects of classes derived from this can have attached [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. 49 +|[[Annotation>>doc:sdmx:Glossary.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.Annotation.WebHome]]. It can be used to disambiguate one [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] from another where there are several [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] for the same annotated object. 51 +| |(% style="width:262px" %)[[title>>doc:sdmx:Glossary.Title.WebHome]]|(% style="width:543px" %)A [[title>>doc:sdmx:Glossary.Title.WebHome]] used to identify an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. 52 +| |(% style="width:262px" %)type|(% style="width:543px" %)Specifies how the [[annotation>>doc:sdmx:Glossary.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:Glossary.Annotation.WebHome]] content. 55 +| |(% style="width:262px" %)+url|(% style="width:543px" %)An International URI provides a set of links that are language specific, via this role. 56 +| |(% style="width:262px" %)+text|(% style="width:543px" %)An [[International String>>doc:sdmx:Glossary.International string.WebHome]] provides the multilingual text content of the [[annotation>>doc:sdmx:Glossary.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 but includes geographic variations such as Canadian French, US English etc.). 59 +|//IdentifiableArtefact//|(% style="width:262px" %)((( 60 +Superclass is //AnnotableArtefact// 64 64 Base inheritance sub classes are: 65 - 66 66 //NameableArtefact// 67 -)))|Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact. 68 -| |id|The unique identifier of the object. 69 -| |uri|Universal resource identifier that may or may not be resolvable. 70 -| |urn|Universal resource name – this is for use in registries: all registered objects have a urn. 71 -|//NameableArtefact//|((( 72 -Superclass is 73 - 74 -//IdentifiableArtefact// Base inheritance sub classes are: 75 - 63 +)))|(% style="width:543px" %)Provides identity to all derived classes. It also provides [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]] to derived classes because it is a subclass of Annotable [[Artefact>>doc:sdmx:Glossary.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: 76 76 //VersionableArtefact// 77 -)))|Provides a Name and Description to all derived classes in addition to identification and annotations. 78 -| |+description|A multi-lingual description is provided by this role via the International String class. 79 -| |+name|A multi-lingual name is provided by this role via the International String class 80 -|InternationalString| |The International String is a collection of Localised Strings and supports the representation of text in multiple locales. 81 -|LocalisedString| |The Localised String supports the representation of text in one locale (locale is similar to language but includes geographic variations such as Canadian French, US English etc.). 82 -| |label|Label of the string. 83 -| |locale|The geographic locale of the string e.g French, Canadian French. 84 -|//VersionableArtefact//|((( 70 +)))|(% style="width:543px" %)Provides a Name and Description to all derived classes in addition to identification and [[annotations>>doc:sdmx:Glossary.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.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.International string.WebHome]] class 73 +|InternationalString|(% style="width:262px" %) |(% style="width:543px" %)The [[International String>>doc:sdmx:Glossary.International string.WebHome]] is a collection of Localised Strings and supports the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of text in multiple locales. 74 +|LocalisedString|(% style="width:262px" %) |(% style="width:543px" %)The Localised String supports the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of text in one locale (locale is similar to language 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" %)((( 85 85 Superclass is 86 - 87 87 //NameableArtefact// 88 - 89 89 Base inheritance sub classes are: 90 - 91 91 //MaintainableArtefact// 92 -)))|Provides versioning information for all derived objects. 93 -| |version|A version string following SDMX versioning rules. 94 -| |validFrom|Date from which the version is valid 95 -| |validTo|Date from which version is superseded 96 -|//MaintainableArtefact//|((( 82 +)))|(% style="width:543px" %)Provides versioning information for all derived objects. 83 +| |(% style="width:262px" %)(% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]]|(% style="width:543px" %)A (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) string following [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules. 84 +| |(% style="width:262px" %)validFrom|(% style="width:543px" %)Date from which the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) is valid 85 +| |(% style="width:262px" %)validTo|(% style="width:543px" %)Date from which (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) is superseded 86 +|//MaintainableArtefact//|(% style="width:262px" %)((( 97 97 Inherits from 98 98 99 99 //VersionableArtefact// 100 -)))|An abstract class to group together primary structural metadata artefacts that are maintained by an Agency. 101 -| |isExternalReference|If set to “true” it indicates that the content of the object is held externally. 102 -| |structureURL|The URL of an SDMX-ML document containing the external object. 103 -| |serviceURL|The URL of an SDMX-compliant web service from which the external object can be retrieved. 104 -| |+maintainer|Association to the Maintenance Agency responsible for maintaining the artefact. 105 -|Agency| |See section on “Organisations” 90 +)))|(% style="width:543px" %)An abstract class to group together primary [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that are maintained by an Agency. 91 +| |(% style="width:262px" %)isExternalReference|(% 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.SDMX-ML.WebHome]] document containing the external object. 93 +| |(% style="width:262px" %)serviceURL|(% style="width:543px" %)The URL of an [[SDMX>>doc:sdmx:Glossary.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.Maintenance agency.WebHome]] responsible for maintaining the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. 95 +|Agency|(% style="width:262px" %) |(% style="width:543px" %)See section on “Organisations” 106 106 97 +== 3.3 Basic Inheritance == 107 107 99 +=== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes === 108 108 109 -==== //3.3 Basic Inheritance// ==== 110 - 111 -===== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes ===== 112 - 113 113 [[image:1749246130530-261.jpeg]] 114 114 115 115 **Figure 11: Basic Inheritance from the Base Structures** 116 116 117 -=== ==3.3.2 Explanation of the Diagram =====105 +=== 3.3.2 Explanation of the Diagram === 118 118 119 -==== ==3.3.2.1 Narrative ======107 +==== 3.3.2.1 Narrative ==== 120 120 121 121 The diagram above shows the inheritance within the base structures. The concrete classes are introduced and defined in the specific package to which they relate. 122 122 123 -== =3.4 Data Types ===111 +== 3.4 Data Types == 124 124 125 -=== =3.4.1 Class Diagram ====113 +=== 3.4.1 Class Diagram === 126 126 127 127 [[image:1749246130536-128.jpeg]] 128 128 129 129 **Figure 12: Class Diagram of Basic Data Types** 130 130 131 -=== ==3.4.2 Explanation of the Diagram =====119 +=== 3.4.2 Explanation of the Diagram === 132 132 133 -==== ==3.4.2.1 Narrative ======121 +==== 3.4.2.1 Narrative ==== 134 134 135 -The FacetType and FacetValueType enumerations are used to specify the valid format of the content of a non-enumerated Concept or the usage of a Concept when specified for use on a //Component// on a //Structure// (such as a Dimension 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 (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) or the usage of a (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) when specified for use on a //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// on a //Structure// (such as a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in a DataStructureDefinition). The description of the various types can be found in the chapter on ConceptScheme (section 4.5). 136 136 137 137 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: 138 138 139 -* Append: Data or metadata is an incremental update for an existing data/metadata set or the provision of new data or documentation (attribute values) formerly absent. If any of the supplied data or metadata is already present, it will not replace that data or metadata. This corresponds to the "Update" value found in version 1.0 of the SDMX Technical Standards. 127 +* Append: Data or metadata is an [[incremental update>>doc:sdmx:Glossary.Incremental update.WebHome]] for an existing data/[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] or the provision of new data or documentation ([[attribute>>doc:sdmx: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 1.0 of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Technical Standards. 140 140 * Replace: Data/metadata is to be replaced and may also include additional data/metadata to be appended. 141 141 * Delete: Data/Metadata is to be deleted. 142 142 * Information: Data and metadata are for information purposes. 143 143 144 -The ToValueType data type contains the attributes to support transformations defined in the StructureMap (see Section 0). 132 +The ToValueType data type contains the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] to support transformations defined in the StructureMap (see Section 0). 145 145 146 -The ConstraintRoleType data type contains the attributes that identify the purpose of a Constraint (allowableContent, actualContent). 134 +The ConstraintRoleType data type contains the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that identify the purpose of a (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) (allowableContent, actualContent). 147 147 148 -The ComponentRoleType data type contains the predefined Concept roles that can be assigned to any Component. 136 +The ComponentRoleType data type contains the predefined (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) roles that can be assigned to any Component. 149 149 150 -The CascadeValues data type contains the possible values for a MemberValue within a CubeRegion, in order to enable cascading to all children Codes of a selected Code, while including/excluding the latter in the selection. 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:Glossary.Code.WebHome]] of a selected [[Code>>doc:sdmx:Glossary.Code.WebHome]], while including/excluding the latter in the selection. 151 151 152 -The VersionType data types provides the details for versioning according to SDMX versioning rules, as explained in SDMX Standards Section 6, paragraph “4.3 Versioning”. 140 +The VersionType data types provides the details for versioning according to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6, paragraph “4.3 Versioning”. 153 153 154 -== ==//3.5 The Item Scheme Pattern//====142 +== 3.5 The Item Scheme Pattern == 155 155 156 -=== ==3.5.1 Context =====144 +=== 3.5.1 Context === 157 157 158 -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 Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example. 159 159 160 160 The //ItemScheme// is the basis for CategoryScheme, Codelist, ConceptScheme, ReportingTaxonomy, //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme. 161 161 162 -=== ==3.5.2 Class Diagram =====150 +=== 3.5.2 Class Diagram === 163 163 164 164 [[image:1749246130543-644.jpeg]] 165 165 166 166 **Figure 13 The Item Scheme pattern** 167 167 168 -=== ==3.5.3 Explanation of the Diagram =====156 +=== 3.5.3 Explanation of the Diagram === 169 169 170 -==== ==3.5.3.1 Narrative ======158 +==== 3.5.3.1 Narrative ==== 171 171 172 -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// 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>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. 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 (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) are //Item//s. 173 173 174 -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// 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>>doc:sdmx:Glossary.Attribute.WebHome]] to "true". 175 175 176 -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// 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, (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%)). This is important as this is the id that that is referenced in other structures (e.g., a [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] referenced in a [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]) and this id is always the same, regardless of whether the disseminated //ItemScheme// is the full //ItemScheme// or a partial //ItemScheme//. 177 177 178 -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// 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>>doc:sdmx:Glossary.Code list.WebHome]] is used in a DataStructureDefinition it is sometimes the case that only a sub-set of the [[Codes>>doc:sdmx:Glossary.Code.WebHome]] in a [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] are relevant. In this case a partial [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] can be constructed using the (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) mechanism explained later in this document. 179 179 180 -//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// inherits from //NameableArtefact// which gives it the ability to be annotated and have identity, and therefore has id, uri and urn [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], 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//). 181 181 182 182 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//. 183 183 184 -==== ==3.5.3.2 Definitions ======172 +==== 3.5.3.2 Definitions ==== 185 185 186 -|**Class**|**Feature**|**Description** 187 -|//ItemScheme//|((( 174 +(% style="width:989.835px" %) 175 +|**Class**|(% style="width:297px" %)**Feature**|(% style="width:583px" %)**Description** 176 +|//ItemScheme//|(% style="width:297px" %)((( 188 188 Inherits from: 189 - 190 190 //MaintainableArtefact// 191 - 192 192 Direct sub classes are: 193 - 194 194 CategoryScheme 195 - 196 196 ConceptScheme 197 - 198 198 Codelist 199 - 200 200 ReportingTaxonomy 201 - 202 202 //OrganisationScheme// 203 - 204 204 TransformationScheme 205 - 206 206 CustomTypeScheme NamePersonalisationSc heme 207 - 208 208 RulesetScheme 209 - 210 - VtlMappingSchemeUserDefinedOperatorSc heme211 -)))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common. 212 -| |isPartial|Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme. 213 -| |/items|Association to the Items in the scheme. 214 -|//Item//|((( 188 +VtlMappingScheme 189 +UserDefinedOperatorSc heme 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>>doc:sdmx:Glossary.Item scheme.WebHome]] contains a subset of the full set of Items in the maintained scheme. 192 +| |(% style="width:297px" %)/items|(% style="width:583px" %)Association to the Items in the scheme. 193 +|//Item//|(% style="width:297px" %)((( 215 215 Inherits from: 216 - 217 217 //NameableArtefact// 218 - 219 219 Direct sub classes are 220 - 221 221 Category 222 - 223 -Concept 224 - 225 -Code 226 - 198 +(% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) 199 +[[Code>>doc:sdmx:Glossary.Code.WebHome]] 227 227 ReportingCategory //Organisation// 228 - 229 229 Transformation 230 - 231 231 CustomType 232 - 233 233 NamePersonalisation 234 - 235 235 Ruleset 236 - 237 237 VtlMapping 238 - 239 239 UserDefinedOperator// //hierarchy 240 -)))|((( 241 -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. 242 - 207 +)))|(% style="width:583px" %)((( 208 +The Item is an item of content in an [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]. This may be a node in a taxonomy or ontology, a [[code>>doc:sdmx:Glossary.Code.WebHome]] in a [[code list>>doc:sdmx:Glossary.Code list.WebHome]] etc. Node that at the conceptual level the Organisation is not hierarchic. 243 243 This allows an Item optionally to have one or more child Items 244 244 ))) 245 245 246 -== ==//3.6 The Structure Pattern//====212 +== 3.6 The Structure Pattern == 247 247 248 -=== ==3.6.1 Context =====214 +=== 3.6.1 Context === 249 249 250 -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 Structure Definition, and Metadata 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. 216 +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 Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], and [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]). 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. 251 251 252 -=== ==3.6.2 Class Diagrams[[image:1749246130548-601.jpeg]]=====218 +=== 3.6.2 Class Diagrams === 253 253 220 +(% class="wikigeneratedid" %) 221 +[[image:1749246130548-601.jpeg]] 222 + 254 254 **Figure 14: The Structure Pattern** 255 255 256 256 [[image:1749246130554-995.jpeg]] ... ... @@ -257,166 +257,138 @@ 257 257 258 258 **Figure 15: Representation within the Structure Pattern** 259 259 260 -=== ===3.6.3 Explanation of the Diagrams ======229 +=== 3.6.3 Explanation of the Diagrams === 261 261 262 -3.6.3.1 Narrative 231 +==== 3.6.3.1 Narrative ==== 263 263 264 264 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. 265 265 266 -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// is a list of one or more //[[Component>>doc:sdmx:Glossary.Component.WebHome]]//(s//)//. The //ComponentList// has several concrete descriptor classes based on it: DimensionDescriptor, GroupDimensionDescriptor, MeasureDescriptor, and AttributeDescriptor of the DataStructureDefinition and MetadataAttributeDescriptor of the MetadataStructureDefinition. 267 267 268 -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:sdmx:Glossary.Component.WebHome]]// is contained in a //ComponentList//. The type of //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// in a //ComponentList// is dependent on the concrete class of the ComponentList as follows: 269 269 270 -DimensionDescriptor: Dimension, TimeDimension 271 - 272 -GroupDimensionDescriptor: Dimension, TimeDimension 273 - 274 -MeasureDescriptor: Measure 275 - 239 +DimensionDescriptor: [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], TimeDimension 240 +GroupDimensionDescriptor: [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], TimeDimension 241 +MeasureDescriptor: [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] 276 276 AttributeDescriptor: DataAttribute, MetadataAttributeRef 277 - 278 278 MetadataAttributeDescriptor: MetadataAttribute 279 279 280 -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:sdmx:Glossary.Component.WebHome]]// takes its semantic (and possibly also its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]) from a (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) in a ConceptScheme. This is represented by the conceptIdentity association to (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%). 281 281 282 -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:sdmx:Glossary.Component.WebHome]]// may also have a localRepresentation. This allows a concrete class, such as [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], to specify its [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which is local to the //Structure// in which it is contained (for [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] this will be DataStructureDefinition), and thus overrides any coreRepresentation specified for the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%). 283 283 284 -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:sdmx:Glossary.Representation.WebHome]] can be enumerated or non-enumerated. The valid content of an enumerated [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is specified either in an //ItemScheme// which can be one of [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]], ValueList or //GeoCodelist//. The valid content of a non-enumerated [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is specified as one or more Facet(s) (for example, these may specify minimum and maximum values). For any [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] this is achieved by one of more 285 285 286 -ExtendedFacet(s), which allow the additional representation of XHTML. 251 +ExtendedFacet(s), which allow the additional [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of XHTML. 287 287 288 -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>>doc:sdmx:Glossary.Representation.WebHome]] that are valid for specific [[components>>doc:sdmx:Glossary.Component.WebHome]] is expressed in the model as a (% style="color:#e74c3c" %)[[constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) on the association: 289 289 290 -* The Dimension, DataAttribute, Measure, MetadataAttribute may be enumerated and, if so, use an //EnumeratedList//. 291 -* 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. 255 +* The [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], DataAttribute, [[Measure>>doc:sdmx:Glossary.Measure.WebHome]], MetadataAttribute may be enumerated and, if so, use an //EnumeratedList//. 256 +* The [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] and [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] 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. 292 292 * The MetadataAttribute and DataAttribute may be non-enumerated and, if so, use one or more ExtendedFacet(s). 293 293 294 -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// may be used by one or more //StructureUsage//(s). An example of this, in terms of concrete classes, is that a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] (sub class of //StructureUsage//) may use a particular DataStructureDefinition (sub class of //Structure//), and similar constructs apply for the [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] (link to MetadataStructureDefinition). 295 295 296 -3.6.3.2 Definitions 261 +==== 3.6.3.2 Definitions ==== 297 297 298 298 |**Class**|**Feature**|**Description** 299 299 |StructureUsage|((( 300 300 Inherits from: 301 - 302 302 //MaintainableArtefact// 303 - 304 304 Sub classes are: 305 - 306 -Dataflow 307 - 308 -Metadataflow 309 -)))|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. 310 -| |structure|An association to a Structure specifying the structure of the artefact. 268 +[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] 269 +[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] 270 +)))|An [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] whose [[components>>doc:sdmx:Glossary.Component.WebHome]] are described by a Structure. In concrete terms (sub-classes) an example would be a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] which is linked to a given structure – in this case the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. 271 +| |structure|An association to a Structure specifying the structure of the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. 311 311 |Structure|((( 312 312 Inherits from: 313 - 314 314 //MaintainableArtefact// 315 - 316 316 Sub classes are: 317 - 318 318 DataStructureDefinition MetadataStructureDefinit ion 319 -)))|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. 320 -| |grouping|A composite association to one or more component lists. 277 +)))|Abstract specification of a list of lists to define a complex tabular structure. A concrete example of this would be statistical (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%), [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], and their organisation in a data or [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], defined by a centre institution, usually for the exchange of statistical information with its partners. 278 +| |grouping|A composite association to one or more [[component>>doc:sdmx:Glossary.Component.WebHome]] lists. 321 321 |//ComponentList//|((( 322 322 Inherits from: 323 - 324 324 //IdentifiableArtefact// 325 - 326 326 Sub classes are: 327 - 328 328 DimensionDescriptor 329 - 330 330 GroupDimensionDescriptor 331 - 332 332 MeasureDescriptor 333 - 334 334 AttributeDescriptor MetadataAttributeDescrip tor 335 -)))|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. 336 -| |components|An aggregate association to one or more components which make up the list. 337 -|//Component//|((( 287 +)))|An abstract definition of a list of [[components>>doc:sdmx:Glossary.Component.WebHome]]. A concrete example is a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor, which defines the list of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] in a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. 288 +| |[[components>>doc:sdmx:Glossary.Component.WebHome]]|An aggregate association to one or more [[components>>doc:sdmx:Glossary.Component.WebHome]] which make up the list. 289 +|//[[Component>>doc:sdmx:Glossary.Component.WebHome]]//|((( 338 338 Inherits from: 339 - 340 340 //IdentifiableArtefact// 341 - 342 342 Sub classes are: 343 - 344 -Measure 345 - 346 -//AttributeComponent// 347 - 348 -//DimensionComponent// 349 -)))|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. 350 -| |conceptIdentity|Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component. 293 +[[Measure>>doc:sdmx:Glossary.Measure.WebHome]] 294 +//AttributeComponent 295 +DimensionComponent// 296 +)))|A [[Component>>doc:sdmx:Glossary.Component.WebHome]] is an abstract super class used to define qualitative and quantitative data and metadata items that belong to a [[Component>>doc:sdmx:Glossary.Component.WebHome]] List and hence a Structure. [[Component>>doc:sdmx:Glossary.Component.WebHome]] is refined through its sub-classes. 297 +| |conceptIdentity|Association to a (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) in a [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] that identifies and defines the semantic of the [[Component>>doc:sdmx:Glossary.Component.WebHome]]. 351 351 | |localRepresentation|((( 352 -Association to the Representation of the Component if this is different from the coreRepresentation of the 299 +Association to the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[Component>>doc:sdmx:Glossary.Component.WebHome]] if this is different from the coreRepresentation of the 353 353 354 -Concept, which the Component uses (ConceptUsage). 301 +(% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%), which the [[Component>>doc:sdmx:Glossary.Component.WebHome]] uses (ConceptUsage). 355 355 ))) 356 -|Representation| |The allowable value or format for Component or Concept 357 -| |+enumerated|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. 358 -| |+nonEnumerated|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. 359 -|Facet| |Defines the format for the content of the Component when reported in a data or metadata set. 360 -| |facetType|A specific content type, which is constrained by the Facet Type enumeration. 361 -| |facetValueType|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. 362 -| |+itemSchemeFacet|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. 363 -|ExtendedFacet| |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. 303 +|[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]| |The allowable value or format for [[Component>>doc:sdmx:Glossary.Component.WebHome]] or (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]] 304 +| |+enumerated|Association to an enumerated list that contains the allowable content for the [[Component>>doc:sdmx:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. The type of enumerated list that is allowed for any concrete [[Component>>doc:sdmx:Glossary.Component.WebHome]] is shown in the (% style="color:#e74c3c" %)[[constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) on the association. 305 +| |+nonEnumerated|Association to a set of [[Facets>>doc:sdmx:Glossary.Facet.WebHome]] that define the allowable format for the content of the [[Component>>doc:sdmx:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. 306 +|[[Facet>>doc:sdmx:Glossary.Facet.WebHome]]| |Defines the format for the content of the [[Component>>doc:sdmx:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. 307 +| |facetType|A specific content type, which is constrained by the [[Facet>>doc:sdmx:Glossary.Facet.WebHome]] Type enumeration. 308 +| |facetValueType|The format of the value of a [[Component>>doc:sdmx:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. This is constrained by the [[Facet>>doc:sdmx:Glossary.Facet.WebHome]] Value Type enumeration. 309 +| |+itemSchemeFacet|Defines the format of the identifiers in an [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] used by a [[Component>>doc:sdmx:Glossary.Component.WebHome]]. Typically, this would define the number of characters (length) of the identifier. 310 +|ExtendedFacet| |This has the same function as [[Facet>>doc:sdmx:Glossary.Facet.WebHome]] but allows additionally an XHTML [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is constrained for use with a Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and a Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. 364 364 365 -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. 312 +The specification of the content and use of the sub classes to //ComponentList// and //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// can be found in the section in which they are used (DataStructureDefinition and MetadataStructureDefinition). Moreover, the FacetType SentinelValues is explained in the datastructure [[representation>>doc:sdmx:Glossary.Representation.WebHome]] diagram (see 5.3.2.2), since it only concerns DataStructureDefinitions. 366 366 367 -3.6.3.3 Representation Constructs 314 +==== 3.6.3.3 Representation Constructs ==== 368 368 369 -The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms: 316 +The majority of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms: 370 370 371 -|((( 372 -**SDMX Facet** 318 +|(% style="width:198px" %)((( 319 +**SDMX Facet Value Type** 320 +)))|(% style="width:204px" %)**XML Schema Data Type**|(% style="width:209px" %)**JSON Schema Data Type**|(% style="width:187px" %)((( 321 +**.NET Framework Type** 322 +)))|(% style="width:817px" %)**Java Data Type** 323 +|(% style="width:198px" %)String|(% style="width:204px" %)xsd:string|(% style="width:209px" %)string|(% style="width:187px" %)System.String|(% style="width:817px" %)java.lang.String 324 +|(% style="width:198px" %)Big Integer|(% style="width:204px" %)xsd:integer|(% style="width:209px" %)integer|(% style="width:187px" %)System.Decimal|(% style="width:817px" %)java.math.BigInteger 325 +|(% style="width:198px" %)Integer|(% style="width:204px" %)xsd:int|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int32|(% style="width:817px" %)int 326 +|(% style="width:198px" %)Long|(% style="width:204px" %)xsd.long|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int64|(% style="width:817px" %)long 327 +|(% style="width:198px" %)Short|(% style="width:204px" %)xsd:short|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int16|(% style="width:817px" %)short 328 +|(% style="width:198px" %)[[Decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|(% style="width:204px" %)xsd:decimal|(% style="width:209px" %)number|(% style="width:187px" %)System.Decimal|(% style="width:817px" %)java.math.BigDecimal 329 +|(% style="width:198px" %)Float|(% style="width:204px" %)xsd:float|(% style="width:209px" %)number|(% style="width:187px" %)System.Single|(% style="width:817px" %)float 330 +|(% style="width:198px" %)Double|(% style="width:204px" %)xsd:double|(% style="width:209px" %)number|(% style="width:187px" %)System.Double|(% style="width:817px" %)double 331 +|(% style="width:198px" %)Boolean|(% style="width:204px" %)xsd:boolean|(% style="width:209px" %)boolean|(% style="width:187px" %)System.Boolean|(% style="width:817px" %)boolean 332 +|(% 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 333 +|(% 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 334 +|(% 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 335 +|(% 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 336 +|(% style="width:198px" %)GregorianMonth|(% style="width:204px" %)xsd:gYearMonth|(% style="width:209px" %)string|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar 337 +|(% style="width:198px" %)GregorianDay|(% style="width:204px" %)xsd:date|(% style="width:209px" %)string|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar 338 +|(% 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 339 +|(% 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 373 373 374 -**Value Type** 375 -)))|**XML Schema Data Type**|**JSON Schema Data Type**|((( 376 -**.NET Framework** 341 +There are also a number of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] data types which do not have these direct correspondences, often because they are composite [[representations>>doc:sdmx:Glossary.Representation.WebHome]] or restrictions of a broader data type. These are detailed in Section 6 of the standards. 377 377 378 -**Type** 379 -)))|**Java Data Type** 380 -|String|xsd:string|string|System.String|java.lang.String 381 -|Big Integer|xsd:integer|integer|System.Decimal|java.math.BigInteger 382 -|Integer|xsd:int|integer|System.Int32|int 383 -|Long|xsd.long|integer|System.Int64|long 384 -|Short|xsd:short|integer|System.Int16|short 385 -|Decimal|xsd:decimal|number|System.Decimal|java.math.BigDecimal 386 -|Float|xsd:float|number|System.Single|float 387 -|Double|xsd:double|number|System.Double|double 388 -|Boolean|xsd:boolean|boolean|System.Boolean|boolean 389 -|URI|xsd:anyURI|string:uri|System.Uri|Java.net.URI or java.lang.String 390 -|DateTime|xsd:dateTime|string:datetime|System.DateTime|javax.xml.datatype.XML GregorianCalendar 391 -|Time|xsd:time|string:time|System.DateTime|javax.xml.datatype.XML GregorianCalendar 392 -|GregorianYear|xsd:gYear|string[[(% class="wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar 393 -|GregorianMonth|xsd:gYearMonth|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar 394 -|GregorianDay|xsd:date|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar 395 -|Day, MonthDay, Month|xsd:g*|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar 396 -|Duration|xsd:duration|string|System.TimeSpan|javax.xml.datatype.Dur ation 343 +The [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] is composed of [[Facets>>doc:sdmx:Glossary.Facet.WebHome]], each of which conveys characteristic information related to the definition of a value domain. Often a set of [[Facets>>doc:sdmx:Glossary.Facet.WebHome]] are needed to convey the required semantic. For example, a sequence is defined by a minimum of two [[Facets>>doc:sdmx:Glossary.Facet.WebHome]]: one to define the start value, and one to define the interval. 397 397 398 -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. 345 +(% style="width:981.835px" %) 346 +|(% style="width:107px" %)**Facet Type**|(% style="width:872px" %)**Explanation** 347 +|(% style="width:107px" %)isSequence|(% style="width:872px" %)The isSequence [[facet>>doc:sdmx:Glossary.Facet.WebHome]] indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue,and endValue [[facet>>doc:sdmx:Glossary.Facet.WebHome]] or the timeInterval, startTime, and endTime, [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. If this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. 348 +|(% style="width:107px" %)interval|(% style="width:872px" %)The interval [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a value of true. 349 +|(% style="width:107px" %)startValue|(% style="width:872px" %)The startValue [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and interval [[facets>>doc:sdmx:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:sdmx:Glossary.Facet.WebHome]]). This [[facet>>doc:sdmx:Glossary.Facet.WebHome]] isused for a numeric sequence and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed. 350 +|(% style="width:107px" %)endValue|(% style="width:872px" %)The endValue [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and interval [[facets>>doc:sdmx:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:sdmx:Glossary.Facet.WebHome]]). This [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used for a numeric sequence and indicates that ending point (if any) of the sequence. 351 +|(% style="width:107px" %)timeInterval|(% style="width:872px" %)The timeInterval [[facet>>doc:sdmx:Glossary.Facet.WebHome]] indicates the permitted duration in a time sequence. In order for this to be used, the isSequence [[facet>>doc:sdmx:Glossary.Facet.WebHome]] must have a value of true. 352 +|(% style="width:107px" %)startTime|(% style="width:872px" %)The startTime [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and timeInterval [[facets>>doc:sdmx:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:sdmx:Glossary.Facet.WebHome]]). 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. 353 +|(% style="width:107px" %)endTime|(% style="width:872px" %)The endTime [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and timeInterval [[facets>>doc:sdmx:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:sdmx:Glossary.Facet.WebHome]]). This [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used for a time sequence and indicates that ending point (if any) ofnthe sequence. 354 +|(% style="width:107px" %)minLength|(% style="width:872px" %)The minLength [[facet>>doc:sdmx:Glossary.Facet.WebHome]] specifies the minimum and length of the value in characters. 355 +|(% style="width:107px" %)maxLength|(% style="width:872px" %)The maxLength [[facet>>doc:sdmx:Glossary.Facet.WebHome]] specifies the maximum length of the value in characters. 356 +|(% style="width:107px" %)minValue|(% style="width:872px" %)The minValue [[facet>>doc:sdmx:Glossary.Facet.WebHome]] 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>>doc:sdmx:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. 357 +|(% style="width:107px" %)maxValue|(% style="width:872px" %)The maxValue [[facet>>doc:sdmx:Glossary.Facet.WebHome]] 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>>doc:sdmx:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. 358 +|(% style="width:107px" %)[[Decimals>>doc:sdmx:Glossary.Decimals.WebHome]]|(% style="width:872px" %)The [[decimals>>doc:sdmx:Glossary.Decimals.WebHome]] [[facet>>doc:sdmx:Glossary.Facet.WebHome]] indicates the number of characters allowed after the [[decimal>>doc:sdmx:Glossary.Decimals.WebHome]] separator. 359 +|(% style="width:107px" %)pattern|(% style="width:872px" %)The pattern [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema). 399 399 400 -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. 401 - 402 - 403 -|**Facet Type**|**Explanation** 404 -|isSequence|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. 405 -|interval|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. 406 -|startValue|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. 407 -|endValue|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. 408 -|timeInterval|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. 409 -|startTime|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. 410 -|endTime|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. 411 -|minLength|The minLength facet specifies the minimum and length of the value in characters. 412 -|maxLength|The maxLength facet specifies the maximum length of the value in characters. 413 -|minValue|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. 414 -|maxValue|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. 415 -|Decimals|The decimals facet indicates the number of characters allowed after the decimal separator. 416 -|pattern|The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema). 417 - 418 - 419 - 420 420 ---- 421 421 422 - [[~[1~]>>path:#_ftnref1]] In the JSON schemas, more complex data types are complemented with regular expressions, whenever no directmapping to a standard typeexists.363 +{{putFootnotes/}}