Wiki source code of 3 SDMX Base Package

Last modified by Helena on 2025/09/10 11:19

version	line-number	content
2.2	1	{{box title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
	4
1.1	5	== 3.1 Introduction ==
	6
6.1	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).
1.1	8
6.1	9	The motivation for establishing the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base package is as follows:
1.1	10
	11	it is accepted “Best Practise” to identify fundamental archetypes occurring in a model// //identification of commonly found structures or “patterns” leads to easier understanding// //identification of patterns encourages re-use
	12
6.1	13	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.
1.1	14
2.3	15	== 3.2 Base Structures - Identification, Versioning, and Maintenance ==
1.1	16
2.3	17	=== 3.2.1 Class Diagram ===
1.1	18
	19	[[image:1749246130522-547.jpeg]]
	20
	21	Figure 10: SDMX Identification, Maintenance and Versioning
	22
2.3	23	=== 3.2.2 Explanation of the Diagram ===
1.1	24
2.3	25	==== 3.2.2.1 Narrative ====
1.1	26
6.1	27	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.
1.1	28
6.1	29	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).
1.1	30
6.1	31	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.
1.1	32
6.1	33	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.
1.1	34
6.1	35	//VersionableArtefact// is an abstract class which inherits from //NameableArtefact// and adds versioning ability to all classes derived from it, as explained in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”.
1.1	36
	37	//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).
	38
6.1	39	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.
1.1	40
2.3	41	==== 3.2.2.2 Definitions ====
1.1	42
2.3	43	(% style="width:973.835px" %)
	44	\|Class\|(% style="width:262px" %)Feature\|(% style="width:543px" %)Description
	45	\|//AnnotableArtefact//\|(% style="width:262px" %)(((
1.1	46	Base inheritance sub classes are:
	47	//IdentifiableArtefact//
6.1	48	)))\|(% style="width:543px" %)Objects of classes derived from this can have attached [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].
	49	\|[[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]\|(% style="width:262px" %)// //\|(% style="width:543px" %)Additional descriptive information attached to an object.
	50	\| \|(% style="width:262px" %)id\|(% style="width:543px" %)Identifier for the [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]]. 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.
	51	\| \|(% style="width:262px" %)[[title>>doc:sdmx:Glossary.Title.WebHome]]\|(% style="width:543px" %)A [[title>>doc:sdmx:Glossary.Title.WebHome]] used to identify an [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]].
	52	\| \|(% style="width:262px" %)type\|(% style="width:543px" %)Specifies how the [[annotation>>doc:sdmx:Glossary.Annotation.WebHome]] is to be processed.
2.3	53	\| \|(% style="width:262px" %)url\|(% style="width:543px" %)A link to external descriptive text.
6.2	54	\| \|(% style="width:262px" %)value\|(% style="width:543px" %)A non-localised version of the [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] content.
2.3	55	\| \|(% style="width:262px" %)+url\|(% style="width:543px" %)An International URI provides a set of links that are language specific, via this role.
6.1	56	\| \|(% style="width:262px" %)+text\|(% style="width:543px" %)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.
2.3	57	\|InternationalUri\|(% style="width:262px" %) \|(% style="width:543px" %)The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales.
	58	\|LocalisedUri\|(% style="width:262px" %) \|(% style="width:543px" %)The Localised URI supports the link to an external description in one locale (locale is similar to language but includes geographic variations such as Canadian French, US English etc.).
	59	\|//IdentifiableArtefact//\|(% style="width:262px" %)(((
	60	Superclass is //AnnotableArtefact//
1.1	61	Base inheritance sub classes are:
	62	//NameableArtefact//
6.1	63	)))\|(% style="width:543px" %)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]].
2.3	64	\| \|(% style="width:262px" %)id\|(% style="width:543px" %)The unique identifier of the object.
	65	\| \|(% style="width:262px" %)uri\|(% style="width:543px" %)Universal resource identifier that may or may not be resolvable.
	66	\| \|(% style="width:262px" %)urn\|(% style="width:543px" %)Universal resource name – this is for use in registries: all registered objects have a urn.
	67	\|//NameableArtefact//\|(% style="width:262px" %)(((
	68	Superclass is //IdentifiableArtefact// Base inheritance sub classes are:
1.1	69	//VersionableArtefact//
6.1	70	)))\|(% style="width:543px" %)Provides a Name and Description to all derived classes in addition to identification and [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].
	71	\| \|(% style="width:262px" %)+description\|(% style="width:543px" %)A multi-lingual description is provided by this role via the [[International String>>doc:sdmx:Glossary.International string.WebHome]] class.
	72	\| \|(% style="width:262px" %)+name\|(% style="width:543px" %)A multi-lingual name is provided by this role via the [[International String>>doc:sdmx:Glossary.International string.WebHome]] class
	73	\|InternationalString\|(% style="width:262px" %) \|(% style="width:543px" %)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.
	74	\|LocalisedString\|(% style="width:262px" %) \|(% style="width:543px" %)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.).
2.3	75	\| \|(% style="width:262px" %)label\|(% style="width:543px" %)Label of the string.
	76	\| \|(% style="width:262px" %)locale\|(% style="width:543px" %)The geographic locale of the string e.g French, Canadian French.
	77	\|//VersionableArtefact//\|(% style="width:262px" %)(((
1.1	78	Superclass is
	79	//NameableArtefact//
	80	Base inheritance sub classes are:
	81	//MaintainableArtefact//
2.3	82	)))\|(% style="width:543px" %)Provides versioning information for all derived objects.
6.2	83	\| \|(% style="width:262px" %)(% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]]\|(% style="width:543px" %)A (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) string following [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules.
	84	\| \|(% style="width:262px" %)validFrom\|(% style="width:543px" %)Date from which the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) is valid
	85	\| \|(% style="width:262px" %)validTo\|(% style="width:543px" %)Date from which (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) is superseded
2.3	86	\|//MaintainableArtefact//\|(% style="width:262px" %)(((
1.1	87	Inherits from
	88
	89	//VersionableArtefact//
6.1	90	)))\|(% style="width:543px" %)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.
2.3	91	\| \|(% style="width:262px" %)isExternalReference\|(% style="width:543px" %)If set to “true” it indicates that the content of the object is held externally.
6.1	92	\| \|(% style="width:262px" %)structureURL\|(% style="width:543px" %)The URL of an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] document containing the external object.
	93	\| \|(% style="width:262px" %)serviceURL\|(% style="width:543px" %)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.
	94	\| \|(% style="width:262px" %)+maintainer\|(% style="width:543px" %)Association to the [[Maintenance Agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] responsible for maintaining the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]].
2.3	95	\|Agency\|(% style="width:262px" %) \|(% style="width:543px" %)See section on “Organisations”
1.1	96
2.3	97	== 3.3 Basic Inheritance ==
1.1	98
2.3	99	=== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes ===
1.1	100
	101	[[image:1749246130530-261.jpeg]]
	102
	103	Figure 11: Basic Inheritance from the Base Structures
	104
2.3	105	=== 3.3.2 Explanation of the Diagram ===
1.1	106
2.3	107	==== 3.3.2.1 Narrative ====
1.1	108
	109	The diagram above shows the inheritance within the base structures. The concrete classes are introduced and defined in the specific package to which they relate.
	110
2.3	111	== 3.4 Data Types ==
1.1	112
2.3	113	=== 3.4.1 Class Diagram ===
1.1	114
	115	[[image:1749246130536-128.jpeg]]
	116
	117	Figure 12: Class Diagram of Basic Data Types
	118
2.4	119	=== 3.4.2 Explanation of the Diagram ===
1.1	120
2.4	121	==== 3.4.2.1 Narrative ====
1.1	122
6.2	123	The FacetType and FacetValueType enumerations are used to specify the valid format of the content of a non-enumerated (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) or the usage of a (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) 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 chapter on ConceptScheme (section 4.5).
1.1	124
	125	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:
	126
6.2	127	* Append: 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 version 1.0 of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Technical Standards.
1.1	128	* Replace: Data/metadata is to be replaced and may also include additional data/metadata to be appended.
	129	* Delete: Data/Metadata is to be deleted.
	130	* Information: Data and metadata are for information purposes.
	131
6.1	132	The ToValueType data type contains the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] to support transformations defined in the StructureMap (see Section 0).
1.1	133
6.2	134	The ConstraintRoleType data type contains the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that identify the purpose of a (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) (allowableContent, actualContent).
1.1	135
6.2	136	The ComponentRoleType data type contains the predefined (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) roles that can be assigned to any Component.
1.1	137
6.1	138	The CascadeValues data type contains the possible values for a MemberValue within a CubeRegion, in order to enable cascading to all children [[Codes>>doc:sdmx:Glossary.Code.WebHome]] of a selected [[Code>>doc:sdmx:Glossary.Code.WebHome]], while including/excluding the latter in the selection.
1.1	139
6.1	140	The VersionType data types provides the details for versioning according to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6, paragraph “4.3 Versioning”.
1.1	141
2.4	142	== 3.5 The Item Scheme Pattern ==
1.1	143
2.4	144	=== 3.5.1 Context ===
1.1	145
6.1	146	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.
1.1	147
	148	The //ItemScheme// is the basis for CategoryScheme, Codelist, ConceptScheme, ReportingTaxonomy, //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme.
	149
2.4	150	=== 3.5.2 Class Diagram ===
1.1	151
	152	[[image:1749246130543-644.jpeg]]
	153
	154	Figure 13 The Item Scheme pattern
	155
2.4	156	=== 3.5.3 Explanation of the Diagram ===
1.1	157
2.4	158	==== 3.5.3.1 Narrative ====
1.1	159
6.2	160	The //ItemScheme// is an abstract class which defines a set of //Item// (this class is also abstract). Its main purpose is to define a mechanism which can be used to create taxonomies which can classify other parts of the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. 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 (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) are //Item//s.
1.1	161
6.1	162	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>>doc:sdmx:Glossary.Attribute.WebHome]] to "true".
1.1	163
6.2	164	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, (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%)). This is important as this is the id that that is referenced in other structures (e.g., a [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] 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//.
1.1	165
6.2	166	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>>doc:sdmx:Glossary.Code list.WebHome]] 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>>doc:sdmx:Glossary.Code list.WebHome]] are relevant. In this case a partial [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] can be constructed using the (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) mechanism explained later in this document.
1.1	167
6.1	168	//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 agencyId as the //ItemScheme//).
1.1	169
	170	The //Item// can be hierarchic and so one //Item// can have child //Item//s. The restriction of the hierarchic association is that a child //Item// can have only parent //Item//.
	171
2.4	172	==== 3.5.3.2 Definitions ====
1.1	173
2.4	174	(% style="width:989.835px" %)
	175	\|Class\|(% style="width:297px" %)Feature\|(% style="width:583px" %)Description
	176	\|//ItemScheme//\|(% style="width:297px" %)(((
1.1	177	Inherits from:
	178	//MaintainableArtefact//
	179	Direct sub classes are:
	180	CategoryScheme
	181	ConceptScheme
	182	Codelist
	183	ReportingTaxonomy
	184	//OrganisationScheme//
	185	TransformationScheme
	186	CustomTypeScheme NamePersonalisationSc heme
	187	RulesetScheme
2.4	188	VtlMappingScheme
	189	UserDefinedOperatorSc heme
	190	)))\|(% style="width:583px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.
6.1	191	\| \|(% style="width:297px" %)isPartial\|(% style="width:583px" %)Denotes whether the [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] contains a subset of the full set of Items in the maintained scheme.
2.4	192	\| \|(% style="width:297px" %)/items\|(% style="width:583px" %)Association to the Items in the scheme.
	193	\|//Item//\|(% style="width:297px" %)(((
1.1	194	Inherits from:
	195	//NameableArtefact//
	196	Direct sub classes are
	197	Category
6.2	198	(% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%)
6.1	199	[[Code>>doc:sdmx:Glossary.Code.WebHome]]
1.1	200	ReportingCategory //Organisation//
	201	Transformation
	202	CustomType
	203	NamePersonalisation
	204	Ruleset
	205	VtlMapping
	206	UserDefinedOperator// //hierarchy
2.4	207	)))\|(% style="width:583px" %)(((
6.2	208	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. Node that at the conceptual level the Organisation is not hierarchic.
1.1	209	This allows an Item optionally to have one or more child Items
	210	)))
	211
2.5	212	== 3.6 The Structure Pattern ==
1.1	213
2.5	214	=== 3.6.1 Context ===
1.1	215
6.1	216	The Structure Pattern is a basic architectural pattern which allows the specification of complex tabular structures which are often found in statistical data (such as [[Data Structure Definition>>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.
1.1	217
3.1	218	=== 3.6.2 Class Diagrams ===
1.1	219
3.1	220	(% class="wikigeneratedid" %)
	221	[[image:1749246130548-601.jpeg]]
	222
1.1	223	Figure 14: The Structure Pattern
	224
	225	[[image:1749246130554-995.jpeg]]
	226
	227	Figure 15: Representation within the Structure Pattern
	228
3.1	229	=== 3.6.3 Explanation of the Diagrams ===
1.1	230
3.1	231	==== 3.6.3.1 Narrative ====
1.1	232
	233	The //Structure// is an abstract class which contains a set of one or more //ComponentList//(s) (this class is also abstract). An example of a concrete //Structure// is DataStructureDefinition.
	234
6.1	235	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 MetadataAttributeDescriptor of the MetadataStructureDefinition.
1.1	236
6.1	237	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:
1.1	238
6.1	239	DimensionDescriptor: [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], TimeDimension
	240	GroupDimensionDescriptor: [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], TimeDimension
	241	MeasureDescriptor: [[Measure>>doc:sdmx:Glossary.Measure.WebHome]]
1.1	242	AttributeDescriptor: DataAttribute, MetadataAttributeRef
	243	MetadataAttributeDescriptor: MetadataAttribute
	244
6.2	245	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>>doc:sdmx:Glossary.Concept.WebHome]](%%) in a ConceptScheme. This is represented by the conceptIdentity association to (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%).
1.1	246
6.2	247	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>>doc:sdmx:Glossary.Concept.WebHome]](%%).
1.1	248
6.2	249	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 [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]], ValueList or //GeoCodelist//. The valid content of a non-enumerated [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is specified as one or more Facet(s) (for example, these may specify minimum and maximum values). For any [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] this is achieved by one of more
1.1	250
6.1	251	ExtendedFacet(s), which allow the additional [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of XHTML.
1.1	252
6.2	253	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>>doc:sdmx:Glossary.Constraint.WebHome]](%%) on the association:
1.1	254
6.1	255	* The [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], DataAttribute, [[Measure>>doc:sdmx:Glossary.Measure.WebHome]], MetadataAttribute may be enumerated and, if so, use an //EnumeratedList//.
6.2	256	* The [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] and [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] 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.
1.1	257	* The MetadataAttribute and DataAttribute may be non-enumerated and, if so, use one or more ExtendedFacet(s).
	258
6.1	259	The //Structure// may be used by one or more //StructureUsage//(s). An example of this, in terms of concrete classes, is that a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] (sub class of //StructureUsage//) may use a particular DataStructureDefinition (sub class of //Structure//), and similar constructs apply for the [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] (link to MetadataStructureDefinition).
1.1	260
3.1	261	==== 3.6.3.2 Definitions ====
1.1	262
	263	\|Class\|Feature\|Description
	264	\|StructureUsage\|(((
	265	Inherits from:
	266	//MaintainableArtefact//
	267	Sub classes are:
6.1	268	[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]
	269	[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]
	270	)))\|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]] which is linked to a given structure – in this case the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
	271	\| \|structure\|An association to a Structure specifying the structure of the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]].
1.1	272	\|Structure\|(((
	273	Inherits from:
	274	//MaintainableArtefact//
	275	Sub classes are:
	276	DataStructureDefinition MetadataStructureDefinit ion
6.2	277	)))\|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>>doc:sdmx:Glossary.Concept.WebHome]](%%), [[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.
6.1	278	\| \|grouping\|A composite association to one or more [[component>>doc:sdmx:Glossary.Component.WebHome]] lists.
1.1	279	\|//ComponentList//\|(((
	280	Inherits from:
	281	//IdentifiableArtefact//
	282	Sub classes are:
	283	DimensionDescriptor
	284	GroupDimensionDescriptor
	285	MeasureDescriptor
	286	AttributeDescriptor MetadataAttributeDescrip tor
6.1	287	)))\|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>>doc:sdmx:Glossary.Data structure definition.WebHome]].
	288	\| \|[[components>>doc:sdmx:Glossary.Component.WebHome]]\|An aggregate association to one or more [[components>>doc:sdmx:Glossary.Component.WebHome]] which make up the list.
	289	\|//[[Component>>doc:sdmx:Glossary.Component.WebHome]]//\|(((
1.1	290	Inherits from:
	291	//IdentifiableArtefact//
	292	Sub classes are:
6.1	293	[[Measure>>doc:sdmx:Glossary.Measure.WebHome]]
3.3	294	//AttributeComponent
	295	DimensionComponent//
6.1	296	)))\|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.
6.2	297	\| \|conceptIdentity\|Association to a (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) in a [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] that identifies and defines the semantic of the [[Component>>doc:sdmx:Glossary.Component.WebHome]].
1.1	298	\| \|localRepresentation\|(((
6.1	299	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
1.1	300
6.2	301	(% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%), which the [[Component>>doc:sdmx:Glossary.Component.WebHome]] uses (ConceptUsage).
1.1	302	)))
6.2	303	\|[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]\| \|The allowable value or format for [[Component>>doc:sdmx:Glossary.Component.WebHome]] or (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]]
	304	\| \|+enumerated\|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>>doc:sdmx:Glossary.Constraint.WebHome]](%%) on the association.
6.1	305	\| \|+nonEnumerated\|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]].
	306	\|[[Facet>>doc:sdmx:Glossary.Facet.WebHome]]\| \|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]].
	307	\| \|facetType\|A specific content type, which is constrained by the [[Facet>>doc:sdmx:Glossary.Facet.WebHome]] Type enumeration.
	308	\| \|facetValueType\|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]]. This is constrained by the [[Facet>>doc:sdmx:Glossary.Facet.WebHome]] Value Type enumeration.
	309	\| \|+itemSchemeFacet\|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.
	310	\|ExtendedFacet\| \|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]] and a Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
1.1	311
6.1	312	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). Moreover, the FacetType SentinelValues is explained in the datastructure [[representation>>doc:sdmx:Glossary.Representation.WebHome]] diagram (see 5.3.2.2), since it only concerns DataStructureDefinitions.
1.1	313
3.1	314	==== 3.6.3.3 Representation Constructs ====
1.1	315
6.1	316	The majority of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms:
1.1	317
4.1	318	\|(% style="width:198px" %)(((
3.1	319	SDMX Facet Value Type
4.1	320	)))\|(% style="width:204px" %)XML Schema Data Type\|(% style="width:209px" %)JSON Schema Data Type\|(% style="width:187px" %)(((
3.1	321	.NET Framework Type
4.1	322	)))\|(% style="width:817px" %)Java Data Type
	323	\|(% style="width:198px" %)String\|(% style="width:204px" %)xsd:string\|(% style="width:209px" %)string\|(% style="width:187px" %)System.String\|(% style="width:817px" %)java.lang.String
	324	\|(% style="width:198px" %)Big Integer\|(% style="width:204px" %)xsd:integer\|(% style="width:209px" %)integer\|(% style="width:187px" %)System.Decimal\|(% style="width:817px" %)java.math.BigInteger
	325	\|(% style="width:198px" %)Integer\|(% style="width:204px" %)xsd:int\|(% style="width:209px" %)integer\|(% style="width:187px" %)System.Int32\|(% style="width:817px" %)int
	326	\|(% style="width:198px" %)Long\|(% style="width:204px" %)xsd.long\|(% style="width:209px" %)integer\|(% style="width:187px" %)System.Int64\|(% style="width:817px" %)long
	327	\|(% style="width:198px" %)Short\|(% style="width:204px" %)xsd:short\|(% style="width:209px" %)integer\|(% style="width:187px" %)System.Int16\|(% style="width:817px" %)short
6.1	328	\|(% style="width:198px" %)[[Decimal>>doc:sdmx:Glossary.Decimals.WebHome]]\|(% style="width:204px" %)xsd:decimal\|(% style="width:209px" %)number\|(% style="width:187px" %)System.Decimal\|(% style="width:817px" %)java.math.BigDecimal
4.1	329	\|(% style="width:198px" %)Float\|(% style="width:204px" %)xsd:float\|(% style="width:209px" %)number\|(% style="width:187px" %)System.Single\|(% style="width:817px" %)float
	330	\|(% style="width:198px" %)Double\|(% style="width:204px" %)xsd:double\|(% style="width:209px" %)number\|(% style="width:187px" %)System.Double\|(% style="width:817px" %)double
	331	\|(% style="width:198px" %)Boolean\|(% style="width:204px" %)xsd:boolean\|(% style="width:209px" %)boolean\|(% style="width:187px" %)System.Boolean\|(% style="width:817px" %)boolean
	332	\|(% style="width:198px" %)URI\|(% style="width:204px" %)xsd:anyURI\|(% style="width:209px" %)string:uri\|(% style="width:187px" %)System.Uri\|(% style="width:817px" %)Java.net.URI or java.lang.String
	333	\|(% style="width:198px" %)DateTime\|(% style="width:204px" %)xsd:dateTime\|(% style="width:209px" %)string:datetime\|(% style="width:187px" %)System.DateTime\|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
	334	\|(% style="width:198px" %)Time\|(% style="width:204px" %)xsd:time\|(% style="width:209px" %)string:time\|(% style="width:187px" %)System.DateTime\|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
5.1	335	\|(% style="width:198px" %)GregorianYear\|(% style="width:204px" %)xsd:gYear\|(% style="width:209px" %)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}}\|(% style="width:187px" %)System.DateTime\|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
4.1	336	\|(% style="width:198px" %)GregorianMonth\|(% style="width:204px" %)xsd:gYearMonth\|(% style="width:209px" %)string\|(% style="width:187px" %)System.DateTime\|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
	337	\|(% style="width:198px" %)GregorianDay\|(% style="width:204px" %)xsd:date\|(% style="width:209px" %)string\|(% style="width:187px" %)System.DateTime\|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
	338	\|(% style="width:198px" %)Day, MonthDay, Month\|(% style="width:204px" %)xsd:g*\|(% style="width:209px" %)string\|(% style="width:187px" %)System.DateTime\|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar
	339	\|(% style="width:198px" %)Duration\|(% style="width:204px" %)xsd:duration\|(% style="width:209px" %)string\|(% style="width:187px" %)System.TimeSpan\|(% style="width:817px" %)javax.xml.datatype.Dur ation
1.1	340
6.1	341	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.
1.1	342
6.1	343	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.
1.1	344
3.1	345	(% style="width:981.835px" %)
	346	\|(% style="width:107px" %)Facet Type\|(% style="width:872px" %)Explanation
6.1	347	\|(% style="width:107px" %)isSequence\|(% style="width:872px" %)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 be supplied. If an end value is not given, then the sequence continues indefinitely.
	348	\|(% style="width:107px" %)interval\|(% style="width:872px" %)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.
	349	\|(% style="width:107px" %)startValue\|(% style="width:872px" %)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]] isused for a numeric sequence and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.
	350	\|(% style="width:107px" %)endValue\|(% style="width:872px" %)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.
	351	\|(% style="width:107px" %)timeInterval\|(% style="width:872px" %)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.
	352	\|(% style="width:107px" %)startTime\|(% style="width:872px" %)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]]). Thisnattribute is used for a time sequence and indicates the start time of thensequence. This value is mandatory for a time sequence to be expressed.
	353	\|(% style="width:107px" %)endTime\|(% style="width:872px" %)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) ofnthe sequence.
	354	\|(% style="width:107px" %)minLength\|(% style="width:872px" %)The minLength [[facet>>doc:sdmx:Glossary.Facet.WebHome]] specifies the minimum and length of the value in characters.
	355	\|(% style="width:107px" %)maxLength\|(% style="width:872px" %)The maxLength [[facet>>doc:sdmx:Glossary.Facet.WebHome]] specifies the maximum length of the value in characters.
	356	\|(% style="width:107px" %)minValue\|(% style="width:872px" %)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.
	357	\|(% style="width:107px" %)maxValue\|(% style="width:872px" %)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.
	358	\|(% style="width:107px" %)[[Decimals>>doc:sdmx:Glossary.Decimals.WebHome]]\|(% style="width:872px" %)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.
	359	\|(% style="width:107px" %)pattern\|(% style="width:872px" %)The pattern [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).
1.1	360
	361	----
	362
5.1	363	{{putFootnotes/}}