Skip to Content

Wiki source code of 3 SDMX Base Package

Version 16.1 by Helena on 2025/05/22 15:25
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 == {{id name="_Toc370968"/}}3.1 Introduction ==
6
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).
8
9 The motivation for establishing the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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>>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.
16
17 == {{id name="_Toc370969"/}}3.2 Base Structures - Identification, Versioning, and Maintenance ==
18
19 === {{id name="_Toc370970"/}}3.2.1 Class Diagram ===
20
21 [[image:1747916560887-863.png]]
22
23 **Figure 9: SDMX Identification, Maintenance and Versioning**
24
25 === {{id name="_Toc370971"/}}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>>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.
30
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).
32
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.
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>>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.
36
37 //VersionableArtefact// is an abstract class which inherits from //NameableArtefact// and adds versioning ability to all classes derived from it.
38
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.
40
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.
42
43 ==== 3.2.2.2 Definitions ====
44
45 (% style="width:902.294px" %)
46 |**Class**|(% style="width:269px" %)**Feature**|(% style="width:455px" %)**Description**
47 |//AnnotableArtefact//|(% style="width:269px" %)(((
48 Base inheritance sub classes are:
49 //IdentifiableArtefact//
50 )))|(% style="width:455px" %)Objects of classes derived from this can have attached [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].
51 |[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]|(% style="width:269px" %) |(% style="width:455px" %)Additional descriptive information attached to an object.
52 | |(% style="width:269px" %)id|(% style="width:455px" %)(((
53 Identifier for the [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]].
54 It can be used to disambiguate one [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] from another where there are several [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] for the same annotated object.
55 )))
56 | |(% style="width:269px" %)[[title>>doc:sdmx:Glossary.Title.WebHome]]|(% style="width:455px" %)A [[title>>doc:sdmx:Glossary.Title.WebHome]] used to identify an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]].
57 | |(% style="width:269px" %)type|(% style="width:455px" %)Specifies how the [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]] 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>>doc:sdmx:Glossary.International string.WebHome]] provides the multilingual text content of the [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]] via this role.
60 |//IdentifiableArtefact//|(% style="width:269px" %)(((
61 Superclass is
62 //AnnotableArtefact//
63 Base inheritance sub classes are:
64 //NameableArtefact//
65 )))|(% style="width:455px" %)Provides identity to all derived classes. It also provides [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]] to derived classes because it is a subclass of Annotable [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]].
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" %)(((
70 Superclass is
71 //IdentifiableArtefact// Base inheritance sub classes are:
72 //VersionableArtefact//
73 )))|(% style="width:455px" %)Provides a Name and Description to all derived classes in addition to identification and [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].
74 | |(% style="width:269px" %)+description|(% style="width:455px" %)A multi-lingual description is provided by this role via the [[International String>>doc:sdmx:Glossary.International string.WebHome]] class.
75 | |(% style="width:269px" %)+name|(% style="width:455px" %)A multi-lingual name is provided by this role via the [[International String>>doc:sdmx:Glossary.International string.WebHome]] class
76 |InternationalString|(% style="width:269px" %) |(% style="width:455px" %)The [[International String>>doc:sdmx:Glossary.International string.WebHome]] is a collection of Localised Strings and supports the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of text in multiple locales.
77 |LocalisedString|(% style="width:269px" %) |(% style="width:455px" %)The Localised String supports the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] 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" %)(((
81 Superclass is
82 //NameableArtefact// Base inheritance sub classes are:
83 //MaintainableArtefact//
84 )))|(% style="width:455px" %)Provides versioning information for all derived objects.
85 | |(% style="width:269px" %)(% style="color:#e74c3c" %)version|(% style="width:455px" %)A (% style="color:#e74c3c" %)version(%%) string following an agreed convention
86 | |(% style="width:269px" %)validFrom|(% style="width:455px" %)Date from which the (% style="color:#e74c3c" %)version(%%) is valid
87 | |(% style="width:269px" %)validTo|(% style="width:455px" %)Date from which (% style="color:#e74c3c" %)version(%%) is superceded
88 |//MaintainableArtefact//|(% style="width:269px" %)(((
89 Inherits from
90
91 //VersionableArtefact//
92 )))|(% style="width:455px" %)An abstract class to group together primary [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that are maintained by an Agency.
93 | |(% style="width:269px" %)final|(% style="width:455px" %)Defines whether a maintained [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] 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>>doc:sdmx:Glossary.SDMX-ML.WebHome]] document containing the external object.
96 | |(% style="width:269px" %)serviceURL|(% style="width:455px" %)The URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-compliant web service from which the external object can be retrieved.
97 | |(% style="width:269px" %)+maintainer|(% style="width:455px" %)Association to the [[Maintenance Agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] responsible for maintaining the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]].
98 |Agency|(% style="width:269px" %) |(% style="width:455px" %)See section on “Organisations”
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 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
118 [[image:1747690333052-506.png]]
119
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>>doc:sdmx:Glossary.Attribute.WebHome]] 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 (% style="color:#e74c3c" %)Concept(%%) or the usage of a (% style="color:#e74c3c" %)Concept(%%) when specified for use on a //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// on a //Structure// (such as a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] 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>>doc:sdmx:Glossary.Incremental update.WebHome]] for an existing data/[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] or the provision of new data or documentation ([[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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 (% style="color:#e74c3c" %)version(%%) 1.0 of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] to support transformations defined in the StructureMap (see Section 9).
151
152 The ConstraintRoleType,, ,,data type contains the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that identify the purpose of a (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Item scheme.WebHome]] 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
166 (% class="wikigeneratedid" id="HFigure12TheItemSchemePattern" %)
167 **Figure 12 The Item Scheme Pattern**
168
169 === {{id name="_Toc370981"/}}3.5.3 Explanation of the Diagram ===
170
171 ==== 3.5.3.1 Narrative ====
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>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. 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>>doc:sdmx:Glossary.Category.WebHome]] are //Items//.
174
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>>doc:sdmx:Glossary.Attribute.WebHome]] to “true”.
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>>doc:sdmx:Glossary.Maintenance agency.WebHome]], id, (% style="color:#e74c3c" %)version(%%)). This is important as this is the Id that that is referenced in other structures (e.g. a Codelist referenced in a [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]) 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>>doc:sdmx:Glossary.Code.WebHome]] in a Codelist are relevant. In this case a partial Codelist can be constructed using the (% style="color:#e74c3c" %)Constraint(%%) mechanism explained later in this document.
182
183 //Item// inherits from //NameableArtefact// which gives it the ability to be annotated and have identity, and therefore has id, uri and urn [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], 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//).
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
189 (% style="width:911.294px" %)
190 |**Class**|(% style="width:246px" %)**Feature**|(% style="width:478px" %)**Description**
191 |//ItemScheme//|(% style="width:246px" %)(((
192 Inherits from:
193 //MaintainableArtefact//
194 Direct sub classes are:
195 CategoryScheme
196 ConceptScheme
197 Codelist
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" %)(((
200 ReportingTaxonomy
201 //OrganisationScheme//
202 Transformation Scheme
203 CustomTypeScheme
204 NamePersonasationScheme
205 RuletScheme
206 VtlMappingScheme
207 UserDefinedOperatorScheme
208 )))|(% style="width:478px" %)
209 | |(% style="width:246px" %)isPartial|(% style="width:478px" %)Denotes whether the [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] 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" %)(((
212 Inherits from:
213 //NameableArtefact//
214 Direct sub classes are [[Category>>doc:sdmx:Glossary.Category.WebHome]]
215 Concept
216 [[Code>>doc:sdmx:Glossary.Code.WebHome]]
217 ReportingCategory
218 //Organisation//
219 Transformation
220 CustomType
221 NamePersonlisation
222 Ruleset
223 VtlMapping
224 UserDefinedOperator
225 )))|(% style="width:478px" %)(((
226 The Item is an item of content in an [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]. This may be a node in a taxonomy or ontology, a [[code>>doc:sdmx:Glossary.Code.WebHome]] in a [[code list>>doc:sdmx:Glossary.Code list.WebHome]] etc.
227 Note that at the conceptual (% style="color:#e74c3c" %)level(%%) the Organisation is not hierarchic
228 )))
229 | |(% style="width:246px" %)hierarchy|(% style="width:478px" %)This allows an Item optionally to have one or more child Items.
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>>doc:sdmx:Glossary.Data structure definition.WebHome]], and [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]). 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
245 (% class="wikigeneratedid" id="HFigure14:RepresentationwithintheStructurePattern" %)
246 **Figure 14: Representation within the Structure Pattern**
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>>doc:sdmx:Glossary.Component.WebHome]]//(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>>doc:sdmx:Glossary.Component.WebHome]] is contained in a ComponentList. The type of [[Component>>doc:sdmx:Glossary.Component.WebHome]] in a ComponentList is dependent on the concrete class of the ComponentList as follows:
257
258 __DimensionDescripto__r: [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]
259
260 __GroupDimensionDescriptor__: [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]
261
262 __MeasureDescriptor__: PrimaryMeasure
263
264 __AttributeDescriptor:__ Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
265
266 __MetadataTarget__: //TargetObject //and its sub classes
267
268 __ReportStructure__: MetadataAttribute
269
270 Each [[Component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic (and possibly also its [[representation>>doc:sdmx:Glossary.Representation.WebHome]]) from a (% style="color:#e74c3c" %)Concept(%%) in a ConceptScheme. This is represented by the conceptIdentity association to (% style="color:#e74c3c" %)Concept(%%).
271
272 The //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// may also have a localRepresentation, This allows a concrete class, such as [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], to specify its [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which is local to the //Structure// in which it is contained (for [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] this will be DataStructureDefinition), and thus overrides any coreRepresentation specified for the (% style="color:#e74c3c" %)Concept(%%).
273
274 The [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] can be enumerated or non-enumerated. The valid content of an enumerated [[representation>>doc:sdmx:Glossary.Representation.WebHome]] 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>>doc:sdmx:Glossary.Representation.WebHome]] is specified as one or more [[Facet>>doc:sdmx:Glossary.Facet.WebHome]] (for example these may specify minimum and maximum values). For a MetadataAttribute this is achieved by one of more Extended [[Facet>>doc:sdmx:Glossary.Facet.WebHome]] which allows the additional [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of XHTML.
275
276 The types of [[representation>>doc:sdmx:Glossary.Representation.WebHome]] that are valid for specific [[components>>doc:sdmx:Glossary.Component.WebHome]] is expressed in the model as a (% style="color:#e74c3c" %)constraint(%%) on the association viz:
277
278 * The MeasureDimension must be enumerated and use a ConceptScheme The [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (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>>doc:sdmx:Glossary.Dimension.WebHome]] (but ot MeasureDimension), Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]], PrimaryMeasure, //TargetObject// may be non-enumerated and, if so, use one of more [[Facet>>doc:sdmx:Glossary.Facet.WebHome]], 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
285 ==== 3.6.3.2 Definitions ====
286
287 (% style="width:1001.29px" %)
288 |**Class**|**Feature**|(% style="width:537px" %)**Description**
289 |//StructureUsage//|(((
290 Inherits from:
291 //MaintainableArtefact//
292 Sub classes are:
293 DataflowDefinition
294 MetadataflowDefinition
295 )))|(% style="width:537px" %)An [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] whose [[components>>doc:sdmx:Glossary.Component.WebHome]] are described by a Structure. In concrete terms (sub-classes) an example would be a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] 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>>doc:sdmx:Glossary.Artefact.WebHome]].
297 |//Structure//|(((
298 Inherits from:
299 //MaintainableArtefact//
300 Sub classes are:
301 DataStructure
302 Definition
303 MetadataStructure
304 Definition
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 (% style="color:#e74c3c" %)concepts(%%), [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], and their organisation in a data or [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], 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>>doc:sdmx:Glossary.Component.WebHome]] lists.
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
318 )))|(% style="width:537px" %)An abstract definition of a list of [[components>>doc:sdmx:Glossary.Component.WebHome]]. A concrete example is a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor which defines the list of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] in a Data Structure Definition.
319 | |[[components>>doc:sdmx:Glossary.Component.WebHome]]|(% style="width:537px" %)An aggregate association to one or more [[components>>doc:sdmx:Glossary.Component.WebHome]] which make up the list.
320 |//[[Component>>doc:sdmx:Glossary.Component.WebHome]]//|(((
321 Inherits from:
322 //IdentifiableArtefact//
323 Sub classes are:
324 PrimaryMeasure
325 DataAttribute
326 //DimensionComponent
327 TargetObject//
328 MetadataAttribute
329 )))|(% style="width:537px" %)A [[component>>doc:sdmx:Glossary.Component.WebHome]] is an abstract super class used to define qualitative and quantitative data and metadata items that belong to a [[Component>>doc:sdmx:Glossary.Component.WebHome]] List and hence a Structure. [[Component>>doc:sdmx:Glossary.Component.WebHome]] is refined through its sub-classes.
330 | |conceptIdentity|(% style="width:537px" %)Association to a (% style="color:#e74c3c" %)Concept(%%) in a [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] that identifies and defines the semantic of the [[Component>>doc:sdmx:Glossary.Component.WebHome]]
331 | |localRepresentation|(% style="width:537px" %)Association to the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[Component>>doc:sdmx:Glossary.Component.WebHome]] if this is different from the coreRepresentation of the (% style="color:#e74c3c" %)Concept(%%) which the [[Component>>doc:sdmx:Glossary.Component.WebHome]] uses (ConceptUsage)
332 |[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]| |(% style="width:537px" %)The allowable value or format for [[Component>>doc:sdmx:Glossary.Component.WebHome]] or (% style="color:#e74c3c" %)Concept
333 | |+enumerated|(% style="width:537px" %)Association to an enumerated list that contains the allowable content for the [[Component>>doc:sdmx:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. The type of enumerated list that is allowed for any concrete [[Component>>doc:sdmx:Glossary.Component.WebHome]] is shown in the (% style="color:#e74c3c" %)constraints(%%) on the association (e.g. Identifier [[Component>>doc:sdmx:Glossary.Component.WebHome]] can have any of the sub classes of [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], whereas [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] must have a [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]).
334 | |+nonEnumerated|(% style="width:537px" %)Association to a set of [[Facets>>doc:sdmx:Glossary.Facet.WebHome]] that define the allowable format for the content of the [[Component>>doc:sdmx:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].
335 |[[Facet>>doc:sdmx:Glossary.Facet.WebHome]]| |(% style="width:537px" %)Defines the format for the content of the [[Component>>doc:sdmx:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].
336 | |facetType|(% style="width:537px" %)A specific content type which is constrained by the FacetType enumeration
337 | |facetValueType|(% style="width:537px" %)(((
338 The format of the value of a [[Component>>doc:sdmx:Glossary.Component.WebHome]] when reported in a data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].
339
340 This is contrained by the FacetValueType enumeration.
341 )))
342 | |+itemSchemeFacet|(% style="width:537px" %)Defines the format of the identifiers in an [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] used by a [[Component>>doc:sdmx:Glossary.Component.WebHome]]. Typically this would define the number of characters (length) of the identifier.
343 |ExtendedFacet| |(% style="width:537px" %)This has the same function as [[Facet>>doc:sdmx:Glossary.Facet.WebHome]] but allows additionally an XHTML [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is constrained for use with a Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
344
345 The specification of the content and use of the sub classes to ComponentList and [[Component>>doc:sdmx:Glossary.Component.WebHome]] can be found in the section in which they are used (DataStructureDefinition and MetadataStructureDefinition)
346
347 ==== 3.6.3.3 Representation Constructs ====
348
349 The majority of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] FacetValueTypes are compatible with those found in XML Schema, 818 and have equivalents in most current implementation platforms:
350
351 (((
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
371 )))
372
373 There are also a number of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] data types which do not have these direct correspondences, often because they are composite [[representations>>doc:sdmx:Glossary.Representation.WebHome]] or restrictions of a broader data type. These are detailed in Section 6 of the standards.
374
375 The [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] is composed of [[Facets>>doc:sdmx:Glossary.Facet.WebHome]], each of which conveys characteristic information related to the definition of a value domain. Often a set of [[Facets>>doc:sdmx:Glossary.Facet.WebHome]] are needed to convey the required semantic. For example, a sequence is defined by a minimum of two [[Facets>>doc:sdmx:Glossary.Facet.WebHome]]: one to define the start value, and one to define the interval.
376
377 (((
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>>doc:sdmx:Glossary.Facet.WebHome]] indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue [[facet>>doc:sdmx:Glossary.Facet.WebHome]] or the timeInterval, startTime, and endTime, [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. If this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a value of true.
382 |(% style="width:179px" %)startValue|(% colspan="1" style="width:862px" %)The startValue [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and interval [[facets>>doc:sdmx:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:sdmx:Glossary.Facet.WebHome]]). This [[facet>>doc:sdmx:Glossary.Facet.WebHome]] 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>>doc:sdmx:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and interval [[facets>>doc:sdmx:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:sdmx:Glossary.Facet.WebHome]]). This [[facet>>doc:sdmx:Glossary.Facet.WebHome]] 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>>doc:sdmx:Glossary.Facet.WebHome]] indicates the permitted duration in a time sequence. In order for this to be used, the isSequence [[facet>>doc:sdmx:Glossary.Facet.WebHome]] must have a value of true.
385 |(% style="width:179px" %)startTime|(% colspan="1" style="width:862px" %)The startTime [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and timeInterval [[facets>>doc:sdmx:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:sdmx:Glossary.Facet.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Facet.WebHome]] is used in conjunction with the isSequence and timeInterval [[facets>>doc:sdmx:Glossary.Facet.WebHome]] (which must be set in order to use this [[facet>>doc:sdmx:Glossary.Facet.WebHome]]). This [[facet>>doc:sdmx:Glossary.Facet.WebHome]] 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>>doc:sdmx:Glossary.Facet.WebHome]] specifies the minimum and length of the value in characters.
388 |(% style="width:179px" %)maxLength|(% colspan="1" style="width:862px" %)The maxLength [[facet>>doc:sdmx:Glossary.Facet.WebHome]] specifies the maximum length of the value in characters.
389 |(% style="width:179px" %)minValue|(% colspan="1" style="width:862px" %)The minValue [[facet>>doc:sdmx:Glossary.Facet.WebHome]] 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>>doc:sdmx:Glossary.Facet.WebHome]] 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>>doc:sdmx:Glossary.Facet.WebHome]] 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>>doc:sdmx:Glossary.Facet.WebHome]] 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>>doc:sdmx:Glossary.Decimals.WebHome]] [[facet>>doc:sdmx:Glossary.Facet.WebHome]] indicates the number of characters allowed after the [[decimal>>doc:sdmx:Glossary.Decimals.WebHome]] separator.
392 |(% style="width:179px" %)pattern|(% colspan="1" style="width:862px" %)The pattern [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds any regular expression permitted in the implementation syntax (e.g. W3C XML Schema).
393 )))