Changes for page 3 SDMX Base Package

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

From 6.3 to 6.4 From 9.1 to 10.1

From version 6.4

edited by Helena
on 2025/05/20 00:23

Change comment: There is no comment for this version

To version 9.1

edited by Helena
on 2025/05/20 00:31

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -162,9 +162,9 @@
  (% class="wikigeneratedid" id="HFigure12TheItemSchemePattern" %)
  **Figure 12 The Item Scheme Pattern**
--===== {{id name="_Toc370981"/}}3.5.3 Explanation of the Diagram =====
++=== {{id name="_Toc370981"/}}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 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//.
@@ -178,81 +178,53 @@
  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.
--//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
++//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//).
--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//).
--
  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 ====
--|**Class**|**Feature**|**Description**
--|//ItemScheme//|(((
++(% style="width:911.294px" %)
++|**Class**|(% style="width:246px" %)**Feature**|(% style="width:478px" %)**Description**
++|//ItemScheme//|(% style="width:246px" %)(((
  Inherits from:
--
  //MaintainableArtefact//
--
  Direct sub classes are:
--
  CategoryScheme
--
  ConceptScheme
--
  Codelist
--)))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
--| |(((
++)))|(% style="width:478px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
++| |(% style="width:246px" %)(((
  ReportingTaxonomy
--
  //OrganisationScheme//
--
  Transformation Scheme
--
  CustomTypeScheme
--
  NamePersonasationScheme
--
  RuletScheme
--
  VtlMappingScheme
--
  UserDefinedOperatorScheme
--)))|
--| |isPartial|Denotes whether the Item Scheme contains a sub set of the full set of Items in the maintained scheme.
--| |items|Association to the Items in the scheme.
--|//Item//|(((
++)))|(% style="width:478px" %)
++| |(% 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.
++| |(% style="width:246px" %)items|(% style="width:478px" %)Association to the Items in the scheme.
++|//Item//|(% style="width:246px" %)(((
  Inherits from:
--
  //NameableArtefact//
--
--Direct sub classes are
--
--Category
--
++Direct sub classes are Category
  Concept
--
  Code
--
  ReportingCategory
--
  //Organisation//
--
  Transformation
--
  CustomType
--
  NamePersonlisation
--
  Ruleset
--
  VtlMapping
--
--UserDefinedOperator// &nbsp;&nbsp;&nbsp;//
--)))|(((
++UserDefinedOperator
++)))|(% style="width:478px" %)(((
  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.
--
  Note that at the conceptual level the Organisation is not hierarchic
  )))
--| |hierarchy|This allows an Item optionally to have one or more child Items.
++| |(% style="width:246px" %)hierarchy|(% style="width:478px" %)This allows an Item optionally to have one or more child Items.
  == {{id name="_Toc370982"/}}3.6 The Structure Pattern ==
@@ -268,7 +268,8 @@
  [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_b6478a73.png||height="774" width="556"]]
--====== Figure 14: Representation within the Structure Pattern ======
++(% class="wikigeneratedid" id="HFigure14:RepresentationwithintheStructurePattern" %)
++**Figure 14: Representation within the Structure Pattern**
  === {{id name="_Toc370985"/}}3.6.3 Explanation of the Diagrams ===
@@ -292,7 +292,7 @@
  __ReportStructure__: MetadataAttribute
--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.
++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.
  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.
@@ -307,140 +307,112 @@
  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).
--**3.6.3.2 Definitions**
++==== 3.6.3.2 Definitions ====
--|**Class**|**Feature**|**Description**
++(% style="width:1001.29px" %)
++|**Class**|**Feature**|(% style="width:537px" %)**Description**
  |//StructureUsage//|(((
  Inherits from:
--
  //MaintainableArtefact//
--
  Sub classes are:
--
  DataflowDefinition
--
--MetadataflowDefinition// &nbsp;&nbsp;&nbsp;//
--)))|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.
--| |structure|An association to a Structure specifying the structure of the artefact.
++MetadataflowDefinition
++)))|(% 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.
++| |structure|(% style="width:537px" %)An association to a Structure specifying the structure of the artefact.
  |//Structure//|(((
  Inherits from:
--
  //MaintainableArtefact//
--
  Sub classes are:
--
  DataStructure
--
  Definition
--
  MetadataStructure
--
  Definition
--)))|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.
++)))|(% 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.
++| |grouping|(% style="width:537px" %)A composite association to one or more component lists.
  |//ComponentList//|(((
  Inherits from:
--
  //IdentifiableArtefact//
--
  Sub classes are:
--
  DimensionDescriptor
--
  GroupDimension
--
  Descriptor
--
  MeasureDescriptor
--
  AttributeDescriptor
--
  MetadataTarget
--
  ReportStructure
--)))|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.
++)))|(% 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.
++| |components|(% style="width:537px" %)An aggregate association to one or more components which make up the list.
  |//Component//|(((
  Inherits from:
--
  //IdentifiableArtefact//
--
  Sub classes are:
--
  PrimaryMeasure
--
  DataAttribute
--
--//DimensionComponent//
--
--//TargetObject//
--
++//DimensionComponent
++TargetObject//
  MetadataAttribute
--)))|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|Association to the Representation of the Component if this is different from the coreRepresentation of the Concept which the Component uses (ConceptUsage)
--|Representation| |The allowable value or format for Component or Concept
--| |+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).
--| |+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.
--|Facet| |Defines the format for the content of the Component when reported in a data or metadata set.
--| |facetType|A specific content type which is constrained by the FacetType enumeration
--| |facetValueType|(((
++)))|(% 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.
++| |conceptIdentity|(% style="width:537px" %)Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component
++| |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)
++|Representation| |(% style="width:537px" %)The allowable value or format for Component or Concept
++| |+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).
++| |+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.
++|Facet| |(% style="width:537px" %)Defines the format for the content of the Component when reported in a data or metadata set.
++| |facetType|(% style="width:537px" %)A specific content type which is constrained by the FacetType enumeration
++| |facetValueType|(% style="width:537px" %)(((
  The format of the value of a Component when reported in a data or metadata set.
  This is contrained by the FacetValueType enumeration.
  )))
--| |+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.
--|ExtendedFacet| |This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute
++| |+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.
++|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
--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)
++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)
  ==== 3.6.3.3 Representation Constructs ====
  The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, 818 and have equivalents in most current implementation platforms:
--:
--
  (((
--|**SDMX Facet Value Type**|**XML Schema Data Type &nbsp;&nbsp;&nbsp;&nbsp;**|**.NET Framework Type**|**Java Data Type**
--|String|xsd:string|System.String|java.lang.String
--|Big Integer|xsd:integer|System.Decimal|java.math.BigInteger
--|Integer|xsd:int|System.Int32|int
--|Long|xsd.long|System.Int64|long
--|Short|xsd:short|System.Int16|short
--|Decimal|xsd:decimal|System.Decimal|java.math.BigDecimal
--|Float|xsd:float|System.Single|float
--|Double|xsd:double|System.Double|double
--|Boolean|xsd:boolean|System.Boolean|boolean
--|URI|xsd:anyURI|System.Uri|Java.net.URI or java.lang.String
--|DateTime|xsd:dateTime|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
--|Time|xsd:time|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
--|GregorianYear|xsd:gYear|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
--|GregorianMonth|xsd:gYearMonth|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
--|GregorianDay|xsd:date|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
--|Day, MonthDay, Month|xsd:g*|System.DateTime|javax.xml.datatype.XMLG regorianCalendar
--|Duration|xsd:duration|System.TimeSpan|javax.xml.datatype.Dura tion
++(% style="width:1034.29px" %)
++|(% 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**
++|(% style="width:222px" %)String|(% style="width:229px" %)xsd:string|(% style="width:216px" %)System.String|(% style="width:354px" %)java.lang.String
++|(% style="width:222px" %)Big Integer|(% style="width:229px" %)xsd:integer|(% style="width:216px" %)System.Decimal|(% style="width:354px" %)java.math.BigInteger
++|(% style="width:222px" %)Integer|(% style="width:229px" %)xsd:int|(% style="width:216px" %)System.Int32|(% style="width:354px" %)int
++|(% style="width:222px" %)Long|(% style="width:229px" %)xsd.long|(% style="width:216px" %)System.Int64|(% style="width:354px" %)long
++|(% style="width:222px" %)Short|(% style="width:229px" %)xsd:short|(% style="width:216px" %)System.Int16|(% style="width:354px" %)short
++|(% style="width:222px" %)Decimal|(% style="width:229px" %)xsd:decimal|(% style="width:216px" %)System.Decimal|(% style="width:354px" %)java.math.BigDecimal
++|(% style="width:222px" %)Float|(% style="width:229px" %)xsd:float|(% style="width:216px" %)System.Single|(% style="width:354px" %)float
++|(% style="width:222px" %)Double|(% style="width:229px" %)xsd:double|(% style="width:216px" %)System.Double|(% style="width:354px" %)double
++|(% style="width:222px" %)Boolean|(% style="width:229px" %)xsd:boolean|(% style="width:216px" %)System.Boolean|(% style="width:354px" %)boolean
++|(% style="width:222px" %)URI|(% style="width:229px" %)xsd:anyURI|(% style="width:216px" %)System.Uri|(% style="width:354px" %)Java.net.URI or java.lang.String
++|(% style="width:222px" %)DateTime|(% style="width:229px" %)xsd:dateTime|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
++|(% style="width:222px" %)Time|(% style="width:229px" %)xsd:time|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
++|(% style="width:222px" %)GregorianYear|(% style="width:229px" %)xsd:gYear|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
++|(% style="width:222px" %)GregorianMonth|(% style="width:229px" %)xsd:gYearMonth|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
++|(% style="width:222px" %)GregorianDay|(% style="width:229px" %)xsd:date|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
++|(% style="width:222px" %)Day, MonthDay, Month|(% style="width:229px" %)xsd:g*|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
++|(% style="width:222px" %)Duration|(% style="width:229px" %)xsd:duration|(% style="width:216px" %)System.TimeSpan|(% style="width:354px" %)javax.xml.datatype.Dura tion
  )))
--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.
++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 ,,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.
++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.
--:
--
  (((
--|**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 supplied. If an end value is not given, then the sequence continues indefinitely.|
--|interval|The interval attribute specifies the permitted interval (increment) in a|
--| |(% colspan="2" %)sequence. In order for this to be used, the isSequence attribute must have a value of true.
--|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.
--|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.
--|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.
--|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.
--|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.
--|minLength|(% colspan="2" %)The minLength facet specifies the minimum and length of the value in characters.
--|maxLength|(% colspan="2" %)The maxLength facet specifies the maximum length of the value in characters.
--|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.
--|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.
--|decimals|(% colspan="2" %)The decimals facet indicates the number of characters allowed after the decimal separator.
--|pattern|(% colspan="2" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g. W3C XML Schema).
++(% style="width:1043.29px" %)
++|(% style="width:179px" %)**Facet Type**|(% style="width:862px" %)**Explanation**
++|(% 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.
++|(% 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.
++|(% 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.
++|(% 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.
++|(% 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.
++|(% 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.
++|(% 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.
++|(% style="width:179px" %)minLength|(% colspan="1" style="width:862px" %)The minLength facet specifies the minimum and length of the value in characters.
++|(% style="width:179px" %)maxLength|(% colspan="1" style="width:862px" %)The maxLength facet specifies the maximum length of the value in characters.
++|(% 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.
++|(% 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.
++|(% style="width:179px" %)decimals|(% colspan="1" style="width:862px" %)The decimals facet indicates the number of characters allowed after the decimal separator.
++|(% 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).
  )))