Skip to Content

Changes for page 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19
From version 10.3
edited by Helena
on 2025/05/15 10:23
Change comment: There is no comment for this version
To version 13.1
edited by Helena
on 2025/05/16 22:47
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,17 +4,15 @@
4 4  
5 5  == 3.1 Introduction ==
6 6  
7 -The constructs in the SDMX Base package comprise the fundamental building blocks that support many of the other structures in the model. For this reason, many of the classes in this package are abstract (i.e., only derived sub-classes can exist in an implementation).
7 +The constructs in the [[SDMX>>doc: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).
8 8  
9 -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:
10 10  
11 11  it is accepted “Best Practise” to identify fundamental archetypes occurring in a model
12 -
13 13  identification of commonly found structures or “patterns” leads to easier understanding
14 -
15 15  identification of patterns encourages re-use
16 16  
17 -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.
18 18  
19 19  == 3.2 Base Structures - Identification, Versioning, and Maintenance ==
20 20  
... ... @@ -28,19 +28,19 @@
28 28  
29 29  ==== 3.2.2.1 Narrative ====
30 30  
31 -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.
32 32  
33 -All classes derived from the abstract class //AnnotableArtefact// may have Annotations (or notes): this supports the need to add notes to all SDMX-ML elements. The Annotation is used to convey extra information to describe any SDMX construct. This information may be in the form of a URL reference and/or a multilingual text (represented by the association to InternationalString).
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).
34 34  
35 -The //IdentifiableArtefact// is an abstract class that comprises the basic attributes needed for identification. Concrete classes based on //IdentifiableArtefact// all inherit the ability to be uniquely identified.
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.
36 36  
37 -The //NamableArtefact// is an abstract class that inherits from //IdentifiableArtefact //and in addition the +description and +name roles support multilingual descriptions and names for all objects based on //NameableArtefact//. The InternationalString supports the representation of a description in multiple locales (locale is similar to language but includes geographic variations such as Canadian French, US English etc.). The //LocalisedString// supports the representation of a description in one locale.
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.
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”.
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”.
40 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  
... ... @@ -48,7 +48,6 @@
48 48  |**Class**|(% style="width:244px" %)**Feature**|(% style="width:514px" %)**Description**
49 49  |//AnnotableArtefact//|(% style="width:244px" %)(((
50 50  Base inheritance sub classes are:
51 -
52 52  //IdentifiableArtefact//
53 53  )))|(% style="width:514px" %)Objects of classes derived from this can have attached annotations.
54 54  |Annotation|(% style="width:244px" %) |(% style="width:514px" %)Additional descriptive information attached to an object.
... ... @@ -139,30 +139,30 @@
139 139  
140 140  ==== 3.4.2.1 Narrative ====
141 141  
142 -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).
139 +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).
143 143  
144 144  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:
145 145  
146 -* 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.
143 +* 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.
147 147  * Replace: Data/metadata is to be replaced and may also include additional data/metadata to be appended.
148 148  * Delete: Data/Metadata is to be deleted.
149 149  * Information: Data and metadata are for information purposes.
150 150  
151 -The ToValueType data type contains the attributes to support transformations defined in the StructureMap (see Section 0).
148 +The ToValueType data type contains the [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] to support transformations defined in the StructureMap (see Section 0).
152 152  
153 -The ConstraintRoleType data type contains the attributes that identify the purpose of a Constraint (allowableContent, actualContent).
150 +The ConstraintRoleType data type contains the [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] that identify the purpose of a (% style="color:#2ecc71" %)Constraint(%%) (allowableContent, actualContent).
154 154  
155 -The ComponentRoleType data type contains the predefined Concept roles that can be assigned to any Component.
152 +The ComponentRoleType data type contains the predefined (% style="color:#2ecc71" %)Concept(%%) roles that can be assigned to any [[Component>>doc:xwiki:Glossary.Component.WebHome]].
156 156  
157 -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.
154 +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.
158 158  
159 -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”.
156 +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”.
160 160  
161 161  == 3.5 The Item Scheme Pattern ==
162 162  
163 163  === 3.5.1 Context ===
164 164  
165 -The Item Scheme is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example.
162 +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.
166 166  
167 167  The //ItemScheme// is the basis for CategoryScheme, Codelist, ConceptScheme, ReportingTaxonomy, //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme.
168 168  
... ... @@ -176,84 +176,63 @@
176 176  
177 177  ==== 3.5.3.1 Narrative ====
178 178  
179 -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.
176 +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.
180 180  
181 -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".
178 +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".
182 182  
183 -A “partial” //ItemScheme// cannot be maintained independently in its partial form i.e., it cannot contain //Item//s that are not present in the full //ItemScheme// and the content of any one //Item //(e.g., names and descriptions) cannot deviate from the content in the full //ItemScheme//. Furthermore, the id of the //ItemScheme// where isPartial is set to "true" is the same as the id of the full //ItemScheme// (agencyId, id, version). This is important as this is the id that that is referenced in other structures (e.g., a Codelist referenced in a DSD) and this id is always the same, regardless of whether the disseminated //ItemScheme// is the full //ItemScheme// or a partial //ItemScheme//.
180 +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//.
184 184  
185 -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.
182 +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.
186 186  
187 -//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//).
184 +//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//).
188 188  
189 189  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//.
190 190  
191 191  ==== 3.5.3.2 Definitions ====
192 192  
193 -|**Class**|**Feature**|**Description**
194 -|//ItemScheme//|(((
190 +(% style="width:800.039px" %)
191 +|**Class**|(% style="width:272px" %)**Feature**|(% style="width:422px" %)**Description**
192 +|//ItemScheme//|(% style="width:272px" %)(((
195 195  Inherits from:
196 -
197 197  //MaintainableArtefact//
198 -
199 199  Direct sub classes are:
200 -
201 201  CategoryScheme
202 -
203 203  ConceptScheme
204 -
205 205  Codelist
206 -
207 207  ReportingTaxonomy
208 -
209 209  //OrganisationScheme//
210 -
211 211  TransformationScheme
212 -
213 -CustomTypeScheme NamePersonalisationSc heme
214 -
202 +CustomTypeScheme
203 +NamePersonalisationSc heme
215 215  RulesetScheme
216 -
217 217  VtlMappingScheme UserDefinedOperatorSc heme
218 -)))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
219 -| |isPartial|Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme.
220 -| |/items|Association to the Items in the scheme.
221 -|//Item//|(((
206 +)))|(% style="width:422px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
207 +| |(% 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.
208 +| |(% style="width:272px" %)/items|(% style="width:422px" %)Association to the Items in the scheme.
209 +|//Item//|(% style="width:272px" %)(((
222 222  Inherits from:
223 223  
224 224  //NameableArtefact//
225 -
226 226  Direct sub classes are
227 -
228 228  Category
229 -
230 230  Concept
231 -
232 232  Code
233 -
234 234  ReportingCategory
235 -
236 236  //Organisation//
237 -
238 238  Transformation
239 -
240 240  CustomType
241 -
242 242  NamePersonalisation
243 -
244 244  Ruleset
245 -
246 246  VtlMapping
247 -
248 248  UserDefinedOperator
249 -)))|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.
250 -| |hierarchy|This allows an Item optionally to have one or more child Items.
225 +)))|(% 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.
226 +| |(% style="width:272px" %)hierarchy|(% style="width:422px" %)This allows an Item optionally to have one or more child Items.
251 251  
252 252  == 3.6 The Structure Pattern ==
253 253  
254 254  === 3.6.1 Context ===
255 255  
256 -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.
232 +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.
257 257  
258 258  === 3.6.2 Class Diagrams ===
259 259  
... ... @@ -271,154 +271,135 @@
271 271  
272 272  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.
273 273  
274 -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.
250 +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.
275 275  
276 -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:
252 +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:
277 277  
278 -DimensionDescriptor: Dimension, TimeDimension
279 -
280 -GroupDimensionDescriptor: Dimension, TimeDimension
281 -
282 -MeasureDescriptor: Measure
283 -
254 +DimensionDescriptor: [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension
255 +GroupDimensionDescriptor: [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension
256 +MeasureDescriptor: [[Measure>>doc:xwiki:Glossary.Measure.WebHome]]
284 284  AttributeDescriptor: DataAttribute, MetadataAttributeRef
285 -
286 286  MetadataAttributeDescriptor: MetadataAttribute
287 287  
288 -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.
260 +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(%%).
289 289  
290 -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.
262 +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(%%).
291 291  
292 -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.
264 +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.
293 293  
294 -The types of representation that are valid for specific components is expressed in the model as a constraint on the association:
266 +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:
295 295  
296 -* The Dimension, DataAttribute, Measure, MetadataAttribute may be enumerated and, if so, use an //EnumeratedList//.
297 -* 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.
268 +* The [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], DataAttribute, [[Measure>>doc:xwiki:Glossary.Measure.WebHome]], MetadataAttribute may be enumerated and, if so, use an //EnumeratedList//.
269 +* 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.
298 298  * The MetadataAttribute and DataAttribute may be non-enumerated and, if so, use one or more ExtendedFacet(s).
299 299  
300 -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).
272 +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).
301 301  
302 302  ==== 3.6.3.2 Definitions ====
303 303  
304 -|**Class**|**Feature**|**Description**
305 -|StructureUsage|(((
276 +(% style="width:756.039px" %)
277 +|**Class**|(% style="width:284px" %)**Feature**|(% style="width:353px" %)**Description**
278 +|StructureUsage|(% style="width:284px" %)(((
306 306  Inherits from:
307 -
308 308  //MaintainableArtefact//
309 309  
310 310  Sub classes are:
311 -
312 312  Dataflow
313 -
314 314  Metadataflow
315 -)))|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.
316 -| |structure|An association to a Structure specifying the structure of the artefact.
317 -|Structure|(((
285 +)))|(% 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.
286 +| |(% style="width:284px" %)structure|(% style="width:353px" %)An association to a Structure specifying the structure of the artefact.
287 +|Structure|(% style="width:284px" %)(((
318 318  Inherits from:
319 -
320 -//MaintainableArtefact//
321 -
322 -Sub classes are:
323 -
289 +//MaintainableArtefact//Sub classes are:
324 324  DataStructureDefinition MetadataStructureDefinit ion
325 -)))|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.
326 -| |grouping|A composite association to one or more component lists.
327 -|//ComponentList//|(((
291 +)))|(% 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.
292 +| |(% style="width:284px" %)grouping|(% style="width:353px" %)A composite association to one or more component lists.
293 +|//ComponentList//|(% style="width:284px" %)(((
328 328  Inherits from:
329 -
330 330  //IdentifiableArtefact//
331 331  
332 332  Sub classes are:
333 -
334 334  DimensionDescriptor
335 -
336 336  GroupDimensionDescriptor
337 -
338 338  MeasureDescriptor
339 -
340 340  AttributeDescriptor MetadataAttributeDescriptor
341 -)))|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.
342 -| |components|An aggregate association to one or more components which make up the list.
343 -|//Component//|(((
302 +)))|(% 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.
303 +| |(% style="width:284px" %)components|(% style="width:353px" %)An aggregate association to one or more components which make up the list.
304 +|//Component//|(% style="width:284px" %)(((
344 344  Inherits from:
345 -
346 346  //IdentifiableArtefact//
347 347  
348 348  Sub classes are:
349 -
350 350  Measure
351 -
352 -//AttributeComponent//
353 -
354 -//DimensionComponent//
355 -)))|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.
356 -| |conceptIdentity|(((
310 +//AttributeComponent
311 +DimensionComponent//
312 +)))|(% 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.
313 +| |(% style="width:284px" %)conceptIdentity|(% style="width:353px" %)(((
357 357  Association to a Concept in a Concept Scheme that identifies and defines the
358 358  
359 359  semantic of the Component.
360 360  )))
361 -| |localRepresentation|Association to the Representation of the Component if this is different from the coreRepresentation of the Concept, which the Component uses (ConceptUsage).
362 -|Representation| |The allowable value or format for Component or Concept
363 -| |+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.
364 -| |+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.
365 -|Facet| |Defines the format for the content of the Component when reported in a data or metadata set.
366 -| |facetType|A specific content type, which is constrained by the Facet Type enumeration.
367 -| |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.
368 -| | |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.
369 -|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.
318 +| |(% 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).
319 +|Representation|(% style="width:284px" %) |(% style="width:353px" %)The allowable value or format for Component or Concept
320 +| |(% 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.
321 +| |(% 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.
322 +|Facet|(% style="width:284px" %) |(% style="width:353px" %)Defines the format for the content of the Component when reported in a data or metadata set.
323 +| |(% style="width:284px" %)facetType|(% style="width:353px" %)A specific content type, which is constrained by the Facet Type enumeration.
324 +| |(% 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.
325 +| |(% 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.
326 +|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.
370 370  
371 -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.
328 +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.
372 372  
373 373  ==== 3.6.3.3 Representation Constructs ====
374 374  
375 -The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms:
332 +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:
376 376  
377 -|**SDMX Facet Value Type**|**XML Schema Data Type**|**JSON Schema Data Type**|**.NET Framework Type**|**Java Data Type**
378 -|String|xsd:string|string|System.String|java.lang.String
379 -|Big Integer|xsd:integer|integer|System.Decimal|java.math.BigInteger
380 -|Integer|xsd:int|integer|System.Int32|int
381 -|Long|xsd.long|integer|System.Int64|long
382 -|Short|xsd:short|integer|System.Int16|short
383 -|Decimal|xsd:decimal|number|System.Decimal|java.math.BigDecimal
384 -|Float|xsd:float|number|System.Single|float
385 -|Double|xsd:double|number|System.Double|double
386 -|Boolean|xsd:boolean|boolean|System.Boolean|boolean
387 -|URI|xsd:anyURI|string:uri|System.Uri|Java.net.URI or java.lang.String
388 -|DateTime|xsd:dateTime|string:datetime|System.DateTime|javax.xml.datatype.XML GregorianCalendar
389 -|Time|xsd:time|string:time|System.DateTime|javax.xml.datatype.XML GregorianCalendar
390 -|GregorianYear|xsd:gYear|(((
391 -2
334 +(% style="width:923.039px" %)
335 +|(% 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**
336 +|(% style="width:167px" %)String|(% style="width:148px" %)xsd:string|(% style="width:158px" %)string|(% style="width:161px" %)System.String|(% style="width:285px" %)java.lang.String
337 +|(% 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
338 +|(% style="width:167px" %)Integer|(% style="width:148px" %)xsd:int|(% style="width:158px" %)integer|(% style="width:161px" %)System.Int32|(% style="width:285px" %)int
339 +|(% style="width:167px" %)Long|(% style="width:148px" %)xsd.long|(% style="width:158px" %)integer|(% style="width:161px" %)System.Int64|(% style="width:285px" %)long
340 +|(% style="width:167px" %)Short|(% style="width:148px" %)xsd:short|(% style="width:158px" %)integer|(% style="width:161px" %)System.Int16|(% style="width:285px" %)short
341 +|(% style="width:167px" %)Decimal|(% style="width:148px" %)xsd:decimal|(% style="width:158px" %)number|(% style="width:161px" %)System.Decimal|(% style="width:285px" %)java.math.BigDecimal
342 +|(% style="width:167px" %)Float|(% style="width:148px" %)xsd:float|(% style="width:158px" %)number|(% style="width:161px" %)System.Single|(% style="width:285px" %)float
343 +|(% style="width:167px" %)Double|(% style="width:148px" %)xsd:double|(% style="width:158px" %)number|(% style="width:161px" %)System.Double|(% style="width:285px" %)double
344 +|(% style="width:167px" %)Boolean|(% style="width:148px" %)xsd:boolean|(% style="width:158px" %)boolean|(% style="width:161px" %)System.Boolean|(% style="width:285px" %)boolean
345 +|(% 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
346 +|(% 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
347 +|(% 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
348 +|(% style="width:167px" %)GregorianYear|(% style="width:148px" %)xsd:gYear|(% style="width:158px" %)(((
349 +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}}
350 +)))|(% style="width:161px" %)System.DateTime|(% style="width:285px" %)javax.xml.datatype.XML GregorianCalendar
351 +|(% 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
352 +|(% 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
353 +|(% 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
354 +|(% 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
392 392  
393 -string
394 -)))|System.DateTime|javax.xml.datatype.XML GregorianCalendar
395 -|GregorianMonth|xsd:gYearMonth|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
396 -|GregorianDay|xsd:date|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
397 -|Day, MonthDay, Month|xsd:g*|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
398 -|Duration|xsd:duration|string|System.TimeSpan|javax.xml.datatype.Dur ation
356 +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.
399 399  
400 -There are also a number of SDMX data types which do not have these direct correspondences, often because they are composite representations or restrictions of a broader data type. These are detailed in Section 6 of the standards.
358 +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.
401 401  
402 -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.
360 +(% style="width:921.039px" %)
361 +|**Facet Type**|(% style="width:827px" %)**Explanation**
362 +|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.
363 +|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.
364 +|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
365 +|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.
366 +|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.
367 +|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.
368 +|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.
369 +|minLength|(% style="width:827px" %)The minLength facet specifies the minimum and length of the value in characters.
370 +|maxLength|(% style="width:827px" %)The maxLength facet specifies the maximum length of the value in characters.
371 +|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.
372 +|minLength|(% style="width:827px" %)The minLength facet specifies the minimum and length of the value in characters.
373 +|maxLength|(% style="width:827px" %)The maxLength facet specifies the maximum length of the value in characters.
374 +|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.
375 +|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.
376 +|decimals|(% style="width:827px" %)The decimals facet indicates the number of characters allowed after the decimal separator.
377 +|pattern|(% style="width:827px" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).
403 403  
404 -|**Facet Type**| |**Explanation**
405 -|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.
406 -|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.
407 -|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
408 -|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.
409 -|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.
410 -|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.
411 -|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.
412 -|minLength| |The minLength facet specifies the minimum and length of the value in characters.
413 -|maxLength| |The maxLength facet specifies the maximum length of the value in characters.
414 -|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.
415 -|minLength| |The minLength facet specifies the minimum and length of the value in characters.
416 -|maxLength| |The maxLength facet specifies the maximum length of the value in characters.
417 -|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.
418 -|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.
419 -|decimals| |The decimals facet indicates the number of characters allowed after the decimal separator.
420 -|pattern| |The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).
379 +----
421 421  
422 -[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_59eee18f.gif||alt="Shape29" height="1" width="192"]]
423 -
424 -^^2^^ In the JSON schemas, more complex data types are complemented with regular expressions, whenever no direct mapping to a standard type exists.
381 +{{putFootnotes/}}