Skip to Content

Changes for page 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19
From version 12.1
edited by Helena
on 2025/05/20 11:56
Change comment: There is no comment for this version
To version 6.6
edited by Helena
on 2025/05/20 00:25
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -113,8 +113,6 @@
113 113  
114 114  === {{id name="_Toc370976"/}}3.4.1 Class Diagram ===
115 115  
116 -[[image:1747690333052-506.png]]
117 -
118 118  **Figure 11: Class Diagram of Basic Data Types**
119 119  
120 120  === {{id name="_Toc370977"/}}3.4.2 Explanation of the Diagram ===
... ... @@ -164,14 +164,16 @@
164 164  (% class="wikigeneratedid" id="HFigure12TheItemSchemePattern" %)
165 165  **Figure 12 The Item Scheme Pattern**
166 166  
167 -=== {{id name="_Toc370981"/}}3.5.3 Explanation of the Diagram ===
165 +===== {{id name="_Toc370981"/}}3.5.3 Explanation of the Diagram =====
168 168  
169 -==== 3.5.3.1 Narrative ====
167 +**3.5.3.1 Narrative**
170 170  
171 171  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 inherits 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 CategoryScheme. The associated Category are //Items//.
172 172  
173 -In an exchange environment an ItemScheme is allowed to contain a sub-set of the Items in the maintained //ItemScheme//. If such an //ItemScheme// is disseminated with a sub-set of the Items then the fact that this is a sub-set is denoted by setting the isPartial attribute to “true”.
171 +In an exchange environment an ItemScheme is allowed to contain a sub-set of the Items in the maintained //ItemScheme//. If such an //ItemScheme// is disseminated with a sub-set of the Items then the fact that this is a sub-set is denoted by setting the isPartial attribute to
174 174  
173 +“true”.
174 +
175 175  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//.
176 176  
177 177  Furthermore, the Id of the //ItemScheme// where isPartial is set to “true” is the same as the Id of the full //ItemScheme// (maintenance agency, 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//.
... ... @@ -178,8 +178,10 @@
178 178  
179 179  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.
180 180  
181 -//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 agency as the //ItemScheme//).
181 +//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
182 182  
183 +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 agency as the //ItemScheme//).
184 +
183 183  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//.
184 184  
185 185  ==== 3.5.3.2 Definitions ====
... ... @@ -257,7 +257,7 @@
257 257  
258 258  __GroupDimensionDescriptor__: Dimension, Measure Dimension, Time Dimension
259 259  
260 -__MeasureDescriptor__: PrimaryMeasure
262 +MeasureDescriptor: PrimaryMeasure
261 261  
262 262  __AttributeDescriptor:__ Data Attribute
263 263  
... ... @@ -280,112 +280,140 @@
280 280  
281 281  The //Structure// may be used by one or more //StructureUsage//. An example of this in terms of concrete classes is that a DataflowDefinition (sub class of //StructureUsage//) may use a particular DataStructureDefinition (sub class of //Structure//), and similar constructs apply for the MetadataflowDefinition (link to MetadataStructureDefinition).
282 282  
283 -==== 3.6.3.2 Definitions ====
285 +**3.6.3.2 Definitions**
284 284  
285 -(% style="width:1001.29px" %)
286 -|**Class**|**Feature**|(% style="width:537px" %)**Description**
287 +|**Class**|**Feature**|**Description**
287 287  |//StructureUsage//|(((
288 288  Inherits from:
290 +
289 289  //MaintainableArtefact//
292 +
290 290  Sub classes are:
294 +
291 291  DataflowDefinition
292 -MetadataflowDefinition
293 -)))|(% style="width:537px" %)An artefact whose components are described by a Structure. In concrete terms (sub-classes) an example would be a Dataflow Definition which is linked to a given structure – in this case the Data Structure Definition.
294 -| |structure|(% style="width:537px" %)An association to a Structure specifying the structure of the artefact.
296 +
297 +MetadataflowDefinition//    //
298 +)))|An artefact whose components are described by a Structure. In concrete terms (sub-classes) an example would be a Dataflow Definition which is linked to a given structure – in this case the Data Structure Definition.
299 +| |structure|An association to a Structure specifying the structure of the artefact.
295 295  |//Structure//|(((
296 296  Inherits from:
302 +
297 297  //MaintainableArtefact//
304 +
298 298  Sub classes are:
306 +
299 299  DataStructure
308 +
300 300  Definition
310 +
301 301  MetadataStructure
312 +
302 302  Definition
303 -)))|(% style="width:537px" %)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.
304 -| |grouping|(% style="width:537px" %)A composite association to one or more component lists.
314 +)))|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.
315 +| |grouping|A composite association to one or more component lists.
305 305  |//ComponentList//|(((
306 306  Inherits from:
318 +
307 307  //IdentifiableArtefact//
320 +
308 308  Sub classes are:
322 +
309 309  DimensionDescriptor
324 +
310 310  GroupDimension
326 +
311 311  Descriptor
328 +
312 312  MeasureDescriptor
330 +
313 313  AttributeDescriptor
332 +
314 314  MetadataTarget
334 +
315 315  ReportStructure
316 -)))|(% style="width:537px" %)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.
317 -| |components|(% style="width:537px" %)An aggregate association to one or more components which make up the list.
336 +)))|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.
337 +| |components|An aggregate association to one or more components which make up the list.
318 318  |//Component//|(((
319 319  Inherits from:
340 +
320 320  //IdentifiableArtefact//
342 +
321 321  Sub classes are:
344 +
322 322  PrimaryMeasure
346 +
323 323  DataAttribute
324 -//DimensionComponent
325 -TargetObject//
348 +
349 +//DimensionComponent//
350 +
351 +//TargetObject//
352 +
326 326  MetadataAttribute
327 -)))|(% style="width:537px" %)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.
328 -| |conceptIdentity|(% style="width:537px" %)Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component
329 -| |localRepresentation|(% style="width:537px" %)Association to the Representation of the Component if this is different from the coreRepresentation of the Concept which the Component uses (ConceptUsage)
330 -|Representation| |(% style="width:537px" %)The allowable value or format for Component or Concept
331 -| |+enumerated|(% style="width:537px" %)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 (e.g. Identifier Component can have any of the sub classes of Item Scheme, whereas Measure Dimension must have a Concept Scheme).
332 -| |+nonEnumerated|(% style="width:537px" %)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.
333 -|Facet| |(% style="width:537px" %)Defines the format for the content of the Component when reported in a data or metadata set.
334 -| |facetType|(% style="width:537px" %)A specific content type which is constrained by the FacetType enumeration
335 -| |facetValueType|(% style="width:537px" %)(((
354 +)))|A component is an abstract super class used to define qualitative and quantitative data and metadata items that belong to a Component List and hence a Structure. Component is refined through its sub-classes.
355 +| |conceptIdentity|Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component
356 +| |localRepresentation|Association to the Representation of the Component if this is different from the coreRepresentation of the Concept which the Component uses (ConceptUsage)
357 +|Representation| |The allowable value or format for Component or Concept
358 +| |+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 (e.g. Identifier Component can have any of the sub classes of Item Scheme, whereas Measure Dimension must have a Concept Scheme).
359 +| |+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.
360 +|Facet| |Defines the format for the content of the Component when reported in a data or metadata set.
361 +| |facetType|A specific content type which is constrained by the FacetType enumeration
362 +| |facetValueType|(((
336 336  The format of the value of a Component when reported in a data or metadata set.
337 337  
338 338  This is contrained by the FacetValueType enumeration.
339 339  )))
340 -| |+itemSchemeFacet|(% style="width:537px" %)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.
341 -|ExtendedFacet| |(% style="width:537px" %)This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute
367 +| |+itemSchemeFacet|Defines the format of the identifiers in an Item Scheme used by a Component. Typically this would define the number of characters (length) of the identifier.
368 +|ExtendedFacet| |This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute
342 342  
343 -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)
370 +The specification of the content and use of the sub classes to ,,ComponentList,, and ,,Component,, can be found in the section in which they are used (DataStructureDefinition and MetadataStructureDefinition)
344 344  
345 345  ==== 3.6.3.3 Representation Constructs ====
346 346  
347 347  The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, 818 and have equivalents in most current implementation platforms:
348 348  
376 +:
377 +
349 349  (((
350 -(% style="width:1034.29px" %)
351 -|(% style="width:222px" %)**SDMX Facet Value Type**|(% style="width:229px" %)**XML Schema Data Type**|(% style="width:216px" %)**.NET Framework Type**|(% style="width:354px" %)**Java Data Type**
352 -|(% style="width:222px" %)String|(% style="width:229px" %)xsd:string|(% style="width:216px" %)System.String|(% style="width:354px" %)java.lang.String
353 -|(% style="width:222px" %)Big Integer|(% style="width:229px" %)xsd:integer|(% style="width:216px" %)System.Decimal|(% style="width:354px" %)java.math.BigInteger
354 -|(% style="width:222px" %)Integer|(% style="width:229px" %)xsd:int|(% style="width:216px" %)System.Int32|(% style="width:354px" %)int
355 -|(% style="width:222px" %)Long|(% style="width:229px" %)xsd.long|(% style="width:216px" %)System.Int64|(% style="width:354px" %)long
356 -|(% style="width:222px" %)Short|(% style="width:229px" %)xsd:short|(% style="width:216px" %)System.Int16|(% style="width:354px" %)short
357 -|(% style="width:222px" %)Decimal|(% style="width:229px" %)xsd:decimal|(% style="width:216px" %)System.Decimal|(% style="width:354px" %)java.math.BigDecimal
358 -|(% style="width:222px" %)Float|(% style="width:229px" %)xsd:float|(% style="width:216px" %)System.Single|(% style="width:354px" %)float
359 -|(% style="width:222px" %)Double|(% style="width:229px" %)xsd:double|(% style="width:216px" %)System.Double|(% style="width:354px" %)double
360 -|(% style="width:222px" %)Boolean|(% style="width:229px" %)xsd:boolean|(% style="width:216px" %)System.Boolean|(% style="width:354px" %)boolean
361 -|(% style="width:222px" %)URI|(% style="width:229px" %)xsd:anyURI|(% style="width:216px" %)System.Uri|(% style="width:354px" %)Java.net.URI or java.lang.String
362 -|(% style="width:222px" %)DateTime|(% style="width:229px" %)xsd:dateTime|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
363 -|(% style="width:222px" %)Time|(% style="width:229px" %)xsd:time|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
364 -|(% style="width:222px" %)GregorianYear|(% style="width:229px" %)xsd:gYear|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
365 -|(% style="width:222px" %)GregorianMonth|(% style="width:229px" %)xsd:gYearMonth|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
366 -|(% style="width:222px" %)GregorianDay|(% style="width:229px" %)xsd:date|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
367 -|(% style="width:222px" %)Day, MonthDay, Month|(% style="width:229px" %)xsd:g*|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
368 -|(% style="width:222px" %)Duration|(% style="width:229px" %)xsd:duration|(% style="width:216px" %)System.TimeSpan|(% style="width:354px" %)javax.xml.datatype.Dura tion
379 +|**SDMX Facet Value Type**|**XML Schema Data Type     **|**.NET Framework Type**|**Java Data Type**
380 +|String|xsd:string|System.String|java.lang.String
381 +|Big Integer|xsd:integer|System.Decimal|java.math.BigInteger
382 +|Integer|xsd:int|System.Int32|int
383 +|Long|xsd.long|System.Int64|long
384 +|Short|xsd:short|System.Int16|short
385 +|Decimal|xsd:decimal|System.Decimal|java.math.BigDecimal
386 +|Float|xsd:float|System.Single|float
387 +|Double|xsd:double|System.Double|double
388 +|Boolean|xsd:boolean|System.Boolean|boolean
389 +|URI|xsd:anyURI|System.Uri|Java.net.URI or java.lang.String
390 +|DateTime|xsd:dateTime|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
391 +|Time|xsd:time|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
392 +|GregorianYear|xsd:gYear|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
393 +|GregorianMonth|xsd:gYearMonth|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
394 +|GregorianDay|xsd:date|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
395 +|Day, MonthDay, Month|xsd:g*|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
396 +|Duration|xsd:duration|System.TimeSpan|javax.xml.datatype.Dura tion
369 369  )))
370 370  
371 -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.
399 +There are also a number of SDMX data types which do not have these direct 822 correspondences, often because they are composite representations or restrictions of a 823 broader data type. These are detailed in Section 6 of the standards.
372 372  
373 -The Representation is composed of Facets, each of which conveys characteristic information related to the definition of a value domain. Often a set of Facets are needed to convey the required semantic. For example, a sequence is defined by a minimum of two Facets: one to define the start value, and one to define the interval.
401 +The ,,Representation,, is composed of ,,Facet,,s, each of which conveys characteristic 826 information related to the definition of a value domain. Often a set of Facets are needed to 827 convey the required semantic. For example, a sequence is defined by a minimum of two 828 Facets: one to define the start value, and one to define the interval.
374 374  
403 +:
404 +
375 375  (((
376 -(% style="width:1043.29px" %)
377 -|(% style="width:179px" %)**Facet Type**|(% style="width:862px" %)**Explanation**
378 -|(% style="width:179px" %)isSequence|(% style="width:862px" %)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 supplied. If an end value is not given, then the sequence continues indefinitely.
379 -|(% style="width:179px" %)interval|(% style="width:862px" %)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.
380 -|(% style="width:179px" %)startValue|(% colspan="1" style="width:862px" %)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.
381 -|(% style="width:179px" %)endValue|(% colspan="1" style="width:862px" %)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.
382 -|(% style="width:179px" %)timeInterval|(% colspan="1" style="width:862px" %)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.
383 -|(% style="width:179px" %)startTime|(% colspan="1" style="width:862px" %)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.
384 -|(% style="width:179px" %)endTime|(% colspan="1" style="width:862px" %)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.
385 -|(% style="width:179px" %)minLength|(% colspan="1" style="width:862px" %)The minLength facet specifies the minimum and length of the value in characters.
386 -|(% style="width:179px" %)maxLength|(% colspan="1" style="width:862px" %)The maxLength facet specifies the maximum length of the value in characters.
387 -|(% style="width:179px" %)minValue|(% colspan="1" style="width:862px" %)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.
388 -|(% style="width:179px" %)maxValue|(% colspan="1" style="width:862px" %)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.
389 -|(% style="width:179px" %)decimals|(% colspan="1" style="width:862px" %)The decimals facet indicates the number of characters allowed after the decimal separator.
390 -|(% style="width:179px" %)pattern|(% colspan="1" style="width:862px" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g. W3C XML Schema).
406 +|**Facet Type**|**Explanation**|
407 +|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 supplied. If an end value is not given, then the sequence continues indefinitely.|
408 +|interval|The interval attribute specifies the permitted interval (increment) in a|
409 +| |(% colspan="2" %)sequence. In order for this to be used, the isSequence attribute must have a value of true.
410 +|startValue|(% colspan="2" %)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.
411 +|endValue|(% colspan="2" %)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.
412 +|timeInterval|(% colspan="2" %)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.
413 +|startTime|(% colspan="2" %)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.
414 +|endTime|(% colspan="2" %)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.
415 +|minLength|(% colspan="2" %)The minLength facet specifies the minimum and length of the value in characters.
416 +|maxLength|(% colspan="2" %)The maxLength facet specifies the maximum length of the value in characters.
417 +|minValue|(% colspan="2" %)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|(% colspan="2" %)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|(% colspan="2" %)The decimals facet indicates the number of characters allowed after the decimal separator.
420 +|pattern|(% colspan="2" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g. W3C XML Schema).
391 391  )))
1747690333052-506.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -67.4 KB
Content