Changes for page 3 SDMX Base Package

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

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.5
edited by Helena
on 2025/06/08 00:53
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -192,17 +192,29 @@
192 192  | |(% style="width:297px" %)/items|(% style="width:583px" %)Association to the Items in the scheme.
193 193  |//Item//|(% style="width:297px" %)(((
194 194  Inherits from:
195 +
195 195  //NameableArtefact//
197 +
196 196  Direct sub classes are
199 +
197 197  Category
201 +
198 198  Concept
203 +
199 199  Code
205 +
200 200  ReportingCategory //Organisation//
207 +
201 201  Transformation
209 +
202 202  CustomType
211 +
203 203  NamePersonalisation
213 +
204 204  Ruleset
215 +
205 205  VtlMapping
217 +
206 206  UserDefinedOperator// //hierarchy
207 207  )))|(% style="width:583px" %)(((
208 208  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.
... ... @@ -215,11 +215,8 @@
215 215  
216 216  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.
217 217  
218 -=== 3.6.2 Class Diagrams ===
230 +===== 3.6.2 Class Diagrams [[image:1749246130548-601.jpeg]] =====
219 219  
220 -(% class="wikigeneratedid" %)
221 -[[image:1749246130548-601.jpeg]]
222 -
223 223  **Figure 14: The Structure Pattern**
224 224  
225 225  [[image:1749246130554-995.jpeg]]
... ... @@ -226,9 +226,9 @@
226 226  
227 227  **Figure 15: Representation within the Structure Pattern**
228 228  
229 -=== 3.6.3 Explanation of the Diagrams ===
238 +====== 3.6.3 Explanation of the Diagrams ======
230 230  
231 -==== 3.6.3.1 Narrative ====
240 +3.6.3.1 Narrative
232 232  
233 233  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.
234 234  
... ... @@ -237,9 +237,13 @@
237 237  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:
238 238  
239 239  DimensionDescriptor: Dimension, TimeDimension
249 +
240 240  GroupDimensionDescriptor: Dimension, TimeDimension
251 +
241 241  MeasureDescriptor: Measure
253 +
242 242  AttributeDescriptor: DataAttribute, MetadataAttributeRef
255 +
243 243  MetadataAttributeDescriptor: MetadataAttribute
244 244  
245 245  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 @@
258 258  
259 259  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).
260 260  
261 -==== 3.6.3.2 Definitions ====
274 +3.6.3.2 Definitions
262 262  
263 263  |**Class**|**Feature**|**Description**
264 264  |StructureUsage|(((
265 265  Inherits from:
279 +
266 266  //MaintainableArtefact//
281 +
267 267  Sub classes are:
283 +
268 268  Dataflow
285 +
269 269  Metadataflow
270 270  )))|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.
271 271  | |structure|An association to a Structure specifying the structure of the artefact.
272 272  |Structure|(((
273 273  Inherits from:
291 +
274 274  //MaintainableArtefact//
293 +
275 275  Sub classes are:
295 +
276 276  DataStructureDefinition MetadataStructureDefinit ion
277 277  )))|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.
278 278  | |grouping|A composite association to one or more component lists.
279 279  |//ComponentList//|(((
280 280  Inherits from:
301 +
281 281  //IdentifiableArtefact//
303 +
282 282  Sub classes are:
305 +
283 283  DimensionDescriptor
307 +
284 284  GroupDimensionDescriptor
309 +
285 285  MeasureDescriptor
311 +
286 286  AttributeDescriptor MetadataAttributeDescrip tor
287 287  )))|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.
288 288  | |components|An aggregate association to one or more components which make up the list.
289 289  |//Component//|(((
290 290  Inherits from:
317 +
291 291  //IdentifiableArtefact//
319 +
292 292  Sub classes are:
321 +
293 293  Measure
294 -//AttributeComponent
295 -DimensionComponent//
323 +
324 +//AttributeComponent//
325 +
326 +//DimensionComponent//
296 296  )))|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.
297 297  | |conceptIdentity|Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component.
298 298  | |localRepresentation|(((
... ... @@ -311,55 +311,59 @@
311 311  
312 312  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.
313 313  
314 -==== 3.6.3.3 Representation Constructs ====
345 +3.6.3.3 Representation Constructs
315 315  
316 316  The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms:
317 317  
318 -|(% style="width:198px" %)(((
319 -**SDMX Facet Value Type**
320 -)))|(% style="width:204px" %)**XML Schema Data Type**|(% style="width:209px" %)**JSON Schema Data Type**|(% style="width:187px" %)(((
321 -**.NET Framework Type**
322 -)))|(% style="width:817px" %)**Java Data Type**
323 -|(% style="width:198px" %)String|(% style="width:204px" %)xsd:string|(% style="width:209px" %)string|(% style="width:187px" %)System.String|(% style="width:817px" %)java.lang.String
324 -|(% 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
325 -|(% style="width:198px" %)Integer|(% style="width:204px" %)xsd:int|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int32|(% style="width:817px" %)int
326 -|(% style="width:198px" %)Long|(% style="width:204px" %)xsd.long|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int64|(% style="width:817px" %)long
327 -|(% style="width:198px" %)Short|(% style="width:204px" %)xsd:short|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int16|(% style="width:817px" %)short
328 -|(% style="width:198px" %)Decimal|(% style="width:204px" %)xsd:decimal|(% style="width:209px" %)number|(% style="width:187px" %)System.Decimal|(% style="width:817px" %)java.math.BigDecimal
329 -|(% style="width:198px" %)Float|(% style="width:204px" %)xsd:float|(% style="width:209px" %)number|(% style="width:187px" %)System.Single|(% style="width:817px" %)float
330 -|(% style="width:198px" %)Double|(% style="width:204px" %)xsd:double|(% style="width:209px" %)number|(% style="width:187px" %)System.Double|(% style="width:817px" %)double
331 -|(% style="width:198px" %)Boolean|(% style="width:204px" %)xsd:boolean|(% style="width:209px" %)boolean|(% style="width:187px" %)System.Boolean|(% style="width:817px" %)boolean
332 -|(% 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
333 -|(% 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
334 -|(% 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
335 -|(% 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
336 -|(% 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
337 -|(% 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
338 -|(% 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
339 -|(% 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
349 +|(((
350 +**SDMX Facet**
340 340  
352 +**Value Type**
353 +)))|**XML Schema Data Type**|**JSON Schema Data Type**|(((
354 +**.NET Framework**
355 +
356 +**Type**
357 +)))|**Java Data Type**
358 +|String|xsd:string|string|System.String|java.lang.String
359 +|Big Integer|xsd:integer|integer|System.Decimal|java.math.BigInteger
360 +|Integer|xsd:int|integer|System.Int32|int
361 +|Long|xsd.long|integer|System.Int64|long
362 +|Short|xsd:short|integer|System.Int16|short
363 +|Decimal|xsd:decimal|number|System.Decimal|java.math.BigDecimal
364 +|Float|xsd:float|number|System.Single|float
365 +|Double|xsd:double|number|System.Double|double
366 +|Boolean|xsd:boolean|boolean|System.Boolean|boolean
367 +|URI|xsd:anyURI|string:uri|System.Uri|Java.net.URI or java.lang.String
368 +|DateTime|xsd:dateTime|string:datetime|System.DateTime|javax.xml.datatype.XML GregorianCalendar
369 +|Time|xsd:time|string:time|System.DateTime|javax.xml.datatype.XML GregorianCalendar
370 +|GregorianYear|xsd:gYear|string[[(% class="wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar
371 +|GregorianMonth|xsd:gYearMonth|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
372 +|GregorianDay|xsd:date|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
373 +|Day, MonthDay, Month|xsd:g*|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar
374 +|Duration|xsd:duration|string|System.TimeSpan|javax.xml.datatype.Dur ation
375 +
341 341  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.
342 342  
343 343  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.
344 344  
345 -(% style="width:981.835px" %)
346 -|(% style="width:107px" %)**Facet Type**|(% style="width:872px" %)**Explanation**
347 -|(% 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.
348 -|(% 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.
349 -|(% 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.
350 -|(% 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.
351 -|(% 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.
352 -|(% 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.
353 -|(% 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.
354 -|(% style="width:107px" %)minLength|(% style="width:872px" %)The minLength facet specifies the minimum and length of the value in characters.
355 -|(% style="width:107px" %)maxLength|(% style="width:872px" %)The maxLength facet specifies the maximum length of the value in characters.
356 -|(% 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.
357 -|(% 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.
358 -|(% style="width:107px" %)Decimals|(% style="width:872px" %)The decimals facet indicates the number of characters allowed after the decimal separator.
359 -|(% style="width:107px" %)pattern|(% style="width:872px" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).
360 360  
381 +|**Facet Type**|**Explanation**
382 +|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.
383 +|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.
384 +|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.
385 +|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.
386 +|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.
387 +|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.
388 +|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.
389 +|minLength|The minLength facet specifies the minimum and length of the value in characters.
390 +|maxLength|The maxLength facet specifies the maximum length of the value in characters.
391 +|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.
392 +|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.
393 +|Decimals|The decimals facet indicates the number of characters allowed after the decimal separator.
394 +|pattern|The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).
361 361  
362 362  
397 +
363 363  ----
364 364  
365 365  [[~[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.