Skip to Content

Wiki source code of 3 SDMX Base Package

Version 12.1 by Helena on 2025/05/16 13:38
Hide last authors
Helena 10.2 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Helena 2.1 4
5 == 3.1 Introduction ==
6
7 The constructs in the SDMX Base package comprise the fundamental building blocks that support many of the other structures in the model. For this reason, many of the classes in this package are abstract (i.e., only derived sub-classes can exist in an implementation).
8
9 The motivation for establishing the SDMX Base package is as follows:
10
11 it is accepted “Best Practise” to identify fundamental archetypes occurring in a model
12 identification of commonly found structures or “patterns” leads to easier understanding
13 identification of patterns encourages re-use
14
15 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.
16
17 == 3.2 Base Structures - Identification, Versioning, and Maintenance ==
18
19 === 3.2.1 Class Diagram ===
20
21 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_1683f36a.jpg||height="675" width="576"]]
22
23 **Figure 10: SDMX Identification, Maintenance and Versioning**
24
25 === 3.2.2 Explanation of the Diagram ===
26
27 ==== 3.2.2.1 Narrative ====
28
29 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.
30
Helena 10.3 31 All classes derived from the abstract class //AnnotableArtefact// may have Annotations (or notes): this supports the need to add notes to all SDMX-ML elements. The Annotation is used to convey extra information to describe any SDMX construct. This information may be in the form of a URL reference and/or a multilingual text (represented by the association to InternationalString).
Helena 2.1 32
33 The //IdentifiableArtefact// is an abstract class that comprises the basic attributes needed for identification. Concrete classes based on //IdentifiableArtefact// all inherit the ability to be uniquely identified.
34
35 The //NamableArtefact// is an abstract class that inherits from //IdentifiableArtefact //and in addition the +description and +name roles support multilingual descriptions and names for all objects based on //NameableArtefact//. The InternationalString supports the representation of a description in multiple locales (locale is similar to language but includes geographic variations such as Canadian French, US English etc.). The //LocalisedString// supports the representation of a description in one locale.
36
37 //VersionableArtefact// is an abstract class which inherits from //NameableArtefact// and adds versioning ability to all classes derived from it, as explained in the SDMX versioning rules in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”.
38
39 //MaintainableArtefact// further adds the ability for derived classes to be maintained via its association to an //Organisation//, and adds locational information (i.e., from where the object can be retrieved).
40
41 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.
42
43 ==== 3.2.2.2 Definitions ====
44
Helena 10.3 45 (% style="width:914.039px" %)
46 |**Class**|(% style="width:244px" %)**Feature**|(% style="width:514px" %)**Description**
47 |//AnnotableArtefact//|(% style="width:244px" %)(((
Helena 2.1 48 Base inheritance sub classes are:
49
50 //IdentifiableArtefact//
Helena 10.3 51 )))|(% style="width:514px" %)Objects of classes derived from this can have attached annotations.
52 |Annotation|(% style="width:244px" %) |(% style="width:514px" %)Additional descriptive information attached to an object.
53 | |(% style="width:244px" %)id|(% style="width:514px" %)Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.
54 | |(% style="width:244px" %)title|(% style="width:514px" %)A title used to identify an annotation.
55 | |(% style="width:244px" %)type|(% style="width:514px" %)Specifies how the annotation is to be processed.
56 | |(% style="width:244px" %)url|(% style="width:514px" %)A link to external descriptive text.
57 | |(% style="width:244px" %)value|(% style="width:514px" %)A non-localised version of the Annotation content.
58 | |(% style="width:244px" %)+url|(% style="width:514px" %)An International URI provides a set of links that are language specific, via this role.
59 | |(% style="width:244px" %)+text|(% style="width:514px" %)An International String provides the multilingual text content of the annotation via this role.
60 |InternationalUri|(% style="width:244px" %) |(% style="width:514px" %)The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales.
61 |LocalisedUri|(% style="width:244px" %) |(% style="width:514px" %)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.).
62 |//IdentifiableArtefact//|(% style="width:244px" %)(((
Helena 2.1 63 Superclass is
64
65 //AnnotableArtefact//
66
Helena 10.2 67 Base inheritance sub classes are:
Helena 2.1 68
69 //NameableArtefact//
Helena 10.3 70 )))|(% style="width:514px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
71 | |(% style="width:244px" %)id|(% style="width:514px" %)The unique identifier of the object.
72 | |(% style="width:244px" %)uri|(% style="width:514px" %)Universal resource identifier that may or may not be resolvable.
73 | |(% style="width:244px" %)urn|(% style="width:514px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
74 |//NameableArtefact//|(% style="width:244px" %)(((
Helena 2.1 75 Superclass is
76
77 //IdentifiableArtefact// Base inheritance sub classes are:
78
79 //VersionableArtefact//
Helena 10.3 80 )))|(% style="width:514px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.
81 | |(% style="width:244px" %)+description|(% style="width:514px" %)(((
Helena 2.1 82 A multi-lingual description is provided by this role via the
83
84 International String class.
85 )))
Helena 10.3 86 | |(% style="width:244px" %)+name|(% style="width:514px" %)A multi-lingual name is provided by this role via the International String class
87 |InternationalString|(% style="width:244px" %) |(% style="width:514px" %)The International String is a collection of Localised Strings and supports the representation of text in multiple locales.
88 |LocalisedString|(% style="width:244px" %) |(% style="width:514px" %)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.).
89 | |(% style="width:244px" %)label|(% style="width:514px" %)Label of the string.
90 | |(% style="width:244px" %)locale|(% style="width:514px" %)The geographic locale of the string e.g French, Canadian French.
91 |//VersionableArtefact//|(% style="width:244px" %)(((
Helena 2.1 92 Superclass is
93
94 //NameableArtefact//
95
96 Base inheritance sub classes are:
97
98 //MaintainableArtefact//
Helena 10.3 99 )))|(% style="width:514px" %)Provides versioning information for all derived objects.
100 | |(% style="width:244px" %)version|(% style="width:514px" %)A version string following SDMX versioning rules.
101 | |(% style="width:244px" %)validFrom|(% style="width:514px" %)Date from which the version is valid
102 | |(% style="width:244px" %)validTo|(% style="width:514px" %)Date from which version is superseded
103 |//MaintainableArtefact//|(% style="width:244px" %)(((
Helena 2.1 104 Inherits from
105
106 //VersionableArtefact//
Helena 10.3 107 )))|(% style="width:514px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
108 | |(% style="width:244px" %)isExternalReference|(% style="width:514px" %)If set to “true” it indicates that the content of the object is held externally.
109 | |(% style="width:244px" %)structureURL|(% style="width:514px" %)The URL of an SDMX-ML document containing the external object.
110 | |(% style="width:244px" %)serviceURL|(% style="width:514px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved.
111 | |(% style="width:244px" %)+maintainer|(% style="width:514px" %)Association to the Maintenance Agency responsible for maintaining the artefact.
112 |Agency|(% style="width:244px" %) |(% style="width:514px" %)See section on “Organisations”
Helena 2.1 113
114 == 3.3 Basic Inheritance ==
115
116 === 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes ===
117
118 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_b6346072.jpg||height="697" width="622"]]
119
120 **Figure 11: Basic Inheritance from the Base Structures**
121
122 === 3.3.2 Explanation of the Diagram ===
123
124 ==== 3.3.2.1 Narrative ====
125
126 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.
127
128 == 3.4 Data Types ==
129
130 === 3.4.1 Class Diagram ===
131
132 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_ec1b8edc.jpg||height="711" width="540"]]
133
134 **Figure 12: Class Diagram of Basic Data Types**
135
136 === 3.4.2 Explanation of the Diagram ===
137
138 ==== 3.4.2.1 Narrative ====
139
140 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).
141
142 The ActionType enumeration is used to specify the action that a receiving system should take when processing the content that is the object of the action. It is enumerated as follows:
143
144 * Append: Data or metadata is an incremental update for an existing data/metadata set or the provision of new data or documentation (attribute values) formerly absent. If any of the supplied data or metadata is already present, it will not replace that data or metadata. This corresponds to the "Update" value found in version 1.0 of the SDMX Technical Standards.
145 * Replace: Data/metadata is to be replaced and may also include additional data/metadata to be appended.
146 * Delete: Data/Metadata is to be deleted.
147 * Information: Data and metadata are for information purposes.
148
149 The ToValueType data type contains the attributes to support transformations defined in the StructureMap (see Section 0).
150
151 The ConstraintRoleType data type contains the attributes that identify the purpose of a Constraint (allowableContent, actualContent).
152
153 The ComponentRoleType data type contains the predefined Concept roles that can be assigned to any Component.
154
155 The CascadeValues data type contains the possible values for a MemberValue within a CubeRegion, in order to enable cascading to all children Codes of a selected Code, while including/excluding the latter in the selection.
156
157 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”.
158
159 == 3.5 The Item Scheme Pattern ==
160
161 === 3.5.1 Context ===
162
163 The Item Scheme is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example.
164
165 The //ItemScheme// is the basis for CategoryScheme, Codelist, ConceptScheme, ReportingTaxonomy, //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme.
166
167 === 3.5.2 Class Diagram ===
168
169 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_6afb5cc3.jpg||height="570" width="594"]]
170
171 **Figure 13 The Item Scheme pattern**
172
173 === 3.5.3 Explanation of the Diagram ===
174
175 ==== 3.5.3.1 Narrative ====
176
177 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.
178
179 In an exchange environment an //ItemScheme// is allowed to contain a sub-set of the //Item//s in the maintained //ItemScheme//. If such an ItemScheme is disseminated with a sub-set of the //Item//s then the fact that this is a sub-set is denoted by setting the isPartial attribute to "true".
180
Helena 10.3 181 A “partial” //ItemScheme// cannot be maintained independently in its partial form i.e., it cannot contain //Item//s that are not present in the full //ItemScheme// and the content of any one //Item //(e.g., names and descriptions) cannot deviate from the content in the full //ItemScheme//. Furthermore, the id of the //ItemScheme// where isPartial is set to "true" is the same as the id of the full //ItemScheme// (agencyId, id, version). This is important as this is the id that that is referenced in other structures (e.g., a Codelist referenced in a DSD) and this id is always the same, regardless of whether the disseminated //ItemScheme// is the full //ItemScheme// or a partial //ItemScheme//.
Helena 2.1 182
183 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.
184
185 //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 agencyId as the //ItemScheme//).
186
187 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//.
188
189 ==== 3.5.3.2 Definitions ====
190
Helena 11.1 191 (% style="width:800.039px" %)
192 |**Class**|(% style="width:272px" %)**Feature**|(% style="width:422px" %)**Description**
193 |//ItemScheme//|(% style="width:272px" %)(((
Helena 2.1 194 Inherits from:
195 //MaintainableArtefact//
196 Direct sub classes are:
197 CategoryScheme
198 ConceptScheme
199 Codelist
200 ReportingTaxonomy
201 //OrganisationScheme//
202 TransformationScheme
Helena 11.2 203 CustomTypeScheme
204 NamePersonalisationSc heme
Helena 2.1 205 RulesetScheme
206 VtlMappingScheme UserDefinedOperatorSc heme
Helena 11.1 207 )))|(% style="width:422px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
208 | |(% style="width:272px" %)isPartial|(% style="width:422px" %)Denotes whether the Item Scheme contains a subset of the full set of Items in the maintained scheme.
209 | |(% style="width:272px" %)/items|(% style="width:422px" %)Association to the Items in the scheme.
210 |//Item//|(% style="width:272px" %)(((
Helena 2.1 211 Inherits from:
212
213 //NameableArtefact//
214 Direct sub classes are
215 Category
216 Concept
217 Code
218 ReportingCategory
219 //Organisation//
220 Transformation
221 CustomType
222 NamePersonalisation
223 Ruleset
224 VtlMapping
Helena 10.2 225 UserDefinedOperator
Helena 11.1 226 )))|(% style="width:422px" %)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.
227 | |(% style="width:272px" %)hierarchy|(% style="width:422px" %)This allows an Item optionally to have one or more child Items.
Helena 2.1 228
229 == 3.6 The Structure Pattern ==
230
231 === 3.6.1 Context ===
232
233 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.
234
235 === 3.6.2 Class Diagrams ===
236
237 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_828a9828.jpg||height="726" width="607"]]
238
239 **Figure 14: The Structure Pattern**
240
241 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_1513ed19.jpg||height="459" width="602"]]
242
243 **Figure 15: Representation within the Structure Pattern**
244
245 === 3.6.3 Explanation of the Diagrams ===
246
247 ==== 3.6.3.1 Narrative ====
248
249 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.
250
251 The //ComponentList// is a list of one or more //Component//(s//)//. The //ComponentList// has several concrete descriptor classes based on it: DimensionDescriptor, GroupDimensionDescriptor, MeasureDescriptor, and AttributeDescriptor of the DataStructureDefinition and MetadataAttributeDescriptor of the MetadataStructureDefinition.
252
253 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:
254
255 DimensionDescriptor: Dimension, TimeDimension
256 GroupDimensionDescriptor: Dimension, TimeDimension
257 MeasureDescriptor: Measure
258 AttributeDescriptor: DataAttribute, MetadataAttributeRef
259 MetadataAttributeDescriptor: MetadataAttribute
260
261 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.
262
263 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.
264
265 The Representation can be enumerated or non-enumerated. The valid content of an enumerated representation is specified either in an //ItemScheme// which can be one of Codelist, ValueList or //GeoCodelist//. The valid content of a non-enumerated representation is specified as one or more Facet(s) (for example, these may specify minimum and maximum values). For any Attribute this is achieved by one of more ExtendedFacet(s), which allow the additional representation of XHTML.
266
267 The types of representation that are valid for specific components is expressed in the model as a constraint on the association:
268
269 * The Dimension, DataAttribute, Measure, MetadataAttribute may be enumerated and, if so, use an //EnumeratedList//.
270 * The Dimension and Measure may be non-enumerated and, if so, use one or more Facet(s), note that the FacetValueType applicable to the TimeDimension is restricted to those that represent time.
271 * The MetadataAttribute and DataAttribute may be non-enumerated and, if so, use one or more ExtendedFacet(s).
272
273 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).
274
275 ==== 3.6.3.2 Definitions ====
276
Helena 11.1 277 (% style="width:756.039px" %)
278 |**Class**|(% style="width:284px" %)**Feature**|(% style="width:353px" %)**Description**
279 |StructureUsage|(% style="width:284px" %)(((
Helena 2.1 280 Inherits from:
281 //MaintainableArtefact//
282
283 Sub classes are:
284 Dataflow
285 Metadataflow
Helena 11.1 286 )))|(% style="width:353px" %)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.
287 | |(% style="width:284px" %)structure|(% style="width:353px" %)An association to a Structure specifying the structure of the artefact.
288 |Structure|(% style="width:284px" %)(((
Helena 2.1 289 Inherits from:
290 //MaintainableArtefact//
291
292 Sub classes are:
293 DataStructureDefinition MetadataStructureDefinit ion
Helena 11.1 294 )))|(% style="width:353px" %)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.
295 | |(% style="width:284px" %)grouping|(% style="width:353px" %)A composite association to one or more component lists.
296 |//ComponentList//|(% style="width:284px" %)(((
Helena 2.1 297 Inherits from:
298 //IdentifiableArtefact//
299
300 Sub classes are:
301 DimensionDescriptor
302 GroupDimensionDescriptor
303 MeasureDescriptor
304 AttributeDescriptor MetadataAttributeDescriptor
Helena 11.1 305 )))|(% style="width:353px" %)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.
306 | |(% style="width:284px" %)components|(% style="width:353px" %)An aggregate association to one or more components which make up the list.
307 |//Component//|(% style="width:284px" %)(((
Helena 2.1 308 Inherits from:
309 //IdentifiableArtefact//
310
311 Sub classes are:
312 Measure
Helena 11.3 313 //AttributeComponent
314 DimensionComponent//
Helena 11.1 315 )))|(% style="width:353px" %)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.
316 | |(% style="width:284px" %)conceptIdentity|(% style="width:353px" %)(((
Helena 2.1 317 Association to a Concept in a Concept Scheme that identifies and defines the
318
319 semantic of the Component.
320 )))
Helena 11.1 321 | |(% style="width:284px" %)localRepresentation|(% style="width:353px" %)Association to the Representation of the Component if this is different from the coreRepresentation of the Concept, which the Component uses (ConceptUsage).
322 |Representation|(% style="width:284px" %) |(% style="width:353px" %)The allowable value or format for Component or Concept
323 | |(% style="width:284px" %)+enumerated|(% style="width:353px" %)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.
324 | |(% style="width:284px" %)+nonEnumerated|(% style="width:353px" %)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.
325 |Facet|(% style="width:284px" %) |(% style="width:353px" %)Defines the format for the content of the Component when reported in a data or metadata set.
326 | |(% style="width:284px" %)facetType|(% style="width:353px" %)A specific content type, which is constrained by the Facet Type enumeration.
327 | |(% style="width:284px" %)facetValueType|(% style="width:353px" %)The format of the value of a Component when reported in a data or metadata set. This is constrained by the Facet Value Type enumeration.
328 | |(% style="width:284px" %) |(% style="width:353px" %)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.
329 |ExtendedFacet|(% style="width:284px" %)+itemSchemeFacet|(% style="width:353px" %)This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute and a Data Attribute.
Helena 2.1 330
331 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.
332
333 ==== 3.6.3.3 Representation Constructs ====
334
335 The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms:
336
Helena 11.1 337 (% style="width:923.039px" %)
338 |(% style="width:167px" %)**SDMX Facet Value Type**|(% style="width:148px" %)**XML Schema Data Type**|(% style="width:158px" %)**JSON Schema Data Type**|(% style="width:161px" %)**.NET Framework Type**|(% style="width:285px" %)**Java Data Type**
339 |(% style="width:167px" %)String|(% style="width:148px" %)xsd:string|(% style="width:158px" %)string|(% style="width:161px" %)System.String|(% style="width:285px" %)java.lang.String
340 |(% style="width:167px" %)Big Integer|(% style="width:148px" %)xsd:integer|(% style="width:158px" %)integer|(% style="width:161px" %)System.Decimal|(% style="width:285px" %)java.math.BigInteger
341 |(% style="width:167px" %)Integer|(% style="width:148px" %)xsd:int|(% style="width:158px" %)integer|(% style="width:161px" %)System.Int32|(% style="width:285px" %)int
342 |(% style="width:167px" %)Long|(% style="width:148px" %)xsd.long|(% style="width:158px" %)integer|(% style="width:161px" %)System.Int64|(% style="width:285px" %)long
343 |(% style="width:167px" %)Short|(% style="width:148px" %)xsd:short|(% style="width:158px" %)integer|(% style="width:161px" %)System.Int16|(% style="width:285px" %)short
344 |(% style="width:167px" %)Decimal|(% style="width:148px" %)xsd:decimal|(% style="width:158px" %)number|(% style="width:161px" %)System.Decimal|(% style="width:285px" %)java.math.BigDecimal
345 |(% style="width:167px" %)Float|(% style="width:148px" %)xsd:float|(% style="width:158px" %)number|(% style="width:161px" %)System.Single|(% style="width:285px" %)float
346 |(% style="width:167px" %)Double|(% style="width:148px" %)xsd:double|(% style="width:158px" %)number|(% style="width:161px" %)System.Double|(% style="width:285px" %)double
347 |(% style="width:167px" %)Boolean|(% style="width:148px" %)xsd:boolean|(% style="width:158px" %)boolean|(% style="width:161px" %)System.Boolean|(% style="width:285px" %)boolean
348 |(% style="width:167px" %)URI|(% style="width:148px" %)xsd:anyURI|(% style="width:158px" %)string:uri|(% style="width:161px" %)System.Uri|(% style="width:285px" %)Java.net.URI or java.lang.String
349 |(% style="width:167px" %)DateTime|(% style="width:148px" %)xsd:dateTime|(% style="width:158px" %)string:datetime|(% style="width:161px" %)System.DateTime|(% style="width:285px" %)javax.xml.datatype.XML GregorianCalendar
350 |(% style="width:167px" %)Time|(% style="width:148px" %)xsd:time|(% style="width:158px" %)string:time|(% style="width:161px" %)System.DateTime|(% style="width:285px" %)javax.xml.datatype.XML GregorianCalendar
351 |(% style="width:167px" %)GregorianYear|(% style="width:148px" %)xsd:gYear|(% style="width:158px" %)(((
352 string{{footnote}}In the JSON schemas, more complex data types are complemented with regular expressions, whenever no direct mapping to a standard type exists.{{/footnote}}
353 )))|(% style="width:161px" %)System.DateTime|(% style="width:285px" %)javax.xml.datatype.XML GregorianCalendar
354 |(% style="width:167px" %)GregorianMonth|(% style="width:148px" %)xsd:gYearMonth|(% style="width:158px" %)string|(% style="width:161px" %)System.DateTime|(% style="width:285px" %)javax.xml.datatype.XML GregorianCalendar
355 |(% style="width:167px" %)GregorianDay|(% style="width:148px" %)xsd:date|(% style="width:158px" %)string|(% style="width:161px" %)System.DateTime|(% style="width:285px" %)javax.xml.datatype.XML GregorianCalendar
356 |(% style="width:167px" %)Day, MonthDay, Month|(% style="width:148px" %)xsd:g*|(% style="width:158px" %)string|(% style="width:161px" %)System.DateTime|(% style="width:285px" %)javax.xml.datatype.XML GregorianCalendar
357 |(% style="width:167px" %)Duration|(% style="width:148px" %)xsd:duration|(% style="width:158px" %)string|(% style="width:161px" %)System.TimeSpan|(% style="width:285px" %)javax.xml.datatype.Dur ation
Helena 2.1 358
359 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.
360
361 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.
362
Helena 11.1 363 (% style="width:921.039px" %)
364 |**Facet Type**|(% style="width:827px" %)**Explanation**
365 |isSequence|(% style="width:827px" %)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.
366 |interval|(% style="width:827px" %)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.
367 |startValue|(% style="width:827px" %)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
368 |endValue|(% style="width:827px" %)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.
369 |timeInterval|(% style="width:827px" %)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.
370 |startTime|(% style="width:827px" %)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.
371 |endTime|(% style="width:827px" %)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.
372 |minLength|(% style="width:827px" %)The minLength facet specifies the minimum and length of the value in characters.
373 |maxLength|(% style="width:827px" %)The maxLength facet specifies the maximum length of the value in characters.
374 |minValue|(% style="width:827px" %)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.
375 |minLength|(% style="width:827px" %)The minLength facet specifies the minimum and length of the value in characters.
376 |maxLength|(% style="width:827px" %)The maxLength facet specifies the maximum length of the value in characters.
377 |minValue|(% style="width:827px" %)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.
378 |maxValue|(% style="width:827px" %)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.
379 |decimals|(% style="width:827px" %)The decimals facet indicates the number of characters allowed after the decimal separator.
380 |pattern|(% style="width:827px" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).
Helena 2.1 381
Helena 12.1 382 ----
Helena 2.1 383
Helena 11.1 384 {{putFootnotes/}}