Interoperability Basis Platform

== 3.1 Introduction ==

The constructs in the [[SDMX>>doc:sdmx:Glossary 2\.1.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 2\.1.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// //identification of commonly found structures or “patterns” leads to easier understanding// //identification of patterns encourages re-use

12

13

Each of the class diagrams in this section views classes from the [[SDMX>>doc:sdmx:Glossary 2\.1.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.

14

15

== 3.2 Base Structures - Identification, Versioning, and Maintenance ==

16

17

=== 3.2.1 Class Diagram ===

18

19

[[image:image36.png]]

20

21

**Figure 10: SDMX Identification, Maintenance and Versioning**

22

23

=== 3.2.2 Explanation of the Diagram ===

24

25

==== 3.2.2.1 Narrative ====

26

27

This group of classes forms the nucleus of the administration [[facets>>doc:sdmx:Glossary 2\.1.Facet.WebHome]] of [[SDMX>>doc:sdmx:Glossary 2\.1.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.

28

29

All classes derived from the abstract class //AnnotableArtefact// may have [[Annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] (or notes): this supports the need to add notes to all [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] elements. The [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] is used to convey extra information to describe any [[SDMX>>doc:sdmx:Glossary 2\.1.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).

30

31

The //IdentifiableArtefact// is an abstract class that comprises the basic [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] needed for identification. Concrete classes based on //IdentifiableArtefact// all inherit the ability to be uniquely identified.

32

33

The (% style="background-color:#e74c3c" %)//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 2\.1.Representation.WebHome]] of a description in multiple locales (locale is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.). The //LocalisedString// supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of a description in one locale.

34

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 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”.

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

39

The inheritance chain from //AnnotableArtefact// through to //MaintainableArtefact// allows [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] classes to inherit the features they need, from simple [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]], through identity, naming, to versioning and maintenance.

40

41

==== 3.2.2.2 Definitions ====

42

43

(% style="width:973.835px" %)

44

|**Class**|(% style="width:262px" %)**Feature**|(% style="width:543px" %)**Description**

45

|//AnnotableArtefact//|(% style="width:262px" %)(((

46

Base inheritance sub classes are:

47

//IdentifiableArtefact//

48

)))|(% style="width:543px" %)Objects of classes derived from this can have attached [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]].

49

|(%%)(% id="confict-imterms-5" style="color:#9b59b6" %)[[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]]|(% style="width:262px" %)// //|(% style="width:543px" %)Additional descriptive information attached to an object.

50

| |(% style="width:262px" %)(% id="confict-imterms-6" style="color:#9b59b6" %)id|(% style="width:543px" %)Identifier for the [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]]. It can be used to disambiguate one [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] from another where there are several [[Annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] for the same annotated object.

51

| |(% style="width:262px" %)[[title>>doc:sdmx:Glossary 2\.1.Title.WebHome]]|(% style="width:543px" %)A [[title>>doc:sdmx:Glossary 2\.1.Title.WebHome]] used to identify an [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]].

52

| |(% style="width:262px" %)(% id="confict-imterms-7" style="color:#9b59b6" %)type|(% style="width:543px" %)Specifies how the [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] is to be processed.

53

| |(% style="width:262px" %)(% id="confict-imterms-8" style="color:#9b59b6" %)url|(% style="width:543px" %)A link to external descriptive text.

54

| |(% style="width:262px" %)(% id="confict-imterms-9" style="color:#9b59b6" %)value|(% style="width:543px" %)A non-localised version of the [[Annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] content.

55

| |(% style="width:262px" %)+(% id="confict-imterms-10" style="color:#9b59b6" %)url|(% style="width:543px" %)An International URI provides a set of links that are [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] specific, via this role.

56

| |(% style="width:262px" %)+text|(% style="width:543px" %)An [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] provides the multilingual text content of the [[annotation>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] via this role.

57

|InternationalUri|(% style="width:262px" %) |(% style="width:543px" %)The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales.

58

|LocalisedUri|(% style="width:262px" %) |(% style="width:543px" %)The Localised URI supports the link to an external description in one locale (locale is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.).

59

|//IdentifiableArtefact//|(% style="width:262px" %)(((

60

Superclass is //AnnotableArtefact//

61

Base inheritance sub classes are:

62

//NameableArtefact//

63

)))|(% style="width:543px" %)Provides identity to all derived classes. It also provides [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] to derived classes because it is a subclass of [[Annotable Artefact>>doc:sdmx:Glossary 2\.1.Annotable artefact.WebHome]].

64

| |(% style="width:262px" %)(% id="confict-imterms-11" style="color:#9b59b6" %)id|(% style="width:543px" %)The unique identifier of the object.

65

| |(% style="width:262px" %)(% id="confict-imterms-12" style="color:#9b59b6" %)uri|(% style="width:543px" %)Universal resource identifier that may or may not be resolvable.

66

| |(% style="width:262px" %)(% id="confict-imterms-13" style="color:#9b59b6" %)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:

69

//VersionableArtefact//

70

)))|(% style="width:543px" %)Provides a Name and Description to all derived classes in addition to identification and [[annotations>>doc:sdmx:Glossary 2\.1.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 2\.1.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 2\.1.International string.WebHome]] class

73

|InternationalString|(% style="width:262px" %) |(% style="width:543px" %)The [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] is a collection of Localised Strings and supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of text in multiple locales.

74

|LocalisedString|(% style="width:262px" %) |(% style="width:543px" %)The Localised String supports the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of text in one locale (locale is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.).

75

| |(% style="width:262px" %)label|(% style="width:543px" %)Label of the string.

76

| |(% style="width:262px" %)(% id="confict-imterms-14" style="color:#9b59b6" %)locale|(% style="width:543px" %)The geographic locale of the string e.g French, Canadian French.

77

|//VersionableArtefact//|(% style="width:262px" %)(((

78

Superclass is

79

//NameableArtefact//

80

Base inheritance sub classes are:

81

//MaintainableArtefact//

82

)))|(% style="width:543px" %)Provides versioning information for all derived objects.

83

| |(% style="width:262px" %)(% id="confict-imterms-15" style="color:#9b59b6" %)[[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]]|(% style="width:543px" %)A [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] string following [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules.

84

| |(% style="width:262px" %)(% id="confict-imterms-16" style="color:#9b59b6" %)validFrom|(% style="width:543px" %)Date from which the [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] is valid

85

| |(% style="width:262px" %)(% id="confict-imterms-17" style="color:#9b59b6" %)validTo|(% style="width:543px" %)Date from which [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] is superseded

86

|//MaintainableArtefact//|(% style="width:262px" %)(((

87

Inherits from

88

89

//VersionableArtefact//

90

)))|(% style="width:543px" %)An abstract class to group together primary [[structural metadata>>doc:sdmx:Glossary 2\.1.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] that are maintained by an Agency.

91

| |(% style="width:262px" %)(% id="confict-imterms-18" style="color:#9b59b6" %)[[isExternalReference>>doc:sdmx:Glossary 2\.1.isExternalReference.WebHome]]|(% style="width:543px" %)If set to “true” it indicates that the content of the object is held externally.

92

| |(% style="width:262px" %)structureURL|(% style="width:543px" %)The URL of an [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] document containing the external object.

93

| |(% style="width:262px" %)serviceURL|(% style="width:543px" %)The URL of an [[SDMX>>doc:sdmx:Glossary 2\.1.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 2\.1.Maintenance agency.WebHome]] responsible for maintaining the [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]].

95

|(%%)(% id="confict-imterms-19" style="color:#9b59b6" %)Agency|(% style="width:262px" %) |(% style="width:543px" %)See section on “Organisations”

96

97

== 3.3 Basic Inheritance ==

98

99

=== 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes ===

100

101

[[image:image37.png]]

102

103

**Figure 11: Basic Inheritance from the Base Structures**

104

105

=== 3.3.2 Explanation of the Diagram ===

106

107

==== 3.3.2.1 Narrative ====

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.

== 3.4 Data Types ==

=== 3.4.1 Class Diagram ===

114

115

[[image:image38.png]]

116

117

**Figure 12: Class Diagram of Basic Data Types**

118

119

=== 3.4.2 Explanation of the Diagram ===

120

121

==== 3.4.2.1 Narrative ====

122

123

The FacetType and FacetValueType enumerations are used to specify the valid format of the content of a non-enumerated (% id="confict-imterms-20" style="color:#9b59b6" %)[[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]](%%) or the usage of a (% id="confict-imterms-21" style="color:#9b59b6" %)[[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]](%%) when specified for use on a (% id="confict-imterms-22" style="color:#9b59b6" %)//[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]//(%%) on a (% id="confict-imterms-23" style="color:#9b59b6" %)//Structure//(%%) (such as a (% id="confict-imterms-24" style="color:#9b59b6" %)[[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]](%%) in a DataStructureDefinition). The description of the various types can be found in the chapter on (% id="confict-imterms-25" style="color:#9b59b6" %)ConceptScheme(%%) (section 4.5).

124

125

The ActionType enumeration is used to specify the (% id="confict-imterms-26" style="color:#9b59b6" %)action(%%) that a receiving system should take when processing the content that is the object of the (% id="confict-imterms-27" style="color:#9b59b6" %)action(%%). It is enumerated as follows:

126

127

* Append: Data or metadata is an [[incremental update>>doc:sdmx:Glossary 2\.1.Incremental update.WebHome]] for an existing data/[[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]] or the provision of new data or documentation ([[attribute>>doc:sdmx:Glossary 2\.1.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" (% id="confict-imterms-28" style="color:#9b59b6" %)value(%%) found in (% id="confict-imterms-29" %)version(%%) 1.0 of the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Technical Standards.

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

132

The ToValueType data (% id="confict-imterms-30" style="color:#9b59b6" %)type(%%) contains the [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] to support transformations defined in the StructureMap (see Section 0).

133

134

The ConstraintRoleType data (% id="confict-imterms-31" style="color:#9b59b6" %)type(%%) contains the [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] that identify the purpose of a [[Constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] (allowableContent, actualContent).

135

136

The ComponentRoleType data (% id="confict-imterms-32" style="color:#9b59b6" %)type(%%) contains the predefined (% id="confict-imterms-33" style="color:#9b59b6" %)[[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]](%%) roles that can be assigned to any (% id="confict-imterms-34" style="color:#9b59b6" %)[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]](%%).

137

138

The CascadeValues data (% id="confict-imterms-35" style="color:#9b59b6" %)type(%%) contains the possible values for a (% id="confict-imterms-36" style="color:#9b59b6" %)MemberValue(%%) within a CubeRegion, in order to enable cascading to all children [[Codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] of a selected (% id="confict-imterms-37" style="color:#9b59b6" %)[[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]](%%), while including/excluding the latter in the selection.

139

140

The VersionType data types provides the details for versioning according to [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Standards Section 6, paragraph “4.3 Versioning”.

141

142

== 3.5 The Item Scheme Pattern ==

143

144

=== 3.5.1 Context ===

145

146

The (% id="confict-imterms-38" style="color:#9b59b6" %)Item(%%) Scheme is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example.

147

148

The //ItemScheme// is the basis for (% id="confict-imterms-39" style="color:#9b59b6" %)CategoryScheme(%%), (% id="confict-imterms-40" style="color:#9b59b6" %)[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]](%%), (% id="confict-imterms-41" style="color:#9b59b6" %)ConceptScheme(%%), (% id="confict-imterms-42" style="color:#9b59b6" %)ReportingTaxonomy(%%), //OrganisationScheme//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme.

149

150

=== 3.5.2 Class Diagram ===

151

152

[[image:image39.png]]

153

154

**Figure 13 The (% id="confict-imterms-43" %)Item(%%) Scheme pattern**

155

156

=== 3.5.3 Explanation of the Diagram ===

157

158

==== 3.5.3.1 Narrative ====

159

160

The //ItemScheme// is an abstract class which defines a set of (% id="confict-imterms-44" style="color:#9b59b6" %)//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 2\.1.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 (% id="confict-imterms-45" style="color:#9b59b6" %)Agency(%%). An example of a concrete class is a (% id="confict-imterms-46" style="color:#9b59b6" %)ConceptScheme(%%). The associated [[Concepts>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] are (% id="confict-imterms-47" style="color:#9b59b6" %)//Item//(%%)s.

161

162

In an exchange environment an //ItemScheme// is allowed to contain a sub-set of the (% id="confict-imterms-48" style="color:#9b59b6" %)//Item//(%%)s in the maintained //ItemScheme//. If such an ItemScheme is disseminated with a sub-set of the (% id="confict-imterms-49" style="color:#9b59b6" %)//Item//(%%)s then the fact that this is a sub-set is denoted by setting the (% id="confict-imterms-50" style="color:#9b59b6" %)isPartial(%%) [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] to "true".

163

164

A “partial” //ItemScheme// cannot be maintained independently in its partial form i.e., it cannot contain (% id="confict-imterms-51" style="color:#9b59b6" %)//Item//(%%)s that are not present in the full //ItemScheme// and the content of any one (% id="confict-imterms-52" style="color:#9b59b6" %)//Item//(%%)// //(e.g., names and descriptions) cannot deviate from the content in the full //ItemScheme//. Furthermore, the (% id="confict-imterms-53" style="color:#9b59b6" %)id(%%) of the //ItemScheme// where (% id="confict-imterms-54" style="color:#9b59b6" %)isPartial(%%) is set to "true" is the same as the (% id="confict-imterms-55" style="color:#9b59b6" %)id(%%) of the full //ItemScheme// (agencyId, (% id="confict-imterms-56" style="color:#9b59b6" %)id(%%), (% id="confict-imterms-57" style="color:#9b59b6" %)[[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]](%%)). This is important as this is the (% id="confict-imterms-58" style="color:#9b59b6" %)id(%%) that that is referenced in other structures (e.g., a (% id="confict-imterms-59" style="color:#9b59b6" %)[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]](%%) referenced in a [[DSD>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]) and this (% id="confict-imterms-60" style="color:#9b59b6" %)id(%%) is always the same, regardless of whether the disseminated //ItemScheme// is the full //ItemScheme// or a partial //ItemScheme//.

165

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 (% id="confict-imterms-61" style="color:#9b59b6" %)//Item//(%%)s. For instance, when a (% id="confict-imterms-62" style="color:#9b59b6" %)[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]](%%) is used in a DataStructureDefinition it is sometimes the case that only a sub-set of the [[Codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] in a (% id="confict-imterms-63" style="color:#9b59b6" %)[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]](%%) are relevant. In this case a partial (% id="confict-imterms-64" style="color:#9b59b6" %)[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]](%%) can be constructed using the [[Constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] mechanism explained later in this document.

167

168

(% id="confict-imterms-65" style="color:#9b59b6" %)//Item//(%%) inherits from //NameableArtefact// which gives it the ability to be annotated and have identity, and therefore has (% id="confict-imterms-66" style="color:#9b59b6" %)id(%%), (% id="confict-imterms-67" style="color:#9b59b6" %)uri(%%) and (% id="confict-imterms-68" style="color:#9b59b6" %)urn(%%) [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]], a name and a description in the form of an InternationalString. Unlike the parent //ItemScheme//, the (% id="confict-imterms-69" style="color:#9b59b6" %)//Item//(%%) itself is not a //MaintainableArtefact// and therefore cannot have an independent (% id="confict-imterms-70" style="color:#9b59b6" %)Agency(%%) (i.e., it implicitly has the same agencyId as the //ItemScheme//).

169

170

The (% id="confict-imterms-71" style="color:#9b59b6" %)//Item//(%%) can be hierarchic and so one (% id="confict-imterms-72" style="color:#9b59b6" %)//Item//(%%) can have child (% id="confict-imterms-73" style="color:#9b59b6" %)//Item//(%%)s. The restriction of the hierarchic association is that a child (% id="confict-imterms-74" style="color:#9b59b6" %)//Item//(%%) can have only parent (% id="confict-imterms-75" style="color:#9b59b6" %)//Item//(%%).

171

172

==== 3.5.3.2 Definitions ====

173

174

(% style="width:989.835px" %)

175

|**Class**|(% style="width:297px" %)**Feature**|(% style="width:583px" %)**Description**

176

|//ItemScheme//|(% style="width:297px" %)(((

177

Inherits from:

178

//MaintainableArtefact//

179

Direct sub classes are:

180

(% id="confict-imterms-76" style="color:#9b59b6" %)CategoryScheme(%%)

181

(% id="confict-imterms-77" style="color:#9b59b6" %)ConceptScheme(%%)

182

(% id="confict-imterms-78" style="color:#9b59b6" %)[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]](%%)

183

(% id="confict-imterms-79" style="color:#9b59b6" %)ReportingTaxonomy(%%)

184

//OrganisationScheme//

185

TransformationScheme

186

CustomTypeScheme NamePersonalisationScheme

187

RulesetScheme

188

VtlMappingScheme

189

UserDefinedOperatorScheme

190

)))|(% style="width:583px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common.

191

| |(% style="width:297px" %)(% id="confict-imterms-80" style="color:#9b59b6" %)isPartial|(% style="width:583px" %)Denotes whether the [[Item Scheme>>doc:sdmx:Glossary 2\.1.Item scheme.WebHome]] contains a subset of the full set of Items in the maintained scheme.

192

| |(% style="width:297px" %)/items|(% style="width:583px" %)Association to the Items in the scheme.

193

|(%%)(% id="confict-imterms-81" style="color:#9b59b6" %)//Item//|(% style="width:297px" %)(((

194

Inherits from:

195

//NameableArtefact//

196

Direct sub classes are

197

(% id="confict-imterms-82" style="color:#9b59b6" %)[[Category>>doc:sdmx:Glossary 2\.1.Category.WebHome]](%%)

198

(% id="confict-imterms-83" style="color:#9b59b6" %)[[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]](%%)

199

(% id="confict-imterms-84" style="color:#9b59b6" %)[[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]](%%)

200

(% id="confict-imterms-85" style="color:#9b59b6" %)ReportingCategory(%%)

201

(% id="confict-imterms-86" style="color:#9b59b6" %)//Organisation//(%%)

Transformation

CustomType

NamePersonalisation

Ruleset

VtlMapping

UserDefinedOperator

)))|(% style="width:583px" %)(((

209

The Item is an item of content in an [[Item Scheme>>doc:sdmx:Glossary 2\.1.Item scheme.WebHome]]. This may be a node in a taxonomy or ontology, a [[code>>doc:sdmx:Glossary 2\.1.Code.WebHome]] in a [[code list>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] etc. Node that at the conceptual level the Organisation is not hierarchic.

210

)))

211

| |(% style="width:297px" %)[[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]]|(% style="width:583px" %)This allows an Item optionally to have one or more child Items

212

213

== 3.6 The Structure Pattern ==

214

215

=== 3.6.1 Context ===

216

217

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 (% id="confict-imterms-88" %)Structure(%%) Definition, and Metadata (% id="confict-imterms-89" %)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.

218

219

=== 3.6.2 Class Diagrams ===

220

221

[[image:image40.png]]

222

223

**Figure 14: The (% id="confict-imterms-91" style="color:#9b59b6" %)Structure(%%) Pattern**

224

225

[[image:image41.png]]

226

227

**Figure 15: (% id="confict-imterms-92" style="color:#9b59b6" %)Representation(%%) within the (% id="confict-imterms-93" style="color:#9b59b6" %)Structure(%%) Pattern**

228

229

=== 3.6.3 Explanation of the Diagrams ===

230

231

==== 3.6.3.1 Narrative ====

232

233

The (% id="confict-imterms-94" style="color:#9b59b6" %)//Structure//(%%) is an abstract class which contains a set of one or more (% id="confict-imterms-95" style="color:#9b59b6" %)//ComponentList//(%%)(s) (this class is also abstract). An example of a concrete (% id="confict-imterms-96" style="color:#9b59b6" %)//Structure//(%%) is DataStructureDefinition.

234

235

The (% id="confict-imterms-97" style="color:#9b59b6" %)//ComponentList//(%%) is a list of one or more (% id="confict-imterms-98" style="color:#9b59b6" %)//Component//(%%)(s//)//. The (% id="confict-imterms-99" style="color:#9b59b6" %)//ComponentList//(%%) has several concrete descriptor classes based on it: DimensionDescriptor, GroupDimensionDescriptor, MeasureDescriptor, and AttributeDescriptor of the DataStructureDefinition and MetadataAttributeDescriptor of the (% id="confict-imterms-100" style="color:#9b59b6" %)MetadataStructureDefinition(%%).

236

237

The (% id="confict-imterms-101" style="color:#9b59b6" %)//Component//(%%) is contained in a (% id="confict-imterms-102" style="color:#9b59b6" %)//ComponentList//(%%). The (% id="confict-imterms-103" style="color:#9b59b6" %)type(%%) of (% id="confict-imterms-104" style="color:#9b59b6" %)//Component//(%%) in a (% id="confict-imterms-105" style="color:#9b59b6" %)//ComponentList//(%%) is dependent on the concrete class of the (% id="confict-imterms-106" style="color:#9b59b6" %)ComponentList(%%) as follows:

238

239

DimensionDescriptor: (% id="confict-imterms-107" style="color:#9b59b6" %)Dimension(%%), (% id="confict-imterms-108" style="color:#9b59b6" %)TimeDimension(%%)

240

GroupDimensionDescriptor: (% id="confict-imterms-109" style="color:#9b59b6" %)Dimension(%%), (% id="confict-imterms-110" style="color:#9b59b6" %)TimeDimension(%%)

241

MeasureDescriptor: (% id="confict-imterms-111" style="color:#9b59b6" %)Measure(%%)

242

AttributeDescriptor: DataAttribute, MetadataAttributeRef

243

MetadataAttributeDescriptor: (% id="confict-imterms-112" style="color:#9b59b6" %)MetadataAttribute

244

245

Each (% id="confict-imterms-113" style="color:#9b59b6" %)//Component//(%%) takes its semantic (and possibly also its representation) from a (% id="confict-imterms-114" style="color:#9b59b6" %)Concept(%%) in a (% id="confict-imterms-115" style="color:#9b59b6" %)ConceptScheme(%%). This is represented by the conceptIdentity association to (% id="confict-imterms-116" style="color:#9b59b6" %)Concept(%%).

246

247

The (% id="confict-imterms-117" style="color:#9b59b6" %)//Component//(%%) may also have a localRepresentation. This allows a concrete class, such as (% id="confict-imterms-118" style="color:#9b59b6" %)Dimension(%%), to specify its representation which is local to the (% id="confict-imterms-119" style="color:#9b59b6" %)//Structure//(%%) in which it is contained (for (% id="confict-imterms-120" style="color:#9b59b6" %)Dimension(%%) this will be DataStructureDefinition), and thus overrides any coreRepresentation specified for the (% id="confict-imterms-121" style="color:#9b59b6" %)Concept(%%).

248

249

The (% id="confict-imterms-122" style="color:#9b59b6" %)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 (% id="confict-imterms-123" style="color:#9b59b6" %)Codelist(%%), (% id="confict-imterms-124" style="color:#9b59b6" %)ValueList(%%) or //GeoCodelist//. The valid content of a non-enumerated representation is specified as one or more (% id="confict-imterms-125" style="color:#9b59b6" %)Facet(%%)(s) (for example, these may specify minimum and maximum values). For any Attribute this is achieved by one of more

250

251

ExtendedFacet(s), which allow the additional representation of XHTML.

252

253

The types of representation that are valid for specific components is expressed in the model as a constraint on the association:

254

255

* The (% id="confict-imterms-126" style="color:#9b59b6" %)Dimension(%%), DataAttribute, (% id="confict-imterms-127" style="color:#9b59b6" %)Measure(%%), (% id="confict-imterms-128" style="color:#9b59b6" %)MetadataAttribute(%%) may be enumerated and, if so, use an //EnumeratedList//.

256

* The (% id="confict-imterms-129" style="color:#9b59b6" %)Dimension(%%) and (% id="confict-imterms-130" style="color:#9b59b6" %)Measure(%%) may be non-enumerated and, if so, use one or more (% id="confict-imterms-131" style="color:#9b59b6" %)Facet(%%)(s), note that the FacetValueType applicable to the (% id="confict-imterms-132" style="color:#9b59b6" %)TimeDimension(%%) is restricted to those that represent time.

257

* The (% id="confict-imterms-133" style="color:#9b59b6" %)MetadataAttribute(%%) and DataAttribute may be non-enumerated and, if so, use one or more ExtendedFacet(s).

258

259

The (% id="confict-imterms-134" style="color:#9b59b6" %)//Structure//(%%) may be used by one or more (% id="confict-imterms-135" style="color:#9b59b6" %)//StructureUsage//(%%)(s). An example of this, in terms of concrete classes, is that a (% id="confict-imterms-136" style="color:#9b59b6" %)Dataflow(%%) (sub class of (% id="confict-imterms-137" style="color:#9b59b6" %)//StructureUsage//(%%)) may use a particular DataStructureDefinition (sub class of (% id="confict-imterms-138" style="color:#9b59b6" %)//Structure//(%%)), and similar constructs apply for the (% id="confict-imterms-139" style="color:#9b59b6" %)Metadataflow(%%) (link to (% id="confict-imterms-140" style="color:#9b59b6" %)MetadataStructureDefinition(%%)).

260

261

==== 3.6.3.2 Definitions ====

262

263

(% style="width:1368.29px" %)

264

|**Class**|**Feature**|(% style="width:897px" %)**Description**

265

|(%%)(% id="confict-imterms-141" style="color:#9b59b6" %)StructureUsage|(((

266

Inherits from:

267

//MaintainableArtefact//

268

Sub classes are:

269

(% id="confict-imterms-142" style="color:#9b59b6" %)Dataflow(%%)

270

(% id="confict-imterms-143" style="color:#9b59b6" %)Metadataflow

271

)))|(% style="width:897px" %)An artefact whose components are described by a Structure. In concrete terms (sub-classes) an example would be a Dataflow which is linked to a given structure – in this case the Data Structure Definition.

272

| |structure|(% style="width:897px" %)An association to a Structure specifying the structure of the artefact.

273

|(%%)(% id="confict-imterms-144" style="color:#9b59b6" %)Structure|(((

274

Inherits from:

275

//MaintainableArtefact//

276

Sub classes are:

277

DataStructureDefinition (% id="confict-imterms-145" style="color:#9b59b6" %)MetadataStructureDefinition

278

)))|(% style="width:897px" %)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.

279

| |grouping|(% style="width:897px" %)A composite association to one or more component lists.

280

|(%%)(% id="confict-imterms-146" style="color:#9b59b6" %)//ComponentList//|(((

281

Inherits from:

282

//IdentifiableArtefact//

283

Sub classes are:

284

DimensionDescriptor

285

GroupDimensionDescriptor

286

MeasureDescriptor

287

AttributeDescriptor MetadataAttributeDescriptor

288

)))|(% style="width:897px" %)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.

289

| |components|(% style="width:897px" %)An aggregate association to one or more components which make up the list.

290

|(%%)(% id="confict-imterms-147" style="color:#9b59b6" %)//Component//|(((

291

Inherits from:

292

//IdentifiableArtefact//

293

Sub classes are:

294

(% id="confict-imterms-148" style="color:#9b59b6" %)Measure(%%)

295

//AttributeComponent

296

DimensionComponent//

297

)))|(% style="width:897px" %)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.

298

| |conceptIdentity|(% style="width:897px" %)Association to a Concept in a Concept Scheme that identifies and defines the semantic of the Component.

299

| |localRepresentation|(% style="width:897px" %)(((

300

Association to the Representation of the Component if this is different from the coreRepresentation of the Concept, which the Component uses (ConceptUsage).

301

)))

302

|(%%)(% id="confict-imterms-149" style="color:#9b59b6" %)Representation| |(% style="width:897px" %)The allowable value or format for Component or Concept

303

| |+enumerated|(% style="width:897px" %)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.

304

| |+nonEnumerated|(% style="width:897px" %)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.

305

|(%%)(% id="confict-imterms-150" style="color:#9b59b6" %)Facet| |(% style="width:897px" %)Defines the format for the content of the Component when reported in a data or metadata set.

306

| |facetType|(% style="width:897px" %)A specific content type, which is constrained by the Facet Type enumeration.

307

| |facetValueType|(% style="width:897px" %)The format of the value of a Component when reported in a data or metadata set. This is constrained by the Facet Value Type enumeration.

308

| |+itemSchemeFacet|(% style="width:897px" %)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.

309

|ExtendedFacet| |(% style="width:897px" %)This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata Attribute and a Data Attribute.

310

311

The specification of the content and use of the sub classes to (% id="confict-imterms-151" style="color:#9b59b6" %)//ComponentList//(%%) and (% id="confict-imterms-152" style="color:#9b59b6" %)//Component//(%%) can be found in the section in which they are used (DataStructureDefinition and (% id="confict-imterms-153" style="color:#9b59b6" %)MetadataStructureDefinition(%%)). Moreover, the FacetType SentinelValues is explained in the datastructure representation diagram (see 5.3.2.2), since it only concerns DataStructureDefinitions.

312

313

==== 3.6.3.3 Representation Constructs ====

314

315

The majority of SDMX FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms:

316

317

|(% style="width:198px" %)(((

318

**SDMX (% id="confict-imterms-154" style="color:#9b59b6" %)Facet(%%) Value Type**

319

)))|(% style="width:204px" %)**XML Schema Data Type**|(% style="width:209px" %)**JSON Schema Data Type**|(% style="width:187px" %)(((

320

**.NET Framework Type**

321

)))|(% style="width:817px" %)**Java Data Type**

|(% style="width:198px" %)URI|(% style="width:204px" %)xsd:anyURI|(% style="width:209px" %)string:(% id="confict-imterms-155" style="color:#9b59b6" %)uri|(% style="width:187px" %)System.Uri|(% style="width:817px" %)Java.net.URI or java.lang.String

332

|(% 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

333

334

|(% 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

335

|(% 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

336

|(% 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

337

|(% 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

338

339

340

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 (% id="confict-imterms-156" style="color:#9b59b6" %)type(%%). These are detailed in Section 6 of the standards.

341

342

The (% id="confict-imterms-157" style="color:#9b59b6" %)Representation(%%) is composed of Facets, each of which conveys characteristic information related to the definition of a (% id="confict-imterms-158" style="color:#9b59b6" %)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 (% id="confict-imterms-159" style="color:#9b59b6" %)value(%%), and one to define the interval.

343

344

(% style="width:981.835px" %)

345

|(% style="width:107px" %)(% id="confict-imterms-160" style="color:#9b59b6" %)**Facet**(%%)** Type**|(% style="width:872px" %)**Explanation**

346

|(% style="width:107px" %)isSequence|(% style="width:872px" %)The isSequence facet indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue,and endValue facet or the timeInterval, (% id="confict-imterms-161" style="color:#9b59b6" %)startTime(%%), and endTime, facets. If this attribute holds a (% id="confict-imterms-162" style="color:#9b59b6" %)value(%%) of true, a start (% id="confict-imterms-163" style="color:#9b59b6" %)value(%%) or time and a numeric or time interval must be supplied. If an end (% id="confict-imterms-164" style="color:#9b59b6" %)value(%%) is not given, then the sequence continues indefinitely.

347

|(% style="width:107px" %)interval|(% style="width:872px" %)The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a (% id="confict-imterms-165" style="color:#9b59b6" %)value(%%) of true.

348

|(% style="width:107px" %)startValue|(% style="width:872px" %)The startValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet isused for a numeric sequence and indicates the starting point of the sequence. This (% id="confict-imterms-166" style="color:#9b59b6" %)value(%%) is mandatory for a numeric sequence to be expressed.

349

|(% style="width:107px" %)endValue|(% style="width:872px" %)The endValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric sequence and indicates that ending point (if any) of the sequence.

350

|(% style="width:107px" %)timeInterval|(% style="width:872px" %)The timeInterval facet indicates the permitted duration in a time sequence. In order for this to be used, the isSequence facet must have a (% id="confict-imterms-167" style="color:#9b59b6" %)value(%%) of true.

351

|(% style="width:107px" %)(% id="confict-imterms-168" style="color:#9b59b6" %)startTime|(% style="width:872px" %)The (% id="confict-imterms-169" style="color:#9b59b6" %)startTime(%%) facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). Thisnattribute is used for a time sequence and indicates the start time of thensequence. This (% id="confict-imterms-170" style="color:#9b59b6" %)value(%%) is mandatory for a time sequence to be expressed.

352

|(% style="width:107px" %)endTime|(% style="width:872px" %)The endTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). This facet is used for a time sequence and indicates that ending point (if any) ofnthe sequence.

353

|(% style="width:107px" %)minLength|(% style="width:872px" %)The minLength facet specifies the minimum and length of the (% id="confict-imterms-171" style="color:#9b59b6" %)value(%%) in characters.

354

|(% style="width:107px" %)maxLength|(% style="width:872px" %)The maxLength facet specifies the maximum length of the (% id="confict-imterms-172" style="color:#9b59b6" %)value(%%) in characters.

355

|(% style="width:107px" %)minValue|(% style="width:872px" %)The minValue facet is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid (% id="confict-imterms-173" style="color:#9b59b6" %)value(%%) will be greater than or equal to the (% id="confict-imterms-174" style="color:#9b59b6" %)value(%%) specified here. If the inclusive and exclusive data (% id="confict-imterms-175" style="color:#9b59b6" %)type(%%) is not specified (e.g., this facet is used with an integer data (% id="confict-imterms-176" style="color:#9b59b6" %)type(%%)), the (% id="confict-imterms-177" style="color:#9b59b6" %)value(%%) is assumed to be inclusive.

356

|(% style="width:107px" %)maxValue|(% style="width:872px" %)The maxValue facet is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid (% id="confict-imterms-178" style="color:#9b59b6" %)value(%%) will be less than or equal to the (% id="confict-imterms-179" style="color:#9b59b6" %)value(%%) specified here. If the inclusive and exclusive data (% id="confict-imterms-180" style="color:#9b59b6" %)type(%%) is not specified (e.g., this facet is used with an integer data (% id="confict-imterms-181" style="color:#9b59b6" %)type(%%)), the (% id="confict-imterms-182" style="color:#9b59b6" %)value(%%) is assumed to be inclusive.

357

|(% style="width:107px" %)Decimals|(% style="width:872px" %)The decimals facet indicates the number of characters allowed after the decimal separator.

358

|(% style="width:107px" %)pattern|(% style="width:872px" %)The pattern attribute holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema).

----

Wiki source code of 3 SDMX Base Package