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

From version 8.3
edited by Helena
on 2025/05/16 13:50
Change comment: There is no comment for this version
To version 10.2
edited by Helena
on 2025/05/19 13:50
Change comment: Update document after refactoring.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +Methodology.SDMX STANDARDS\: SECTION 2\. INFORMATION MODEL\: UML CONCEPTUAL DESIGN Version 3\.0.WebHome
Content
... ... @@ -4,15 +4,15 @@
4 4  
5 5  == 5.1 Introduction ==
6 6  
7 -The DataStructureDefiniton is the class name for a structure definition for data. Some organisations know this type of definition as a “Key Family” and so the two names are synonymous. The term Data Structure Definition (also referred to as DSD) is used in this specification.
7 +The DataStructureDefiniton is the class name for a structure definition for data. Some organisations know this type of definition as a “Key Family” and so the two names are synonymous. The term [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] (also referred to as [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]]) is used in this specification.
8 8  
9 -Many of the constructs in this layer of the model inherit from the SDMX Base Layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual packages. In simple sub models these are shown in the same diagram but are omitted from the more complex sub models for the sake of clarity. In these cases, the inheritance diagram below shows the full inheritance tree for the classes concerned with data structure definitions.
9 +Many of the constructs in this layer of the model inherit from the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base Layer. Therefore, it is necessary to study both the inheritance and the relationship diagrams to understand the functionality of individual packages. In simple sub models these are shown in the same diagram but are omitted from the more complex sub models for the sake of clarity. In these cases, the inheritance diagram below shows the full inheritance tree for the classes concerned with data structure definitions.
10 10  
11 -There are very few additional classes in this sub model other than those shown in the inheritance diagram below. In other words, the SDMX Base gives most of the structure of this sub model both in terms of associations and in terms of attributes. The relationship diagrams shown in this section show clearly when these associations are inherited from the SDMX Base (see the Appendix “A Short Guide to UML in the SDMX Information Model” to see the diagrammatic notation used to depict this).
11 +There are very few additional classes in this sub model other than those shown in the inheritance diagram below. In other words, the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base gives most of the structure of this sub model both in terms of associations and in terms of [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]. The relationship diagrams shown in this section show clearly when these associations are inherited from the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base (see the Appendix “A Short Guide to UML in the [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]” to see the diagrammatic notation used to depict this).
12 12  
13 -The actual SDMX Base construct from which the concrete classes inherit depends upon the requirements of the class for:
13 +The actual [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base construct from which the concrete classes inherit depends upon the requirements of the class for:
14 14  
15 -Annotation – //AnnotableArtefact//
15 +[[Annotation>>doc:xwiki:Glossary.Annotation.WebHome]] – //AnnotableArtefact//
16 16  Identification – //IdentifiableArtefact//
17 17  Naming – //NameableArtefact//
18 18  Versioning – //VersionableArtefact//
... ... @@ -30,29 +30,29 @@
30 30  
31 31  ==== 5.2.2.1 Narrative ====
32 32  
33 -Those classes in the SDMX metamodel which require annotations inherit from //AnnotableArtefact//. These are:
33 +Those classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]] inherit from //AnnotableArtefact//. These are:
34 34  
35 35  //IdentifiableArtefact
36 -DataSet
36 +[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]
37 37  Key// (and therefore //SeriesKey// and //GroupKey//)
38 38  //Observation//
39 39  
40 -Those classes in the SDMX metamodel which require annotations and global identity are derived from //IdentifiableArtefact//. These are:
40 +Those classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]] and global identity are derived from //IdentifiableArtefact//. These are:
41 41  
42 42  //NameableArtefact
43 43  ComponentList
44 -Component//
44 +[[Component>>doc:xwiki:Glossary.Component.WebHome]]//
45 45  
46 -Those classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description are derived from //NameableArtefact//. These are:
46 +Those classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]], global identity, multilingual name and multilingual description are derived from //NameableArtefact//. These are:
47 47  
48 48  //VersionableArtefact
49 49  Item//
50 50  
51 -The classes in the SDMX metamodel which require annotations, global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact//. These are:
51 +The classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:xwiki:Glossary.Annotation.WebHome]], global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact//. These are:
52 52  
53 53  //MaintainableArtefact//
54 54  
55 -Abstract classes which represent information that is maintained by Maintenance Agencies all inherit from //MaintainableArtefact//, they also inherit all the features of a //VersionableArtefact//, and are:
55 +Abstract classes which represent information that is maintained by [[Maintenance Agencies>>doc:xwiki:Glossary.Maintenance agency.WebHome]] all inherit from //MaintainableArtefact//, they also inherit all the features of a //VersionableArtefact//, and are:
56 56  
57 57  //StructureUsage
58 58  Structure
... ... @@ -60,29 +60,29 @@
60 60  
61 61  All the above classes are abstract. The key to understanding the class diagrams presented in this section are the concrete classes that inherit from these abstract classes.
62 62  
63 -Those concrete classes in the SDMX Data Structure Definition and Dataset packages of the metamodel which require to be maintained by Agencies all inherit (via other abstract classes) from //MaintainableArtefact//, these are:
63 +Those concrete classes in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] and [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]] packages of the metamodel which require to be maintained by Agencies all inherit (via other abstract classes) from //MaintainableArtefact//, these are:
64 64  
65 65  Dataflow
66 66  DataStructureDefinition
67 67  
68 -The component structures that are lists of lists, inherit directly from //Structure//. A //Structure// contains several lists of components. The concrete class that inherits from //Structure// is:
68 +The [[component>>doc:xwiki:Glossary.Component.WebHome]] structures that are lists of lists, inherit directly from //Structure//. A //Structure// contains several lists of [[components>>doc:xwiki:Glossary.Component.WebHome]]. The concrete class that inherits from //Structure// is:
69 69  
70 70  DataStructureDefinition
71 71  
72 -A DataStructureDefinition contains a list of dimensions, a list of measures and a list of attributes.
72 +A DataStructureDefinition contains a list of [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]], a list of [[measures>>doc:xwiki:Glossary.Measure.WebHome]] and a list of attributes.
73 73  
74 74  The concrete classes which inherit from //ComponentList// and are subcomponents of the DataStructureDefinition are:
75 75  
76 -DimensionDescriptor – content is Dimension and TimeDimension
77 -DimensionGroupDescriptor – content is an association to Dimension, TimeDimension
76 +DimensionDescriptor – content is [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] and TimeDimension
77 +DimensionGroupDescriptor – content is an association to [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension
78 78  MeasureDescriptor – content is Measure
79 79  AttributeDescriptor – content is DataAttribute and an association to MetadataAttribute
80 80  
81 -The classes that inherit from //Component// are:
81 +The classes that inherit from //[[Component>>doc:xwiki:Glossary.Component.WebHome]]// are:
82 82  
83 83  Measure
84 84  
85 -//DimensionComponent// and thereby its sub classes of Dimension and TimeDimension
85 +//DimensionComponent// and thereby its sub classes of [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] and TimeDimension
86 86  //Attribute// and thereby its sub classes of DataAttribute and MetadataAttribute
87 87  
88 88  The concrete classes identified above are the majority of the classes required to define the metamodel for the DataStructureDefinition. The diagrams and explanations in the rest of this section show how these concrete classes are related in order to support the functionality required.
... ... @@ -99,42 +99,42 @@
99 99  
100 100  ==== 5.3.2.1 Narrative ====
101 101  
102 -A DataStructureDefinition defines the Dimensions, TimeDimension, DataAttributes, and Measures, and associated Representations, that comprise the valid structure of data and related attributes that are contained in a DataSet, which is defined by a Dataflow. In addition, a DataStructureDefinition may be related to one MetadataStructureDefinition, in order to use the latter’s MetadataAttributes, by relating them to other //Components// within the DSD, as explained below.
102 +A DataStructureDefinition defines the [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension, DataAttributes, and [[Measures>>doc:xwiki:Glossary.Measure.WebHome]], and associated [[Representations>>doc:xwiki:Glossary.Representation.WebHome]], that comprise the valid structure of data and related [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] that are contained in a [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]], which is defined by a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]. In addition, a DataStructureDefinition may be related to one MetadataStructureDefinition, in order to use the latter’s MetadataAttributes, by relating them to other //[[Components>>doc:xwiki:Glossary.Component.WebHome]]// within the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]], as explained below.
103 103  
104 -The Dataflow may also have additional metadata attached that define qualitative information and Constraints on the use of the DataStructureDefinition such as the subset of Codes used in a Dimension (this is covered later in this document – see sections “Constraints” and “Data Provisioning”). Each Dataflow has a maximum of one DataStructureDefinition specified which defines the structure of any DataSets to be reported/disseminated.
104 +The [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] may also have additional metadata attached that define qualitative information and (% style="color:#2ecc71" %)Constraints(%%) on the use of the DataStructureDefinition such as the subset of [[Codes>>doc:xwiki:Glossary.Code.WebHome]] used in a [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] (this is covered later in this document – see sections “(% style="color:#2ecc71" %)Constraints(%%)” and “Data Provisioning”). Each [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] has a maximum of one DataStructureDefinition specified which defines the structure of any [[DataSets>>doc:xwiki:Glossary.Data set.WebHome]] to be reported/disseminated.
105 105  
106 -There are two types of dimensions each having a common association to Concept:
106 +There are two types of [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] each having a common association to (% style="color:#2ecc71" %)Concept(%%):
107 107  
108 -* Dimension
108 +* [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]]
109 109  * TimeDimension
110 110  
111 -Note that DimensionComponent can be any or all its sub classes i.e., Dimension, TimeDimension.
111 +Note that DimensionComponent can be any or all its sub classes i.e., [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension.
112 112  
113 -The //DimensionComponent//, DataAttribute, MetadataAttribute and Measure link to the Concept that defines its name and semantic (/conceptIdentity association to Concept). The DataAttribute, Dimension (but not TimeDimension) and Measure can optionally have a +conceptRole association with a Concept that identifies its role in the DataStructureDefinition, or one of the standard pre-defined roles, i.e., those published in "GUIDELINES FOR SDMX CONCEPT ROLES" by the SDMX SWG. The use of these roles is to enable applications to process the data in a meaningful way (e.g., relating a dimension value to a mapping vector). It is expected, beyond the standard roles published by the SWG, that communities (such as the official statistics community) will harmonise such roles within their community so that data can be exchanged and shared in a meaningful way within that community.
113 +The //DimensionComponent//, DataAttribute, MetadataAttribute and [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] link to the (% style="color:#2ecc71" %)Concept(%%) that defines its name and semantic (/conceptIdentity association to (% style="color:#2ecc71" %)Concept(%%)). The DataAttribute, [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] (but not TimeDimension) and [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] can optionally have a +conceptRole association with a (% style="color:#2ecc71" %)Concept(%%) that identifies its role in the DataStructureDefinition, or one of the standard pre-defined roles, i.e., those published in "GUIDELINES FOR [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#2ecc71" %)CONCEPT(%%) ROLES" by the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] SWG. The use of these roles is to enable applications to process the data in a meaningful way (e.g., relating a [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] value to a mapping vector). It is expected, beyond the standard roles published by the SWG, that communities (such as the official statistics community) will harmonise such roles within their community so that data can be exchanged and shared in a meaningful way within that community.
114 114  
115 -The valid values for a //DimensionComponent//, Measure, DataAttribute or MetadataAttribute, when used in this DataStructureDefinition, are defined by the Representation. This Representation is taken from the Concept definition (coreRepresentation) unless it is overridden in this DataStructureDefinition (localRepresentation) – see Figure 28. Note also that TimeDimension is constrained to specific FacetValueTypes. Moreover, the Representations of MetadataAttributes are specified in the corresponding MetadataStructureDefinition, linked by the DataStructureDefinition.
115 +The valid values for a //DimensionComponent//, [[Measure>>doc:xwiki:Glossary.Measure.WebHome]], DataAttribute or MetadataAttribute, when used in this DataStructureDefinition, are defined by the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]]. This [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] is taken from the (% style="color:#2ecc71" %)Concept(%%) definition (coreRepresentation) unless it is overridden in this DataStructureDefinition (localRepresentation) – see Figure 28. Note also that TimeDimension is constrained to specific FacetValueTypes. Moreover, the [[Representations>>doc:xwiki:Glossary.Representation.WebHome]] of MetadataAttributes are specified in the corresponding MetadataStructureDefinition, linked by the DataStructureDefinition.
116 116  
117 -There will always be a DimensionDescriptor grouping that identifies all of the Dimension comprising the full key. Together the Dimensions specify the key of an Observation.
117 +There will always be a DimensionDescriptor grouping that identifies all of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] comprising the full key. Together the [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] specify the key of an Observation.
118 118  
119 -The //DimensionComponent// can optionally be grouped by multiple GroupDimensionDescriptors each of which identifies the group of Dimensions that can form a partial key. The GroupDimensionDescriptor must be identified (GroupDimensionDescriptor.id) and this is used in the GroupKey of the DataSet to declare which DataAttributes or MetadataAttributes are reported at this group level in the DataSet.
119 +The //DimensionComponent// can optionally be grouped by multiple GroupDimensionDescriptors each of which identifies the group of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] that can form a partial key. The GroupDimensionDescriptor must be identified (GroupDimensionDescriptor.id) and this is used in the GroupKey of the [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]] to declare which DataAttributes or MetadataAttributes are reported at this group (% style="color:#2ecc71" %)level(%%) in the [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]].
120 120  
121 -There can be a maximum of one TimeDimension specified in the DimensionDescriptor. The TimeDimension is used to specify the Concept used to convey the time period of the observation in a data set. The TimeDimension must contain a valid representation of time and cannot be coded.
121 +There can be a maximum of one TimeDimension specified in the DimensionDescriptor. The TimeDimension is used to specify the (% style="color:#2ecc71" %)Concept(%%) used to convey the [[time period>>doc:xwiki:Glossary.Time period.WebHome]] of the observation in a [[data set>>doc:xwiki:Glossary.Data set.WebHome]]. The TimeDimension must contain a valid [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of time and cannot be coded.
122 122  
123 -here can be one or more Measures under the MeasureDescriptor. Measures represent the observable phenomena. Each Measure may have a valid representation, a maxOccurs attribute limiting the maximum number of values per Measure (which may be set to 'unbounded' for unlimited occurrences), as well as a minOccurs attribute, indicating the minimum required number of values, when the Measure is reported. If minOccurs or maxOccurs are omitted (they both default to ‘1’), the Measure is considered to take a single value; otherwise, it is an array. Moreover, the usage attribute indicates whether a Measure must be reported or not, by the corresponding values: mandatory or optional.
123 +here can be one or more [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] under the MeasureDescriptor. [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] represent the observable phenomena. Each [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] may have a valid [[representation>>doc:xwiki:Glossary.Representation.WebHome]], a maxOccurs [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] limiting the maximum number of values per [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] (which may be set to 'unbounded' for unlimited occurrences), as well as a minOccurs [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]], indicating the minimum required number of values, when the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] is reported. If minOccurs or maxOccurs are omitted (they both default to ‘1’), the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] is considered to take a single value; otherwise, it is an array. Moreover, the usage [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] indicates whether a [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] must be reported or not, by the corresponding values: mandatory or optional.
124 124  
125 -The AttributeDescriptor may contain one or more //Attribute//s, i.e., at least one DataAttribute definition or one MetadataAttribute reference.
125 +The AttributeDescriptor may contain one or more //[[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]]//s, i.e., at least one DataAttribute definition or one MetadataAttribute reference.
126 126  
127 -The DataAttribute defines a characteristic of data that are collected or disseminated and is grouped in the DataStructureDefinition by a single AttributeDescriptor. The DataAttribute can be indicated if it must be reported or not, by the corresponding value of the usage attribute: i.e., mandatory or optional. The property minOccurs specifies the minimum number of array values to be included when the DataAttribute is reported. Moreover, a maxOccurs attribute indicates whether the DataAttribute may need to report more than one values, i.e., an array of values. The DataAttribute may play a specific role in the structure and this is specified by the +role association to the Concept that identifies its role.
127 +The DataAttribute defines a characteristic of data that are collected or disseminated and is grouped in the DataStructureDefinition by a single AttributeDescriptor. The DataAttribute can be indicated if it must be reported or not, by the corresponding value of the usage [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]]: i.e., mandatory or optional. The property minOccurs specifies the minimum number of array values to be included when the DataAttribute is reported. Moreover, a maxOccurs [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] indicates whether the DataAttribute may need to report more than one values, i.e., an array of values. The DataAttribute may play a specific role in the structure and this is specified by the +role association to the (% style="color:#2ecc71" %)Concept(%%) that identifies its role.
128 128  
129 -The MetadataAttribute defines reference metadata that may be collected or disseminated and is grouped together with DataAttribute under the AttributeDescriptor.
129 +The MetadataAttribute defines [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] that may be collected or disseminated and is grouped together with DataAttribute under the AttributeDescriptor.
130 130  
131 -A DataAttribute or a MetadataAttribute (i.e., an //AttributeComponent//) is specified as being +relatedTo an AttributeRelationship, which defines the constructs to which the //AttributeComponent// is to be reported within a //DataSet//. An //AttributeComponent// can be specified as being related to one of the following artefacts:
131 +A DataAttribute or a MetadataAttribute (i.e., an //AttributeComponent//) is specified as being +relatedTo an AttributeRelationship, which defines the constructs to which the //AttributeComponent// is to be reported within a //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//. An //AttributeComponent// can be specified as being related to one of the following [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]:
132 132  
133 -* All data within the dataset (DataflowRelationship) – this is equivalent to attaching an Attribute to all data within the Dataflow.
134 -* Dimension or set of Dimensions (DimensionRelationship)
135 -* Set of Dimensions specified by a GroupKey (GroupRelationship – this is retained for compatibility reasons – or +groupKey of the DimensionRelationship)
133 +* All data within the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] (DataflowRelationship) – this is equivalent to attaching an [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] to all data within the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]].
134 +* [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] or set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] (DimensionRelationship)
135 +* Set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] specified by a GroupKey (GroupRelationship – this is retained for compatibility reasons – or +groupKey of the DimensionRelationship)
136 136  * Observation (ObservationRelationship)
137 -* In addition to the positioning of an //AttributeComponent// within a //DataSet//, another relationship indicates the Measure(s) for which the //AttributeComponent// is reported. Regardless of the position of the //AttributeComponent// within the //DataSet//, the //AttributeComponent// may concern one, more than one, or all Measures included in the DSD. This is expressed using the MeasureRelationship class, which relates a DataAttribute to one or more Measures. Lack of the MeasureRelationship defaults to a relationship to all Measures.
137 +* In addition to the positioning of an //AttributeComponent// within a //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//, another relationship indicates the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]](s) for which the //AttributeComponent// is reported. Regardless of the position of the //AttributeComponent// within the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//, the //AttributeComponent// may concern one, more than one, or all [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] included in the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]]. This is expressed using the MeasureRelationship class, which relates a DataAttribute to one or more [[Measures>>doc:xwiki:Glossary.Measure.WebHome]]. Lack of the MeasureRelationship defaults to a relationship to all [[Measures>>doc:xwiki:Glossary.Measure.WebHome]].
138 138  
139 139  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_f235bfd4.jpg||height="542" width="604"]]
140 140  
... ... @@ -144,135 +144,117 @@
144 144  
145 145  (% style="width:839.039px" %)
146 146  |**Relationship**|(% style="width:384px" %)**Meaning**|(% style="width:303px" %)**Location in Data Set at which the Attribute is reported**
147 -|DataflowRelationship|(% style="width:384px" %)The value of the attribute is fixed for all data contained in the dataset. The Attribute value applies to all data defined by the underlying Dataflow.|(% style="width:303px" %)The attribute is reported at the Dataset level.
148 -|Dimension (1..n)|(% style="width:384px" %)The value of the attribute will vary with the value(s) of the referenced Dimension(s). In this case, Group(s) to which the attribute should be attached may optionally be specified.|(% style="width:303px" %)The attribute is reported at the lowest level of the Dimension to which the Attribute is related, otherwise at the level of the Group if Attachment Group(s) is specified.
149 -|Group|(% style="width:384px" %)The value of the Attribute varies with combination of values for all of the Dimensions contained in the Group. This is added as a convenience to listing all Dimensions and the attachment Group, but should only be used when the Attribute value varies based on __all__ Group Dimension values.|(% style="width:303px" %)The attribute is reported at the level of Group.
150 -|Observation|(% style="width:384px" %)The value of the Attribute varies with the observed value.|(% style="width:303px" %)The attribute is reported at the level of Observation.
147 +|DataflowRelationship|(% style="width:384px" %)The value of the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is fixed for all data contained in the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]]. The [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] value applies to all data defined by the underlying [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]].|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]] (% style="color:#2ecc71" %)level(%%).
148 +|[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] (1..n)|(% style="width:384px" %)The value of the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] will vary with the value(s) of the referenced [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]](s). In this case, Group(s) to which the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] should be attached may optionally be specified.|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the lowest (% style="color:#2ecc71" %)level(%%) of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] to which the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related, otherwise at the (% style="color:#2ecc71" %)level(%%) of the Group if Attachment Group(s) is specified.
149 +|Group|(% style="width:384px" %)The value of the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] varies with combination of values for all of the [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] contained in the Group. This is added as a convenience to listing all [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] and the attachment Group, but should only be used when the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] value varies based on __all__ Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] values.|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the (% style="color:#2ecc71" %)level(%%) of Group.
150 +|Observation|(% style="width:384px" %)The value of the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] varies with the observed value.|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the (% style="color:#2ecc71" %)level(%%) of Observation.
151 151  
152 152  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_42ff01fb.jpg||height="380" width="590"]]
153 153  
154 154  **Figure 30: Representation of DSD Components**
155 155  
156 -Each of Dimension, TimeDimension, Measure, DataAttribute and MetadataAttribute can have a Representation specified (using the localRepresentation association). If this is not specified in the DataStructureDefinition then the representation specified for Concept
156 +Each of [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension, [[Measure>>doc:xwiki:Glossary.Measure.WebHome]], DataAttribute and MetadataAttribute can have a [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] specified (using the localRepresentation association). If this is not specified in the DataStructureDefinition then the [[representation>>doc:xwiki:Glossary.Representation.WebHome]] specified for (% style="color:#2ecc71" %)Concept(%%) (coreRepresentation) is used. [[Measure>>doc:xwiki:Glossary.Measure.WebHome]], and DataAttribute may be also represented by multilingual text (as seen in the [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]] diagram further down). An exception is the MetadataAttribute, where its [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] is specified in the MetadataStructureDefinition.
157 157  
158 -(coreRepresentation) is used. Measure, and DataAttribute may be also represented by multilingual text (as seen in the DataSet diagram further down). An exception is the MetadataAttribute, where its Representation is specified in the MetadataStructureDefinition.
159 -
160 160  A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap.
161 161  
162 162  ==== 5.3.2.2 Definitions ====
163 163  
164 -:
165 -
166 166  (((
167 167  (% style="width:834.039px" %)
168 -|**Class**|(% style="width:194px" %)**Feature**|(% style="width:454px" %)**Description**
169 -|StructureUsage|(% style="width:194px" %) |(% style="width:454px" %)See “SDMX Base”.
170 -|Dataflow|(% style="width:194px" %)(((
164 +|(% style="width:209px" %)**Class**|(% style="width:175px" %)**Feature**|(% style="width:454px" %)**Description**
165 +|(% style="width:209px" %)StructureUsage|(% style="width:175px" %) |(% style="width:454px" %)See “[[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base”.
166 +|(% style="width:209px" %)[[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]|(% style="width:175px" %)(((
171 171  Inherits from
172 -
173 173  //StructureUsage//
174 -)))|(% style="width:454px" %)Abstract concept (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.
175 -| |(% style="width:194px" %)/structure|(% style="width:454px" %)Associates a Dataflow to the Data Structure Definition.
176 -|DataStructureDefiniti on|(% style="width:194px" %) |(% style="width:454px" %)A collection of metadata concepts, their structure and usage when used to collect or disseminate data.
177 -| |(% style="width:194px" %)/grouping|(% style="width:454px" %)An association to a set of metadata concepts that have an identified structural role in a Data Structure Definition.
178 -|GroupDimensionDescrip tor|(% style="width:194px" %)(((
169 +)))|(% style="width:454px" %)Abstract (% style="color:#2ecc71" %)concept(%%) (i.e., the structure without any data) of a flow of data that providers will provide for different reference periods.
170 +|(% style="width:209px" %) |(% style="width:175px" %)/structure|(% style="width:454px" %)Associates a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] to the Data Structure Definition.
171 +|(% style="width:209px" %)DataStructureDefiniti on|(% style="width:175px" %) |(% style="width:454px" %)A collection of metadata (% style="color:#2ecc71" %)concepts(%%), their structure and usage when used to collect or disseminate data.
172 +|(% style="width:209px" %) |(% style="width:175px" %)/grouping|(% style="width:454px" %)An association to a set of metadata (% style="color:#2ecc71" %)concepts(%%) that have an identified structural role in a Data Structure Definition.
173 +|(% style="width:209px" %)GroupDimensionDescriptor|(% style="width:175px" %)(((
179 179  Inherits from
180 -
181 181  //ComponentList//
182 -)))|(% style="width:454px" %)A set of metadata concepts that define a partial key derived from the Dimension Descriptor in a Data Structure Definition.
183 -| |(% style="width:194px" %)/components|(% style="width:454px" %)An association to the Dimension components that comprise the group.
184 -|DimensionDescriptor|(% style="width:194px" %)(((
176 +)))|(% style="width:454px" %)A set of metadata (% style="color:#2ecc71" %)concepts(%%) that define a partial key derived from the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor in a Data Structure Definition.
177 +|(% style="width:209px" %) |(% style="width:175px" %)/components|(% style="width:454px" %)An association to the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[components>>doc:xwiki:Glossary.Component.WebHome]] that comprise the group.
178 +|(% style="width:209px" %)DimensionDescriptor|(% style="width:175px" %)(((
185 185  Inherits from
186 -
187 187  //ComponentList//
188 -)))|(% style="width:454px" %)An ordered set of metadata concepts that, combined, classify a statistical series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific observation.
189 -| |(% style="width:194px" %)/components|(% style="width:454px" %)(((
190 -An association to the Dimension and Time Dimension comprising the Key Descriptor.
181 +)))|(% style="width:454px" %)An ordered set of metadata (% style="color:#2ecc71" %)concepts(%%) that, combined, classify a statistical series, and whose values, when combined (the key) in an instance such as a [[data set>>doc:xwiki:Glossary.Data set.WebHome]], uniquely identify a specific observation.
182 +|(% style="width:209px" %) |(% style="width:175px" %)/components|(% style="width:454px" %)(((
183 +An association to the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] and Time [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] comprising the Key Descriptor.
191 191  )))
192 -|AttributeDescriptor|(% style="width:194px" %)(((
185 +|(% style="width:209px" %)AttributeDescriptor|(% style="width:175px" %)(((
193 193  Inherits from
194 -
195 195  //ComponentList//
196 -)))|(% style="width:454px" %)A set metadata concepts that define the Attributes of a Data Structure Definition.
197 -| |(% style="width:194px" %)/components|(% style="width:454px" %)An association to a Data Attribute component.
198 -|MeasureDescriptor|(% style="width:194px" %)(((
188 +)))|(% style="width:454px" %)A set metadata (% style="color:#2ecc71" %)concepts(%%) that define the [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] of a Data Structure Definition.
189 +|(% style="width:209px" %) |(% style="width:175px" %)/[[components>>doc:xwiki:Glossary.Component.WebHome]]|(% style="width:454px" %)An association to a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] [[component>>doc:xwiki:Glossary.Component.WebHome]].
190 +|(% style="width:209px" %)MeasureDescriptor|(% style="width:175px" %)(((
199 199  Inherits from
200 -
201 201  //ComponentList//
202 -)))|(% style="width:454px" %)A metadata concept that defines the Measures of a Data Structure Definition.
203 -| |(% style="width:194px" %)/components|(% style="width:454px" %)An association to a Measure component.
204 -|//DimensionComponent//|(% style="width:194px" %)(((
193 +)))|(% style="width:454px" %)A metadata (% style="color:#2ecc71" %)concept(%%) that defines the [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] of a Data Structure Definition.
194 +|(% style="width:209px" %) |(% style="width:175px" %)/components|(% style="width:454px" %)An association to a [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] [[component>>doc:xwiki:Glossary.Component.WebHome]].
195 +|(% style="width:209px" %)//DimensionComponent//|(% style="width:175px" %)(((
205 205  Inherits from
197 +//[[Component>>doc:xwiki:Glossary.Component.WebHome]]//
206 206  
207 -//Component//
208 -
209 -Sub class Dimension
210 -
199 +Sub class [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]]
211 211  TimeDimension
212 -)))|(% style="width:454px" %)An abstract class representing any Component that can be used for identifying observations.
213 -| |(% style="width:194px" %)order|(% style="width:454px" %)Specifies the order of the Dimension Components within the DSD. The property is used to indicate the position of the Dimension Component and determines the Key for identifying observations, or series. The Time Dimension, when specified, must be the last within the Dimension Descriptor.
214 -|Dimension|(% style="width:194px" %)(((
201 +)))|(% style="width:454px" %)An abstract class representing any [[Component>>doc:xwiki:Glossary.Component.WebHome]] that can be used for identifying observations.
202 +|(% style="width:209px" %) |(% style="width:175px" %)order|(% style="width:454px" %)Specifies the order of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[Components>>doc:xwiki:Glossary.Component.WebHome]] within the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]]. The property is used to indicate the position of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[Component>>doc:xwiki:Glossary.Component.WebHome]] and determines the Key for identifying observations, or series. The Time [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], when specified, must be the last within the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor.
203 +|(% style="width:209px" %)[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]]|(% style="width:175px" %)(((
215 215  Inherits from
216 -
217 217  //DimensionComponent//
218 -)))|(% style="width:454px" %)A metadata concept used (most probably together with other metadata concepts) to classify a statistical series, e.g., a statistical concept indicating a certain economic activity or a geographical reference area.
219 -| |(% style="width:194px" %)/role|(% style="width:454px" %)Association to the Concept that specifies the role that that the Dimension plays in the Data Structure Definition.
220 -| |(% style="width:194px" %)/conceptIdentity|(% style="width:454px" %)An association to the metadata concept which defines the semantic of the Dimension.
221 -|TimeDimension|(% style="width:194px" %)(((
206 +)))|(% style="width:454px" %)A metadata (% style="color:#2ecc71" %)concept(%%) used (most probably together with other metadata (% style="color:#2ecc71" %)concepts(%%)) to classify a statistical series, e.g., a statistical (% style="color:#2ecc71" %)concept(%%) indicating a certain [[economic activity>>doc:xwiki:Glossary.Economic activity.WebHome]] or a geographical reference area.
207 +|(% style="width:209px" %) |(% style="width:175px" %)/role|(% style="width:454px" %)Association to the (% style="color:#2ecc71" %)Concept(%%) that specifies the role that that the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] plays in the Data Structure Definition.
208 +|(% style="width:209px" %) |(% style="width:175px" %)/conceptIdentity|(% style="width:454px" %)An association to the metadata (% style="color:#2ecc71" %)concept(%%) which defines the semantic of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]].
209 +|(% style="width:209px" %)TimeDimension|(% style="width:175px" %)(((
222 222  Inherits from
223 -
224 224  //DimensionComponent//
225 -)))|(% style="width:454px" %)A metadata concept that identifies the component in the key structure that has the role of “time”.
226 -|DataAttribute|(% style="width:194px" %)(((
212 +)))|(% style="width:454px" %)A metadata (% style="color:#2ecc71" %)concept(%%) that identifies the [[component>>doc:xwiki:Glossary.Component.WebHome]] in the key structure that has the role of “time”.
213 +|(% style="width:209px" %)DataAttribute|(% style="width:175px" %)(((
227 227  Inherits from
228 -
229 -//Component//
215 +//[[Component>>doc:xwiki:Glossary.Component.WebHome]]//
230 230  )))|(% style="width:454px" %)A characteristic of an object or entity.
231 -| |(% style="width:194px" %)/role|(% style="width:454px" %)Association to the Concept that specifies the role that that the Data Attribute plays in the Data Structure Definition.
232 -| |(% style="width:194px" %)minOccurs|(% style="width:454px" %)Defines the minimum required occurrences for the Attribute. When equals to zero, the Attribute is conditional.
233 -| |(% style="width:194px" %)maxOccurs|(% style="width:454px" %)Defines the maximum allowed occurrences for the Attribute.
234 -| |(% style="width:194px" %)usage|(% style="width:454px" %)Defines whether a Data Attribute must be reported or not.
235 -| |(% style="width:194px" %)+relatedTo|(% style="width:454px" %)Association to an Attribute Relationship.
236 -| |(% style="width:194px" %)/conceptIdentity|(% style="width:454px" %)An association to the Concept which defines the semantic of the component.
237 -|Measure|(% style="width:194px" %)(((
217 +|(% style="width:209px" %) |(% style="width:175px" %)/role|(% style="width:454px" %)Association to the (% style="color:#2ecc71" %)Concept(%%) that specifies the role that that the Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] plays in the Data Structure Definition.
218 +|(% style="width:209px" %) |(% style="width:175px" %)minOccurs|(% style="width:454px" %)Defines the minimum required occurrences for the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]]. When equals to zero, the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is conditional.
219 +|(% style="width:209px" %) |(% style="width:175px" %)maxOccurs|(% style="width:454px" %)Defines the maximum allowed occurrences for the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]].
220 +|(% style="width:209px" %) |(% style="width:175px" %)usage|(% style="width:454px" %)Defines whether a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] must be reported or not.
221 +|(% style="width:209px" %) |(% style="width:175px" %)+relatedTo|(% style="width:454px" %)Association to an [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Relationship.
222 +|(% style="width:209px" %) |(% style="width:175px" %)/conceptIdentity|(% style="width:454px" %)An association to the (% style="color:#2ecc71" %)Concept(%%) which defines the semantic of the [[component>>doc:xwiki:Glossary.Component.WebHome]].
223 +|(% style="width:209px" %)[[Measure>>doc:xwiki:Glossary.Measure.WebHome]]|(% style="width:175px" %)(((
238 238  Inherits from
239 -
240 -//Component//
241 -)))|(% style="width:454px" %)The metadata concept that is the phenomenon to be measured in a data set. In a data set the instance of the measure is often called the observation.
242 -| |(% style="width:194px" %)/conceptIdentity|(% style="width:454px" %)An association to the Concept which carries the values of the measures.
243 -| |(% style="width:194px" %)minOccurs|(% style="width:454px" %)Defines the minimum required occurrences for the Measure. When equals to zero, the Measure is conditional.
244 -| |(% style="width:194px" %)maxOccurs|(% style="width:454px" %)Defines the maximum allowed occurrences for the Measure.
245 -| |(% style="width:194px" %)usage|(% style="width:454px" %)Defines whether a Measure must be reported or not.
246 -|//AttributeRelationship//|(% style="width:194px" %)(((
225 +//[[Component>>doc:xwiki:Glossary.Component.WebHome]]//
226 +)))|(% style="width:454px" %)The metadata (% style="color:#2ecc71" %)concept(%%) that is the phenomenon to be measured in a [[data set>>doc:xwiki:Glossary.Data set.WebHome]]. In a [[data set>>doc:xwiki:Glossary.Data set.WebHome]] the instance of the [[measure>>doc:xwiki:Glossary.Measure.WebHome]] is often called the observation.
227 +|(% style="width:209px" %) |(% style="width:175px" %)/conceptIdentity|(% style="width:454px" %)An association to the (% style="color:#2ecc71" %)Concept(%%) which carries the values of the [[measures>>doc:xwiki:Glossary.Measure.WebHome]].
228 +|(% style="width:209px" %) |(% style="width:175px" %)minOccurs|(% style="width:454px" %)Defines the minimum required occurrences for the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]]. When equals to zero, the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] is conditional.
229 +|(% style="width:209px" %) |(% style="width:175px" %)maxOccurs|(% style="width:454px" %)Defines the maximum allowed occurrences for the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]].
230 +|(% style="width:209px" %) |(% style="width:175px" %)usage|(% style="width:454px" %)Defines whether a [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] must be reported or not.
231 +|(% style="width:209px" %)//AttributeRelationship//|(% style="width:175px" %)(((
247 247  Abstract Class
248 -
249 249  Sub classes
250 -
251 251  ObservationRelationship
252 -
253 -GroupRelationship DimensionRelationshi p
254 -)))|(% style="width:454px" %)Specifies the type of artefact to which a Data Attribute can be attached in a Data Set.
255 -|ObservationRelationsh ip|(% style="width:194px" %) |(% style="width:454px" %)The Data Attribute is related to the observations of the Data Set.
256 -|GroupRelationship|(% style="width:194px" %) |(% style="width:454px" %)The Data Attribute is related to a Group Dimension Descriptor construct.
257 -| |(% style="width:194px" %)+groupKey|(% style="width:454px" %)An association to the Group Dimension Descriptor
258 -|DimensionRelationship|(% style="width:194px" %) |(% style="width:454px" %)The Data Attribute is related to a set of Dimensions.
259 -| |(% style="width:194px" %)+dimensions|(% style="width:454px" %)Association to the set of Dimensions to which the Data Attribute is related.
260 -| |(% style="width:194px" %)+groupKey|(% style="width:454px" %)Association to the Group Dimension Descriptor which specifies the set of Dimensions to which the Data Attribute is attached.
261 -|MeasureRelationship|(% style="width:194px" %) |(% style="width:454px" %)The Measures that a Data Attribute is reported for.
262 -| |(% style="width:194px" %)+measures|(% style="width:454px" %)Association to the set of Measures to which a Data Attribute is related to.
263 -|SentinelValuesType|(% style="width:194px" %) |(% style="width:454px" %)This facet indicates that an Attribute or a Measure has sentinel values with special meaning within their data type. This is realised by providing such values within the TextFormat, in addition to any textType or other Facet.
264 -|SentinelValue|(% style="width:194px" %) |(% style="width:454px" %)A value that has a special meaning within the text format representation of the Component.
265 -| |(% style="width:194px" %)+name|(% style="width:454px" %)An association of a Sentinel Value to a multilingual name.
266 -| |(% style="width:194px" %)+description|(% style="width:454px" %)An association of a Sentinel Value to a multilingual description.
235 +GroupRelationship DimensionRelationship
236 +)))|(% style="width:454px" %)Specifies the type of [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] to which a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] can be attached in a [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]].
237 +|(% style="width:209px" %)ObservationRelationship|(% style="width:175px" %) |(% style="width:454px" %)The Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related to the observations of the [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]].
238 +|(% style="width:209px" %)GroupRelationship|(% style="width:175px" %) |(% style="width:454px" %)The Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related to a Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor construct.
239 +|(% style="width:209px" %) |(% style="width:175px" %)+groupKey|(% style="width:454px" %)An association to the Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor
240 +|(% style="width:209px" %)DimensionRelationship|(% style="width:175px" %) |(% style="width:454px" %)The Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related to a set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]].
241 +|(% style="width:209px" %) |(% style="width:175px" %)+dimensions|(% style="width:454px" %)Association to the set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] to which the Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related.
242 +|(% style="width:209px" %) |(% style="width:175px" %)+groupKey|(% style="width:454px" %)Association to the Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor which specifies the set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] to which the Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is attached.
243 +|(% style="width:209px" %)MeasureRelationship|(% style="width:175px" %) |(% style="width:454px" %)The [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] that a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported for.
244 +|(% style="width:209px" %) |(% style="width:175px" %)+measures|(% style="width:454px" %)Association to the set of [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] to which a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related to.
245 +|(% style="width:209px" %)SentinelValuesType|(% style="width:175px" %) |(% style="width:454px" %)This [[facet>>doc:xwiki:Glossary.Facet.WebHome]] indicates that an [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] or a [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] has sentinel values with special meaning within their data type. This is realised by providing such values within the TextFormat, in addition to any textType or other [[Facet>>doc:xwiki:Glossary.Facet.WebHome]].
246 +|(% style="width:209px" %)SentinelValue|(% style="width:175px" %) |(% style="width:454px" %)A value that has a special meaning within the text format [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of the [[Component>>doc:xwiki:Glossary.Component.WebHome]].
247 +|(% style="width:209px" %) |(% style="width:175px" %)+name|(% style="width:454px" %)An association of a Sentinel Value to a multilingual name.
248 +|(% style="width:209px" %) |(% style="width:175px" %)+description|(% style="width:454px" %)An association of a Sentinel Value to a multilingual description.
267 267  )))
268 268  
269 -The explanation of the classes, attributes, and associations comprising the Representation is described in the section on the SDMX Base.
251 +The explanation of the classes, [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]], and associations comprising the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] is described in the section on the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Base.
270 270  
271 271  == 5.4 Data Set – Relationship View ==
272 272  
273 273  === 5.4.1 Context ===
274 274  
275 -A data set comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition.
257 +A [[data set>>doc:xwiki:Glossary.Data set.WebHome]] comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition.
276 276  
277 277  === 5.4.2 Class Diagram ===
278 278  
... ... @@ -284,27 +284,25 @@
284 284  
285 285  ==== 5.4.3.1 Narrative – Data Set ====
286 286  
287 -Note that the //DataSet// must conform to the DataStructureDefinition associated to the Dataflow for which this DataSet is an “instance of data”. Whilst the model shows the association to the classes of the DataStructureDefinition, this is for conceptual purposes to show the link to the DataStructureDefinition. In the actual //DataSet// as exchanged there must, of course, be a reference to the DataStructureDefinition and optionally a Dataflow or a ProvisionAgreement, but the DataStructureDefinition is not necessarily exchanged with the data. Therefore, the DataStructureDefinition classes are shown in the grey areas, as these are not a part of the //DataSet// when the //DataSet// is exchanged. However, the structural metadata in the DataStructureDefinition can be used by an application to validate the contents of the //DataSet// in terms of the valid content of a //KeyValue// as defined by the Representation in the DataStructureDefinition.
269 +Note that the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// must conform to the DataStructureDefinition associated to the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] for which this [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]] is an “instance of data”. Whilst the model shows the association to the classes of the DataStructureDefinition, this is for conceptual purposes to show the link to the DataStructureDefinition. In the actual //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// as exchanged there must, of course, be a reference to the DataStructureDefinition and optionally a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] or a ProvisionAgreement, but the DataStructureDefinition is not necessarily exchanged with the data. Therefore, the DataStructureDefinition classes are shown in the grey areas, as these are not a part of the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// when the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// is exchanged. However, the [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] in the DataStructureDefinition can be used by an application to validate the contents of the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// in terms of the valid content of a //KeyValue// as defined by the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] in the DataStructureDefinition.
288 288  
289 -An organisation playing the role of DataProvider can be responsible for one or more //DataSet//.
271 +An organisation playing the role of DataProvider can be responsible for one or more //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//.
290 290  
291 -A //DataSet// is formatted as a DataStructureDefinition specific data set (StructureSpecificDataSet). The structured data set is structured according to one specific DataStructureDefinition; hence the latter is required for validation at the syntax level.
273 +A //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// is formatted as a DataStructureDefinition specific [[data set>>doc:xwiki:Glossary.Data set.WebHome]] (StructureSpecificDataSet). The structured [[data set>>doc:xwiki:Glossary.Data set.WebHome]] is structured according to one specific DataStructureDefinition; hence the latter is required for validation at the syntax (% style="color:#2ecc71" %)level(%%).
292 292  
293 -A //DataSet// is a collection of a set of //Observation//s that share the same dimensionality, which is specified by a set of unique components (Dimension, TimeDimension) defined in the
275 +A //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// is a collection of a set of //Observation//s that share the same dimensionality, which is specified by a set of unique [[components>>doc:xwiki:Glossary.Component.WebHome]] ([[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension) defined in the DimensionDescriptor of the DataStructureDefinition, together with associated
294 294  
295 -DimensionDescriptor of the DataStructureDefinition, together with associated
277 +//AttributeValue//s that define specific characteristics about the [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] to which it is attached – //Observation//s, set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]]. It can be structured in terms of a SeriesKey to which //Observation//s are reported.
296 296  
297 -//AttributeValue//s that define specific characteristics about the artefact to which it is attached – //Observation//s, set of Dimensions. It can be structured in terms of a SeriesKey to which //Observation//s are reported.
279 +The //Observation// can be the value(s) of the variable(s) being measured for the (% style="color:#2ecc71" %)Concept(%%) associated to the Measure(s) in the MeasureDescriptor of the DataStructureDefinition. Each //Observation// associates one or more //ObservationValue//s with a KeyValue (+observationDimension) which is the value for the “[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] at the Observation (% style="color:#2ecc71" %)Level(%%)”. Any [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] can be specified as being the “[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] at the Observation (% style="color:#2ecc71" %)Level(%%)”, and this specification is made at the (% style="color:#2ecc71" %)level(%%) of the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// (i.e., it must be the same [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] for the entire //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//).
298 298  
299 -The //Observation// can be the value(s) of the variable(s) being measured for the Concept associated to the Measure(s) in the MeasureDescriptor of the DataStructureDefinition. Each //Observation// associates one or more //ObservationValue//s with a KeyValue (+observationDimension) which is the value for the Dimension at the Observation Level”. Any Dimension can be specified as being the “Dimension at the Observation Level”, and this specification is made at the level of the //DataSet// (i.e., it must be the same Dimension for the entire //DataSet//).
281 +The //KeyValue// is a value for one of TimeDimension or [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] specified in the DataStructureDefinition. If it is a [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], it can be coded (CodedKeyValue) or uncoded (UncodedKeyValue). If it is the TimeDimension then it is a TimeKeyValue. The actual value that the CodedDimensionValue can take must be one of the [[Codes>>doc:xwiki:Glossary.Code.WebHome]] in the Codelist specified as the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] in the DataStructureDefinition.
300 300  
301 -The //KeyValue// is a value for one of TimeDimension or Dimension specified in the DataStructureDefinition. If it is a Dimension, it can be coded (CodedKeyValue) or uncoded (UncodedKeyValue). If it is the TimeDimension then it is a TimeKeyValue. The actual value that the CodedDimensionValue can take must be one of the Codes in the Codelist specified as the Representation of the Dimension in the DataStructureDefinition.
302 -
303 303  An ObservationValue can be coded – this is the CodedObservation – or it can be uncoded – this is the UncodedObservation. In the case of uncoded observations, the values may be multilingual – expressed via the TextMeasureValue – or not (OtherUncodedMeasureValue).
304 304  
305 -The GroupKey is a subunit of the //Key// that has the same dimensionality as the SeriesKey but defines a subset of the KeyValues of the SeriesKey. Its sub dimension structure is defined in the GroupDimensionDescriptor of the DataStructureDefinition identified by the same id as the GroupKey. The id identifies a “type” of group and the purpose of the GroupKey is to report one or more //AttributeValue// that are contained at this group level. The GroupKey is present when the GroupDimensionDescriptor is related to the GroupRelationship in the DataStructureDefinition. There can be many types of groups in a //DataSet//. If the Group is related to the DimensionRelationship in the DataStructureDefinition then the //AttributeValue// will be reported with the appropriate dimension in the SeriesKey or Observation.
285 +The GroupKey is a subunit of the //Key// that has the same dimensionality as the SeriesKey but defines a subset of the KeyValues of the SeriesKey. Its sub [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] structure is defined in the GroupDimensionDescriptor of the DataStructureDefinition identified by the same id as the GroupKey. The id identifies a “type” of group and the purpose of the GroupKey is to report one or more //AttributeValue// that are contained at this group (% style="color:#2ecc71" %)level(%%). The GroupKey is present when the GroupDimensionDescriptor is related to the GroupRelationship in the DataStructureDefinition. There can be many types of groups in a //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//. If the Group is related to the DimensionRelationship in the DataStructureDefinition then the //AttributeValue// will be reported with the appropriate [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] in the SeriesKey or Observation.
306 306  
307 -In this way each of SeriesKey, GroupKey, and Observation can have zero or more //AttributeValue//s that define some metadata about the object to which it is associated. The //AttributeValue// may be either a //DataAttributeValue// or a //MetadataAttributeValue//, representing values of DataAttributes defined in the DSD or MetadataAttributes of the linked MSD, respectively. The allowable Concepts and the objects to which these metadata can be associated (attached) are defined in the DataStructureDefinition and the linked MetadataStructureDefinition.
287 +In this way each of SeriesKey, GroupKey, and Observation can have zero or more //AttributeValue//s that define some metadata about the object to which it is associated. The //AttributeValue// may be either a //DataAttributeValue// or a //MetadataAttributeValue//, representing values of DataAttributes defined in the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]] or MetadataAttributes of the linked [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], respectively. The allowable (% style="color:#2ecc71" %)Concepts(%%) and the objects to which these metadata can be associated (attached) are defined in the DataStructureDefinition and the linked MetadataStructureDefinition.
308 308  
309 309  The //AttributeValue// links to the object type (SeriesKey, GroupKey, Observation) to which it is associated.
310 310  
... ... @@ -311,194 +311,153 @@
311 311  ==== 5.4.3.2 Definitions ====
312 312  
313 313  (% style="width:812.039px" %)
314 -|(% style="width:147px" %)**Class**|(% style="width:222px" %)**Feature**|(% style="width:437px" %)**Description**
315 -|(% style="width:147px" %)//DataSet//|(% style="width:222px" %)(((
294 +|(% style="width:147px" %)**Class**|(% style="width:246px" %)**Feature**|(% style="width:395px" %)**Description**
295 +|(% style="width:147px" %)//[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//|(% style="width:246px" %)(((
316 316  Abstract Class
317 -
318 318  Sub classes
319 -
320 320  StructureSpecificData
321 -
322 322  Set
323 -)))|(% style="width:437px" %)An organised collection of data.
324 -|(% style="width:147px" %) |(% style="width:222px" %)reportingBegin|(% style="width:437px" %)A specific time period in a known system of time periods that identifies the start period of a report.
325 -|(% style="width:147px" %) |(% style="width:222px" %)reportingEnd|(% style="width:437px" %)A specific time period in a known system of time periods that identifies the end period of a report.
326 -|(% style="width:147px" %) |(% style="width:222px" %)dataExtractionDate|(% style="width:437px" %)A specific time period that identifies the date and time that the data are extracted from a data source.
327 -|(% style="width:147px" %) |(% style="width:222px" %)validFrom|(% style="width:437px" %)Indicates the inclusive start time indicating the validity of the information in the data set.
328 -|(% style="width:147px" %) |(% style="width:222px" %)validTo|(% style="width:437px" %)Indicates the inclusive end time indicating the validity of the information in the data set.
329 -|(% style="width:147px" %) |(% style="width:222px" %)publicationYear|(% style="width:437px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
330 -|(% style="width:147px" %) |(% style="width:222px" %)publicationPeriod|(% style="width:437px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
331 -|(% style="width:147px" %) |(% style="width:222px" %)setId|(% style="width:437px" %)Provides an identification of the data set.
332 -|(% style="width:147px" %) |(% style="width:222px" %)action|(% style="width:437px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
333 -|(% style="width:147px" %) |(% style="width:222px" %)describedBy|(% style="width:437px" %)Associates a Dataflow and thereby a Data Structure Definition to the data set.
334 -|(% style="width:147px" %) |(% style="width:222px" %)+structuredBy|(% style="width:437px" %)Associates the Data Structure Definition that defines the structure of the Data Set. Note that the Data Structure Definition is the same as that associated (non-mandatory) to the Dataflow.
335 -|(% style="width:147px" %) |(% style="width:222px" %)+publishedBy|(% style="width:437px" %)Associates the Data Provider that reports/publishes the data.
336 -|(% style="width:147px" %)StructureSpecific DataSet|(% style="width:222px" %) |(% style="width:437px" %)An XML specific data format structure that contains data corresponding to one specific Data Structure Definition.
337 -|(% style="width:147px" %)//Key//|(% style="width:222px" %)(((
300 +)))|(% style="width:395px" %)An organised collection of data.
301 +|(% style="width:147px" %) |(% style="width:246px" %)reportingBegin|(% style="width:395px" %)A specific [[time period>>doc:xwiki:Glossary.Time period.WebHome]] in a known system of [[time periods>>doc:xwiki:Glossary.Time period.WebHome]] that identifies the start period of a report.
302 +|(% style="width:147px" %) |(% style="width:246px" %)reportingEnd|(% style="width:395px" %)A specific [[time period>>doc:xwiki:Glossary.Time period.WebHome]] in a known system of [[time periods>>doc:xwiki:Glossary.Time period.WebHome]] that identifies the end period of a report.
303 +|(% style="width:147px" %) |(% style="width:246px" %)dataExtractionDate|(% style="width:395px" %)A specific [[time period>>doc:xwiki:Glossary.Time period.WebHome]] that identifies the date and time that the data are extracted from a data source.
304 +|(% style="width:147px" %) |(% style="width:246px" %)validFrom|(% style="width:395px" %)Indicates the inclusive start time indicating the validity of the information in the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].
305 +|(% style="width:147px" %) |(% style="width:246px" %)validTo|(% style="width:395px" %)Indicates the inclusive end time indicating the validity of the information in the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].
306 +|(% style="width:147px" %) |(% style="width:246px" %)publicationYear|(% style="width:395px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
307 +|(% style="width:147px" %) |(% style="width:246px" %)publicationPeriod|(% style="width:395px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force.
308 +|(% style="width:147px" %) |(% style="width:246px" %)setId|(% style="width:395px" %)Provides an identification of the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].
309 +|(% style="width:147px" %) |(% style="width:246px" %)action|(% style="width:395px" %)Defines the action to be taken by the recipient system (information, append, replace, delete)
310 +|(% style="width:147px" %) |(% style="width:246px" %)describedBy|(% style="width:395px" %)Associates a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] and thereby a [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] to the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].
311 +|(% style="width:147px" %) |(% style="width:246px" %)+structuredBy|(% style="width:395px" %)Associates the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] that defines the structure of the [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]]. Note that the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] is the same as that associated (non-mandatory) to the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]].
312 +|(% style="width:147px" %) |(% style="width:246px" %)+publishedBy|(% style="width:395px" %)Associates the [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]] that reports/publishes the data.
313 +|(% style="width:147px" %)StructureSpecificDataSet|(% style="width:246px" %) |(% style="width:395px" %)An XML specific data format structure that contains data corresponding to one specific [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].
314 +|(% style="width:147px" %)//Key//|(% style="width:246px" %)(((
338 338  Abstract class Sub classes
339 -
340 340  SeriesKey
341 -
342 342  GroupKey
343 -)))|(% style="width:437px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation.
344 -|(% style="width:147px" %) |(% style="width:222px" %)keyValues|(% style="width:437px" %)Association to the individual Key Values that comprise the Key.
345 -|(% style="width:147px" %) |(% style="width:222px" %)+attachedAttribute|(% style="width:437px" %)Association to the Attribute Values relating to the Series Key or Group Key.
346 -|(% style="width:147px" %)//KeyValue//|(% style="width:222px" %)(((
318 +)))|(% style="width:395px" %)Comprises the cross product of values of [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] that identify uniquely an Observation.
319 +|(% style="width:147px" %) |(% style="width:246px" %)keyValues|(% style="width:395px" %)Association to the individual Key Values that comprise the Key.
320 +|(% style="width:147px" %) |(% style="width:246px" %)+attachedAttribute|(% style="width:395px" %)Association to the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Values relating to the [[Series Key>>doc:xwiki:Glossary.Series key.WebHome]] or Group Key.
321 +|(% style="width:147px" %)//KeyValue//|(% style="width:246px" %)(((
347 347  Abstract class Sub classes
348 -
349 349  TimeKeyValue
350 -
351 351  CodedKeyValue
352 -
353 353  UncodedKeyValue
354 -)))|(% style="width:437px" %)The value of a component of a key such as the value of the instance a Dimension in a Dimension Descriptor of a Data Structure Definition.
355 -|(% style="width:147px" %) |(% style="width:222px" %)+valueFor|(% style="width:437px" %)(((
356 -Association to the key component in the Data Structure Definition for which this Key Value is a valid representation.
357 -Note that this is conceptual association as the key component is identified explicitly in the data set.
326 +)))|(% style="width:395px" %)The value of a [[component>>doc:xwiki:Glossary.Component.WebHome]] of a key such as the value of the instance a [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] in a [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor of a [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].
327 +|(% style="width:147px" %) |(% style="width:246px" %)+valueFor|(% style="width:395px" %)(((
328 +Association to the key [[component>>doc:xwiki:Glossary.Component.WebHome]] in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] for which this Key Value is a valid representation.
329 +Note that this is conceptual association as the key [[component>>doc:xwiki:Glossary.Component.WebHome]] is identified explicitly in the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].
358 358  )))
359 -|(% style="width:147px" %)TimeKeyValue|(% style="width:222px" %)(((
331 +|(% style="width:147px" %)TimeKeyValue|(% style="width:246px" %)(((
360 360  Inherits from
361 -
362 362  //KeyValue//
363 -)))|(% style="width:437px" %)The value of the Time Dimension component of the key.
364 -|(% style="width:147px" %)CodedKeyValue|(% style="width:222px" %)(((
334 +)))|(% style="width:395px" %)The value of the Time [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[component>>doc:xwiki:Glossary.Component.WebHome]] of the key.
335 +|(% style="width:147px" %)CodedKeyValue|(% style="width:246px" %)(((
365 365  Inherits from
366 -
367 367  //KeyValue//
368 -)))|(% style="width:437px" %)The value of a coded component of the key. The value is the Code to which this class is associated.
369 -|(% style="width:147px" %) |(% style="width:222px" %)+valueOf|(% style="width:437px" %)Association to the Code. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Dimension in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Key Value.
370 -|(% style="width:147px" %)UnCodedKeyValue|(% style="width:222px" %)(((
338 +)))|(% style="width:395px" %)The value of a coded [[component>>doc:xwiki:Glossary.Component.WebHome]] of the key. The value is the [[Code>>doc:xwiki:Glossary.Code.WebHome]] to which this class is associated.
339 +|(% style="width:147px" %) |(% style="width:246px" %)+valueOf|(% style="width:395px" %)Association to the [[Code>>doc:xwiki:Glossary.Code.WebHome]]. Note that this is a conceptual association showing that the [[Code>>doc:xwiki:Glossary.Code.WebHome]] must exist in the [[Code list>>doc:xwiki:Glossary.Code list.WebHome]] associated with the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. In the actual [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]] the value of the [[Code>>doc:xwiki:Glossary.Code.WebHome]] is placed in the Key Value.
340 +|(% style="width:147px" %)UnCodedKeyValue|(% style="width:246px" %)(((
371 371  Inherits from
372 -
373 373  //KeyValue//
374 -)))|(% style="width:437px" %)The value of an uncoded component of the key.
375 -|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the key component.
376 -|(% style="width:147px" %) |(% style="width:222px" %)startTime|(% style="width:437px" %)This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
377 -|(% style="width:147px" %)GroupKey|(% style="width:222px" %)(((
343 +)))|(% style="width:395px" %)The value of an uncoded [[component>>doc:xwiki:Glossary.Component.WebHome]] of the key.
344 +|(% style="width:147px" %) |(% style="width:246px" %)value|(% style="width:395px" %)The value of the key [[component>>doc:xwiki:Glossary.Component.WebHome]].
345 +|(% style="width:147px" %) |(% style="width:246px" %)startTime|(% style="width:395px" %)This [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is only used if the textFormat of the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is of the Timespan type in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] (in which case the value field takes a duration).
346 +|(% style="width:147px" %)GroupKey|(% style="width:246px" %)(((
378 378  Inherits from
379 -
380 380  //Key//
381 -)))|(% style="width:437px" %)A set of Key Values that comprise a partial key, of the same dimensionality as the Time Series Key for the purpose of attaching Data Attributes.
382 -|(% style="width:147px" %) |(% style="width:222px" %)+describedBy|(% style="width:437px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition.
383 -|(% style="width:147px" %)SeriesKey|(% style="width:222px" %)(((
349 +)))|(% style="width:395px" %)A set of Key Values that comprise a partial key, of the same dimensionality as the Time [[Series Key>>doc:xwiki:Glossary.Series key.WebHome]] for the purpose of attaching Data Attributes.
350 +|(% style="width:147px" %) |(% style="width:246px" %)+describedBy|(% style="width:395px" %)Associates the Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor defined in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].
351 +|(% style="width:147px" %)SeriesKey|(% style="width:246px" %)(((
384 384  Inherits from
385 -
386 386  //Key//
387 -)))|(% style="width:437px" %)Comprises the cross product of values of all the Key Values that, together with the Key Value of the +observation Dimension identify uniquely an Observation.
388 -|(% style="width:147px" %) |(% style="width:222px" %)+describedBy|(% style="width:437px" %)Associates the Dimension Descriptor defined in the Data Structure Definition.
389 -|(% style="width:147px" %)Observation|(% style="width:222px" %) |(% style="width:437px" %)The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
390 -|(% style="width:147px" %) |(% style="width:222px" %)+valueFor|(% style="width:437px" %)(((
391 -Associates the Measure(s) defined in the Data Structure Definition.
354 +)))|(% style="width:395px" %)Comprises the cross product of values of all the Key Values that, together with the Key Value of the +observation [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] identify uniquely an Observation.
355 +|(% style="width:147px" %) |(% style="width:246px" %)+describedBy|(% style="width:395px" %)Associates the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor defined in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].
356 +|(% style="width:147px" %)Observation|(% style="width:246px" %) |(% style="width:395px" %)The value(s) of the observed phenomenon in the context of the Key Values comprising the key.
357 +|(% style="width:147px" %) |(% style="width:246px" %)+valueFor|(% style="width:395px" %)(((
358 +Associates the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]](s) defined in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].
392 392  
393 -The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it.
360 +The source multiplicity (1..*) indicates that more than one values may be provided for a [[Measure>>doc:xwiki:Glossary.Measure.WebHome]], if the latter allows it.
394 394  )))
395 -|(% style="width:147px" %) |(% style="width:222px" %)+attachedAttribute|(% style="width:437px" %)Association to the Attribute Values relating to the Observation.
396 -|(% style="width:147px" %) |(% style="width:222px" %)+observationDimension|(% style="width:437px" %)Association to the Key Value that holds the value of the “Dimension at the Observation Level”.
397 -|(% style="width:147px" %)//ObservationValue//|(% style="width:222px" %)(((
362 +|(% style="width:147px" %) |(% style="width:246px" %)+attachedAttribute|(% style="width:395px" %)Association to the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Values relating to the Observation.
363 +|(% style="width:147px" %) |(% style="width:246px" %)+observationDimension|(% style="width:395px" %)Association to the Key Value that holds the value of the “[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] at the Observation Level”.
364 +|(% style="width:147px" %)//ObservationValue//|(% style="width:246px" %)(((
398 398  Abstract class
399 -
400 400  Sub classes
401 -
402 -//UncodedObservationVal//
403 -
404 -//ue//
405 -
367 +//UncodedObservationValue//
406 406  CodedObservation
407 -)))|(% style="width:437px" %)
408 -|(% style="width:147px" %)//UncodedObservatio nValue//|(% style="width:222px" %)(((
369 +)))|(% style="width:395px" %)
370 +|(% style="width:147px" %)//UncodedObservationValue//|(% style="width:246px" %)(((
409 409  Abstract class
410 -
411 411  Inherits from
412 -
413 413  //ObservationValue//
414 -
415 415  Sub classes
416 -
417 -OtherUncodedMeasureVa lue
418 -
375 +OtherUncodedMeasureValue
419 419  TextMeasureValue
420 -)))|(% style="width:437px" %)
421 -|(% style="width:147px" %)OtherUncodedMeasu reValue|(% style="width:222px" %)(((
377 +)))|(% style="width:395px" %)
378 +|(% style="width:147px" %)OtherUncodedMeasureValue|(% style="width:246px" %)(((
422 422  Inherits from
423 423  
424 -//UncodedObservationVal ue//
425 -)))|(% style="width:437px" %)An observation that has a text value.
426 -|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the Uncoded Observation.
427 -|(% style="width:147px" %) |(% style="width:222px" %)startTime|(% style="width:437px" %)This attribute is only used if the textFormat of the Measure is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
428 -|(% style="width:147px" %)TextMeasureValue|(% style="width:222px" %)(((
381 +//UncodedObservationValue//
382 +)))|(% style="width:395px" %)An observation that has a text value.
383 +|(% style="width:147px" %) |(% style="width:246px" %)value|(% style="width:395px" %)The value of the Uncoded Observation.
384 +|(% style="width:147px" %) |(% style="width:246px" %)startTime|(% style="width:395px" %)This [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is only used if the textFormat of the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] is of the Timespan type in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] (in which case the value field takes a duration).
385 +|(% style="width:147px" %)TextMeasureValue|(% style="width:246px" %)(((
429 429  Inherits from
430 -
431 -//UncodedObservationVal ue//
432 -)))|(% style="width:437px" %)An observation that has a localised text value
433 -|(% style="width:147px" %) |(% style="width:222px" %)text|(% style="width:437px" %)The localised text values.
434 -|(% style="width:147px" %)CodedObservation|(% style="width:222px" %)(((
387 +//UncodedObservationValue//
388 +)))|(% style="width:395px" %)An observation that has a localised text value
389 +|(% style="width:147px" %) |(% style="width:246px" %)text|(% style="width:395px" %)The localised text values.
390 +|(% style="width:147px" %)CodedObservation|(% style="width:246px" %)(((
435 435  Inherits from
436 -
437 437  //ObservationValue//
438 -)))|(% style="width:437px" %)An Observation that takes its value from a code in a Code list.
439 -|(% style="width:147px" %) |(% style="width:222px" %)+valueOf|(% style="width:437px" %)Association to the Code that is the value of the Observation. Note that this is a conceptual association showing that the Code must exist in the Codelist(s) associated with the Measure(s) in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Observation.
440 -|(% style="width:147px" %)//AttributeValue//|(% style="width:222px" %)(((
393 +)))|(% style="width:395px" %)An Observation that takes its value from a [[code>>doc:xwiki:Glossary.Code.WebHome]] in a [[Code list>>doc:xwiki:Glossary.Code list.WebHome]].
394 +|(% style="width:147px" %) |(% style="width:246px" %)+valueOf|(% style="width:395px" %)Association to the [[Code>>doc:xwiki:Glossary.Code.WebHome]] that is the value of the Observation. Note that this is a conceptual association showing that the [[Code>>doc:xwiki:Glossary.Code.WebHome]] must exist in the Codelist(s) associated with the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]](s) in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. In the actual [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]] the value of the [[Code>>doc:xwiki:Glossary.Code.WebHome]] is placed in the Observation.
395 +|(% style="width:147px" %)//AttributeValue//|(% style="width:246px" %)(((
441 441  Abstract class
442 -
443 443  Sub classes
444 -
445 -//DataAttributeValue// //MetadataAttributeValu e//
446 -)))|(% style="width:437px" %)Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute.
447 -|(% style="width:147px" %)//DataAttributeValu e//|(% style="width:222px" %)(((
398 +//DataAttributeValue// //MetadataAttributeValue//
399 +)))|(% style="width:395px" %)Represents the value for any [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] reported in the [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]], i.e., Data or Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]].
400 +|(% style="width:147px" %)//DataAttributeValue//|(% style="width:246px" %)(((
448 448  Abstract class
449 -
450 450  Inherits from
451 -
452 452  //AttributeValue//
453 -
454 454  Sub classes
455 -
456 -//UncodedAttributeValue//
457 -
458 -//CodedAttributeValue//
459 -)))|(% style="width:437px" %)The value of a Data Attribute, such as the instance of a Coded Attribute or of an Uncoded Attribute in a structure such as a Data Structure Definition.
460 -|(% style="width:147px" %) |(% style="width:222px" %)+valueFor|(% style="width:437px" %)(((
461 -Association to the Data Attribute defined in the Data Structure Definition. Note that this is conceptual association as the Concept is identified explicitly in the data set.
462 -The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it.
405 +//UncodedAttributeValue
406 +CodedAttributeValue//
407 +)))|(% style="width:395px" %)The value of a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]], such as the instance of a Coded [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] or of an Uncoded [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] in a structure such as a [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].
408 +|(% style="width:147px" %) |(% style="width:246px" %)+valueFor|(% style="width:395px" %)(((
409 +Association to the Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] defined in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. Note that this is conceptual association as the (% style="color:#2ecc71" %)Concept(%%) is identified explicitly in the [[data set>>doc:xwiki:Glossary.Data set.WebHome]].
410 +The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]], if the latter allows it.
463 463  )))
464 -|(% style="width:147px" %)//MetadataAttribute Value//|(% style="width:222px" %)(((
465 -(explained further in section
412 +|(% style="width:147px" %)//MetadataAttributeValue//|(% style="width:246px" %)(((
413 +(explained further in section “Metadata Set”)
414 +)))|(% style="width:395px" %)(((
415 +The value of a Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]], as specified in the [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], which is linked in the Data Structure
466 466  
467 -“Metadata Set”)
468 -)))|(% style="width:437px" %)(((
469 -The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure
470 -
471 471  Definition
472 472  )))
473 -|(% style="width:147px" %)//UncodedAttributeV alue//|(% style="width:222px" %)(((
419 +|(% style="width:147px" %)//UncodedAttributeValue//|(% style="width:246px" %)(((
474 474  Inherits from
475 -
476 476  //AttributeValue//
477 -
478 478  Sub classes
479 -
480 480  OtherUncodedAttribute Value
481 -
482 482  TextAttributeValue
483 -)))|(% style="width:437px" %)
484 -|(% style="width:147px" %)OtherUncodedAttri buteValue|(% style="width:222px" %)(((
425 +)))|(% style="width:395px" %)
426 +|(% style="width:147px" %)OtherUncodedAttributeValue|(% style="width:246px" %)(((
485 485  Inherits from
486 -
487 -//UncodedObservationVal ue//
488 -)))|(% style="width:437px" %)An attribute value that has a text value
489 -|(% style="width:147px" %) |(% style="width:222px" %)value|(% style="width:437px" %)The value of the Uncoded attribute.
490 -|(% style="width:147px" %) |(% style="width:222px" %)startTime|(% style="width:437px" %)This attribute is only used if the textFormat of the attribute is of the Timespan type in the Data Structure Definition (in which case the value field takes a duration).
491 -|(% style="width:147px" %)TextAttributeValu e|(% style="width:222px" %)(((
428 +//UncodedObservationValue//
429 +)))|(% style="width:395px" %)An [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] value that has a text value
430 +|(% style="width:147px" %) |(% style="width:246px" %)value|(% style="width:395px" %)The value of the Uncoded [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]].
431 +|(% style="width:147px" %) |(% style="width:246px" %)startTime|(% style="width:395px" %)This [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is only used if the textFormat of the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is of the Timespan type in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] (in which case the value field takes a duration).
432 +|(% style="width:147px" %)TextAttributeValue|(% style="width:246px" %)(((
492 492  Inherits from
493 -
494 494  //UncodedAttributeValue//
495 -)))|(% style="width:437px" %)An attribute that has a localised text value
496 -|(% style="width:147px" %) |(% style="width:222px" %)text|(% style="width:437px" %)The localised text values.
497 -|(% style="width:147px" %)CodedAttributeVal ue|(% style="width:222px" %)(((
435 +)))|(% style="width:395px" %)An [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] that has a localised text value
436 +|(% style="width:147px" %) |(% style="width:246px" %)text|(% style="width:395px" %)The localised text values.
437 +|(% style="width:147px" %)CodedAttributeValue|(% style="width:246px" %)(((
498 498  Inherits from
499 -
500 500  //AttributeValue//
501 -)))|(% style="width:437px" %)An attribute that takes it value from a Code in Code list.
502 -|(% style="width:147px" %) |(% style="width:222px" %)+valueOf|(% style="width:437px" %)Association to the Code that is the value of the Attribute Value. Note that this is a conceptual association showing that the Code must exist in the Code list associated with the Data Attribute in the Data Structure Definition. In the actual Data Set the value of the Code is placed in the Attribute Value.
440 +)))|(% style="width:395px" %)An [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] that takes it value from a [[Code>>doc:xwiki:Glossary.Code.WebHome]] in [[Code list>>doc:xwiki:Glossary.Code list.WebHome]].
441 +|(% style="width:147px" %) |(% style="width:246px" %)+valueOf|(% style="width:395px" %)Association to the [[Code>>doc:xwiki:Glossary.Code.WebHome]] that is the value of the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Value. Note that this is a conceptual association showing that the [[Code>>doc:xwiki:Glossary.Code.WebHome]] must exist in the [[Code list>>doc:xwiki:Glossary.Code list.WebHome]] associated with the Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. In the actual [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]] the value of the [[Code>>doc:xwiki:Glossary.Code.WebHome]] is placed in the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Value.
503 503  
504 504