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