Skip to Content

Changes for page 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19
From version 6.9
edited by Helena
on 2025/05/20 00:29
Change comment: There is no comment for this version
To version 6.4
edited by Helena
on 2025/05/20 00:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -186,47 +186,73 @@
186 186  
187 187  ==== 3.5.3.2 Definitions ====
188 188  
189 -(% style="width:911.294px" %)
190 -|**Class**|(% style="width:246px" %)**Feature**|(% style="width:478px" %)**Description**
191 -|//ItemScheme//|(% style="width:246px" %)(((
189 +|**Class**|**Feature**|**Description**
190 +|//ItemScheme//|(((
192 192  Inherits from:
192 +
193 193  //MaintainableArtefact//
194 +
194 194  Direct sub classes are:
196 +
195 195  CategoryScheme
198 +
196 196  ConceptScheme
200 +
197 197  Codelist
198 -)))|(% style="width:478px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
199 -| |(% style="width:246px" %)(((
202 +)))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
203 +| |(((
200 200  ReportingTaxonomy
205 +
201 201  //OrganisationScheme//
207 +
202 202  Transformation Scheme
209 +
203 203  CustomTypeScheme
211 +
204 204  NamePersonasationScheme
213 +
205 205  RuletScheme
215 +
206 206  VtlMappingScheme
217 +
207 207  UserDefinedOperatorScheme
208 -)))|(% style="width:478px" %)
209 -| |(% style="width:246px" %)isPartial|(% style="width:478px" %)Denotes whether the Item Scheme contains a sub set of the full set of Items in the maintained scheme.
210 -| |(% style="width:246px" %)items|(% style="width:478px" %)Association to the Items in the scheme.
211 -|//Item//|(% style="width:246px" %)(((
219 +)))|
220 +| |isPartial|Denotes whether the Item Scheme contains a sub set of the full set of Items in the maintained scheme.
221 +| |items|Association to the Items in the scheme.
222 +|//Item//|(((
212 212  Inherits from:
224 +
213 213  //NameableArtefact//
214 -Direct sub classes are Category
226 +
227 +Direct sub classes are
228 +
229 +Category
230 +
215 215  Concept
232 +
216 216  Code
234 +
217 217  ReportingCategory
236 +
218 218  //Organisation//
238 +
219 219  Transformation
240 +
220 220  CustomType
242 +
221 221  NamePersonlisation
244 +
222 222  Ruleset
246 +
223 223  VtlMapping
224 -UserDefinedOperator
225 -)))|(% style="width:478px" %)(((
248 +
249 +UserDefinedOperator//    //
250 +)))|(((
226 226  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.
252 +
227 227  Note that at the conceptual level the Organisation is not hierarchic
228 228  )))
229 -| |(% style="width:246px" %)hierarchy|(% style="width:478px" %)This allows an Item optionally to have one or more child Items.
255 +| |hierarchy|This allows an Item optionally to have one or more child Items.
230 230  
231 231  == {{id name="_Toc370982"/}}3.6 The Structure Pattern ==
232 232  
... ... @@ -242,8 +242,7 @@
242 242  
243 243  [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_b6478a73.png||height="774" width="556"]]
244 244  
245 -(% class="wikigeneratedid" id="HFigure14:RepresentationwithintheStructurePattern" %)
246 -**Figure 14: Representation within the Structure Pattern**
271 +====== Figure 14: Representation within the Structure Pattern ======
247 247  
248 248  === {{id name="_Toc370985"/}}3.6.3 Explanation of the Diagrams ===
249 249  
... ... @@ -267,7 +267,7 @@
267 267  
268 268  __ReportStructure__: MetadataAttribute
269 269  
270 -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.
295 +Each Component takes its semantic (and possibly also its representation) from a Concept in 773 a ConceptScheme. This is represented by the conceptIdentity association to Concept.
271 271  
272 272  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.
273 273  
... ... @@ -282,112 +282,140 @@
282 282  
283 283  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).
284 284  
285 -==== 3.6.3.2 Definitions ====
310 +**3.6.3.2 Definitions**
286 286  
287 -(% style="width:1001.29px" %)
288 -|**Class**|**Feature**|(% style="width:537px" %)**Description**
312 +|**Class**|**Feature**|**Description**
289 289  |//StructureUsage//|(((
290 290  Inherits from:
315 +
291 291  //MaintainableArtefact//
317 +
292 292  Sub classes are:
319 +
293 293  DataflowDefinition
294 -MetadataflowDefinition
295 -)))|(% 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.
296 -| |structure|(% style="width:537px" %)An association to a Structure specifying the structure of the artefact.
321 +
322 +MetadataflowDefinition//    //
323 +)))|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.
324 +| |structure|An association to a Structure specifying the structure of the artefact.
297 297  |//Structure//|(((
298 298  Inherits from:
327 +
299 299  //MaintainableArtefact//
329 +
300 300  Sub classes are:
331 +
301 301  DataStructure
333 +
302 302  Definition
335 +
303 303  MetadataStructure
337 +
304 304  Definition
305 -)))|(% 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.
306 -| |grouping|(% style="width:537px" %)A composite association to one or more component lists.
339 +)))|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.
340 +| |grouping|A composite association to one or more component lists.
307 307  |//ComponentList//|(((
308 308  Inherits from:
343 +
309 309  //IdentifiableArtefact//
345 +
310 310  Sub classes are:
347 +
311 311  DimensionDescriptor
349 +
312 312  GroupDimension
351 +
313 313  Descriptor
353 +
314 314  MeasureDescriptor
355 +
315 315  AttributeDescriptor
357 +
316 316  MetadataTarget
359 +
317 317  ReportStructure
318 -)))|(% 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.
319 -| |components|(% style="width:537px" %)An aggregate association to one or more components which make up the list.
361 +)))|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.
362 +| |components|An aggregate association to one or more components which make up the list.
320 320  |//Component//|(((
321 321  Inherits from:
365 +
322 322  //IdentifiableArtefact//
367 +
323 323  Sub classes are:
369 +
324 324  PrimaryMeasure
371 +
325 325  DataAttribute
326 -//DimensionComponent
327 -TargetObject//
373 +
374 +//DimensionComponent//
375 +
376 +//TargetObject//
377 +
328 328  MetadataAttribute
329 -)))|(% 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.
330 -| |conceptIdentity|(% style="width:537px" %)Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component
331 -| |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)
332 -|Representation| |(% style="width:537px" %)The allowable value or format for Component or Concept
333 -| |+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).
334 -| |+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.
335 -|Facet| |(% style="width:537px" %)Defines the format for the content of the Component when reported in a data or metadata set.
336 -| |facetType|(% style="width:537px" %)A specific content type which is constrained by the FacetType enumeration
337 -| |facetValueType|(% style="width:537px" %)(((
379 +)))|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.
380 +| |conceptIdentity|Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component
381 +| |localRepresentation|Association to the Representation of the Component if this is different from the coreRepresentation of the Concept which the Component uses (ConceptUsage)
382 +|Representation| |The allowable value or format for Component or Concept
383 +| |+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).
384 +| |+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.
385 +|Facet| |Defines the format for the content of the Component when reported in a data or metadata set.
386 +| |facetType|A specific content type which is constrained by the FacetType enumeration
387 +| |facetValueType|(((
338 338  The format of the value of a Component when reported in a data or metadata set.
339 339  
340 340  This is contrained by the FacetValueType enumeration.
341 341  )))
342 -| |+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.
343 -|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
392 +| |+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.
393 +|ExtendedFacet| |This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute
344 344  
345 -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)
395 +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)
346 346  
347 347  ==== 3.6.3.3 Representation Constructs ====
348 348  
349 349  The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, 818 and have equivalents in most current implementation platforms:
350 350  
401 +:
402 +
351 351  (((
352 -(% style="width:1034.29px" %)
353 -|(% 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**
354 -|(% style="width:222px" %)String|(% style="width:229px" %)xsd:string|(% style="width:216px" %)System.String|(% style="width:354px" %)java.lang.String
355 -|(% style="width:222px" %)Big Integer|(% style="width:229px" %)xsd:integer|(% style="width:216px" %)System.Decimal|(% style="width:354px" %)java.math.BigInteger
356 -|(% style="width:222px" %)Integer|(% style="width:229px" %)xsd:int|(% style="width:216px" %)System.Int32|(% style="width:354px" %)int
357 -|(% style="width:222px" %)Long|(% style="width:229px" %)xsd.long|(% style="width:216px" %)System.Int64|(% style="width:354px" %)long
358 -|(% style="width:222px" %)Short|(% style="width:229px" %)xsd:short|(% style="width:216px" %)System.Int16|(% style="width:354px" %)short
359 -|(% style="width:222px" %)Decimal|(% style="width:229px" %)xsd:decimal|(% style="width:216px" %)System.Decimal|(% style="width:354px" %)java.math.BigDecimal
360 -|(% style="width:222px" %)Float|(% style="width:229px" %)xsd:float|(% style="width:216px" %)System.Single|(% style="width:354px" %)float
361 -|(% style="width:222px" %)Double|(% style="width:229px" %)xsd:double|(% style="width:216px" %)System.Double|(% style="width:354px" %)double
362 -|(% style="width:222px" %)Boolean|(% style="width:229px" %)xsd:boolean|(% style="width:216px" %)System.Boolean|(% style="width:354px" %)boolean
363 -|(% style="width:222px" %)URI|(% style="width:229px" %)xsd:anyURI|(% style="width:216px" %)System.Uri|(% style="width:354px" %)Java.net.URI or java.lang.String
364 -|(% style="width:222px" %)DateTime|(% style="width:229px" %)xsd:dateTime|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
365 -|(% style="width:222px" %)Time|(% style="width:229px" %)xsd:time|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
366 -|(% style="width:222px" %)GregorianYear|(% style="width:229px" %)xsd:gYear|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
367 -|(% style="width:222px" %)GregorianMonth|(% style="width:229px" %)xsd:gYearMonth|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
368 -|(% style="width:222px" %)GregorianDay|(% style="width:229px" %)xsd:date|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
369 -|(% style="width:222px" %)Day, MonthDay, Month|(% style="width:229px" %)xsd:g*|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
370 -|(% style="width:222px" %)Duration|(% style="width:229px" %)xsd:duration|(% style="width:216px" %)System.TimeSpan|(% style="width:354px" %)javax.xml.datatype.Dura tion
404 +|**SDMX Facet Value Type**|**XML Schema Data Type     **|**.NET Framework Type**|**Java Data Type**
405 +|String|xsd:string|System.String|java.lang.String
406 +|Big Integer|xsd:integer|System.Decimal|java.math.BigInteger
407 +|Integer|xsd:int|System.Int32|int
408 +|Long|xsd.long|System.Int64|long
409 +|Short|xsd:short|System.Int16|short
410 +|Decimal|xsd:decimal|System.Decimal|java.math.BigDecimal
411 +|Float|xsd:float|System.Single|float
412 +|Double|xsd:double|System.Double|double
413 +|Boolean|xsd:boolean|System.Boolean|boolean
414 +|URI|xsd:anyURI|System.Uri|Java.net.URI or java.lang.String
415 +|DateTime|xsd:dateTime|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
416 +|Time|xsd:time|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
417 +|GregorianYear|xsd:gYear|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
418 +|GregorianMonth|xsd:gYearMonth|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
419 +|GregorianDay|xsd:date|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
420 +|Day, MonthDay, Month|xsd:g*|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
421 +|Duration|xsd:duration|System.TimeSpan|javax.xml.datatype.Dura tion
371 371  )))
372 372  
373 -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.
424 +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.
374 374  
375 -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.
426 +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.
376 376  
428 +:
429 +
377 377  (((
378 -(% style="width:1043.29px" %)
379 -|(% style="width:179px" %)**Facet Type**|(% style="width:862px" %)**Explanation**
380 -|(% 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.
381 -|(% 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.
382 -|(% 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.
383 -|(% 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.
384 -|(% 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.
385 -|(% 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.
386 -|(% 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.
387 -|(% style="width:179px" %)minLength|(% colspan="1" style="width:862px" %)The minLength facet specifies the minimum and length of the value in characters.
388 -|(% style="width:179px" %)maxLength|(% colspan="1" style="width:862px" %)The maxLength facet specifies the maximum length of the value in characters.
389 -|(% 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.
390 -|(% 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.
391 -|(% style="width:179px" %)decimals|(% colspan="1" style="width:862px" %)The decimals facet indicates the number of characters allowed after the decimal separator.
392 -|(% 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).
431 +|**Facet Type**|**Explanation**|
432 +|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.|
433 +|interval|The interval attribute specifies the permitted interval (increment) in a|
434 +| |(% colspan="2" %)sequence. In order for this to be used, the isSequence attribute must have a value of true.
435 +|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.
436 +|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.
437 +|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.
438 +|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.
439 +|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.
440 +|minLength|(% colspan="2" %)The minLength facet specifies the minimum and length of the value in characters.
441 +|maxLength|(% colspan="2" %)The maxLength facet specifies the maximum length of the value in characters.
442 +|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.
443 +|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.
444 +|decimals|(% colspan="2" %)The decimals facet indicates the number of characters allowed after the decimal separator.
445 +|pattern|(% colspan="2" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g. W3C XML Schema).
393 393  )))