Changes for page Part IV. Data and Reference Metadata Namespaces
Last modified by Elena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -379,45 +379,45 @@ 379 379 380 380 **Schema:** Refers to the format specific schema in general, and in particular the root xs:schema element of that schema file. 381 381 382 -**Global Element:** Refers to an element definition at the top (% style="color:#e74c3c" %)level(%%)of the schema (i.e. an xs:element element in the root xs:schema element). It will define a name and type (name and type[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and possibly a substitution group (substitutionGroup[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).382 +**Global Element:** Refers to an element definition at the top level of the schema (i.e. an xs:element element in the root xs:schema element). It will define a name and type (name and type attributes) and possibly a substitution group (substitutionGroup attribute). 383 383 384 -**Local Element:** Refers to an element definition within a complex type (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). A local element must define a name and type (name and type [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).384 +**Local Element:** Refers to an element definition within a complex type (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). A local element must define a name and type (name and type attributes) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute). 385 385 386 386 **Qualified/Unqualified Element:** A qualified element is an element that must be referred to by the namespace in which it was defined. An unqualified element does not have a namespace associated with it. The structure-specific schemas make use of unqualified elements to that the structure-specific schemas can restrict the base content to meet the specific needs of the structure, while maintaining as much of the original document structure as possible. 387 387 388 -**Element Reference:** Refers to an element definition within a complex type that is a reference to a global element (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). An element reference must reference a global element (via its ref [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).388 +**Element Reference:** Refers to an element definition within a complex type that is a reference to a global element (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). An element reference must reference a global element (via its ref attribute) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute). 389 389 390 -**Complex Type:** Refers to a complex type definition. In this context, all complex type definitions occur at the top (% style="color:#e74c3c" %)level(%%)of the schema (i.e. an xs:complexType element in the root xs:schema element). A complex type must define a name (name[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and may be made abstract (via the abstract[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]’s boolean value).390 +**Complex Type:** Refers to a complex type definition. In this context, all complex type definitions occur at the top level of the schema (i.e. an xs:complexType element in the root xs:schema element). A complex type must define a name (name attribute) and may be made abstract (via the abstract attribute’s boolean value). 391 391 392 -**Simple Type:** Refers to a simple type definition. In this context, all simple type definitions occur at the top (% style="color:#e74c3c" %)level(%%)of the schema (i.e. an xs:simpleType element in the root xs:schema element). In this context, a simple type will always be defined via a restriction (an xs:restriction element in the xs:simpleType element). The restriction will reference a base type.392 +**Simple Type:** Refers to a simple type definition. In this context, all simple type definitions occur at the top level of the schema (i.e. an xs:simpleType element in the root xs:schema element). In this context, a simple type will always be defined via a restriction (an xs:restriction element in the xs:simpleType element). The restriction will reference a base type. 393 393 394 394 **Anonymous Type:** A complex or simple type definition which occurs within an element definition. The method is sometimes referred to a the "Russian-doll" technique as it creates nested constructs. Anonymous types are not given names and cannot be abstract. The can however, be derived from other types. 395 395 396 396 **Content Group:** A group which defines a content model for reuse. This is contained in the xs:group element and is defined at the root of the schema. It allows for a common sequence or choice of elements to be reused across multiple types without having to redefine the sequence or choice in each type. 397 397 398 -**Uniqueness (% style="color:#e74c3c" %)Constraint(%%):** A uniqueness(% style="color:#e74c3c" %)constraint(%%)is defined within an element and is used to force descendent elements to be unique based on some criteria of it fields (elements or[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). This is defined in an \<xs:unique\> element and has content of an \<xs:selector\> and multiple \<xs:field\> elements. The selector designates the descendants that must be unique (with an xpath[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and the field specifies which property of the selected element must be unique (also with an xpath[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]])398 +**Uniqueness Constraint:** A uniqueness constraint is defined within an element and is used to force descendent elements to be unique based on some criteria of it fields (elements or attributes). This is defined in an \<xs:unique\> element and has content of an \<xs:selector\> and multiple \<xs:field\> elements. The selector designates the descendants that must be unique (with an xpath attribute) and the field specifies which property of the selected element must be unique (also with an xpath attribute) 399 399 400 -**Extension:** Refers to the definition of a complex type that is an extension of another complex type. The extension will always make a reference to a base. In the schema, this is defined within the xs:complexType element as a child xs:complexContent element containing an xs:extension element (with a base [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).400 +**Extension:** Refers to the definition of a complex type that is an extension of another complex type. The extension will always make a reference to a base. In the schema, this is defined within the xs:complexType element as a child xs:complexContent element containing an xs:extension element (with a base attribute). 401 401 402 -**Restriction:** Refers to the definition of a simple or complex type that is a restriction of another type of the same variety. The restriction will always make a reference to a base. In the schema, this is defined with an xs:restriction element (with a base [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).402 +**Restriction:** Refers to the definition of a simple or complex type that is a restriction of another type of the same variety. The restriction will always make a reference to a base. In the schema, this is defined with an xs:restriction element (with a base attribute). 403 403 404 -**Sequence:** Refers to a sequence of elements that may be defined as the root of a complex type content model, or as part of the content of a choice or another sequence. This is defined as an xs:sequence element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).404 +**Sequence:** Refers to a sequence of elements that may be defined as the root of a complex type content model, or as part of the content of a choice or another sequence. This is defined as an xs:sequence element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute). 405 405 406 -**Choice:** Refers to a choice of elements that may be defined as the root of a complex type content model, or as part of the content of a sequence or another choice. This is defined as an xs:choice element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).406 +**Choice:** Refers to a choice of elements that may be defined as the root of a complex type content model, or as part of the content of a sequence or another choice. This is defined as an xs:choice element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute). 407 407 408 -** [[Facet>>doc:sdmx:Glossary.Facet.WebHome]]:** Refers to a single detail of a simple type restriction. This is represented by elements such as xs:minInclusive, xs:totalDigits, xs:minLength, and is contained in the xs:restriction element of a simple type definition. The value of the[[facet>>doc:sdmx:Glossary.Facet.WebHome]]is contained in a value[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]of the particular element.408 +**Facet:** Refers to a single detail of a simple type restriction. This is represented by elements such as xs:minInclusive, xs:totalDigits, xs:minLength, and is contained in the xs:restriction element of a simple type definition. The value of the facet is contained in a value attribute of the particular element. 409 409 410 -**Enumeration:** Refers to an enumerated value of a simple type definition. It is represented by an xs:enumeration element contained within an xs:restriction element of a simple type definition. An enumeration defines a value (in the value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and documentation (in xs:documentation elements contained in an xs:[[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]element).410 +**Enumeration:** Refers to an enumerated value of a simple type definition. It is represented by an xs:enumeration element contained within an xs:restriction element of a simple type definition. An enumeration defines a value (in the value attribute) and documentation (in xs:documentation elements contained in an xs:annotation element). 411 411 412 -**XML [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]:** Refers to the definition of an XML[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for a complex type (i.e. and xs:[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]element in a xs:complexType element). An[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]must define a name and type (name and type[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a usage (use[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).412 +**XML Attribute:** Refers to the definition of an XML attribute for a complex type (i.e. and xs:attribute element in a xs:complexType element). An attribute must define a name and type (name and type attributes) and may also specify a usage (use attribute). 413 413 414 414 == 3.2 Namespace Rules == 415 415 416 -Each format specific schema will specify its namespace in the target namespace of the schema (the targetNamespace [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]of the schema). This document also assumes that the root namespace (that which is defined by the xmlns[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) of the schema will be the same as the target namespace. Therefore, any types or global elements referenced in these descriptions without a namespace prefix are assumed to be in the format specific namespace.416 +Each format specific schema will specify its namespace in the target namespace of the schema (the targetNamespace attribute of the schema). This document also assumes that the root namespace (that which is defined by the xmlns attribute) of the schema will be the same as the target namespace. Therefore, any types or global elements referenced in these descriptions without a namespace prefix are assumed to be in the format specific namespace. 417 417 418 418 The format specific schemas will incorporate the core format namespace and the common namespace by importing the schemas (via the xs:import element). If necessary, additional namespaces may be imported and referenced. 419 419 420 -For the purpose of the descriptions here, the default element form for the schema (as specified in the elementFormDefault [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]of the schema) is "qualified", and the default[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]form (as specified in the attributeFormDefault[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]of the schema) is "unqualified".420 +For the purpose of the descriptions here, the default element form for the schema (as specified in the elementFormDefault attribute of the schema) is "qualified", and the default attribute form (as specified in the attributeFormDefault attribute of the schema) is "unqualified". 421 421 422 422 == 3.3 General Rules == 423 423 ... ... @@ -425,56 +425,57 @@ 425 425 426 426 === 3.3.1 Component Name Determination === 427 427 428 -When required to create an XML element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], the name for a[[component>>doc:sdmx:Glossary.Component.WebHome]]is always its identifier. However, the identifier may be inherited. Therefore, the general rules are as follows:428 +When required to create an XML element or attribute, the name for a component is always its identifier. However, the identifier may be inherited. Therefore, the general rules are as follows: 429 429 430 -1. If the [[component>>doc:sdmx:Glossary.Component.WebHome]]defines an identifier, the element or[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]name is the value of that identifier431 -2. Otherwise, the element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]name is the identifier of the(% style="color:#e74c3c" %)concept(%%)from which it takes its semantic (Note that this is technically the[[component>>doc:sdmx:Glossary.Component.WebHome]]identifier).430 +1. If the component defines an identifier, the element or attribute name is the value of that identifier 431 +2. Otherwise, the element or attribute name is the identifier of the concept from which it takes its semantic (Note that this is technically the component identifier). 432 432 433 433 === 3.3.2 Representation Determination === 434 434 435 -Every [[component>>doc:sdmx:Glossary.Component.WebHome]]has a[[representation>>doc:sdmx:Glossary.Representation.WebHome]]associated with it, whether it is defined as a local[[representation>>doc:sdmx:Glossary.Representation.WebHome]]in the[[component>>doc:sdmx:Glossary.Component.WebHome]]definition, or it is inherited from the(% style="color:#e74c3c" %)concept(%%)from which the[[component>>doc:sdmx:Glossary.Component.WebHome]]takes it semantic (as defined in the(% style="color:#e74c3c" %)concept(%%)identity of the[[component>>doc:sdmx:Glossary.Component.WebHome]]).435 +Every component has a representation associated with it, whether it is defined as a local representation in the component definition, or it is inherited from the concept from which the component takes it semantic (as defined in the concept identity of the component). 436 436 437 -The [[representation>>doc:sdmx:Glossary.Representation.WebHome]]of a[[component>>doc:sdmx:Glossary.Component.WebHome]]is determined by the following precedence:437 +The representation of a component is determined by the following precedence: 438 438 439 -1. The local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]defined by the[[component>>doc:sdmx:Glossary.Component.WebHome]]440 -1. The core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]defined in the(% style="color:#e74c3c" %)concept(%%)from which the[[component>>doc:sdmx:Glossary.Component.WebHome]]takes its semantic441 -1. A default [[representation>>doc:sdmx:Glossary.Representation.WebHome]]of an un-faceted text format with a data type of String.439 +1. The local representation defined by the component 440 +1. The core representation defined in the concept from which the component takes its semantic 441 +1. A default representation of an un-faceted text format with a data type of String. 442 442 443 -The [[representation>>doc:sdmx:Glossary.Representation.WebHome]]will either define a text format, an enumeration with an enumeration format, or a union of the former with the value of a irrelevant[[representation>>doc:sdmx:Glossary.Representation.WebHome]]‘’ (tilde).443 +The representation will either define a text format, an enumeration with an enumeration format, or a union of the former with the value of a irrelevant representation ‘’ (tilde). 444 444 445 -A text format consists of a data type and an optional collection of [[facets>>doc:sdmx:Glossary.Facet.WebHome]].It is the combination of these which determine the exact nature of the[[component>>doc:sdmx:Glossary.Component.WebHome]][[representation>>doc:sdmx:Glossary.Representation.WebHome]].An enumeration consists of a reference to a[[codelist>>doc:sdmx:Glossary.Code list.WebHome]],[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], or value list, for which an enumerated list of possible values can be created.445 +A text format consists of a data type and an optional collection of facets. It is the combination of these which determine the exact nature of the component representation. An enumeration consists of a reference to a codelist, hierarchy, or value list, for which an enumerated list of possible values can be created. 446 446 447 447 === 3.3.3 Simple / Primitive Type Determination === 448 448 449 -For any given [[representation>>doc:sdmx:Glossary.Representation.WebHome]], there exist rules for determining the simple or primitive type which should be used to validate the value. There are no specific requirements to how a simple type is named or if it is referenced or used as an anonymous type. This section simply serves to state the requirements of the type for a[[component>>doc:sdmx:Glossary.Component.WebHome]]based on its [determined[[representation>>doc:sdmx:Glossary.Representation.WebHome]]](#332-[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]-Determination).449 +For any given representation, there exist rules for determining the simple or primitive type which should be used to validate the value. There are no specific requirements to how a simple type is named or if it is referenced or used as an anonymous type. This section simply serves to state the requirements of the type for a component based on its [determined representation](#332-Representation-Determination). 450 450 451 -For example, a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]may inherit its[[representation>>doc:sdmx:Glossary.Representation.WebHome]]for a(% style="color:#e74c3c" %)concept(%%), and the data type of a[[representation>>doc:sdmx:Glossary.Representation.WebHome]]data type may be a String. The simplest solution would be to use the xs:string primitive type. However, an implementer may have chosen to generate simple types for all(% style="color:#e74c3c" %)concepts(%%)to avoid having to look up the(% style="color:#e74c3c" %)concept(%%)core[[representation>>doc:sdmx:Glossary.Representation.WebHome]]for very[[component>>doc:sdmx:Glossary.Component.WebHome]].In this case, the type may be given a name based on the(% style="color:#e74c3c" %)concept(%%)and be a simple derivation from the xs:string type that places no further restrictions. The result would be that the type that is actually used for the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], although named after the(% style="color:#e74c3c" %)concept(%%), is effectively the required xs:string. These rules are meant to allow such flexibility in how types are created. The only requirement is that the type meet the requirements stated here.451 +For example, a dimension may inherit its representation for a concept, and the data type of a representation data type may be a String. The simplest solution would be to use the xs:string primitive type. However, an implementer may have chosen to generate simple types for all concepts to avoid having to look up the concept core representation for very component. In this case, the type may be given a name based on the concept and be a simple derivation from the xs:string type that places no further restrictions. The result would be that the type that is actually used for the dimension, although named after the concept, is effectively the required xs:string. These rules are meant to allow such flexibility in how types are created. The only requirement is that the type meet the requirements stated here. 452 452 453 453 === 3.3.4 Representation with Codelist Enumeration === 454 454 455 -A [[representation>>doc:sdmx:Glossary.Representation.WebHome]]which defines an enumeration from a[[codelist>>doc:sdmx:Glossary.Codelist.WebHome]] or[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each[[code>>doc:sdmx:Glossary.Code.WebHome]]in the[[codelist>>doc:sdmx:Glossary.Codelist.WebHome]] or[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], accounting for extensions. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required. Example:455 +A representation which defines an enumeration from a codelist or hierarchy will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each code in the codelist or hierarchy, accounting for extensions. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required. Example: 456 456 457 -> <xs:simpleType name="ESTAT.CL\_COUNTRY.1.0"> 458 -> <xs:restriction base="common:IDType"> 459 -> <xs:enumeration value="BE"> 460 -> <xs:annotation> 461 -> <xs:documentation xml:lang="en">Belgium</xs:documentation> 462 -> </xs:annotation> 463 -> </xs:enumeration> 457 +xml 458 + <xs:simpleType name="ESTAT.CL\_COUNTRY.1.0"> 459 + <xs:restriction base="common:IDType"> 460 + <xs:enumeration value="BE"> 461 + <xs:annotation> 462 + <xs:documentation xml:lang="en">Belgium</xs:documentation> 463 + </xs:annotation> 464 + </xs:enumeration> 464 464 465 465 === 3.3.5 Representation with Value List Enumeration === 466 466 467 -A [[representation>>doc:sdmx:Glossary.Representation.WebHome]]which defines an enumeration from a value list will result in a simple type that is a restriction of the xs:string data type. The simple type will define enumerations for each value item in the value list. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required.468 +A representation which defines an enumeration from a value list will result in a simple type that is a restriction of the xs:string data type. The simple type will define enumerations for each value item in the value list. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required. 468 468 469 469 === 3.3.6 Representation with Simple Text Format === 470 470 471 -A [[representation>>doc:sdmx:Glossary.Representation.WebHome]]which defines a simple text format will result in a simple type or primitive type. The[[representation>>doc:sdmx:Glossary.Representation.WebHome]]is simple if none of the following conditions are true:472 +A representation which defines a simple text format will result in a simple type or primitive type. The representation is simple if none of the following conditions are true: 472 472 473 -* [[representation>>doc:sdmx:Glossary.Representation.WebHome]]max occurs is greater than 1474 +* representation max occurs is greater than 1 474 474 * text format data type is XHMTL 475 475 * text format is multi-lingual 476 476 477 -If the [[representation>>doc:sdmx:Glossary.Representation.WebHome]]is not simple, see the rules in the following section for complex text formats. If the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]is simple, the first step is to determine the base type from the text format data type:478 +If the representation is not simple, see the rules in the following section for complex text formats. If the representation is simple, the first step is to determine the base type from the text format data type: 478 478 479 479 (% style="width:679.294px" %) 480 480 |(% style="width:286px" %)**SDMX Data Type**|(% style="width:390px" %)**XML Schema Data Type** ... ... @@ -520,7 +520,7 @@ 520 520 |(% style="width:286px" %)GeospatialInformation|(% style="width:390px" %)xs:string 521 521 |(% style="width:286px" %)XHTML|(% style="width:390px" %)See the following section for complex representations 522 522 523 -If the text format does not specify any further [[facets>>doc:sdmx:Glossary.Facet.WebHome]], then the determined type is the listed type or a type which derives from the listed type without placing any addition restrictions on it. However, if one or more[[facets>>doc:sdmx:Glossary.Facet.WebHome]]are specified, then a simple type based on the listed type is necessary. The simple type derives via restriction from the listed type and adds[[facets>>doc:sdmx:Glossary.Facet.WebHome]]according to the following table (the values are(% style="color:#e74c3c" %)mapped(%%)as is):524 +If the text format does not specify any further facets, then the determined type is the listed type or a type which derives from the listed type without placing any addition restrictions on it. However, if one or more facets are specified, then a simple type based on the listed type is necessary. The simple type derives via restriction from the listed type and adds facets according to the following table (the values are mapped as is): 524 524 525 525 (% style="width:1007.29px" %) 526 526 |(% style="width:267px" %)**SDMX Facet**|(% style="width:729px" %)**XML Schema Facet**