Changes for page 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19

From version 6.3
edited by Helena
on 2025/05/20 00:23
Change comment: There is no comment for this version
To version 7.1
edited by Helena
on 2025/05/20 00:29
Change comment: There is no comment for this version

Summary

Details

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