Wiki source code of 3 SDMX Base Package

Version 15.3 by Helena on 2025/05/22 15:22

Hide last authors
Helena 6.2 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Helena 2.1 4
5 == {{id name="_Toc370968"/}}3.1 Introduction ==
6
Helena 15.2 7 The constructs in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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).
Helena 2.1 8
Helena 15.2 9 The motivation for establishing the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base package is as follows:
Helena 2.1 10
Helena 6.2 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
Helena 2.1 14
Helena 15.2 15 Each of the class diagrams in this section views classes from the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base package from a different perspective. There are detailed views of specific patterns, plus overviews showing inheritance between classes, and relationships amongst classes.
Helena 2.1 16
17 == {{id name="_Toc370969"/}}3.2 Base Structures - Identification, Versioning, and Maintenance ==
18
19 === {{id name="_Toc370970"/}}3.2.1 Class Diagram ===
20
Helena 15.3 21 [[image:1747916560887-863.png]]
Helena 2.1 22
Helena 15.3 23 **Figure 9: SDMX Identification, Maintenance and Versioning**
24
Helena 2.1 25 === {{id name="_Toc370971"/}}3.2.2 Explanation of the Diagram ===
26
27 ==== 3.2.2.1 Narrative ====
28
Helena 15.2 29 This group of classes forms the nucleus of the administration [[facets>>doc:sdmx:Glossary.Facet.WebHome]] of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] objects. They provide features which are reusable by derived classes to support horizontal functionality such as identity, versioning etc.
Helena 2.1 30
Helena 15.2 31 All classes derived from the abstract class //AnnotableArtefact// may have [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] (or notes): this supports the need to add notes to all [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] elements. The [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is used to convey extra information to describe any [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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
Helena 15.2 33 The //IdentifiableArtefact// is an abstract class that comprises the basic [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] needed for identification. Concrete classes based on //IdentifiableArtefact// all inherit the ability to be uniquely identified.
Helena 2.1 34
Helena 15.2 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>>doc:sdmx:Glossary.Representation.WebHome]] 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>>doc:sdmx:Glossary.Representation.WebHome]] of a description in one locale.
Helena 2.1 36
37 //VersionableArtefact// is an abstract class which inherits from //NameableArtefact// and adds versioning ability to all classes derived from it.
38
Helena 15.2 39 //MaintainableArtefact// further adds the ability for derived classes to be maintained via its association to //Agency, //and adds locational information (i.e. from where the object can be retrieved). It is possible to define whether the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is draft or final with the final attribute.
Helena 2.1 40
Helena 15.2 41 The inheritance chain from //AnnotableArtefact// through to //MaintainableArtefact// allows [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] classes to inherit the features they need, from simple [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]], through identity, naming, to versioning and maintenance.
Helena 2.1 42
Helena 6.3 43 ==== 3.2.2.2 Definitions ====
Helena 2.1 44
Helena 6.3 45 (% style="width:902.294px" %)
Helena 15.2 46 |**Class**|(% style="width:269px" %)**Feature**|(% style="width:455px" %)**Description**
47 |//AnnotableArtefact//|(% style="width:269px" %)(((
Helena 2.1 48 Base inheritance sub classes are:
49 //IdentifiableArtefact//
Helena 15.2 50 )))|(% style="width:455px" %)Objects of classes derived from this can have attached annotations.
51 |Annotation|(% style="width:269px" %) |(% style="width:455px" %)Additional descriptive information attached to an object.
52 | |(% style="width:269px" %)id|(% style="width:455px" %)(((
Helena 2.1 53 Identifier for the Annotation.
54 It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.
55 )))
Helena 15.2 56 | |(% style="width:269px" %)title|(% style="width:455px" %)A title used to identify an annotation.
57 | |(% style="width:269px" %)type|(% style="width:455px" %)Specifies how the annotation is to be processed.
58 | |(% style="width:269px" %)url|(% style="width:455px" %)A link to external descriptive text.
59 | |(% style="width:269px" %)+text|(% style="width:455px" %)An International String provides the multilingual text content of the annotation via this role.
60 |//IdentifiableArtefact//|(% style="width:269px" %)(((
Helena 2.1 61 Superclass is
62 //AnnotableArtefact//
Helena 6.3 63 Base inheritance sub classes are:
Helena 2.1 64 //NameableArtefact//
Helena 15.2 65 )))|(% style="width:455px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of Annotable Artefact.
66 | |(% style="width:269px" %)id|(% style="width:455px" %)The unique identifier of the object.
67 | |(% style="width:269px" %)uri|(% style="width:455px" %)Universal resource identifier that may or may not be resolvable.
68 | |(% style="width:269px" %)urn|(% style="width:455px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
69 |//NameableArtefact//|(% style="width:269px" %)(((
Helena 2.1 70 Superclass is
71 //IdentifiableArtefact// Base inheritance sub classes are:
72 //VersionableArtefact//
Helena 15.2 73 )))|(% style="width:455px" %)Provides a Name and Description to all derived classes in addition to identification and annotations.
74 | |(% style="width:269px" %)+description|(% style="width:455px" %)A multi-lingual description is provided by this role via the International String class.
75 | |(% style="width:269px" %)+name|(% style="width:455px" %)A multi-lingual name is provided by this role via the International String class
76 |InternationalString|(% style="width:269px" %) |(% style="width:455px" %)The International String is a collection of Localised Strings and supports the representation of text in multiple locales.
77 |LocalisedString|(% style="width:269px" %) |(% style="width:455px" %)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.).
78 | |(% style="width:269px" %)label|(% style="width:455px" %)Label of the string.
79 | |(% style="width:269px" %)locale|(% style="width:455px" %)The geographic locale of the string e.g French, Canadian French.
80 |//VersionableArtefact//|(% style="width:269px" %)(((
Helena 2.1 81 Superclass is
82 //NameableArtefact// Base inheritance sub classes are:
83 //MaintainableArtefact//
Helena 15.2 84 )))|(% style="width:455px" %)Provides versioning information for all derived objects.
85 | |(% style="width:269px" %)version|(% style="width:455px" %)A version string following an agreed convention
86 | |(% style="width:269px" %)validFrom|(% style="width:455px" %)Date from which the version is valid
87 | |(% style="width:269px" %)validTo|(% style="width:455px" %)Date from which version is superceded
88 |//MaintainableArtefact//|(% style="width:269px" %)(((
Helena 2.1 89 Inherits from
90
91 //VersionableArtefact//
Helena 15.2 92 )))|(% style="width:455px" %)An abstract class to group together primary structural metadata artefacts that are maintained by an Agency.
93 | |(% style="width:269px" %)final|(% style="width:455px" %)Defines whether a maintained artefact is draft or final.
94 | |(% style="width:269px" %)isExternalReference|(% style="width:455px" %)If set to “true” it indicates that the content of the object is held externally.
95 | |(% style="width:269px" %)structureURL|(% style="width:455px" %)The URL of an SDMX-ML document containing the external object.
96 | |(% style="width:269px" %)serviceURL|(% style="width:455px" %)The URL of an SDMX-compliant web service from which the external object can be retrieved.
97 | |(% style="width:269px" %)+maintainer|(% style="width:455px" %)Association to the Maintenance Agency responsible for maintaining the artefact.
98 |Agency|(% style="width:269px" %) |(% style="width:455px" %)See section on “Organisations”
Helena 2.1 99
100 == {{id name="_Toc370972"/}}3.3 Basic Inheritance ==
101
102 === {{id name="_Toc370973"/}}3.3.1 Class Diagram– Basic Inheritance from the Base Inheritance Classes ===
103
104 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_84176ba5.png||height="709" width="514"]]
105
106 **Figure 10: Basic Inheritance from the Base Structures**
107
108 === {{id name="_Toc370974"/}}3.3.2 Explanation of the Diagram ===
109
110 ==== 3.3.2.1 Narrative ====
111
112 The diagram above shows the inheritance within the base structures. The concrete classes 642 are introduced and defined in the specific package to which they relate.
113
114 == {{id name="_Toc370975"/}}3.4 Data Types ==
115
116 === {{id name="_Toc370976"/}}3.4.1 Class Diagram ===
117
Helena 10.1 118 [[image:1747690333052-506.png]]
119
Helena 2.1 120 **Figure 11: Class Diagram of Basic Data Types**
121
122 === {{id name="_Toc370977"/}}3.4.2 Explanation of the Diagram ===
123
124 ==== 3.4.2.1 Narrative ====
125
126 The UsageStatus enumeration is used as a data type on a DataAttribute where the value of the attribute in an instance of the class must take one of the values in the UsageStatus (i.e. mandatory, conditional).
127
128 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 section on //ConceptScheme// (section 4.4).
129
130 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:
131
132 * Append
133
134 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
135
136 * Replace
137
138 Data/metadata is to be replaced, and may also include additional data/metadata to be appended.
139
140 * Delete
141
142 Data/Metadata is to be deleted.
143
144 * Information
145
146 Data and metadata are for information purposes.
147
148 The IdentifiableObjectType enumeration is used to specify an object type whose class is a sub class of IdentifiableArtefact either directly of via NameableArtefact, VersionableArtefact or MaintainableArtefact.
149
150 The ToValueType,, ,,data type contains the attributes to support transformations defined in the StructureMap (see Section 9).
151
152 The ConstraintRoleType,, ,,data type contains the attributes that identify the purpose of a Constraint (allowableContent, actualContent).
153
154 == {{id name="_Toc370978"/}}3.5 The Item Scheme Pattern ==
155
156 === {{id name="_Toc370979"/}}3.5.1 Context ===
157
158 The Item Scheme is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example.
159
160 The ItemScheme is the basis for CategoryScheme, Codelist, ConceptScheme, ReportingTaxonomy, and //OrganisationScheme//.
161
162 === {{id name="_Toc370980"/}}3.5.2 Class Diagram ===
163
164 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_a2879920.jpg||height="602" width="614"]]
165
Helena 6.4 166 (% class="wikigeneratedid" id="HFigure12TheItemSchemePattern" %)
167 **Figure 12 The Item Scheme Pattern**
Helena 2.1 168
Helena 9.1 169 === {{id name="_Toc370981"/}}3.5.3 Explanation of the Diagram ===
Helena 2.1 170
Helena 8.1 171 ==== 3.5.3.1 Narrative ====
Helena 2.1 172
173 The //ItemScheme// is an abstract class which defines a set of //Item// (this class is also abstract). Its main purpose is to define a mechanism which can be used to create taxonomies which can classify other parts of the SDMX Information Model. It inherits from //MaintainableArtefact// which gives it the ability to be annotated, have identity, naming, versioning and be associated with an Agency. An example of a concrete class is a CategoryScheme. The associated Category are //Items//.
174
Helena 11.1 175 In an exchange environment an ItemScheme is allowed to contain a sub-set of the Items in the maintained //ItemScheme//. If such an //ItemScheme// is disseminated with a sub-set of the Items then the fact that this is a sub-set is denoted by setting the isPartial attribute to “true”.
Helena 2.1 176
177 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//.
178
179 Furthermore, the Id of the //ItemScheme// where isPartial is set to “true” is the same as the Id of the full //ItemScheme// (maintenance agency, 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//.
180
181 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.
182
Helena 8.1 183 //Item// inherits from //NameableArtefact// which gives it the ability to be annotated and have identity, and therefore has id, uri and urn attributes, a name and a description in the form of an InternationalString. Unlike the parent //ItemScheme//, the //Item// itself is not a //MaintainableArtefact// and therefore cannot have an independent Agency (i.e. it implicitly has the same agency as the //ItemScheme//).
Helena 2.1 184
185 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//.
186
187 ==== 3.5.3.2 Definitions ====
188
Helena 6.5 189 (% style="width:911.294px" %)
190 |**Class**|(% style="width:246px" %)**Feature**|(% style="width:478px" %)**Description**
191 |//ItemScheme//|(% style="width:246px" %)(((
Helena 2.1 192 Inherits from:
193 //MaintainableArtefact//
194 Direct sub classes are:
195 CategoryScheme
196 ConceptScheme
197 Codelist
Helena 6.5 198 )))|(% style="width:478px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
199 | |(% style="width:246px" %)(((
Helena 2.1 200 ReportingTaxonomy
201 //OrganisationScheme//
202 Transformation Scheme
203 CustomTypeScheme
204 NamePersonasationScheme
205 RuletScheme
206 VtlMappingScheme
207 UserDefinedOperatorScheme
Helena 6.5 208 )))|(% style="width:478px" %)
209 | |(% style="width:246px" %)isPartial|(% style="width:478px" %)Denotes whether the Item Scheme contains a sub set of the full set of Items in the maintained scheme.
210 | |(% style="width:246px" %)items|(% style="width:478px" %)Association to the Items in the scheme.
211 |//Item//|(% style="width:246px" %)(((
Helena 2.1 212 Inherits from:
213 //NameableArtefact//
Helena 6.5 214 Direct sub classes are Category
Helena 2.1 215 Concept
216 Code
217 ReportingCategory
218 //Organisation//
219 Transformation
220 CustomType
221 NamePersonlisation
222 Ruleset
223 VtlMapping
Helena 6.5 224 UserDefinedOperator
225 )))|(% style="width:478px" %)(((
Helena 2.1 226 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.
227 Note that at the conceptual level the Organisation is not hierarchic
228 )))
Helena 6.5 229 | |(% style="width:246px" %)hierarchy|(% style="width:478px" %)This allows an Item optionally to have one or more child Items.
Helena 2.1 230
231 == {{id name="_Toc370982"/}}3.6 The Structure Pattern ==
232
233 === {{id name="_Toc370983"/}}3.6.1 Context ===
234
235 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.
236
237 === {{id name="_Toc370984"/}}3.6.2 Class Diagrams ===
238
239 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_1645dbd1.png||height="441" width="578"]]
240
241 **Figure 13: The Structure Pattern**
242
243 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_b6478a73.png||height="774" width="556"]]
244
Helena 6.6 245 (% class="wikigeneratedid" id="HFigure14:RepresentationwithintheStructurePattern" %)
246 **Figure 14: Representation within the Structure Pattern**
Helena 2.1 247
248 === {{id name="_Toc370985"/}}3.6.3 Explanation of the Diagrams ===
249
250 ==== 3.6.3.1 Narrative ====
251
252 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.
253
254 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 MetadataTarget, and ReportStructure of the MetaDataStructureDefinition.
255
256 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:
257
258 __DimensionDescripto__r: Dimension, Measure Dimension, Time Dimension
259
260 __GroupDimensionDescriptor__: Dimension, Measure Dimension, Time Dimension
261
Helena 12.1 262 __MeasureDescriptor__: PrimaryMeasure
Helena 2.1 263
264 __AttributeDescriptor:__ Data Attribute
265
266 __MetadataTarget__: //TargetObject //and its sub classes
267
268 __ReportStructure__: MetadataAttribute
269
Helena 6.6 270 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.
Helena 2.1 271
272 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.
273
274 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 ConceptScheme, Codelist, //OrganisationScheme//, CategoryScheme, and ReportingTaxonomy. The valid content of a non-enumerated representation is specified as one or more Facet (for example these may specify minimum and maximum values). For a MetadataAttribute this is achieved by one of more Extended Facet which allows the additional representation of XHTML.
275
276 The types of representation that are valid for specific components is expressed in the model as a constraint on the association viz:
277
278 * The MeasureDimension must be enumerated and use a ConceptScheme The Dimension (but not MeasureDimension), DataAttribute, PrimaryMeasure, MetadataAttribute may be enumerated and, if so, use a Codelist
279 * The //TargetObject// may be enumerated and, if so, can use any ItemScheme (Codelist, ConceptScheme, //OrganisationScheme//, CategoryScheme, ReportingTaxonomy)
280 * The Dimension (but ot MeasureDimension), Data Attribute, PrimaryMeasure, //TargetObject// may be non-enumerated and, if so, use one of more Facet, note that the FacetValueType applicable to the TimeDimension is restricted to those that represent time
281 * The MetadataAttribute may be non-enumerated and, if so, uses one or more ExtendedFacet
282
283 The //Structure// may be used by one or more //StructureUsage//. An example of this in terms of concrete classes is that a DataflowDefinition (sub class of //StructureUsage//) may use a particular DataStructureDefinition (sub class of //Structure//), and similar constructs apply for the MetadataflowDefinition (link to MetadataStructureDefinition).
284
Helena 6.7 285 ==== 3.6.3.2 Definitions ====
Helena 2.1 286
Helena 6.7 287 (% style="width:1001.29px" %)
288 |**Class**|**Feature**|(% style="width:537px" %)**Description**
Helena 2.1 289 |//StructureUsage//|(((
290 Inherits from:
291 //MaintainableArtefact//
292 Sub classes are:
293 DataflowDefinition
Helena 6.7 294 MetadataflowDefinition
295 )))|(% style="width:537px" %)An artefact whose components are described by a Structure. In concrete terms (sub-classes) an example would be a Dataflow Definition which is linked to a given structure – in this case the Data Structure Definition.
296 | |structure|(% style="width:537px" %)An association to a Structure specifying the structure of the artefact.
Helena 2.1 297 |//Structure//|(((
298 Inherits from:
299 //MaintainableArtefact//
300 Sub classes are:
301 DataStructure
302 Definition
303 MetadataStructure
304 Definition
Helena 6.7 305 )))|(% style="width:537px" %)Abstract specification of a list of lists to define a complex tabular structure. A concrete example of this would be statistical concepts, code lists, and their organisation in a data or metadata structure definition, defined by a centre institution, usually for the exchange of statistical information with its partners.
306 | |grouping|(% style="width:537px" %)A composite association to one or more component lists.
Helena 2.1 307 |//ComponentList//|(((
308 Inherits from:
309 //IdentifiableArtefact//
310 Sub classes are:
311 DimensionDescriptor
312 GroupDimension
313 Descriptor
314 MeasureDescriptor
315 AttributeDescriptor
316 MetadataTarget
317 ReportStructure
Helena 6.7 318 )))|(% style="width:537px" %)An abstract definition of a list of components. A concrete example is a Dimension Descriptor which defines the list of Dimensions in a Data Structure Definition.
319 | |components|(% style="width:537px" %)An aggregate association to one or more components which make up the list.
Helena 2.1 320 |//Component//|(((
321 Inherits from:
322 //IdentifiableArtefact//
323 Sub classes are:
324 PrimaryMeasure
325 DataAttribute
Helena 6.7 326 //DimensionComponent
327 TargetObject//
Helena 2.1 328 MetadataAttribute
Helena 6.7 329 )))|(% style="width:537px" %)A component is an abstract super class used to define qualitative and quantitative data and metadata items that belong to a Component List and hence a Structure. Component is refined through its sub-classes.
330 | |conceptIdentity|(% style="width:537px" %)Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component
331 | |localRepresentation|(% style="width:537px" %)Association to the Representation of the Component if this is different from the coreRepresentation of the Concept which the Component uses (ConceptUsage)
332 |Representation| |(% style="width:537px" %)The allowable value or format for Component or Concept
333 | |+enumerated|(% style="width:537px" %)Association to an enumerated list that contains the allowable content for the Component when reported in a data or metadata set. The type of enumerated list that is allowed for any concrete Component is shown in the constraints on the association (e.g. Identifier Component can have any of the sub classes of Item Scheme, whereas Measure Dimension must have a Concept Scheme).
334 | |+nonEnumerated|(% style="width:537px" %)Association to a set of Facets that define the allowable format for the content of the Component when reported in a data or metadata set.
335 |Facet| |(% style="width:537px" %)Defines the format for the content of the Component when reported in a data or metadata set.
336 | |facetType|(% style="width:537px" %)A specific content type which is constrained by the FacetType enumeration
337 | |facetValueType|(% style="width:537px" %)(((
Helena 2.1 338 The format of the value of a Component when reported in a data or metadata set.
339
340 This is contrained by the FacetValueType enumeration.
341 )))
Helena 6.7 342 | |+itemSchemeFacet|(% style="width:537px" %)Defines the format of the identifiers in an Item Scheme used by a Component. Typically this would define the number of characters (length) of the identifier.
343 |ExtendedFacet| |(% style="width:537px" %)This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute
Helena 2.1 344
Helena 6.7 345 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)
Helena 2.1 346
347 ==== 3.6.3.3 Representation Constructs ====
348
349 The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, 818 and have equivalents in most current implementation platforms:
350
351 (((
Helena 6.7 352 (% style="width:1034.29px" %)
353 |(% style="width:222px" %)**SDMX Facet Value Type**|(% style="width:229px" %)**XML Schema Data Type**|(% style="width:216px" %)**.NET Framework Type**|(% style="width:354px" %)**Java Data Type**
354 |(% style="width:222px" %)String|(% style="width:229px" %)xsd:string|(% style="width:216px" %)System.String|(% style="width:354px" %)java.lang.String
355 |(% style="width:222px" %)Big Integer|(% style="width:229px" %)xsd:integer|(% style="width:216px" %)System.Decimal|(% style="width:354px" %)java.math.BigInteger
356 |(% style="width:222px" %)Integer|(% style="width:229px" %)xsd:int|(% style="width:216px" %)System.Int32|(% style="width:354px" %)int
357 |(% style="width:222px" %)Long|(% style="width:229px" %)xsd.long|(% style="width:216px" %)System.Int64|(% style="width:354px" %)long
358 |(% style="width:222px" %)Short|(% style="width:229px" %)xsd:short|(% style="width:216px" %)System.Int16|(% style="width:354px" %)short
359 |(% style="width:222px" %)Decimal|(% style="width:229px" %)xsd:decimal|(% style="width:216px" %)System.Decimal|(% style="width:354px" %)java.math.BigDecimal
360 |(% style="width:222px" %)Float|(% style="width:229px" %)xsd:float|(% style="width:216px" %)System.Single|(% style="width:354px" %)float
361 |(% style="width:222px" %)Double|(% style="width:229px" %)xsd:double|(% style="width:216px" %)System.Double|(% style="width:354px" %)double
362 |(% style="width:222px" %)Boolean|(% style="width:229px" %)xsd:boolean|(% style="width:216px" %)System.Boolean|(% style="width:354px" %)boolean
363 |(% style="width:222px" %)URI|(% style="width:229px" %)xsd:anyURI|(% style="width:216px" %)System.Uri|(% style="width:354px" %)Java.net.URI or java.lang.String
364 |(% style="width:222px" %)DateTime|(% style="width:229px" %)xsd:dateTime|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
365 |(% style="width:222px" %)Time|(% style="width:229px" %)xsd:time|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
366 |(% style="width:222px" %)GregorianYear|(% style="width:229px" %)xsd:gYear|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
367 |(% style="width:222px" %)GregorianMonth|(% style="width:229px" %)xsd:gYearMonth|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
368 |(% style="width:222px" %)GregorianDay|(% style="width:229px" %)xsd:date|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
369 |(% style="width:222px" %)Day, MonthDay, Month|(% style="width:229px" %)xsd:g*|(% style="width:216px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
370 |(% style="width:222px" %)Duration|(% style="width:229px" %)xsd:duration|(% style="width:216px" %)System.TimeSpan|(% style="width:354px" %)javax.xml.datatype.Dura tion
Helena 2.1 371 )))
372
Helena 6.8 373 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.
Helena 2.1 374
Helena 6.8 375 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.
Helena 2.1 376
377 (((
Helena 6.9 378 (% style="width:1043.29px" %)
379 |(% style="width:179px" %)**Facet Type**|(% style="width:862px" %)**Explanation**
380 |(% style="width:179px" %)isSequence|(% style="width:862px" %)The isSequence facet indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue facet or the timeInterval, startTime, and endTime, facets. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely.
381 |(% style="width:179px" %)interval|(% style="width:862px" %)The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true.
382 |(% style="width:179px" %)startValue|(% colspan="1" style="width:862px" %)The startValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.
383 |(% style="width:179px" %)endValue|(% colspan="1" style="width:862px" %)The endValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric sequence, and indicates that ending point (if any) of the sequence.
384 |(% style="width:179px" %)timeInterval|(% colspan="1" style="width:862px" %)The timeInterval facet indicates the permitted duration in a time sequence. In order for this to be used, the isSequence facet must have a value of true.
385 |(% style="width:179px" %)startTime|(% colspan="1" style="width:862px" %)The startTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
386 |(% style="width:179px" %)endTime|(% colspan="1" style="width:862px" %)The endTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). This facet is used for a time sequence, and indicates that ending point (if any) of the sequence.
387 |(% style="width:179px" %)minLength|(% colspan="1" style="width:862px" %)The minLength facet specifies the minimum and length of the value in characters.
388 |(% style="width:179px" %)maxLength|(% colspan="1" style="width:862px" %)The maxLength facet specifies the maximum length of the value in characters.
389 |(% style="width:179px" %)minValue|(% colspan="1" style="width:862px" %)The minValue facet is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
390 |(% style="width:179px" %)maxValue|(% colspan="1" style="width:862px" %)The maxValue facet is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
391 |(% style="width:179px" %)decimals|(% colspan="1" style="width:862px" %)The decimals facet indicates the number of characters allowed after the decimal separator.
392 |(% style="width:179px" %)pattern|(% colspan="1" style="width:862px" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g. W3C XML Schema).
Helena 2.1 393 )))