Changes for page 3 SDMX Base Package
Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -12,17 +12,17 @@ 12 12 13 13 Each of the class diagrams in this section views classes from the SDMX Base package from a different perspective. There are detailed views of specific patterns, plus overviews showing inheritance between classes, and relationships amongst classes. 14 14 15 -== 3.2 Base Structures - Identification, Versioning, and Maintenance == 15 +=== 3.2 Base Structures - Identification, Versioning, and Maintenance === 16 16 17 -=== 3.2.1 Class Diagram === 17 +==== 3.2.1 Class Diagram ==== 18 18 19 19 [[image:1749246130522-547.jpeg]] 20 20 21 21 **Figure 10: SDMX Identification, Maintenance and Versioning** 22 22 23 -=== 3.2.2 Explanation of the Diagram === 23 +===== 3.2.2 Explanation of the Diagram ===== 24 24 25 -==== 3.2.2.1 Narrative ==== 25 +====== 3.2.2.1 Narrative ====== 26 26 27 27 This group of classes forms the nucleus of the administration facets of SDMX objects. They provide features which are reusable by derived classes to support horizontal functionality such as identity, versioning etc. 28 28 ... ... @@ -38,87 +38,99 @@ 38 38 39 39 The inheritance chain from //AnnotableArtefact// through to //MaintainableArtefact// allows SDMX classes to inherit the features they need, from simple annotation, through identity, naming, to versioning and maintenance. 40 40 41 -==== 3.2.2.2 Definitions ==== 41 +====== 3.2.2.2 Definitions ====== 42 42 43 -(% style="width:973.835px" %) 44 -|**Class**|(% style="width:262px" %)**Feature**|(% style="width:543px" %)**Description** 45 -|//AnnotableArtefact//|(% style="width:262px" %)((( 43 +|**Class**|**Feature**|**Description** 44 +|//AnnotableArtefact//|((( 46 46 Base inheritance sub classes are: 46 + 47 47 //IdentifiableArtefact// 48 -)))|(% style="width:543px" %)Objects of classes derived from this can have attached annotations. 49 -|Annotation|(% style="width:262px" %)// //|(% style="width:543px" %)Additional descriptive information attached to an object. 50 -| |(% style="width:262px" %)id|(% style="width:543px" %)Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object. 51 -| |(% style="width:262px" %)title|(% style="width:543px" %)A title used to identify an annotation. 52 -| |(% style="width:262px" %)type|(% style="width:543px" %)Specifies how the annotation is to be processed. 53 -| |(% style="width:262px" %)url|(% style="width:543px" %)A link to external descriptive text. 54 -| |(% style="width:262px" %)value|(% style="width:543px" %)A non-localised version of the Annotation content. 55 -| |(% style="width:262px" %)+url|(% style="width:543px" %)An International URI provides a set of links that are language specific, via this role. 56 -| |(% style="width:262px" %)+text|(% style="width:543px" %)An International String provides the multilingual text content of the annotation via this role. 57 -|InternationalUri|(% style="width:262px" %) |(% style="width:543px" %)The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales. 58 -|LocalisedUri|(% style="width:262px" %) |(% style="width:543px" %)The Localised URI supports the link to an external description in one locale (locale is similar to language but includes geographic variations such as Canadian French, US English etc.). 59 -|//IdentifiableArtefact//|(% style="width:262px" %)((( 60 -Superclass is //AnnotableArtefact// 48 +)))|Objects of classes derived from this can have attached annotations. 49 +|Annotation|// //|Additional descriptive information attached to an object. 50 +| |id|Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object. 51 +| |title|A title used to identify an annotation. 52 +| |type|Specifies how the annotation is to be processed. 53 +| |url|A link to external descriptive text. 54 +| |value|A non-localised version of the Annotation content. 55 +| |+url|An International URI provides a set of links that are language specific, via this role. 56 +| |+text|An International String provides the multilingual text content of the annotation via this role. 57 +|InternationalUri| |The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales. 58 +|LocalisedUri| |The Localised URI supports the link to an external description in one locale (locale is similar to language but includes geographic variations such as Canadian French, US English etc.). 59 +|//IdentifiableArtefact//|((( 60 +Superclass is 61 + 62 +//AnnotableArtefact// 63 + 61 61 Base inheritance sub classes are: 65 + 62 62 //NameableArtefact// 63 -)))|(% style="width:543px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact. 64 -| |(% style="width:262px" %)id|(% style="width:543px" %)The unique identifier of the object. 65 -| |(% style="width:262px" %)uri|(% style="width:543px" %)Universal resource identifier that may or may not be resolvable. 66 -| |(% style="width:262px" %)urn|(% style="width:543px" %)Universal resource name – this is for use in registries: all registered objects have a urn. 67 -|//NameableArtefact//|(% style="width:262px" %)((( 68 -Superclass is //IdentifiableArtefact// Base inheritance sub classes are: 67 +)))|Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact. 68 +| |id|The unique identifier of the object. 69 +| |uri|Universal resource identifier that may or may not be resolvable. 70 +| |urn|Universal resource name – this is for use in registries: all registered objects have a urn. 71 +|//NameableArtefact//|((( 72 +Superclass is 73 + 74 +//IdentifiableArtefact// Base inheritance sub classes are: 75 + 69 69 //VersionableArtefact// 70 -)))| (% style="width:543px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.71 -| | (% style="width:262px" %)+description|(% style="width:543px" %)A multi-lingual description is provided by this role via the International String class.72 -| | (% style="width:262px" %)+name|(% style="width:543px" %)A multi-lingual name is provided by this role via the International String class73 -|InternationalString| (%style="width:262px" %)|(% style="width:543px" %)The International String is a collection of Localised Strings and supports the representation of text in multiple locales.74 -|LocalisedString| (%style="width:262px" %)|(% style="width:543px" %)The Localised String supports the representation of text in one locale (locale is similar to language but includes geographic variations such as Canadian French, US English etc.).75 -| | (% style="width:262px" %)label|(% style="width:543px" %)Label of the string.76 -| | (% style="width:262px" %)locale|(% style="width:543px" %)The geographic locale of the string e.g French, Canadian French.77 -|//VersionableArtefact//|( % style="width:262px" %)(((77 +)))|Provides a Name and Description to all derived classes in addition to identification and annotations. 78 +| |+description|A multi-lingual description is provided by this role via the International String class. 79 +| |+name|A multi-lingual name is provided by this role via the International String class 80 +|InternationalString| |The International String is a collection of Localised Strings and supports the representation of text in multiple locales. 81 +|LocalisedString| |The Localised String supports the representation of text in one locale (locale is similar to language but includes geographic variations such as Canadian French, US English etc.). 82 +| |label|Label of the string. 83 +| |locale|The geographic locale of the string e.g French, Canadian French. 84 +|//VersionableArtefact//|((( 78 78 Superclass is 86 + 79 79 //NameableArtefact// 88 + 80 80 Base inheritance sub classes are: 90 + 81 81 //MaintainableArtefact// 82 -)))| (% style="width:543px" %)Provides versioning information for all derived objects.83 -| | (% style="width:262px" %)version|(% style="width:543px" %)A version string following SDMX versioning rules.84 -| | (% style="width:262px" %)validFrom|(% style="width:543px" %)Date from which the version is valid85 -| | (% style="width:262px" %)validTo|(% style="width:543px" %)Date from which version is superseded86 -|//MaintainableArtefact//|( % style="width:262px" %)(((92 +)))|Provides versioning information for all derived objects. 93 +| |version|A version string following SDMX versioning rules. 94 +| |validFrom|Date from which the version is valid 95 +| |validTo|Date from which version is superseded 96 +|//MaintainableArtefact//|((( 87 87 Inherits from 88 88 89 89 //VersionableArtefact// 90 -)))| (% style="width:543px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.91 -| | (% style="width:262px" %)isExternalReference|(% style="width:543px" %)If set to “true” it indicates that the content of the object is held externally.92 -| | (%style="width:262px" %)structureURL|(% style="width:543px" %)The URL of an SDMX-ML document containing the external object.93 -| | (%style="width:262px" %)serviceURL|(% style="width:543px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved.94 -| | (% style="width:262px" %)+maintainer|(% style="width:543px" %)Association to the Maintenance Agency responsible for maintaining the artefact.95 -|Agency| (%style="width:262px" %)|(% style="width:543px" %)See section on “Organisations”100 +)))|An abstract class to group together primary structural metadata artefacts that are maintained by an Agency. 101 +| |isExternalReference|If set to “true” it indicates that the content of the object is held externally. 102 +| |structureURL|The URL of an SDMX-ML document containing the external object. 103 +| |serviceURL|The URL of an SDMX-compliant web service from which the external object can be retrieved. 104 +| |+maintainer|Association to the Maintenance Agency responsible for maintaining the artefact. 105 +|Agency| |See section on “Organisations” 96 96 97 -== 3.3 Basic Inheritance == 98 98 99 -=== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes === 100 100 109 +==== //3.3 Basic Inheritance// ==== 110 + 111 +===== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes ===== 112 + 101 101 [[image:1749246130530-261.jpeg]] 102 102 103 103 **Figure 11: Basic Inheritance from the Base Structures** 104 104 105 -=== 3.3.2 Explanation of the Diagram === 117 +===== 3.3.2 Explanation of the Diagram ===== 106 106 107 -==== 3.3.2.1 Narrative ==== 119 +====== 3.3.2.1 Narrative ====== 108 108 109 109 The diagram above shows the inheritance within the base structures. The concrete classes are introduced and defined in the specific package to which they relate. 110 110 111 -== 3.4 Data Types == 123 +=== 3.4 Data Types === 112 112 113 -=== 3.4.1 Class Diagram === 125 +==== 3.4.1 Class Diagram ==== 114 114 115 115 [[image:1749246130536-128.jpeg]] 116 116 117 117 **Figure 12: Class Diagram of Basic Data Types** 118 118 119 -=== 3.4.2 Explanation of the Diagram === 131 +===== 3.4.2 Explanation of the Diagram ===== 120 120 121 -==== 3.4.2.1 Narrative ==== 133 +====== 3.4.2.1 Narrative ====== 122 122 123 123 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). 124 124 ... ... @@ -139,23 +139,23 @@ 139 139 140 140 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”. 141 141 142 -== 3.5 The Item Scheme Pattern == 154 +==== //3.5 The Item Scheme Pattern// ==== 143 143 144 -=== 3.5.1 Context === 156 +===== 3.5.1 Context ===== 145 145 146 146 The Item Scheme is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example. 147 147 148 148 The //ItemScheme// is the basis for CategoryScheme, Codelist, ConceptScheme, ReportingTaxonomy, //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme. 149 149 150 -=== 3.5.2 Class Diagram === 162 +===== 3.5.2 Class Diagram ===== 151 151 152 152 [[image:1749246130543-644.jpeg]] 153 153 154 154 **Figure 13 The Item Scheme pattern** 155 155 156 -=== 3.5.3 Explanation of the Diagram === 168 +===== 3.5.3 Explanation of the Diagram ===== 157 157 158 -==== 3.5.3.1 Narrative ==== 170 +====== 3.5.3.1 Narrative ====== 159 159 160 160 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. 161 161 ... ... @@ -169,57 +169,76 @@ 169 169 170 170 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//. 171 171 172 -==== 3.5.3.2 Definitions ==== 184 +====== 3.5.3.2 Definitions ====== 173 173 174 -(% style="width:989.835px" %) 175 -|**Class**|(% style="width:297px" %)**Feature**|(% style="width:583px" %)**Description** 176 -|//ItemScheme//|(% style="width:297px" %)((( 186 +|**Class**|**Feature**|**Description** 187 +|//ItemScheme//|((( 177 177 Inherits from: 189 + 178 178 //MaintainableArtefact// 191 + 179 179 Direct sub classes are: 193 + 180 180 CategoryScheme 195 + 181 181 ConceptScheme 197 + 182 182 Codelist 199 + 183 183 ReportingTaxonomy 201 + 184 184 //OrganisationScheme// 203 + 185 185 TransformationScheme 205 + 186 186 CustomTypeScheme NamePersonalisationSc heme 207 + 187 187 RulesetScheme 188 - VtlMappingScheme189 -UserDefinedOperatorSc heme 190 -)))| (% style="width:583px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.191 -| | (% 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.192 -| | (% style="width:297px" %)/items|(% style="width:583px" %)Association to the Items in the scheme.193 -|//Item//|( % style="width:297px" %)(((209 + 210 +VtlMappingScheme UserDefinedOperatorSc heme 211 +)))|The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common. 212 +| |isPartial|Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme. 213 +| |/items|Association to the Items in the scheme. 214 +|//Item//|((( 194 194 Inherits from: 216 + 195 195 //NameableArtefact// 218 + 196 196 Direct sub classes are 220 + 197 197 Category 222 + 198 198 Concept 224 + 199 199 Code 226 + 200 200 ReportingCategory //Organisation// 228 + 201 201 Transformation 230 + 202 202 CustomType 232 + 203 203 NamePersonalisation 234 + 204 204 Ruleset 236 + 205 205 VtlMapping 238 + 206 206 UserDefinedOperator// //hierarchy 207 -)))|( % style="width:583px" %)(((240 +)))|((( 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. 242 + 209 209 This allows an Item optionally to have one or more child Items 210 210 ))) 211 211 212 -== 3.6 The Structure Pattern == 246 +==== //3.6 The Structure Pattern// ==== 213 213 214 -=== 3.6.1 Context === 248 +===== 3.6.1 Context ===== 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 === 252 +===== 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 === 260 +====== 3.6.3 Explanation of the Diagrams ====== 230 230 231 - ====3.6.3.1 Narrative====262 +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 ... ... @@ -262,7 +262,7 @@ 262 262 263 263 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). 264 264 265 - ====3.6.3.2 Definitions====296 +3.6.3.2 Definitions 266 266 267 267 |**Class**|**Feature**|**Description** 268 268 |StructureUsage|((( ... ... @@ -333,55 +333,59 @@ 333 333 334 334 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. 335 335 336 - ====3.6.3.3 Representation Constructs====367 +3.6.3.3 Representation Constructs 337 337 338 338 The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms: 339 339 340 -|(% style="width:188px" %)((( 341 -**SDMX Facet Value Type** 342 -)))|(% style="width:203px" %)**XML Schema Data Type**|(% style="width:207px" %)**JSON Schema Data Type**|(% style="width:184px" %)((( 343 -**.NET Framework Type** 344 -)))|(% style="width:833px" %)**Java Data Type** 345 -|(% style="width:188px" %)String|(% style="width:203px" %)xsd:string|(% style="width:207px" %)string|(% style="width:184px" %)System.String|(% style="width:833px" %)java.lang.String 346 -|(% style="width:188px" %)Big Integer|(% style="width:203px" %)xsd:integer|(% style="width:207px" %)integer|(% style="width:184px" %)System.Decimal|(% style="width:833px" %)java.math.BigInteger 347 -|(% style="width:188px" %)Integer|(% style="width:203px" %)xsd:int|(% style="width:207px" %)integer|(% style="width:184px" %)System.Int32|(% style="width:833px" %)int 348 -|(% style="width:188px" %)Long|(% style="width:203px" %)xsd.long|(% style="width:207px" %)integer|(% style="width:184px" %)System.Int64|(% style="width:833px" %)long 349 -|(% style="width:188px" %)Short|(% style="width:203px" %)xsd:short|(% style="width:207px" %)integer|(% style="width:184px" %)System.Int16|(% style="width:833px" %)short 350 -|(% style="width:188px" %)Decimal|(% style="width:203px" %)xsd:decimal|(% style="width:207px" %)number|(% style="width:184px" %)System.Decimal|(% style="width:833px" %)java.math.BigDecimal 351 -|(% style="width:188px" %)Float|(% style="width:203px" %)xsd:float|(% style="width:207px" %)number|(% style="width:184px" %)System.Single|(% style="width:833px" %)float 352 -|(% style="width:188px" %)Double|(% style="width:203px" %)xsd:double|(% style="width:207px" %)number|(% style="width:184px" %)System.Double|(% style="width:833px" %)double 353 -|(% style="width:188px" %)Boolean|(% style="width:203px" %)xsd:boolean|(% style="width:207px" %)boolean|(% style="width:184px" %)System.Boolean|(% style="width:833px" %)boolean 354 -|(% style="width:188px" %)URI|(% style="width:203px" %)xsd:anyURI|(% style="width:207px" %)string:uri|(% style="width:184px" %)System.Uri|(% style="width:833px" %)Java.net.URI or java.lang.String 355 -|(% style="width:188px" %)DateTime|(% style="width:203px" %)xsd:dateTime|(% style="width:207px" %)string:datetime|(% style="width:184px" %)System.DateTime|(% style="width:833px" %)javax.xml.datatype.XML GregorianCalendar 356 -|(% style="width:188px" %)Time|(% style="width:203px" %)xsd:time|(% style="width:207px" %)string:time|(% style="width:184px" %)System.DateTime|(% style="width:833px" %)javax.xml.datatype.XML GregorianCalendar 357 -|(% style="width:188px" %)GregorianYear|(% style="width:203px" %)xsd:gYear|(% style="width:207px" %)string[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|(% style="width:184px" %)System.DateTime|(% style="width:833px" %)javax.xml.datatype.XML GregorianCalendar 358 -|(% style="width:188px" %)GregorianMonth|(% style="width:203px" %)xsd:gYearMonth|(% style="width:207px" %)string|(% style="width:184px" %)System.DateTime|(% style="width:833px" %)javax.xml.datatype.XML GregorianCalendar 359 -|(% style="width:188px" %)GregorianDay|(% style="width:203px" %)xsd:date|(% style="width:207px" %)string|(% style="width:184px" %)System.DateTime|(% style="width:833px" %)javax.xml.datatype.XML GregorianCalendar 360 -|(% style="width:188px" %)Day, MonthDay, Month|(% style="width:203px" %)xsd:g*|(% style="width:207px" %)string|(% style="width:184px" %)System.DateTime|(% style="width:833px" %)javax.xml.datatype.XML GregorianCalendar 361 -|(% style="width:188px" %)Duration|(% style="width:203px" %)xsd:duration|(% style="width:207px" %)string|(% style="width:184px" %)System.TimeSpan|(% style="width:833px" %)javax.xml.datatype.Dur ation 371 +|((( 372 +**SDMX Facet** 362 362 374 +**Value Type** 375 +)))|**XML Schema Data Type**|**JSON Schema Data Type**|((( 376 +**.NET Framework** 377 + 378 +**Type** 379 +)))|**Java Data Type** 380 +|String|xsd:string|string|System.String|java.lang.String 381 +|Big Integer|xsd:integer|integer|System.Decimal|java.math.BigInteger 382 +|Integer|xsd:int|integer|System.Int32|int 383 +|Long|xsd.long|integer|System.Int64|long 384 +|Short|xsd:short|integer|System.Int16|short 385 +|Decimal|xsd:decimal|number|System.Decimal|java.math.BigDecimal 386 +|Float|xsd:float|number|System.Single|float 387 +|Double|xsd:double|number|System.Double|double 388 +|Boolean|xsd:boolean|boolean|System.Boolean|boolean 389 +|URI|xsd:anyURI|string:uri|System.Uri|Java.net.URI or java.lang.String 390 +|DateTime|xsd:dateTime|string:datetime|System.DateTime|javax.xml.datatype.XML GregorianCalendar 391 +|Time|xsd:time|string:time|System.DateTime|javax.xml.datatype.XML GregorianCalendar 392 +|GregorianYear|xsd:gYear|string[[(% class="wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]|System.DateTime|javax.xml.datatype.XML GregorianCalendar 393 +|GregorianMonth|xsd:gYearMonth|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar 394 +|GregorianDay|xsd:date|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar 395 +|Day, MonthDay, Month|xsd:g*|string|System.DateTime|javax.xml.datatype.XML GregorianCalendar 396 +|Duration|xsd:duration|string|System.TimeSpan|javax.xml.datatype.Dur ation 397 + 363 363 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. 364 364 365 365 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. 366 366 367 -(% style="width:981.835px" %) 368 -|(% style="width:107px" %)**Facet Type**|(% style="width:872px" %)**Explanation** 369 -|(% 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. 370 -|(% 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. 371 -|(% 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. 372 -|(% 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. 373 -|(% 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. 374 -|(% 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. 375 -|(% 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. 376 -|(% style="width:107px" %)minLength|(% style="width:872px" %)The minLength facet specifies the minimum and length of the value in characters. 377 -|(% style="width:107px" %)maxLength|(% style="width:872px" %)The maxLength facet specifies the maximum length of the value in characters. 378 -|(% 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. 379 -|(% 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. 380 -|(% style="width:107px" %)Decimals|(% style="width:872px" %)The decimals facet indicates the number of characters allowed after the decimal separator. 381 -|(% style="width:107px" %)pattern|(% style="width:872px" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema). 382 382 403 +|**Facet Type**|**Explanation** 404 +|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. 405 +|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. 406 +|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. 407 +|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. 408 +|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. 409 +|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. 410 +|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. 411 +|minLength|The minLength facet specifies the minimum and length of the value in characters. 412 +|maxLength|The maxLength facet specifies the maximum length of the value in characters. 413 +|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. 414 +|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. 415 +|Decimals|The decimals facet indicates the number of characters allowed after the decimal separator. 416 +|pattern|The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema). 383 383 384 384 419 + 385 385 ---- 386 386 387 387 [[~[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.