Changes for page 3 SDMX Base Package

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

From 2.3 to 2.2 From 5.1 to 4.1

From version 4.1

edited by Helena
on 2025/06/08 01:00

Change comment: There is no comment for this version

To version 2.3

edited by Helena
on 2025/06/08 00:51

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -116,9 +116,9 @@
  **Figure 12: Class Diagram of Basic Data Types**
--=== 3.4.2 Explanation of the Diagram ===
++===== 3.4.2 Explanation of the Diagram =====
--==== 3.4.2.1 Narrative ====
++====== 3.4.2.1 Narrative ======
  The FacetType and FacetValueType enumerations are used to specify the valid format of the content of a non-enumerated Concept or the usage of a Concept when specified for use on a //Component// on a //Structure// (such as a Dimension in a DataStructureDefinition). The description of the various types can be found in the chapter on ConceptScheme (section 4.5).
@@ -139,23 +139,23 @@
  The VersionType data types provides the details for versioning according to SDMX versioning rules, as explained in SDMX Standards Section 6, paragraph “4.3 Versioning”.
--== 3.5 The Item Scheme Pattern ==
++==== //3.5 The Item Scheme Pattern// ====
--=== 3.5.1 Context ===
++===== 3.5.1 Context =====
  The Item Scheme is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example.
  The //ItemScheme// is the basis for CategoryScheme, Codelist, ConceptScheme, ReportingTaxonomy, //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme.
--=== 3.5.2 Class Diagram ===
++===== 3.5.2 Class Diagram =====
  [[image:1749246130543-644.jpeg]]
  **Figure 13 The Item Scheme pattern**
--=== 3.5.3 Explanation of the Diagram ===
++===== 3.5.3 Explanation of the Diagram =====
--==== 3.5.3.1 Narrative ====
++====== 3.5.3.1 Narrative ======
  The //ItemScheme// is an abstract class which defines a set of //Item// (this class is also abstract). Its main purpose is to define a mechanism which can be used to create taxonomies which can classify other parts of the SDMX Information Model. It is derived from //MaintainableArtefact// which gives it the ability to be annotated, have identity, naming, versioning and be associated with an Agency. An example of a concrete class is a ConceptScheme. The associated Concepts are //Item//s.
@@ -169,57 +169,76 @@
  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//.
--==== 3.5.3.2 Definitions ====
++====== 3.5.3.2 Definitions ======
--(% style="width:989.835px" %)
--|**Class**|(% style="width:297px" %)**Feature**|(% style="width:583px" %)**Description**
--|//ItemScheme//|(% style="width:297px" %)(((
++|**Class**|**Feature**|**Description**
++|//ItemScheme//|(((
  Inherits from:
++
  //MaintainableArtefact//
++
  Direct sub classes are:
++
  CategoryScheme
++
  ConceptScheme
++
  Codelist
++
  ReportingTaxonomy
++
  //OrganisationScheme//
++
  TransformationScheme
++
  CustomTypeScheme NamePersonalisationSc heme
++
  RulesetScheme
--VtlMappingScheme
--UserDefinedOperatorSc heme
--)))|(% style="width:583px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
--| |(% style="width:297px" %)isPartial|(% style="width:583px" %)Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme.
--| |(% style="width:297px" %)/items|(% style="width:583px" %)Association to the Items in the scheme.
--|//Item//|(% style="width:297px" %)(((
++
++VtlMappingScheme UserDefinedOperatorSc heme
++)))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
++| |isPartial|Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme.
++| |/items|Association to the Items in the scheme.
++|//Item//|(((
  Inherits from:
++
  //NameableArtefact//
++
  Direct sub classes are
++
  Category
++
  Concept
++
  Code
++
  ReportingCategory //Organisation//
++
  Transformation
++
  CustomType
++
  NamePersonalisation
++
  Ruleset
++
  VtlMapping
++
  UserDefinedOperator// //hierarchy
--)))|(% style="width:583px" %)(((
++)))|(((
  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.
++
  This allows an Item optionally to have one or more child Items
  )))
--== 3.6 The Structure Pattern ==
++==== //3.6 The Structure Pattern// ====
--=== 3.6.1 Context ===
++===== 3.6.1 Context =====
  The Structure Pattern is a basic architectural pattern which allows the specification of complex tabular structures which are often found in statistical data (such as Data Structure Definition, and Metadata Structure Definition). A Structure is a set of ordered lists. A pattern to underpin this tabular structure has been developed, so that commonalities between these structure definitions can be supported by common software and common syntax structures.
--=== 3.6.2 Class Diagrams ===
++===== 3.6.2 Class Diagrams [[image:1749246130548-601.jpeg]] =====
--(% class="wikigeneratedid" %)
--[[image:1749246130548-601.jpeg]]
--
  **Figure 14: The Structure Pattern**
  [[image:1749246130554-995.jpeg]]
@@ -226,9 +226,9 @@
  **Figure 15: Representation within the Structure Pattern**
--=== 3.6.3 Explanation of the Diagrams ===
++====== 3.6.3 Explanation of the Diagrams ======
--==== 3.6.3.1 Narrative ====
++3.6.3.1 Narrative
  The //Structure// is an abstract class which contains a set of one or more //ComponentList//(s) (this class is also abstract). An example of a concrete //Structure// is DataStructureDefinition.
@@ -237,9 +237,13 @@
  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:
  DimensionDescriptor: Dimension, TimeDimension
++
  GroupDimensionDescriptor: Dimension, TimeDimension
++
  MeasureDescriptor: Measure
++
  AttributeDescriptor: DataAttribute, MetadataAttributeRef
++
  MetadataAttributeDescriptor: MetadataAttribute
  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.
@@ -258,41 +258,59 @@
  The //Structure// may be used by one or more //StructureUsage//(s). An example of this, in terms of concrete classes, is that a Dataflow (sub class of //StructureUsage//) may use a particular DataStructureDefinition (sub class of //Structure//), and similar constructs apply for the Metadataflow (link to MetadataStructureDefinition).
--==== 3.6.3.2 Definitions ====
++3.6.3.2 Definitions
  |**Class**|**Feature**|**Description**
  |StructureUsage|(((
  Inherits from:
++
  //MaintainableArtefact//
++
  Sub classes are:
++
  Dataflow
++
  Metadataflow
  )))|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.
  | |structure|An association to a Structure specifying the structure of the artefact.
  |Structure|(((
  Inherits from:
++
  //MaintainableArtefact//
++
  Sub classes are:
++
  DataStructureDefinition MetadataStructureDefinit ion
  )))|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.
  | |grouping|A composite association to one or more component lists.
  |//ComponentList//|(((
  Inherits from:
++
  //IdentifiableArtefact//
++
  Sub classes are:
++
  DimensionDescriptor
++
  GroupDimensionDescriptor
++
  MeasureDescriptor
++
  AttributeDescriptor MetadataAttributeDescrip tor
  )))|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.
  | |components|An aggregate association to one or more components which make up the list.
  |//Component//|(((
  Inherits from:
++
  //IdentifiableArtefact//
++
  Sub classes are:
++
  Measure
--//AttributeComponent
--DimensionComponent//
++
++//AttributeComponent//
++
++//DimensionComponent//
  )))|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.
  | |conceptIdentity|Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component.
  | |localRepresentation|(((
@@ -311,55 +311,59 @@
  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.
--==== 3.6.3.3 Representation Constructs ====
++3.6.3.3 Representation Constructs
  The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms:
--|(% style="width:198px" %)(((
--**SDMX Facet Value Type**
--)))|(% style="width:204px" %)**XML Schema Data Type**|(% style="width:209px" %)**JSON Schema Data Type**|(% style="width:187px" %)(((
--**.NET Framework Type**
--)))|(% style="width:817px" %)**Java Data Type**
--|(% style="width:198px" %)String|(% style="width:204px" %)xsd:string|(% style="width:209px" %)string|(% style="width:187px" %)System.String|(% style="width:817px" %)java.lang.String
--|(% style="width:198px" %)Big Integer|(% style="width:204px" %)xsd:integer|(% style="width:209px" %)integer|(% style="width:187px" %)System.Decimal|(% style="width:817px" %)java.math.BigInteger
--|(% style="width:198px" %)Integer|(% style="width:204px" %)xsd:int|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int32|(% style="width:817px" %)int
--|(% style="width:198px" %)Long|(% style="width:204px" %)xsd.long|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int64|(% style="width:817px" %)long
--|(% style="width:198px" %)Short|(% style="width:204px" %)xsd:short|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int16|(% style="width:817px" %)short
--|(% style="width:198px" %)Decimal|(% style="width:204px" %)xsd:decimal|(% style="width:209px" %)number|(% style="width:187px" %)System.Decimal|(% style="width:817px" %)java.math.BigDecimal
--|(% style="width:198px" %)Float|(% style="width:204px" %)xsd:float|(% style="width:209px" %)number|(% style="width:187px" %)System.Single|(% style="width:817px" %)float
--|(% style="width:198px" %)Double|(% style="width:204px" %)xsd:double|(% style="width:209px" %)number|(% style="width:187px" %)System.Double|(% style="width:817px" %)double
--|(% style="width:198px" %)Boolean|(% style="width:204px" %)xsd:boolean|(% style="width:209px" %)boolean|(% style="width:187px" %)System.Boolean|(% style="width:817px" %)boolean
--|(% style="width:198px" %)URI|(% style="width:204px" %)xsd:anyURI|(% style="width:209px" %)string:uri|(% style="width:187px" %)System.Uri|(% style="width:817px" %)Java.net.URI or java.lang.String
--|(% style="width:198px" %)DateTime|(% style="width:204px" %)xsd:dateTime|(% style="width:209px" %)string:datetime|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
--|(% style="width:198px" %)Time|(% style="width:204px" %)xsd:time|(% style="width:209px" %)string:time|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
--|(% style="width:198px" %)GregorianYear|(% style="width:204px" %)xsd:gYear|(% style="width:209px" %)string[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
--|(% style="width:198px" %)GregorianMonth|(% style="width:204px" %)xsd:gYearMonth|(% style="width:209px" %)string|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
--|(% style="width:198px" %)GregorianDay|(% style="width:204px" %)xsd:date|(% style="width:209px" %)string|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
--|(% style="width:198px" %)Day, MonthDay, Month|(% style="width:204px" %)xsd:g*|(% style="width:209px" %)string|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
--|(% style="width:198px" %)Duration|(% style="width:204px" %)xsd:duration|(% style="width:209px" %)string|(% style="width:187px" %)System.TimeSpan|(% style="width:817px" %)javax.xml.datatype.Dur ation
++|(((
++**SDMX Facet**
++**Value Type**
++)))|**XML Schema Data Type**|**JSON Schema Data Type**|(((
++**.NET Framework**
++
++**Type**
++)))|**Java Data Type**
++|String|xsd:string|string|System.String|java.lang.String
++|Big Integer|xsd:integer|integer|System.Decimal|java.math.BigInteger
++|Integer|xsd:int|integer|System.Int32|int
++|Long|xsd.long|integer|System.Int64|long
++|Short|xsd:short|integer|System.Int16|short
++|Decimal|xsd:decimal|number|System.Decimal|java.math.BigDecimal
++|Float|xsd:float|number|System.Single|float
++|Double|xsd:double|number|System.Double|double
++|Boolean|xsd:boolean|boolean|System.Boolean|boolean
++|URI|xsd:anyURI|string:uri|System.Uri|Java.net.URI or java.lang.String
++|DateTime|xsd:dateTime|string:datetime|System.DateTime|javax.xml.datatype.XML GregorianCalendar
++|Time|xsd:time|string:time|System.DateTime|javax.xml.datatype.XML GregorianCalendar
++|GregorianYear|xsd:gYear|string[[(% class="wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar
++|GregorianMonth|xsd:gYearMonth|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
++|GregorianDay|xsd:date|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
++|Day, MonthDay, Month|xsd:g*|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
++|Duration|xsd:duration|string|System.TimeSpan|javax.xml.datatype.Dur ation
++
  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.
  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.
--(% style="width:981.835px" %)
--|(% style="width:107px" %)**Facet Type**|(% style="width:872px" %)**Explanation**
--|(% style="width:107px" %)isSequence|(% style="width:872px" %)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.
--|(% style="width:107px" %)interval|(% style="width:872px" %)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.
--|(% style="width:107px" %)startValue|(% style="width:872px" %)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 isused for a numeric sequence and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.
--|(% style="width:107px" %)endValue|(% style="width:872px" %)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.
--|(% style="width:107px" %)timeInterval|(% style="width:872px" %)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.
--|(% style="width:107px" %)startTime|(% style="width:872px" %)The startTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). Thisnattribute is used for a time sequence and indicates the start time of thensequence. This value is mandatory for a time sequence to be expressed.
--|(% style="width:107px" %)endTime|(% style="width:872px" %)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) ofnthe sequence.
--|(% style="width:107px" %)minLength|(% style="width:872px" %)The minLength facet specifies the minimum and length of the value in characters.
--|(% style="width:107px" %)maxLength|(% style="width:872px" %)The maxLength facet specifies the maximum length of the value in characters.
--|(% style="width:107px" %)minValue|(% style="width:872px" %)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.
--|(% style="width:107px" %)maxValue|(% style="width:872px" %)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.
--|(% style="width:107px" %)Decimals|(% style="width:872px" %)The decimals facet indicates the number of characters allowed after the decimal separator.
--|(% style="width:107px" %)pattern|(% style="width:872px" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).
++|**Facet Type**|**Explanation**
++|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.
++|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.
++|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 isused for a numeric sequence and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.
++|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.
++|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.
++|startTime|The startTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). Thisnattribute is used for a time sequence and indicates the start time of thensequence. This value is mandatory for a time sequence to be expressed.
++|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) ofnthe sequence.
++|minLength|The minLength facet specifies the minimum and length of the value in characters.
++|maxLength|The maxLength facet specifies the maximum length of the value in characters.
++|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.
++|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.
++|Decimals|The decimals facet indicates the number of characters allowed after the decimal separator.
++|pattern|The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).
++
  ----
  [[~[1~]>>path:#_ftnref1]] In the JSON schemas, more complex data types are complemented with regular expressions, whenever no direct mapping to a standard type exists.