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.he lena1 +xwiki:XWiki.arturkryazhev - 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,15 +4,15 @@ 4 4 5 5 == 3.1 Introduction == 6 6 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).7 +The constructs in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Base package comprise the fundamental building blocks that support many of the other structures in the model. For this reason, many of the classes in this package are abstract (i.e., only derived sub-classes can exist in an implementation). 8 8 9 -The motivation for establishing the [[SDMX>>doc: xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base package is as follows:9 +The motivation for establishing the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Base package is as follows: 10 10 11 11 it is accepted “Best Practise” to identify fundamental archetypes occurring in a model 12 12 identification of commonly found structures or “patterns” leads to easier understanding 13 13 identification of patterns encourages re-use 14 14 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.15 +Each of the class diagrams in this section views classes from the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Base package from a different perspective. There are detailed views of specific patterns, plus overviews showing inheritance between classes, and relationships amongst classes. 16 16 17 17 == 3.2 Base Structures - Identification, Versioning, and Maintenance == 18 18 ... ... @@ -26,19 +26,19 @@ 26 26 27 27 ==== 3.2.2.1 Narrative ==== 28 28 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.29 +This group of classes forms the nucleus of the administration [[facets>>doc:Glossary.Facet.WebHome]] of [[SDMX>>doc: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>>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).31 +All classes derived from the abstract class //AnnotableArtefact// may have [[Annotations>>doc:Glossary.Annotation.WebHome]] (or notes): this supports the need to add notes to all [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] elements. The [[Annotation>>doc:Glossary.Annotation.WebHome]] is used to convey extra information to describe any [[SDMX>>doc: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 -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.33 +The //IdentifiableArtefact// is an abstract class that comprises the basic [[attributes>>doc:Glossary.Attribute.WebHome]] needed for identification. Concrete classes based on //IdentifiableArtefact// all inherit the ability to be uniquely identified. 34 34 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.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: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:Glossary.Representation.WebHome]] of a description in one locale. 36 36 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”.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:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. 38 38 39 39 //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). 40 40 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.41 +The inheritance chain from //AnnotableArtefact// through to //MaintainableArtefact// allows [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] classes to inherit the features they need, from simple [[annotation>>doc:Glossary.Annotation.WebHome]], through identity, naming, to versioning and maintenance. 42 42 43 43 ==== 3.2.2.2 Definitions ==== 44 44 ... ... @@ -47,15 +47,15 @@ 47 47 |//AnnotableArtefact//|(% style="width:244px" %)((( 48 48 Base inheritance sub classes are: 49 49 //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.50 +)))|(% style="width:514px" %)Objects of classes derived from this can have attached [[annotations>>doc:Glossary.Annotation.WebHome]]. 51 +|[[Annotation>>doc: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:Glossary.Annotation.WebHome]]. It can be used to disambiguate one [[Annotation>>doc:Glossary.Annotation.WebHome]] from another where there are several [[Annotations>>doc:Glossary.Annotation.WebHome]] for the same annotated object. 53 +| |(% style="width:244px" %)[[title>>doc:Glossary.Title.WebHome]]|(% style="width:514px" %)A [[title>>doc:Glossary.Title.WebHome]] used to identify an [[annotation>>doc:Glossary.Annotation.WebHome]]. 54 +| |(% style="width:244px" %)type|(% style="width:514px" %)Specifies how the [[annotation>>doc:Glossary.Annotation.WebHome]] is to be processed. 55 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.56 +| |(% style="width:244px" %)value|(% style="width:514px" %)A non-localised (% style="color:#e74c3c" %)version(%%) of the [[Annotation>>doc:Glossary.Annotation.WebHome]] content. 57 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.58 +| |(% style="width:244px" %)+text|(% style="width:514px" %)An [[International String>>doc:Glossary.International string.WebHome]] provides the multilingual text content of the [[annotation>>doc:Glossary.Annotation.WebHome]] via this role. 59 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 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 61 |//IdentifiableArtefact//|(% style="width:244px" %)((( ... ... @@ -64,7 +64,7 @@ 64 64 65 65 Base inheritance sub classes are: 66 66 //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.67 +)))|(% style="width:514px" %)Provides identity to all derived classes. It also provides [[annotations>>doc:Glossary.Annotation.WebHome]] to derived classes because it is a subclass of Annotable Artefact. 68 68 | |(% style="width:244px" %)id|(% style="width:514px" %)The unique identifier of the object. 69 69 | |(% style="width:244px" %)uri|(% style="width:514px" %)Universal resource identifier that may or may not be resolvable. 70 70 | |(% style="width:244px" %)urn|(% style="width:514px" %)Universal resource name – this is for use in registries: all registered objects have a urn. ... ... @@ -72,15 +72,15 @@ 72 72 Superclass is 73 73 //IdentifiableArtefact// Base inheritance sub classes are: 74 74 //VersionableArtefact// 75 -)))|(% style="width:514px" %)Provides a Name and Description to all derived classes in addition to identification and [[annotations>>doc: xwiki:Glossary.Annotation.WebHome]].75 +)))|(% style="width:514px" %)Provides a Name and Description to all derived classes in addition to identification and [[annotations>>doc:Glossary.Annotation.WebHome]]. 76 76 | |(% style="width:244px" %)+description|(% style="width:514px" %)((( 77 77 A multi-lingual description is provided by this role via the 78 78 79 -[[International String>>doc: xwiki:Glossary.International string.WebHome]] class.79 +[[International String>>doc:Glossary.International string.WebHome]] class. 80 80 ))) 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]] class82 -|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.).81 +| |(% style="width:244px" %)+name|(% style="width:514px" %)A multi-lingual name is provided by this role via the [[International String>>doc:Glossary.International string.WebHome]] class 82 +|InternationalString|(% style="width:244px" %) |(% style="width:514px" %)The [[International String>>doc:Glossary.International string.WebHome]] is a collection of Localised Strings and supports the [[representation>>doc:Glossary.Representation.WebHome]] of text in multiple locales. 83 +|LocalisedString|(% style="width:244px" %) |(% style="width:514px" %)The Localised String supports the [[representation>>doc: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 84 | |(% style="width:244px" %)label|(% style="width:514px" %)Label of the string. 85 85 | |(% style="width:244px" %)locale|(% style="width:514px" %)The geographic locale of the string e.g French, Canadian French. 86 86 |//VersionableArtefact//|(% style="width:244px" %)((( ... ... @@ -90,18 +90,18 @@ 90 90 Base inheritance sub classes are: 91 91 //MaintainableArtefact// 92 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 valid95 -| |(% style="width:244px" %)validTo|(% style="width:514px" %)Date from which (% style="color:# 2ecc71" %)version(%%) is superseded93 +| |(% style="width:244px" %)(% style="color:#e74c3c" %)version|(% style="width:514px" %)A (% style="color:#e74c3c" %)version(%%) string following [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules. 94 +| |(% style="width:244px" %)validFrom|(% style="width:514px" %)Date from which the (% style="color:#e74c3c" %)version(%%) is valid 95 +| |(% style="width:244px" %)validTo|(% style="width:514px" %)Date from which (% style="color:#e74c3c" %)version(%%) is superseded 96 96 |//MaintainableArtefact//|(% style="width:244px" %)((( 97 97 Inherits from 98 98 99 99 //VersionableArtefact// 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.100 +)))|(% style="width:514px" %)An abstract class to group together primary [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:Glossary.Artefact.WebHome]] that are maintained by an Agency. 101 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.102 +| |(% style="width:244px" %)structureURL|(% style="width:514px" %)The URL of an [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] document containing the external object. 103 +| |(% style="width:244px" %)serviceURL|(% style="width:514px" %)The URL of an [[SDMX>>doc: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:Glossary.Maintenance agency.WebHome]] responsible for maintaining the artefact. 105 105 |Agency|(% style="width:244px" %) |(% style="width:514px" %)See section on “Organisations” 106 106 107 107 == 3.3 Basic Inheritance == ... ... @@ -130,30 +130,30 @@ 130 130 131 131 ==== 3.4.2.1 Narrative ==== 132 132 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).133 +The FacetType and FacetValueType enumerations are used to specify the valid format of the content of a non-enumerated (% style="color:#e74c3c" %)Concept(%%) or the usage of a (% style="color:#e74c3c" %)Concept(%%) when specified for use on a //[[Component>>doc:Glossary.Component.WebHome]]// on a //Structure// (such as a [[Dimension>>doc:Glossary.Dimension.WebHome]] in a DataStructureDefinition). The description of the various types can be found in the chapter on ConceptScheme (section 4.5). 134 134 135 135 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: 136 136 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.137 +* Append: Data or metadata is an [[incremental update>>doc:Glossary.Incremental update.WebHome]] for an existing data/[[metadata set>>doc:Glossary.Metadata set.WebHome]] or the provision of new data or documentation ([[attribute>>doc:Glossary.Attribute.WebHome]] values) formerly absent. If any of the supplied data or metadata is already present, it will not replace that data or metadata. This corresponds to the "Update" value found in (% style="color:#e74c3c" %)version(%%) 1.0 of the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Technical Standards. 138 138 * Replace: Data/metadata is to be replaced and may also include additional data/metadata to be appended. 139 139 * Delete: Data/Metadata is to be deleted. 140 140 * Information: Data and metadata are for information purposes. 141 141 142 -The ToValueType data type contains the [[attributes>>doc: xwiki:Glossary.Attribute.WebHome]] to support transformations defined in the StructureMap (see Section 0).142 +The ToValueType data type contains the [[attributes>>doc:Glossary.Attribute.WebHome]] to support transformations defined in the StructureMap (see Section 0). 143 143 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).144 +The ConstraintRoleType data type contains the [[attributes>>doc:Glossary.Attribute.WebHome]] that identify the purpose of a (% style="color:#e74c3c" %)Constraint(%%) (allowableContent, actualContent). 145 145 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]].146 +The ComponentRoleType data type contains the predefined (% style="color:#e74c3c" %)Concept(%%) roles that can be assigned to any [[Component>>doc:Glossary.Component.WebHome]]. 147 147 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.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:Glossary.Code.WebHome]] of a selected [[Code>>doc:Glossary.Code.WebHome]], while including/excluding the latter in the selection. 149 149 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”.150 +The VersionType data types provides the details for versioning according to [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6, paragraph “4.3 Versioning”. 151 151 152 152 == 3.5 The Item Scheme Pattern == 153 153 154 154 === 3.5.1 Context === 155 155 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.156 +The [[Item Scheme>>doc:Glossary.Item scheme.WebHome]] is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example. 157 157 158 158 The //ItemScheme// is the basis for CategoryScheme, Codelist, ConceptScheme, ReportingTaxonomy, //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme. 159 159 ... ... @@ -167,15 +167,15 @@ 167 167 168 168 ==== 3.5.3.1 Narrative ==== 169 169 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.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: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(%%) are //Item//s. 171 171 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".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:Glossary.Attribute.WebHome]] to "true". 173 173 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//.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:#e74c3c" %)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: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//. 175 175 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.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:Glossary.Code.WebHome]] in a Codelist are relevant. In this case a partial Codelist can be constructed using the (% style="color:#e74c3c" %)Constraint(%%) mechanism explained later in this document. 177 177 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//).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: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//). 179 179 180 180 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//. 181 181 ... ... @@ -198,7 +198,7 @@ 198 198 RulesetScheme 199 199 VtlMappingScheme UserDefinedOperatorSc heme 200 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>>doc: xwiki:Glossary.Item scheme.WebHome]] contains a subset of the full set of Items in the maintained scheme.201 +| |(% style="width:272px" %)isPartial|(% style="width:422px" %)Denotes whether the [[Item Scheme>>doc:Glossary.Item scheme.WebHome]] contains a subset of the full set of Items in the maintained scheme. 202 202 | |(% style="width:272px" %)/items|(% style="width:422px" %)Association to the Items in the scheme. 203 203 |//Item//|(% style="width:272px" %)((( 204 204 Inherits from: ... ... @@ -207,7 +207,7 @@ 207 207 Direct sub classes are 208 208 Category 209 209 Concept 210 -[[Code>>doc: xwiki:Glossary.Code.WebHome]]210 +[[Code>>doc:Glossary.Code.WebHome]] 211 211 ReportingCategory 212 212 //Organisation// 213 213 Transformation ... ... @@ -216,7 +216,7 @@ 216 216 Ruleset 217 217 VtlMapping 218 218 UserDefinedOperator 219 -)))|(% style="width:422px" %)The Item is an item of content in an [[Item Scheme>>doc: xwiki:Glossary.Item scheme.WebHome]]. This may be a node in a taxonomy or ontology, a [[code>>doc:xwiki:Glossary.Code.WebHome]] in a [[code list>>doc:xwiki:Glossary.Code list.WebHome]] etc. Node that at the conceptual (% style="color:#2ecc71" %)level(%%) the Organisation is not hierarchic.219 +)))|(% style="width:422px" %)The Item is an item of content in an [[Item Scheme>>doc:Glossary.Item scheme.WebHome]]. This may be a node in a taxonomy or ontology, a [[code>>doc:Glossary.Code.WebHome]] in a [[code list>>doc:Glossary.Code list.WebHome]] etc. Node that at the conceptual (% style="color:#e74c3c" %)level(%%) the Organisation is not hierarchic. 220 220 | |(% style="width:272px" %)hierarchy|(% style="width:422px" %)This allows an Item optionally to have one or more child Items. 221 221 222 222 == 3.6 The Structure Pattern == ... ... @@ -223,7 +223,7 @@ 223 223 224 224 === 3.6.1 Context === 225 225 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.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:Glossary.Data structure definition.WebHome]], and [[Metadata Structure Definition>>doc: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. 227 227 228 228 === 3.6.2 Class Diagrams === 229 229 ... ... @@ -241,29 +241,29 @@ 241 241 242 242 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. 243 243 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.244 +The //ComponentList// is a list of one or more //[[Component>>doc: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. 245 245 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:246 +The //[[Component>>doc:Glossary.Component.WebHome]]// is contained in a //ComponentList//. The type of //[[Component>>doc:Glossary.Component.WebHome]]// in a //ComponentList// is dependent on the concrete class of the ComponentList as follows: 247 247 248 -DimensionDescriptor: [[Dimension>>doc: xwiki:Glossary.Dimension.WebHome]], TimeDimension249 -GroupDimensionDescriptor: [[Dimension>>doc: xwiki:Glossary.Dimension.WebHome]], TimeDimension250 -MeasureDescriptor: [[Measure>>doc: xwiki:Glossary.Measure.WebHome]]248 +DimensionDescriptor: [[Dimension>>doc:Glossary.Dimension.WebHome]], TimeDimension 249 +GroupDimensionDescriptor: [[Dimension>>doc:Glossary.Dimension.WebHome]], TimeDimension 250 +MeasureDescriptor: [[Measure>>doc:Glossary.Measure.WebHome]] 251 251 AttributeDescriptor: DataAttribute, MetadataAttributeRef 252 252 MetadataAttributeDescriptor: MetadataAttribute 253 253 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(%%).254 +Each //[[Component>>doc:Glossary.Component.WebHome]]// takes its semantic (and possibly also its [[representation>>doc:Glossary.Representation.WebHome]]) from a (% style="color:#e74c3c" %)Concept(%%) in a ConceptScheme. This is represented by the conceptIdentity association to (% style="color:#e74c3c" %)Concept(%%). 255 255 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(%%).256 +The //[[Component>>doc:Glossary.Component.WebHome]]// may also have a localRepresentation. This allows a concrete class, such as [[Dimension>>doc:Glossary.Dimension.WebHome]], to specify its [[representation>>doc:Glossary.Representation.WebHome]] which is local to the //Structure// in which it is contained (for [[Dimension>>doc:Glossary.Dimension.WebHome]] this will be DataStructureDefinition), and thus overrides any coreRepresentation specified for the (% style="color:#e74c3c" %)Concept(%%). 257 257 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.258 +The [[Representation>>doc:Glossary.Representation.WebHome]] can be enumerated or non-enumerated. The valid content of an enumerated [[representation>>doc: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:Glossary.Representation.WebHome]] is specified as one or more Facet(s) (for example, these may specify minimum and maximum values). For any [[Attribute>>doc:Glossary.Attribute.WebHome]] this is achieved by one of more ExtendedFacet(s), which allow the additional [[representation>>doc:Glossary.Representation.WebHome]] of XHTML. 259 259 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:260 +The types of [[representation>>doc:Glossary.Representation.WebHome]] that are valid for specific [[components>>doc:Glossary.Component.WebHome]] is expressed in the model as a (% style="color:#e74c3c" %)constraint(%%) on the association: 261 261 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.262 +* The [[Dimension>>doc:Glossary.Dimension.WebHome]], DataAttribute, [[Measure>>doc:Glossary.Measure.WebHome]], MetadataAttribute may be enumerated and, if so, use an //EnumeratedList//. 263 +* The [[Dimension>>doc:Glossary.Dimension.WebHome]] and [[Measure>>doc: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. 264 264 * The MetadataAttribute and DataAttribute may be non-enumerated and, if so, use one or more ExtendedFacet(s). 265 265 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).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:Glossary.Dataflow.WebHome]] (sub class of //StructureUsage//) may use a particular DataStructureDefinition (sub class of //Structure//), and similar constructs apply for the [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] (link to MetadataStructureDefinition). 267 267 268 268 ==== 3.6.3.2 Definitions ==== 269 269 ... ... @@ -276,14 +276,14 @@ 276 276 Sub classes are: 277 277 Dataflow 278 278 Metadataflow 279 -)))|(% style="width:353px" %)An [[artefact>>doc: xwiki:Glossary.Artefact.WebHome]] whose [[components>>doc:xwiki:Glossary.Component.WebHome]] are described by a Structure. In concrete terms (sub-classes) an example would be a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] 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>>doc: xwiki:Glossary.Artefact.WebHome]].279 +)))|(% style="width:353px" %)An [[artefact>>doc:Glossary.Artefact.WebHome]] whose [[components>>doc:Glossary.Component.WebHome]] are described by a Structure. In concrete terms (sub-classes) an example would be a [[Dataflow>>doc:Glossary.Dataflow.WebHome]] 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>>doc:Glossary.Artefact.WebHome]]. 281 281 |Structure|(% style="width:284px" %)((( 282 282 Inherits from: 283 283 //MaintainableArtefact//Sub classes are: 284 284 DataStructureDefinition MetadataStructureDefinit ion 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 (% style="color:# 2ecc71" %)concepts(%%), [[code lists>>doc:xwiki:Glossary.Code list.WebHome]], and their organisation in a data or [[metadata structure definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], 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>>doc: xwiki:Glossary.Component.WebHome]] lists.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 (% style="color:#e74c3c" %)concepts(%%), [[code lists>>doc:Glossary.Code list.WebHome]], and their organisation in a data or [[metadata structure definition>>doc:Glossary.Metadata structure definition.WebHome]], 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>>doc:Glossary.Component.WebHome]] lists. 287 287 |//ComponentList//|(% style="width:284px" %)((( 288 288 Inherits from: 289 289 //IdentifiableArtefact// ... ... @@ -293,9 +293,9 @@ 293 293 GroupDimensionDescriptor 294 294 MeasureDescriptor 295 295 AttributeDescriptor MetadataAttributeDescriptor 296 -)))|(% style="width:353px" %)An abstract definition of a list of [[components>>doc: xwiki:Glossary.Component.WebHome]]. A concrete example is a [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor, which defines the list of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] in a Data Structure Definition.297 -| |(% style="width:284px" %)components|(% style="width:353px" %)An aggregate association to one or more [[components>>doc: xwiki:Glossary.Component.WebHome]] which make up the list.298 -|//[[Component>>doc: xwiki:Glossary.Component.WebHome]]//|(% style="width:284px" %)(((296 +)))|(% style="width:353px" %)An abstract definition of a list of [[components>>doc:Glossary.Component.WebHome]]. A concrete example is a [[Dimension>>doc:Glossary.Dimension.WebHome]] Descriptor, which defines the list of [[Dimensions>>doc:Glossary.Dimension.WebHome]] in a Data Structure Definition. 297 +| |(% style="width:284px" %)components|(% style="width:353px" %)An aggregate association to one or more [[components>>doc:Glossary.Component.WebHome]] which make up the list. 298 +|//[[Component>>doc:Glossary.Component.WebHome]]//|(% style="width:284px" %)((( 299 299 Inherits from: 300 300 //IdentifiableArtefact// 301 301 ... ... @@ -303,27 +303,27 @@ 303 303 Measure 304 304 //AttributeComponent 305 305 DimensionComponent// 306 -)))|(% style="width:353px" %)A [[Component>>doc: xwiki:Glossary.Component.WebHome]] is an abstract super class used to define qualitative and quantitative data and metadata items that belong to a [[Component>>doc:xwiki:Glossary.Component.WebHome]] List and hence a Structure. [[Component>>doc:xwiki:Glossary.Component.WebHome]] is refined through its sub-classes.306 +)))|(% style="width:353px" %)A [[Component>>doc:Glossary.Component.WebHome]] is an abstract super class used to define qualitative and quantitative data and metadata items that belong to a [[Component>>doc:Glossary.Component.WebHome]] List and hence a Structure. [[Component>>doc:Glossary.Component.WebHome]] is refined through its sub-classes. 307 307 | |(% style="width:284px" %)conceptIdentity|(% style="width:353px" %)((( 308 -Association to a (% style="color:# 2ecc71" %)Concept(%%) in a [[Concept Scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]] that identifies and defines the308 +Association to a (% style="color:#e74c3c" %)Concept(%%) in a [[Concept Scheme>>doc:Glossary.Concept scheme.WebHome]] that identifies and defines the 309 309 310 -semantic of the [[Component>>doc: xwiki:Glossary.Component.WebHome]].310 +semantic of the [[Component>>doc:Glossary.Component.WebHome]]. 311 311 ))) 312 -| |(% style="width:284px" %)localRepresentation|(% style="width:353px" %)Association to the [[Representation>>doc: xwiki:Glossary.Representation.WebHome]] of the [[Component>>doc:xwiki:Glossary.Component.WebHome]] if this is different from the coreRepresentation of the (% style="color:#2ecc71" %)Concept(%%), which the [[Component>>doc:xwiki:Glossary.Component.WebHome]] uses (ConceptUsage).313 -|[[Representation>>doc: xwiki:Glossary.Representation.WebHome]]|(% style="width:284px" %) |(% style="width:353px" %)The allowable value or format for [[Component>>doc:xwiki:Glossary.Component.WebHome]] or (% style="color:#2ecc71" %)Concept314 -| |(% style="width:284px" %)+enumerated|(% style="width:353px" %)Association to an enumerated list that contains the allowable content for the [[Component>>doc: xwiki:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:xwiki:Glossary.Metadata set.WebHome]]. The type of enumerated list that is allowed for any concrete [[Component>>doc:xwiki:Glossary.Component.WebHome]] is shown in the (% style="color:#2ecc71" %)constraints(%%) on the association.315 -| |(% style="width:284px" %)+nonEnumerated|(% style="width:353px" %)Association to a set of [[Facets>>doc: xwiki:Glossary.Facet.WebHome]] that define the allowable format for the content of the [[Component>>doc:xwiki:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:xwiki:Glossary.Metadata set.WebHome]].316 -|[[Facet>>doc: xwiki:Glossary.Facet.WebHome]]|(% style="width:284px" %) |(% style="width:353px" %)Defines the format for the content of the [[Component>>doc:xwiki:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:xwiki:Glossary.Metadata set.WebHome]].317 -| |(% style="width:284px" %)facetType|(% style="width:353px" %)A specific content type, which is constrained by the [[Facet>>doc: xwiki:Glossary.Facet.WebHome]] Type enumeration.318 -| |(% style="width:284px" %)facetValueType|(% style="width:353px" %)The format of the value of a [[Component>>doc: xwiki:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:xwiki:Glossary.Metadata set.WebHome]]. This is constrained by the [[Facet>>doc:xwiki:Glossary.Facet.WebHome]] Value Type enumeration.319 -| |(% style="width:284px" %) |(% style="width:353px" %)Defines the format of the identifiers in an [[Item Scheme>>doc: xwiki:Glossary.Item scheme.WebHome]] used by a [[Component>>doc:xwiki:Glossary.Component.WebHome]]. 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>>doc: xwiki:Glossary.Facet.WebHome]] but allows additionally an XHTML [[representation>>doc:xwiki:Glossary.Representation.WebHome]]. This is constrained for use with a Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] and a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]].312 +| |(% style="width:284px" %)localRepresentation|(% style="width:353px" %)Association to the [[Representation>>doc:Glossary.Representation.WebHome]] of the [[Component>>doc:Glossary.Component.WebHome]] if this is different from the coreRepresentation of the (% style="color:#e74c3c" %)Concept(%%), which the [[Component>>doc:Glossary.Component.WebHome]] uses (ConceptUsage). 313 +|[[Representation>>doc:Glossary.Representation.WebHome]]|(% style="width:284px" %) |(% style="width:353px" %)The allowable value or format for [[Component>>doc:Glossary.Component.WebHome]] or (% style="color:#e74c3c" %)Concept 314 +| |(% style="width:284px" %)+enumerated|(% style="width:353px" %)Association to an enumerated list that contains the allowable content for the [[Component>>doc:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:Glossary.Metadata set.WebHome]]. The type of enumerated list that is allowed for any concrete [[Component>>doc:Glossary.Component.WebHome]] is shown in the (% style="color:#e74c3c" %)constraints(%%) on the association. 315 +| |(% style="width:284px" %)+nonEnumerated|(% style="width:353px" %)Association to a set of [[Facets>>doc:Glossary.Facet.WebHome]] that define the allowable format for the content of the [[Component>>doc:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:Glossary.Metadata set.WebHome]]. 316 +|[[Facet>>doc:Glossary.Facet.WebHome]]|(% style="width:284px" %) |(% style="width:353px" %)Defines the format for the content of the [[Component>>doc:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:Glossary.Metadata set.WebHome]]. 317 +| |(% style="width:284px" %)facetType|(% style="width:353px" %)A specific content type, which is constrained by the [[Facet>>doc:Glossary.Facet.WebHome]] Type enumeration. 318 +| |(% style="width:284px" %)facetValueType|(% style="width:353px" %)The format of the value of a [[Component>>doc:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:Glossary.Metadata set.WebHome]]. This is constrained by the [[Facet>>doc:Glossary.Facet.WebHome]] Value Type enumeration. 319 +| |(% style="width:284px" %) |(% style="width:353px" %)Defines the format of the identifiers in an [[Item Scheme>>doc:Glossary.Item scheme.WebHome]] used by a [[Component>>doc:Glossary.Component.WebHome]]. 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>>doc:Glossary.Facet.WebHome]] but allows additionally an XHTML [[representation>>doc:Glossary.Representation.WebHome]]. This is constrained for use with a Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] and a Data [[Attribute>>doc:Glossary.Attribute.WebHome]]. 321 321 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.322 +The specification of the content and use of the sub classes to //ComponentList// and //[[Component>>doc: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:Glossary.Representation.WebHome]] diagram (see 5.3.2.2), since it only concerns DataStructureDefinitions. 323 323 324 324 ==== 3.6.3.3 Representation Constructs ==== 325 325 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:326 +The majority of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms: 327 327 328 328 (% style="width:923.039px" %) 329 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** ... ... @@ -347,28 +347,28 @@ 347 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 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 349 349 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.350 +There are also a number of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] data types which do not have these direct correspondences, often because they are composite [[representations>>doc:Glossary.Representation.WebHome]] or restrictions of a broader data type. These are detailed in Section 6 of the standards. 351 351 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.352 +The [[Representation>>doc:Glossary.Representation.WebHome]] is composed of [[Facets>>doc:Glossary.Facet.WebHome]], each of which conveys characteristic information related to the definition of a value domain. Often a set of [[Facets>>doc:Glossary.Facet.WebHome]] are needed to convey the required semantic. For example, a sequence is defined by a minimum of two [[Facets>>doc:Glossary.Facet.WebHome]]: one to define the start value, and one to define the interval. 353 353 354 354 (% style="width:921.039px" %) 355 355 |**Facet Type**|(% style="width:827px" %)**Explanation** 356 -|isSequence|(% style="width:827px" %)The isSequence [[facet>>doc: xwiki: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:xwiki:Glossary.Facet.WebHome]] or the timeInterval, startTime, and endTime, [[facets>>doc:xwiki:Glossary.Facet.WebHome]]. If this [[attribute>>doc:xwiki: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.357 -|interval|(% style="width:827px" %)The interval [[attribute>>doc: xwiki:Glossary.Attribute.WebHome]] specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] must have a value of true.358 -|startValue|(% style="width:827px" %)The startValue [[facet>>doc: xwiki:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and interval [[facets>>doc:xwiki:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:xwiki:Glossary.Facet.WebHome]]). This [[facet>>doc:xwiki:Glossary.Facet.WebHome]] is used for a numeric sequence and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed359 -|endValue|(% style="width:827px" %)The endValue [[facet>>doc: xwiki:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and interval [[facets>>doc:xwiki:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:xwiki:Glossary.Facet.WebHome]]). This [[facet>>doc:xwiki:Glossary.Facet.WebHome]] is used for a numeric sequence and indicates that ending point (if any) of the sequence.360 -|timeInterval|(% style="width:827px" %)The timeInterval [[facet>>doc: xwiki:Glossary.Facet.WebHome]] indicates the permitted duration in a time sequence. In order for this to be used, the isSequence [[facet>>doc:xwiki:Glossary.Facet.WebHome]] must have a value of true.361 -|startTime|(% style="width:827px" %)The startTime [[facet>>doc: xwiki:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and timeInterval [[facets>>doc:xwiki:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:xwiki:Glossary.Facet.WebHome]]). This [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] 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>>doc: xwiki:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and timeInterval [[facets>>doc:xwiki:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:xwiki:Glossary.Facet.WebHome]]). This [[facet>>doc:xwiki:Glossary.Facet.WebHome]] is used for a time sequence and indicates that ending point (if any) of the sequence.363 -|minLength|(% style="width:827px" %)The minLength [[facet>>doc: xwiki:Glossary.Facet.WebHome]] specifies the minimum and length of the value in characters.364 -|maxLength|(% style="width:827px" %)The maxLength [[facet>>doc: xwiki:Glossary.Facet.WebHome]] specifies the maximum length of the value in characters.365 -|minValue|(% style="width:827px" %)The minValue [[facet>>doc: xwiki: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:xwiki:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive.366 -|minLength|(% style="width:827px" %)The minLength [[facet>>doc: xwiki:Glossary.Facet.WebHome]] specifies the minimum and length of the value in characters.367 -|maxLength|(% style="width:827px" %)The maxLength [[facet>>doc: xwiki:Glossary.Facet.WebHome]] specifies the maximum length of the value in characters.368 -|minValue|(% style="width:827px" %)The minValue [[facet>>doc: xwiki: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:xwiki:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive.369 -|maxValue|(% style="width:827px" %)The maxValue [[facet>>doc: xwiki: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:xwiki:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive.370 -|decimals|(% style="width:827px" %)The [[decimals>>doc: xwiki:Glossary.Decimals.WebHome]] [[facet>>doc:xwiki:Glossary.Facet.WebHome]] indicates the number of characters allowed after the [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] separator.371 -|pattern|(% style="width:827px" %)The pattern [[attribute>>doc: xwiki:Glossary.Attribute.WebHome]] holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).356 +|isSequence|(% style="width:827px" %)The isSequence [[facet>>doc: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:Glossary.Facet.WebHome]] or the timeInterval, startTime, and endTime, [[facets>>doc:Glossary.Facet.WebHome]]. If this [[attribute>>doc: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. 357 +|interval|(% style="width:827px" %)The interval [[attribute>>doc:Glossary.Attribute.WebHome]] specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence [[attribute>>doc:Glossary.Attribute.WebHome]] must have a value of true. 358 +|startValue|(% style="width:827px" %)The startValue [[facet>>doc:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and interval [[facets>>doc:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:Glossary.Facet.WebHome]]). This [[facet>>doc:Glossary.Facet.WebHome]] 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>>doc:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and interval [[facets>>doc:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:Glossary.Facet.WebHome]]). This [[facet>>doc:Glossary.Facet.WebHome]] is used for a numeric sequence and indicates that ending point (if any) of the sequence. 360 +|timeInterval|(% style="width:827px" %)The timeInterval [[facet>>doc:Glossary.Facet.WebHome]] indicates the permitted duration in a time sequence. In order for this to be used, the isSequence [[facet>>doc:Glossary.Facet.WebHome]] must have a value of true. 361 +|startTime|(% style="width:827px" %)The startTime [[facet>>doc:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and timeInterval [[facets>>doc:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:Glossary.Facet.WebHome]]). This [[attribute>>doc:Glossary.Attribute.WebHome]] 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>>doc:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and timeInterval [[facets>>doc:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:Glossary.Facet.WebHome]]). This [[facet>>doc:Glossary.Facet.WebHome]] is used for a time sequence and indicates that ending point (if any) of the sequence. 363 +|minLength|(% style="width:827px" %)The minLength [[facet>>doc:Glossary.Facet.WebHome]] specifies the minimum and length of the value in characters. 364 +|maxLength|(% style="width:827px" %)The maxLength [[facet>>doc:Glossary.Facet.WebHome]] specifies the maximum length of the value in characters. 365 +|minValue|(% style="width:827px" %)The minValue [[facet>>doc: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:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. 366 +|minLength|(% style="width:827px" %)The minLength [[facet>>doc:Glossary.Facet.WebHome]] specifies the minimum and length of the value in characters. 367 +|maxLength|(% style="width:827px" %)The maxLength [[facet>>doc:Glossary.Facet.WebHome]] specifies the maximum length of the value in characters. 368 +|minValue|(% style="width:827px" %)The minValue [[facet>>doc: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:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. 369 +|maxValue|(% style="width:827px" %)The maxValue [[facet>>doc: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:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. 370 +|decimals|(% style="width:827px" %)The [[decimals>>doc:Glossary.Decimals.WebHome]] [[facet>>doc:Glossary.Facet.WebHome]] indicates the number of characters allowed after the [[decimal>>doc:Glossary.Decimals.WebHome]] separator. 371 +|pattern|(% style="width:827px" %)The pattern [[attribute>>doc:Glossary.Attribute.WebHome]] holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema). 372 372 373 373 ---- 374 374