Wiki source code of 5 Data Structure Definition and Dataset
Last modified by Artur on 2025/09/10 11:19
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | == {{id name="_Toc371009"/}}5.1 Introduction == | ||
| 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] (also referred to as [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]) is used in this specification. | ||
| 8 | |||
| 9 | Many of the constructs in this layer of the model inherit from the [[SDMX>>doc:sdmx: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 | |||
| 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:sdmx: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:sdmx:Glossary.Attribute.WebHome]]. The relationship diagrams shown in this section show clearly when these associations are inherited from the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base (see the Appendix “A Short Guide to UML in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]” to see the diagrammatic notation used to depict this). | ||
| 12 | |||
| 13 | The actual [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base construct from which the concrete classes inherit depends upon the requirements of the class for: | ||
| 14 | |||
| 15 | * [[Annotation>>doc:sdmx:Glossary.Annotation.WebHome]] - //AnnotableArtefact// | ||
| 16 | * Identification - //IdentifiableArtefact// | ||
| 17 | * Naming - //NameableArtefact// | ||
| 18 | * Versioning – //VersionableArtefact// | ||
| 19 | * Maintenance - //MaintainableArtefact// | ||
| 20 | |||
| 21 | == {{id name="_Toc371010"/}}5.2 Inheritance View == | ||
| 22 | |||
| 23 | === {{id name="_Toc371011"/}}5.2.1 Class Diagram === | ||
| 24 | |||
| 25 | [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_aa1923f1.png||height="628" width="556"]] | ||
| 26 | |||
| 27 | **Figure 22 Class inheritance in the Data Structure Definition and Data Set Packages** | ||
| 28 | |||
| 29 | === {{id name="_Toc371012"/}}5.2.2 Explanation of the Diagram === | ||
| 30 | |||
| 31 | ==== 5.2.2.1 Narrative ==== | ||
| 32 | |||
| 33 | Those classes in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]] inherit from //AnnotableArtefact// . These are: | ||
| 34 | |||
| 35 | * //IdentifiableArtefact// | ||
| 36 | * [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] (and therefore StructureSpecificDataSet, GenericDataSet, GenericTimeSeriesDataSet StructureSpecificTimeSeriesDataSet) | ||
| 37 | * //Key //(and therefore SeriesKey and GroupKey) | ||
| 38 | |||
| 39 | Those classes in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]] and global identity are derived from //IdentifiableArtefact// . These are: | ||
| 40 | |||
| 41 | * //NameableArtefact// | ||
| 42 | * //ComponentList// | ||
| 43 | * //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 44 | |||
| 45 | Those classes in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]], global identity, multilingual name and multilingual description are derived from //NameableArtefact// . These are: | ||
| 46 | |||
| 47 | * //VersionableArtefact// | ||
| 48 | * //Item// | ||
| 49 | |||
| 50 | The classes in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]], global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact// . These are: | ||
| 51 | |||
| 52 | * //MaintainableArtefact// | ||
| 53 | |||
| 54 | Abstract classes which represent information that is maintained by [[Maintenance Agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] all inherit from //MaintainableArtefact//, they also inherit all the features of a //VersionableArtefact//, and are: | ||
| 55 | |||
| 56 | * //StructureUsage// | ||
| 57 | * //Structure// | ||
| 58 | * //ItemScheme// | ||
| 59 | |||
| 60 | 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. | ||
| 61 | |||
| 62 | Those concrete classes in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and [[Dataset>>doc:sdmx: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: | ||
| 63 | |||
| 64 | * DataflowDefinition | ||
| 65 | * DataStructureDefinition | ||
| 66 | |||
| 67 | The [[component>>doc:sdmx:Glossary.Component.WebHome]] structures that are lists of lists, inherit directly from //Structure//. A //Structure// contains several lists of [[components>>doc:sdmx:Glossary.Component.WebHome]]. The concrete class that inherits from Structure is: | ||
| 68 | |||
| 69 | * DataStructureDefinition | ||
| 70 | |||
| 71 | A DataStructureDefinition contains a list of [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], a list of [[measures>>doc:sdmx:Glossary.Measure.WebHome]] and a list of attributes. | ||
| 72 | |||
| 73 | The concrete classes which inherit from //ComponentList// and are sub [[components>>doc:sdmx:Glossary.Component.WebHome]] of the DataStructureDefinition are: | ||
| 74 | |||
| 75 | * DimensionDescriptor – content is [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], MeasureDimension and Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] | ||
| 76 | * DimensionGroupDescriptor – content is an association to [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], MeasureDimension, TimeDimension | ||
| 77 | * MeasureDescriptor – content is PrimaryMeasure | ||
| 78 | * AttributeDescriptor – content is DataAttribute | ||
| 79 | |||
| 80 | The classes that inherit from //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// are: | ||
| 81 | |||
| 82 | * PrimaryMeasure | ||
| 83 | * DimensionComponent and thereby its sub classes of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], MeasureDimension, and TimeDimension | ||
| 84 | * DataAttribute | ||
| 85 | |||
| 86 | The class that inherit from DataAttribute is: | ||
| 87 | |||
| 88 | * ReportingYearStartDay | ||
| 89 | |||
| 90 | 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. | ||
| 91 | |||
| 92 | == {{id name="_Toc371013"/}}5.3 Data Structure Definition – Relationship View == | ||
| 93 | |||
| 94 | === {{id name="_Toc371014"/}}5.3.1 Class Diagram === | ||
| 95 | |||
| 96 | (% class="wikigeneratedid" %) | ||
| 97 | [[image:1747897165713-725.png]] | ||
| 98 | |||
| 99 | (% class="wikigeneratedid" id="HFigure23RelationshipclassdiagramoftheDataStructureDefinitionexcludingrepresentation" %) | ||
| 100 | **Figure 23 Relationship class diagram of the Data Structure Definition excluding representation** | ||
| 101 | |||
| 102 | === {{id name="_Toc371015"/}}5.3.2 Explanation of the Diagrams === | ||
| 103 | |||
| 104 | ==== 5.3.2.1 Narrative ==== | ||
| 105 | |||
| 106 | A DataStructureDefinition defines the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], MeasureDimension, TimeDimension, DataAttributes, and PrimaryMeasure, and associated [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] that comprise the valid structure of data and related [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that are contained in a [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]], which is defined by a DataflowDefinition. | ||
| 107 | |||
| 108 | The DataflowDefinition may also have additional metadata attached that defines qualitative information and [[Constraints>>doc:Glossary.Constraint.WebHome]] on the use of the DataStructureDefinition such as the sub set of [[Codes>>doc:sdmx:Glossary.Code.WebHome]] used in a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (this is covered later in this document – see “Data [[Constraints>>doc:Glossary.Constraint.WebHome]] and Provisioning” section 9). Each DataflowDefinition has a maximum of one DataStructureDefinition specified which defines the structure of any [[DataSets>>doc:sdmx:Glossary.Data set.WebHome]] to be reported/disseminated. | ||
| 109 | |||
| 110 | There are three types of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] each having a common association to (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%): | ||
| 111 | |||
| 112 | * [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] | ||
| 113 | * MeasureDimension | ||
| 114 | * TimeDimension | ||
| 115 | |||
| 116 | Note that In the description here //DimensionComponent// can be oany or all of its sub classes i.e. [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], MeasureDimension, TimeDimension., and the term “DataAttribute” refers to both DataAttribute and its sub class ReportingYearStartDate. | ||
| 117 | |||
| 118 | The //DimensionComponent//, DataAttribute, and PrimaryMeasure link to the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) that defines its name and semantic (/conceptIdentity association to (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%)). The DataAttribute, [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], and MeasureDimension (but not TimeDimension) can optionally have a +conceptRole association with a (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) that identifies its role in the DataStructureDefinition. Therefore, the allowable roles of a (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) are maintained in a ConceptScheme. Examples of roles are: geography, entity, count, [[unit of measure>>doc:sdmx:Glossary.Unit of measure.WebHome]]. The use of these roles is to enable applications to process the data in a meaningful way (e.g. relating a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] value to a mapping vector). It is expected that communities (such as the official statistics community) will harmonise these roles with their community so that data can be exchanged and shared in a meaningful way in the community. | ||
| 119 | |||
| 120 | The valid values for a //DimensionComponent//, PrimaryMeasure, or DataAttribute, when used in this DataStructureDefinition, are defined by the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]]. This [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] is taken from the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) definition (coreRepresentation) unless it is overridden in this DataStructureDefinition (localRepresentation) – see Figure 23. Note that for the MeasureDimension the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] must be a ConceptScheme and this must always be referenced from the MeasureDimension and cannot therefore be defaulted to the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] of the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) associated by the/conceptIdentity. Note also that TimeDimension and ReportingYearStartDate are constrained to specific FacetValueTypes | ||
| 121 | |||
| 122 | There will always be a DimensionDescriptor grouping that identifies all of the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] comprising the full key. Together the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] specify the key of an Observation. | ||
| 123 | |||
| 124 | The //DimensionComponent// can optionally be grouped by multiple GroupDimensionDescriptors each of which identifies the group of [[Dimensions>>doc:sdmx: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:sdmx:Glossary.Data set.WebHome]] to declare which DataAttributes are reported at this group (% style="color: rgb(231, 76, 60); color: rgb(231, 76, 60)" %)level(%%) in the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 125 | |||
| 126 | There may be a maximum of one MeasureDimension specified in the DimensionDescriptor. The purpose of a MeasureDimension is to specify formally the meaning of the [[measures>>doc:sdmx:Glossary.Measure.WebHome]] (because the PrimaryMeasure typically has a generic meaning e.g. [[observation value>>doc:sdmx:Glossary.Observation value.WebHome]]) and to enable multiple [[measures>>doc:sdmx:Glossary.Measure.WebHome]] to be defined and reported in a StructureSpecificDataSet. Note that the MeasureDimension references a ConceptScheme as its [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (see later) whereas a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can have either an enumerated ([[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]) or non-enumerated ([[Facet>>doc:sdmx:Glossary.Facet.WebHome]]) [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. For a MeasureDimension the (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) in the ConceptScheme comprise the list of allowable [[measures>>doc:sdmx:Glossary.Measure.WebHome]]. This enables the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for each individual [[measure>>doc:sdmx:Glossary.Measure.WebHome]] ((% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%)) to be declared as the coreRepresentation of the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%), thus overriding the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] specified for the PrimaryMeasure for the [[observation value>>doc:sdmx:Glossary.Observation value.WebHome]] of this MeasureDimension (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%). | ||
| 127 | |||
| 128 | There can be a maximum of one TimeDimension specified in the DimensionDescriptor. The TimeDimension is used to specify the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) used to convey the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] of the observation in a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. The TimeDimension must contain a valid [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time and cannot be coded | ||
| 129 | |||
| 130 | The PrimaryMeasure is the observable phenomenon, and, although there can be only one PrimaryMeasure, for consistency with the ComponentList/[[Component>>doc:sdmx:Glossary.Component.WebHome]] pattern it is grouped by a MeasureDescriptor. | ||
| 131 | |||
| 132 | 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 specified as being mandatory, or conditional, as defined in usageStatus. The DataAttribute may play a specific role in the structure and this is specified by the +role association to the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) that identifies its role. | ||
| 133 | |||
| 134 | A DataAttribute is specified as being +relatedTo an AttributeRelationship which defines the constructs to which the DataAttribute is to be reported present in a //[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]//. The DataAttribute can be specified as being related to one of the following [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]: | ||
| 135 | |||
| 136 | * [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] (NoSpecifiedRelationship) | ||
| 137 | * [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or set of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] (DimensionRelationship) | ||
| 138 | * Set of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] specified by a GroupKey (GroupRelationship – this is retained for compatibility reasons – or +groupKey of the DimensionRelationship) | ||
| 139 | * Observation (PrimaryMeasureRelationship) | ||
| 140 | |||
| 141 | [[image:1747896950895-141.png]] | ||
| 142 | |||
| 143 | **Figure 24: Attribute Attachment Defined in the Data Structure Definition** | ||
| 144 | |||
| 145 | The following table details the possible relationships a DataAttribute may specify. Note that these relationships are mutually exclusive, and therefore only one of the following is possible. | ||
| 146 | |||
| 147 | ((( | ||
| 148 | (% style="width:1104.83px" %) | ||
| 149 | |**Relationship**|(% style="width:415px" %)**Meaning**|(% style="width:556px" %)**Location in [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] at which the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is reported** | ||
| 150 | |None|(% style="width:415px" %)The value of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] does not vary with the values of any other [[Component>>doc:sdmx:Glossary.Component.WebHome]].|(% style="width:556px" %)The [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is reported at the level of the [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]] [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 151 | |((( | ||
| 152 | [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] | ||
| 153 | |||
| 154 | (1..n) | ||
| 155 | )))|(% style="width:415px" %)The value of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will vary with the value(s) of the referenced [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]](s). In this case, Group(s) to which the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be attached may optionally be specified.|(% style="width:556px" %)The [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is reported at the lowest level of the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] to which the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is related, otherwise at the level of the Group if Attachment Group(s) is specified. | ||
| 156 | |Group|(% style="width:415px" %)((( | ||
| 157 | The value of the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] varies with combination of values for all of the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] contained in the Group. This is added as a convenience to listing all [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and the attachment Group, but should only be used when the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] value varies based on __all__ Group [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values. | ||
| 158 | )))|(% style="width:556px" %)The [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is reported at the level of Group. | ||
| 159 | |Primary [[Measure>>doc:sdmx:Glossary.Measure.WebHome]]|(% style="width:415px" %)The value of the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] varies with the observed value.|(% style="width:556px" %)The [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is reported at the level of Observation. | ||
| 160 | ))) | ||
| 161 | |||
| 162 | **Figure 25: Representation of DSD Components** | ||
| 163 | |||
| 164 | Each of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], MeasureDimension, TimeDimension, PrimaryMeasure, and DataAttribute can have a [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] specified (using the localRepresentation association). If this is not specified in the DataStructureDefinition then the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] specified for (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) (coreRepresentation) is used. For the MeasureDimension the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for the individual [[measures>>doc:sdmx:Glossary.Measure.WebHome]] is specified for the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) in the ConceptScheme referenced by the MeasureDimension. | ||
| 165 | |||
| 166 | A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap. | ||
| 167 | |||
| 168 | ==== 5.3.2.2 Definitions ==== | ||
| 169 | |||
| 170 | (% style="width:1060.83px" %) | ||
| 171 | |**Class**|**Feature**|(% style="width:695px" %)**Description** | ||
| 172 | |StructureUsage| |(% style="width:695px" %)See “[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base”. | ||
| 173 | |DataflowDefinition|((( | ||
| 174 | Inherits from | ||
| 175 | //StructureUsage// | ||
| 176 | )))|(% style="width:695px" %)Abstract (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) (i.e. the structure without any data) of a flow of data that providers will provide for different reference periods. | ||
| 177 | | |/structure|(% style="width:695px" %)Associates a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition to the Data Structure Definition. | ||
| 178 | |DataStructureDefinition| |(% style="width:695px" %)A collection of metadata (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%), their structure and usage when used to collect or disseminate data. | ||
| 179 | | |///grouping//|(% style="width:695px" %)An association to a set of metadata (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) that have an identified structural role in a Data Structure Definition. | ||
| 180 | |((( | ||
| 181 | Group | ||
| 182 | |||
| 183 | DimensionDescriptor | ||
| 184 | )))|((( | ||
| 185 | Inherits from | ||
| 186 | //ComponentList// | ||
| 187 | )))|(% style="width:695px" %)A set metadata (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) that define a partial key derived from the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor in a Data Structure Definition. | ||
| 188 | | |+constraint|(% style="width:695px" %)Identifies an Attachment [[Constraint>>doc:Glossary.Constraint.WebHome]] that specifies the sub set of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[Measure>>doc:sdmx:Glossary.Measure.WebHome]], or [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values to which an [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be attached. | ||
| 189 | | |/components|(% style="width:695px" %)An association to the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] and [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]] that comprise the group. | ||
| 190 | |DimensionDescriptor|((( | ||
| 191 | Inherits from | ||
| 192 | //ComponentList// | ||
| 193 | )))|(% style="width:695px" %)An ordered set of metadata (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) that, combined, classify a statistical series, and whose values, when combined (the key) in an instance such as a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], uniquely identify a specific observation. | ||
| 194 | | |/components|(% style="width:695px" %)An association to the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], and Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] comprising the Key Descriptor. | ||
| 195 | |AttributeDescriptor|((( | ||
| 196 | Inherits from | ||
| 197 | //ComponentList// | ||
| 198 | )))|(% style="width:695px" %)A set metadata (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) that define the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] of a Data Structure Definition. | ||
| 199 | | |/components|(% style="width:695px" %)An association to a Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 200 | |MeasureDescriptor|((( | ||
| 201 | Inherits from | ||
| 202 | //ComponentList// | ||
| 203 | )))|(% style="width:695px" %)A metadata (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) that defines the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] of a Data Structure Definition. | ||
| 204 | | |/components|(% style="width:695px" %)An association to a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 205 | |[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]|((( | ||
| 206 | Inherits from | ||
| 207 | [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 208 | )))|(% style="width:695px" %)A metadata (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) used (most probably together with other metadata (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%)) to classify a statistical series, e.g. a statistical (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) indicating a certain [[economic activity>>doc:sdmx:Glossary.Economic activity.WebHome]] or a geographical reference area. | ||
| 209 | | |/role|(% style="width:695px" %)Association to the (% style="color:#e74c3c" %)[[Сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) that specifies the role that that the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] plays in the Data Structure Definition. | ||
| 210 | | |/conceptIdentity|(% style="width:695px" %)An association to the metadata (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) which defines the semantic of the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 211 | |MeasureDimension|((( | ||
| 212 | Inherits from | ||
| 213 | |||
| 214 | [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] | ||
| 215 | )))|(% style="width:695px" %)A statistical (% style="color:#e74c3c" %)[[concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) that identifies the [[component>>doc:sdmx:Glossary.Component.WebHome]] in the key structure that has an enumerated list of [[measures>>doc:sdmx:Glossary.Measure.WebHome]]. This [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] has, as its [[representation>>doc:sdmx:Glossary.Representation.WebHome]] the [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] that enumerates the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)[[concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%). | ||
| 216 | |DataAttribute|((( | ||
| 217 | Inherits from | ||
| 218 | [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 219 | Sub class | ||
| 220 | ReportingYear | ||
| 221 | StartDay | ||
| 222 | )))|(% style="width:695px" %)A characteristic of an object or entity. | ||
| 223 | | |/role|(% style="width:695px" %)Association to the (% style="color:#e74c3c" %)[[Сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) that specifies the role that that the Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] plays in the Data Structure Definition. | ||
| 224 | | |usageStatus|(% style="width:695px" %)Defines the [[usage status>>doc:sdmx:Glossary.Usage status.WebHome]] which is constrained by the data type [[Usage Status>>doc:sdmx:Glossary.Usage status.WebHome]]. | ||
| 225 | | |+relatedTo|(% style="width:695px" %)Association to a [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Relationship. | ||
| 226 | | |/conceptIdentity|(% style="width:695px" %)An association to the (% style="color:#e74c3c" %)[[Сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) which defines the semantic of the [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 227 | |TimeDimension|((( | ||
| 228 | Inherits from | ||
| 229 | [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] | ||
| 230 | )))|(% style="width:695px" %)A metadata (% style="color:#e74c3c" %)[[сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) that identifies the [[component>>doc:sdmx:Glossary.Component.WebHome]] in the key structure that has the role of “time”. | ||
| 231 | |ReportingYearStartDay|((( | ||
| 232 | Inherits from | ||
| 233 | DataAttribute | ||
| 234 | )))|(% style="width:695px" %)A specialised Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] whose value is used in conjunction with the predefined reporting periods in the Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. If this is not present, then by default all reporting period values for the Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] will be assumed to be based on a reporting year start day of January 1. | ||
| 235 | |PrimaryMeasure|((( | ||
| 236 | Inherits from | ||
| 237 | //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 238 | )))|(% style="width:695px" %)The metadata (% style="color:#e74c3c" %)[[сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) that is the phenomenon to be measured in a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. In a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] the instance of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] is often called the observation. | ||
| 239 | | |/conceptIdentity|(% style="width:695px" %)An association to the (% style="color:#e74c3c" %)[[Сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) which carries the values of the [[measures>>doc:sdmx:Glossary.Measure.WebHome]]. | ||
| 240 | |//AttributeRelationship//|((( | ||
| 241 | Abstract Class | ||
| 242 | Sub classes | ||
| 243 | NoSpecified | ||
| 244 | Relationship | ||
| 245 | PrimaryMeasure | ||
| 246 | Relationship | ||
| 247 | GroupRelationship | ||
| 248 | Dimension | ||
| 249 | Relationship | ||
| 250 | )))|(% style="width:695px" %)Specifies the type of [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] to which a Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be attached in a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 251 | |NoSpecifiedRelationship| |(% style="width:695px" %)The Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not related to any specific construct. | ||
| 252 | |PrimaryMeasure Relationship| |(% style="width:695px" %)The Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is related to the Primary [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] construct. | ||
| 253 | |GroupRelationship| |(% style="width:695px" %)The Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is related to a Group [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor construct. | ||
| 254 | | |+groupKey|(% style="width:695px" %)An association to the Group [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor | ||
| 255 | |DimensionRelationship| |(% style="width:695px" %)The Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is related to a set of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 256 | | |+dimensions|(% style="width:695px" %)Association to the set of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] to which the Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is related. | ||
| 257 | | |+groupKey|(% style="width:695px" %)Association to the Group [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor which specifies the set of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] to which the Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is attached. | ||
| 258 | |||
| 259 | The explanation of the classes, [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], and associations comprising the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] is described in the section on the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Base. | ||
| 260 | |||
| 261 | == {{id name="_Toc371016"/}}5.4 Data Set – Relationship View == | ||
| 262 | |||
| 263 | === {{id name="_Toc371017"/}}5.4.1 Context === | ||
| 264 | |||
| 265 | A [[data set>>doc:sdmx:Glossary.Data set.WebHome]] comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition. | ||
| 266 | |||
| 267 | === {{id name="_Toc371018"/}}5.4.2 Class Diagram === | ||
| 268 | |||
| 269 | (% class="wikigeneratedid" id="H" %) | ||
| 270 | [[image:1747897072125-219.png]] | ||
| 271 | |||
| 272 | (% class="wikigeneratedid" id="HFigure26ClassDiagramoftheDataSet" %) | ||
| 273 | **Figure 26 Class Diagram of the Data Set** | ||
| 274 | |||
| 275 | === {{id name="_Toc371019"/}}5.4.3 Explanation of the Diagram === | ||
| 276 | |||
| 277 | ==== 5.4.3.1 Narrative – Data Set ==== | ||
| 278 | |||
| 279 | Note that the //[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]// must conform to the DataStructureDefinition associated to the DataflowDefinition for which this [[DataSet>>doc:sdmx: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:sdmx:Glossary.Data set.WebHome]] as exchanged there must, of course, be a reference to the DataStructureDefinition and optionally a DataflowDefinition, 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:sdmx:Glossary.Data set.WebHome]]// when the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] is exchanged. However, the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] in the DataStructureDefinition can be used by an application to validate the contents of the //[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]// in terms of the valid content of a //KeyValue// as defined by the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] in the DataStructureDefinition. | ||
| 280 | |||
| 281 | An organisation playing the role of DataProvider can be responsible for one or more //[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]//. | ||
| 282 | |||
| 283 | A //[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]// can be formatted either as a generic [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (GenericDataSet, GenericTimeseriesDataSet) or a DataStructureDefinition specific [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (StructureSpecificDataSet, StructureSpecificTimeseriesDataSet). The generic [[data set>>doc:sdmx:Glossary.Data set.WebHome]] is structured in exactly the same way no matter which DataStructureDefinition the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] expresses. The structured [[data set>>doc:sdmx:Glossary.Data set.WebHome]] is structured according to one specific DataStructureDefinition. Depending on the syntax chosen for the implementation the structured [[data set>>doc:sdmx:Glossary.Data set.WebHome]] should support better validation at the syntax level. | ||
| 284 | |||
| 285 | A //[[DataSet>>doc:sdmx: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:sdmx:Glossary.Component.WebHome]] ([[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], MeasureDimension, TimeDimension) defined in the DimensionDescriptor of the DataStructureDefinition, together with associated //AttributeValue//s that define specific characteristics about the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] to which it is attached. - [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]], Observation, set of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]. It is structured in terms of a SeriesKey to which //Observation//s are reported. | ||
| 286 | |||
| 287 | The Observation can be the value of the variable being measured for the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) associated to the PrimaryMeasure in the MeasureDescriptor of the DataStructureDefinition. This is true when there is no MeasureDimension that specifies the precise meaning of each Observation. Each Observation associates an ObservationValue with a KeyValue (+observationDimension) which is the value for the “[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the Observation Level”. Any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be specified as being the “[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the Observation (% style="color: rgb(231, 76, 60); color: rgb(231, 76, 60)" %)Level(%%)”, and this specification is made at the level of the //[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]// (i.e. it must be the same [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] for the entire //[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]//). | ||
| 288 | |||
| 289 | If the “[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the Observation Level” is the MeasureDimension it is possible (but not mandatory) that an Observation can be reported with an explicit identification of one or more (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) in the ConceptScheme referenced by the MeasureDimension as its [[Representation>>doc:sdmx:Glossary.Representation.WebHome]]. In other words, the actual (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) are explicitly stated in the Observation. | ||
| 290 | |||
| 291 | If it is required to specify explicitly that the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] is time series then one of GenericTimeSeriesDataSet or StructureSpecificTimeSeriesDataSet is used and the //KeyValue// for the +observationDimension must be a TimeKeyValue. In a GenericDataSet and a StructureSpecificDataSet it is permissible to have any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] as the +observationDimension including the TimeDimension. | ||
| 292 | |||
| 293 | The //KeyValue// is a value for one of MeasureDimension, TimeDimension, or [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] specified in the DataStructureDefinition. If it is a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] it can be coded (CodedKeyValue) or uncoded (UncodedKeyValue). If it is a MeasureDimension then it is MeasureKeyValue. If it is TimeDimension then it is a TimeKeyValue. The actual value that the CodedDimensionValue can take must be one of the [[Codes>>doc:sdmx:Glossary.Code.WebHome]] in the [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] specified as the [[Representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the DataStructureDefinition. The actual value that the MeasureDimensionValue can take must be a valid [[representation>>doc:sdmx:Glossary.Representation.WebHome]] specified for the (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) in the ConceptScheme to which this MeasureDimensionValue is related (+valueFor). | ||
| 294 | |||
| 295 | The ObservationValue can be coded - this is the CodedObservation – or it can be uncoded – this is the UncodedObservation. | ||
| 296 | |||
| 297 | The GroupKey is a sub unit 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:sdmx: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 | ||
| 298 | |||
| 299 | 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>>doc:sdmx: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:sdmx:Glossary.Dimension.WebHome]] in the SeriesKey or Observation. | ||
| 300 | |||
| 301 | In this way each of //[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]//, SeriesKey, GroupKey, and Observation can have zero or more AttributeValue that defines some metadata about the object to which it is associated. The allowable (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) and the objects to which these metadata can be associated (attached) are defined in the DataStructureDefinition. | ||
| 302 | |||
| 303 | The //AttributeValue// links to the object type ([[DataSet>>doc:sdmx:Glossary.Data set.WebHome]], SeriesKey, GroupKey, Observation,) to which it is associated. | ||
| 304 | |||
| 305 | ==== 5.4.3.2 Definitions ==== | ||
| 306 | |||
| 307 | (% style="width:1012.83px" %) | ||
| 308 | |(% style="width:182px" %)**Class**|(% style="width:210px" %)**Feature**|(% style="width:617px" %)**Description** | ||
| 309 | |(% style="width:182px" %)//[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]//|(% style="width:210px" %)((( | ||
| 310 | Abstract Class | ||
| 311 | Sub classes | ||
| 312 | GenericDataSet | ||
| 313 | StructureSpecificDataSet | ||
| 314 | GenericTime | ||
| 315 | SeriesDataSet | ||
| 316 | StructureSpecificTime | ||
| 317 | SeriesDataSet | ||
| 318 | )))|(% style="width:617px" %)An organised collection of data. | ||
| 319 | |(% style="width:182px" %) |(% style="width:210px" %)reportingBegin|(% style="width:617px" %)A specific [[time period>>doc:sdmx:Glossary.Time period.WebHome]] in a known system of [[time periods>>doc:sdmx:Glossary.Time period.WebHome]] that identifies the start period of a report. | ||
| 320 | |(% style="width:182px" %) |(% style="width:210px" %)reportingEnd|(% style="width:617px" %)A specific [[time period>>doc:sdmx:Glossary.Time period.WebHome]] in a known system of [[time periods>>doc:sdmx:Glossary.Time period.WebHome]] that identifies the end period of a report. | ||
| 321 | |(% style="width:182px" %) |(% style="width:210px" %)dataExtractionDate|(% style="width:617px" %)A specific [[time period>>doc:sdmx:Glossary.Time period.WebHome]] that identifies the date and time that the data are extracted from a data source. | ||
| 322 | |(% style="width:182px" %) |(% style="width:210px" %)validFrom|(% style="width:617px" %)Indicates the inclusive start time indicating the validity of the information in the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 323 | |(% style="width:182px" %) |(% style="width:210px" %)validTo|(% style="width:617px" %)Indicates the inclusive end time indicating the validity of the information in the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 324 | |(% style="width:182px" %) |(% style="width:210px" %)publicationYear|(% style="width:617px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force. | ||
| 325 | |(% style="width:182px" %) |(% style="width:210px" %)publicationPeriod|(% style="width:617px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force. | ||
| 326 | |(% style="width:182px" %) |(% style="width:210px" %)setId|(% style="width:617px" %)Provides an identification of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 327 | |(% style="width:182px" %) |(% style="width:210px" %)action|(% style="width:617px" %)Defines the action to be taken by the recipient system (update, append, delete) | ||
| 328 | |(% style="width:182px" %) |(% style="width:210px" %)describedBy|(% style="width:617px" %)Associates a [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] definition and thereby a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] to the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 329 | |(% style="width:182px" %) |(% style="width:210px" %)+structuredBy|(% style="width:617px" %)Associates the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] that defines the structure of the [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]]. Note that the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] is the same as that associated (nonmandatory) to the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition. | ||
| 330 | |(% style="width:182px" %) |(% style="width:210px" %)+publishedBy|(% style="width:617px" %)Associates the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] that reports/publishes the data. | ||
| 331 | |(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Values relating to the [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] | ||
| 332 | |(% style="width:182px" %)GenericDataSet|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that is able to contain data corresponding to any [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 333 | |(% style="width:182px" %)StructureSpecific [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that contains data corresponding to one specific [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 334 | |(% style="width:182px" %)GenericTimeseries [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that is able to contain timeseries data corresponding to any [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 335 | |(% style="width:182px" %)((( | ||
| 336 | StructureSpecific | ||
| 337 | |||
| 338 | TimeseriesDataSet | ||
| 339 | )))|(% style="width:210px" %) |(% style="width:617px" %)A data format structure that contains timeseries data corresponding to one specific [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 340 | |(% style="width:182px" %)Key|(% style="width:210px" %)((( | ||
| 341 | Abstract class Sub classes | ||
| 342 | SeriesKey | ||
| 343 | GroupKey | ||
| 344 | )))|(% style="width:617px" %)Comprises the cross product of values of [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] that identify uniquely an Observation. | ||
| 345 | |(% style="width:182px" %) |(% style="width:210px" %)keyValues|(% style="width:617px" %)Association to the individual Key Values that comprise the Key. | ||
| 346 | |(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Values relating to the [[Series Key>>doc:sdmx:Glossary.Series key.WebHome]] or Group Key. | ||
| 347 | |(% style="width:182px" %)//KeyValue//|(% style="width:210px" %)((( | ||
| 348 | Abstract class | ||
| 349 | Sub classes | ||
| 350 | MeasureKeyValue | ||
| 351 | TimeKeyValue | ||
| 352 | CodedKeyValue | ||
| 353 | UncodedKeyValue | ||
| 354 | )))|(% style="width:617px" %)The value of a [[component>>doc:sdmx:Glossary.Component.WebHome]] of a key such as the value of the instance a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor of a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 355 | |(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)((( | ||
| 356 | Association to the key [[component>>doc:sdmx:Glossary.Component.WebHome]] in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] for which this Key Value is a valid [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 357 | Note that this is conceptual association as the key [[component>>doc:sdmx:Glossary.Component.WebHome]] is identified explicitly in the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 358 | ))) | ||
| 359 | |(% style="width:182px" %)MeasureKeyValue|(% style="width:210px" %)((( | ||
| 360 | Inherits from | ||
| 361 | //KeyValue// | ||
| 362 | )))|(% style="width:617px" %)The value of the [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]] of the key. The value is the (% style="color:#e74c3c" %)[[Сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) to which this class is associated. | ||
| 363 | |(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)((( | ||
| 364 | Association to the (% style="color:#e74c3c" %)[[Сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%). | ||
| 365 | Note that this is a conceptual association showing that the (% style="color:#e74c3c" %)[[Сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) must exist in the [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] associated with the [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. In the actual [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] the value of the (% style="color:#e74c3c" %)[[Сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) is placed in the Key Value. | ||
| 366 | ))) | ||
| 367 | |(% style="width:182px" %)TimeKeyValue|(% style="width:210px" %)((( | ||
| 368 | Inherits from | ||
| 369 | //KeyValue// | ||
| 370 | )))|(% style="width:617px" %)The value of the Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]] of the key. | ||
| 371 | |(% style="width:182px" %)CodedKeyValue|(% style="width:210px" %)((( | ||
| 372 | Inherits from | ||
| 373 | //KeyValue// | ||
| 374 | )))|(% style="width:617px" %)The value of a coded [[component>>doc:sdmx:Glossary.Component.WebHome]] of the key. The value is the [[Code>>doc:sdmx:Glossary.Code.WebHome]] to which this class is associated. | ||
| 375 | |(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)((( | ||
| 376 | Association to the [[Code>>doc:sdmx:Glossary.Code.WebHome]]. | ||
| 377 | Note that this is a conceptual association showing that the [[Code>>doc:sdmx:Glossary.Code.WebHome]] must exist in the [[Code list>>doc:sdmx:Glossary.Code list.WebHome]] associated with the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. In the actual [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] the value of the [[Code>>doc:sdmx:Glossary.Code.WebHome]] is placed in the Key Value. | ||
| 378 | ))) | ||
| 379 | |(% style="width:182px" %)UnCodedKeyValue|(% style="width:210px" %)((( | ||
| 380 | Inherits from | ||
| 381 | //KeyValue// | ||
| 382 | )))|(% style="width:617px" %)The value of an uncoded [[component>>doc:sdmx:Glossary.Component.WebHome]] of the key. | ||
| 383 | |(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the key [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 384 | |(% style="width:182px" %) |(% style="width:210px" %)startTime|(% style="width:617px" %)This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is only used if the textFormat of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is of the Timespan type in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] (in which case the value field takes a duration). | ||
| 385 | |(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)Associates [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], or Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] to the Key Value, and thereby to the (% style="color:#e74c3c" %)[[Сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) that is the semantic of the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], or Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 386 | |(% style="width:182px" %)GroupKey|(% style="width:210px" %)((( | ||
| 387 | Inherits from | ||
| 388 | |||
| 389 | Key | ||
| 390 | )))|(% style="width:617px" %)A set of Key Values that comprise a partial key, of the same dimensionality as the Time [[Series Key>>doc:sdmx:Glossary.Series key.WebHome]] for the purpose of attaching Data Attributes. | ||
| 391 | |(% style="width:182px" %) |(% style="width:210px" %)+describedBy|(% style="width:617px" %)Associates the Group [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor defined in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 392 | |(% style="width:182px" %)SeriesKey|(% style="width:210px" %)((( | ||
| 393 | Inherits from | ||
| 394 | Key | ||
| 395 | )))|(% style="width:617px" %)Comprises the cross product of values of all the Key Values that, together with the Key Value of the +observation [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] identify uniquely an Observation. | ||
| 396 | |(% style="width:182px" %) |(% style="width:210px" %)+describedBy|(% style="width:617px" %)Associates the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor defined in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 397 | |(% style="width:182px" %)Observation|(% style="width:210px" %) |(% style="width:617px" %)The value of the observed phenomenon in the context of the Key Values comprising the key. | ||
| 398 | |(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)Associates the Primary [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] defined in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 399 | |(% style="width:182px" %) |(% style="width:210px" %)+attachedAttribute|(% style="width:617px" %)Association to the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Values relating to the Observation. | ||
| 400 | |(% style="width:182px" %) |(% style="width:210px" %)+observationDimension|(% style="width:617px" %)Association to the Key Value that holds the value of the “[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the Observation Level”. | ||
| 401 | |(% style="width:182px" %)//ObservationValue//|(% style="width:210px" %)((( | ||
| 402 | Abstract class | ||
| 403 | Sub classes | ||
| 404 | UncodedObservation | ||
| 405 | CodedObservation | ||
| 406 | )))|(% style="width:617px" %) | ||
| 407 | |(% style="width:182px" %)UncodedObservation|(% style="width:210px" %)((( | ||
| 408 | Inherits from | ||
| 409 | ObservationValue | ||
| 410 | )))|(% style="width:617px" %)An observation that has a text value. | ||
| 411 | |(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the Uncoded Observation. | ||
| 412 | |(% style="width:182px" %)CodedObservation|(% style="width:210px" %)((( | ||
| 413 | Inherits from | ||
| 414 | ObservationValue | ||
| 415 | )))|(% style="width:617px" %)An Observation that takes its value from a [[code>>doc:sdmx:Glossary.Code.WebHome]] in a [[Code list>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 416 | |(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)((( | ||
| 417 | Association to the [[Code>>doc:sdmx:Glossary.Code.WebHome]] that is the value of the Observation. | ||
| 418 | Note that this is a conceptual association showing that the [[Code>>doc:sdmx:Glossary.Code.WebHome]] must exist in the [[Code list>>doc:sdmx:Glossary.Code list.WebHome]] associated with the Primary [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] or the (% style="color:#e74c3c" %)[[Сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) of the [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. In the actual [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] the value of the [[Code>>doc:sdmx:Glossary.Code.WebHome]] is placed in the Observation. | ||
| 419 | ))) | ||
| 420 | |(% style="width:182px" %)//AttributeValue//|(% style="width:210px" %)((( | ||
| 421 | Abstract class | ||
| 422 | Sub classes | ||
| 423 | //UncodedAttributeValue | ||
| 424 | CodedAttributeValue// | ||
| 425 | )))|(% style="width:617px" %)The value of an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], such as the instance of a Coded [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or of an Uncoded [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in a structure such as a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 426 | |(% style="width:182px" %) |(% style="width:210px" %)value|(% style="width:617px" %)The value of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 427 | |(% style="width:182px" %) |(% style="width:210px" %)+valueFor|(% style="width:617px" %)((( | ||
| 428 | Association to the Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 429 | Note that this is conceptual association as the (% style="color:#e74c3c" %)[[Сoncept>>doc:sdmx:Glossary.Concept.WebHome]](%%) is identified explicitly in the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 430 | ))) | ||
| 431 | |(% style="width:182px" %)//UncodedAttribute Value//|(% style="width:210px" %)((( | ||
| 432 | Inherits from | ||
| 433 | //AttributeValue// | ||
| 434 | )))|(% style="width:617px" %)An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] value that has a text value. | ||
| 435 | |(% style="width:182px" %) |(% style="width:210px" %)startTime|(% style="width:617px" %)This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is only used if the textFormat of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is of the Timespan type in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] (in which case the value field takes a duration). | ||
| 436 | |(% style="width:182px" %)((( | ||
| 437 | CodedAttribute | ||
| 438 | |||
| 439 | Value | ||
| 440 | )))|(% style="width:210px" %)((( | ||
| 441 | Inherits from | ||
| 442 | //AttributeValue// | ||
| 443 | )))|(% style="width:617px" %)An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that takes it value from a [[Code>>doc:sdmx:Glossary.Code.WebHome]] in [[Code list>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 444 | |(% style="width:182px" %) |(% style="width:210px" %)+value|(% style="width:617px" %)((( | ||
| 445 | Association to the [[Code>>doc:sdmx:Glossary.Code.WebHome]] that is the value of the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Value. | ||
| 446 | Note that this is a conceptual association showing that the [[Code>>doc:sdmx:Glossary.Code.WebHome]] must exist in the [[Code list>>doc:sdmx:Glossary.Code list.WebHome]] associated with the Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. In the actual [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] the value of the [[Code>>doc:sdmx:Glossary.Code.WebHome]] is placed in the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Value. | ||
| 447 | ))) |