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 12.1
edited by Helena
on 2025/05/16 13:38
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -9,9 +9,7 @@
9 9  The motivation for establishing the SDMX 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 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.
... ... @@ -190,64 +190,43 @@
190 190  
191 191  ==== 3.5.3.2 Definitions ====
192 192  
193 -|**Class**|**Feature**|**Description**
194 -|//ItemScheme//|(((
191 +(% style="width:800.039px" %)
192 +|**Class**|(% style="width:272px" %)**Feature**|(% style="width:422px" %)**Description**
193 +|//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 -
203 +CustomTypeScheme
204 +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//|(((
207 +)))|(% style="width:422px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
208 +| |(% 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.
209 +| |(% style="width:272px" %)/items|(% style="width:422px" %)Association to the Items in the scheme.
210 +|//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.
226 +)))|(% 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.
227 +| |(% 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  
... ... @@ -276,13 +276,9 @@
276 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:
277 277  
278 278  DimensionDescriptor: Dimension, TimeDimension
279 -
280 280  GroupDimensionDescriptor: Dimension, TimeDimension
281 -
282 282  MeasureDescriptor: Measure
283 -
284 284  AttributeDescriptor: DataAttribute, MetadataAttributeRef
285 -
286 286  MetadataAttributeDescriptor: MetadataAttribute
287 287  
288 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.
... ... @@ -301,72 +301,59 @@
301 301  
302 302  ==== 3.6.3.2 Definitions ====
303 303  
304 -|**Class**|**Feature**|**Description**
305 -|StructureUsage|(((
277 +(% style="width:756.039px" %)
278 +|**Class**|(% style="width:284px" %)**Feature**|(% style="width:353px" %)**Description**
279 +|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|(((
286 +)))|(% 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.
287 +| |(% style="width:284px" %)structure|(% style="width:353px" %)An association to a Structure specifying the structure of the artefact.
288 +|Structure|(% style="width:284px" %)(((
318 318  Inherits from:
319 -
320 320  //MaintainableArtefact//
321 321  
322 322  Sub classes are:
323 -
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//|(((
294 +)))|(% 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.
295 +| |(% style="width:284px" %)grouping|(% style="width:353px" %)A composite association to one or more component lists.
296 +|//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//|(((
305 +)))|(% 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.
306 +| |(% style="width:284px" %)components|(% style="width:353px" %)An aggregate association to one or more components which make up the list.
307 +|//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|(((
313 +//AttributeComponent
314 +DimensionComponent//
315 +)))|(% 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.
316 +| |(% 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.
321 +| |(% 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).
322 +|Representation|(% style="width:284px" %) |(% style="width:353px" %)The allowable value or format for Component or Concept
323 +| |(% 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.
324 +| |(% 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.
325 +|Facet|(% style="width:284px" %) |(% style="width:353px" %)Defines the format for the content of the Component when reported in a data or metadata set.
326 +| |(% style="width:284px" %)facetType|(% style="width:353px" %)A specific content type, which is constrained by the Facet Type enumeration.
327 +| |(% 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.
328 +| |(% 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.
329 +|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 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.
372 372  
... ... @@ -374,51 +374,51 @@
374 374  
375 375  The majority of SDMX 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
337 +(% style="width:923.039px" %)
338 +|(% 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**
339 +|(% style="width:167px" %)String|(% style="width:148px" %)xsd:string|(% style="width:158px" %)string|(% style="width:161px" %)System.String|(% style="width:285px" %)java.lang.String
340 +|(% 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
341 +|(% style="width:167px" %)Integer|(% style="width:148px" %)xsd:int|(% style="width:158px" %)integer|(% style="width:161px" %)System.Int32|(% style="width:285px" %)int
342 +|(% style="width:167px" %)Long|(% style="width:148px" %)xsd.long|(% style="width:158px" %)integer|(% style="width:161px" %)System.Int64|(% style="width:285px" %)long
343 +|(% style="width:167px" %)Short|(% style="width:148px" %)xsd:short|(% style="width:158px" %)integer|(% style="width:161px" %)System.Int16|(% style="width:285px" %)short
344 +|(% style="width:167px" %)Decimal|(% style="width:148px" %)xsd:decimal|(% style="width:158px" %)number|(% style="width:161px" %)System.Decimal|(% style="width:285px" %)java.math.BigDecimal
345 +|(% style="width:167px" %)Float|(% style="width:148px" %)xsd:float|(% style="width:158px" %)number|(% style="width:161px" %)System.Single|(% style="width:285px" %)float
346 +|(% style="width:167px" %)Double|(% style="width:148px" %)xsd:double|(% style="width:158px" %)number|(% style="width:161px" %)System.Double|(% style="width:285px" %)double
347 +|(% style="width:167px" %)Boolean|(% style="width:148px" %)xsd:boolean|(% style="width:158px" %)boolean|(% style="width:161px" %)System.Boolean|(% style="width:285px" %)boolean
348 +|(% 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
349 +|(% 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
350 +|(% 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
351 +|(% style="width:167px" %)GregorianYear|(% style="width:148px" %)xsd:gYear|(% style="width:158px" %)(((
352 +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}}
353 +)))|(% style="width:161px" %)System.DateTime|(% style="width:285px" %)javax.xml.datatype.XML GregorianCalendar
354 +|(% 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
355 +|(% 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
356 +|(% 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
357 +|(% 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
399 -
400 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.
401 401  
402 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.
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).
363 +(% style="width:921.039px" %)
364 +|**Facet Type**|(% style="width:827px" %)**Explanation**
365 +|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.
366 +|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.
367 +|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
368 +|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.
369 +|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.
370 +|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.
371 +|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.
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 +|minLength|(% style="width:827px" %)The minLength facet specifies the minimum and length of the value in characters.
376 +|maxLength|(% style="width:827px" %)The maxLength facet specifies the maximum length of the value in characters.
377 +|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.
378 +|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.
379 +|decimals|(% style="width:827px" %)The decimals facet indicates the number of characters allowed after the decimal separator.
380 +|pattern|(% style="width:827px" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).
421 421  
422 -[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_59eee18f.gif||alt="Shape29" height="1" width="192"]]
382 +----
423 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.
384 +{{putFootnotes/}}