Wiki source code of 5 Data Structure Definition and Dataset
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | == 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 2\.1.Data structure definition.WebHome]] (also referred to as [[DSD>>doc:sdmx:Glossary 2\.1.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 2\.1.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>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. | ||
| 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 2\.1.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 2\.1.Attribute.WebHome]]. The relationship diagrams shown in this section show clearly when these associations are inherited from the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Base (see the Appendix “A Short Guide to UML in the [[SDMX Information Model>>doc:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]]” to see the diagrammatic notation used to depict this). | ||
| 12 | |||
| 13 | The actual [[SDMX>>doc:sdmx:Glossary 2\.1.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 2\.1.Annotation.WebHome]] – //AnnotableArtefact// | ||
| 16 | Identification – //IdentifiableArtefact// | ||
| 17 | Naming – //NameableArtefact// | ||
| 18 | Versioning – //VersionableArtefact// | ||
| 19 | Maintenance – //MaintainableArtefact// | ||
| 20 | |||
| 21 | == 5.2 Inheritance View == | ||
| 22 | |||
| 23 | === 5.2.1 Class Diagram === | ||
| 24 | |||
| 25 | [[image:image53.png]] | ||
| 26 | |||
| 27 | **Figure 27 Class inheritance in the Data Structure Definition and Data Set Packages** | ||
| 28 | |||
| 29 | === 5.2.2 Explanation of the Diagram === | ||
| 30 | |||
| 31 | ==== 5.2.2.1 Narrative ==== | ||
| 32 | |||
| 33 | Those classes in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] inherit from //AnnotableArtefact//. These are: | ||
| 34 | |||
| 35 | //IdentifiableArtefact | ||
| 36 | [[DataSet>>doc:sdmx:Glossary 2\.1.Data set.WebHome]] | ||
| 37 | Key// (and therefore //SeriesKey// and //GroupKey//) | ||
| 38 | //Observation// | ||
| 39 | |||
| 40 | Those classes in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]] and global identity are derived from //IdentifiableArtefact//. These are: | ||
| 41 | |||
| 42 | //NameableArtefact | ||
| 43 | ComponentList | ||
| 44 | [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]// | ||
| 45 | |||
| 46 | Those classes in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]], global identity, multilingual name and multilingual description are derived from //NameableArtefact//. These are: | ||
| 47 | |||
| 48 | //VersionableArtefact | ||
| 49 | Item// | ||
| 50 | |||
| 51 | The classes in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] metamodel which require [[annotations>>doc:sdmx:Glossary 2\.1.Annotation.WebHome]], global identity, multilingual name and multilingual description, and versioning are derived from //VersionableArtefact//. These are: | ||
| 52 | |||
| 53 | //MaintainableArtefact// | ||
| 54 | |||
| 55 | Abstract classes which represent information that is maintained by [[Maintenance Agencies>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]] all inherit from //MaintainableArtefact//, they also inherit all the features of a //VersionableArtefact//, and are: | ||
| 56 | |||
| 57 | //StructureUsage | ||
| 58 | Structure | ||
| 59 | ItemScheme// | ||
| 60 | |||
| 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 | |||
| 63 | Those concrete classes in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]] and [[Dataset>>doc:sdmx:Glossary 2\.1.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 | |||
| 65 | [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] | ||
| 66 | DataStructureDefinition | ||
| 67 | The [[component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] structures that are lists of lists, inherit directly from //Structure//. A //Structure// contains several lists of [[components>>doc:sdmx:Glossary 2\.1.Component.WebHome]]. The concrete class that inherits from //Structure// is: | ||
| 68 | DataStructureDefinition | ||
| 69 | |||
| 70 | A DataStructureDefinition contains a list of [[dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]], a list of [[measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] and a list of [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]. | ||
| 71 | |||
| 72 | The concrete classes which inherit from //ComponentList// and are subcomponents of the DataStructureDefinition are: | ||
| 73 | |||
| 74 | DimensionDescriptor – content is [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] and TimeDimension | ||
| 75 | DimensionGroupDescriptor – content is an association to [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]], TimeDimension | ||
| 76 | MeasureDescriptor – content is [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] | ||
| 77 | AttributeDescriptor – content is DataAttribute and an association to MetadataAttribute | ||
| 78 | |||
| 79 | The classes that inherit from //[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]// are: | ||
| 80 | |||
| 81 | [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] | ||
| 82 | //DimensionComponent// and thereby its sub classes of [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] and TimeDimension | ||
| 83 | //[[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]// and thereby its sub classes of DataAttribute and MetadataAttribute | ||
| 84 | |||
| 85 | 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. | ||
| 86 | |||
| 87 | == 5.3 Data Structure Definition – Relationship View == | ||
| 88 | |||
| 89 | === 5.3.1 Class Diagram === | ||
| 90 | |||
| 91 | [[image:image54.png]] | ||
| 92 | |||
| 93 | **Figure 28 Relationship class diagram of the Data Structure Definition excluding representation** | ||
| 94 | |||
| 95 | === 5.3.2 Explanation of the Diagrams === | ||
| 96 | |||
| 97 | ==== 5.3.2.1 Narrative ==== | ||
| 98 | |||
| 99 | A DataStructureDefinition defines the [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]], TimeDimension, DataAttributes, and [[Measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]], and associated [[Representations>>doc:sdmx:Glossary 2\.1.Representation.WebHome]], that comprise the valid structure of data and related [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] that are contained in a [[DataSet>>doc:sdmx:Glossary 2\.1.Data set.WebHome]], which is defined by a [[Dataflow>>doc:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.Component.WebHome]]// within the [[DSD>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]], as explained below. | ||
| 100 | |||
| 101 | The [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] may also have additional metadata attached that define qualitative information and [[Constraints>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] on the use of the DataStructureDefinition such as the subset of [[Codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] used in a [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] (this is covered later in this document – see sections “[[Constraints>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]]” and “Data Provisioning”). Each [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] has a maximum of one DataStructureDefinition specified which defines the structure of any [[DataSets>>doc:sdmx:Glossary 2\.1.Data set.WebHome]] to be reported/disseminated. A [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] may optionally define which [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] it uses, by defining a DimensionConstraint (this is a mandatory requirement if the DataStructureDefinition sets its’ evolvingStructure property to ‘true’ and is sematically referenced by the [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]]). | ||
| 102 | |||
| 103 | There are two types of [[dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] each having a common association to [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]]: | ||
| 104 | |||
| 105 | * [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] | ||
| 106 | * TimeDimension | ||
| 107 | |||
| 108 | Note that DimensionComponent can be any or all its sub classes i.e., [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]], TimeDimension. | ||
| 109 | |||
| 110 | The //DimensionComponent//, DataAttribute, MetadataAttribute and [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] link to the [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] that defines its name and semantic (/conceptIdentity association to [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]]). The DataAttribute, [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] (but not TimeDimension) and [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] can optionally have a +conceptRole association with a [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] that identifies its role in the DataStructureDefinition, or one of the standard pre-defined roles, i.e., those published in "GUIDELINES FOR [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] [[CONCEPT>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] ROLES" by the [[SDMX>>doc:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.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. | ||
| 111 | |||
| 112 | The valid values for a //DimensionComponent//, [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]], DataAttribute or MetadataAttribute, when used in this DataStructureDefinition, are defined by the [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]]. This [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] is taken from the [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] 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:sdmx:Glossary 2\.1.Representation.WebHome]] of MetadataAttributes are specified in the corresponding MetadataStructureDefinition, linked by the DataStructureDefinition. | ||
| 113 | |||
| 114 | There will always be a DimensionDescriptor grouping that identifies all of the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] comprising the full key. Together the [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] specify the key of an Observation. | ||
| 115 | |||
| 116 | The //DimensionComponent// can optionally be grouped by multiple GroupDimensionDescriptors each of which identifies the group of [[Dimensions>>doc:sdmx:Glossary 2\.1.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 2\.1.Data set.WebHome]] to declare which DataAttributes or MetadataAttributes are reported at this group level in the [[DataSet>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]. | ||
| 117 | |||
| 118 | There can be a maximum of one TimeDimension specified in the DimensionDescriptor. The TimeDimension is used to specify the [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] used to convey the [[time period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]] of the observation in a [[data set>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]. The TimeDimension must contain a valid [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of time and cannot be coded. | ||
| 119 | |||
| 120 | There can be one or more [[Measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] under the MeasureDescriptor. [[Measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] represent the observable phenomena. Each [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] may have a valid [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]], a maxOccurs [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] limiting the maximum number of values per [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] (which may be set to 'unbounded' for unlimited occurrences), as well as a minOccurs [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]], indicating the minimum required number of values, when the [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] is reported. If minOccurs or maxOccurs are omitted (they both default to ‘1’), the [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] is considered to take a single value; otherwise, it is an array. Moreover, the usage [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] indicates whether a [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] must be reported or not, by the corresponding values: mandatory or optional. | ||
| 121 | |||
| 122 | The AttributeDescriptor may contain one or more //[[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]//s, i.e., at least one DataAttribute definition or one MetadataAttribute reference. | ||
| 123 | |||
| 124 | 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:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.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 [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] that identifies its role. | ||
| 125 | |||
| 126 | The MetadataAttribute defines [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] that may be collected or disseminated and is grouped together with DataAttribute under the AttributeDescriptor. | ||
| 127 | |||
| 128 | 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:sdmx:Glossary 2\.1.Data set.WebHome]]//. An //AttributeComponent// can be specified as being related to one of the following [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]: | ||
| 129 | |||
| 130 | * All data within the [[dataset>>doc:sdmx:Glossary 2\.1.Data set.WebHome]] (DataflowRelationship) – this is equivalent to attaching an [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] to all data within the [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]]. | ||
| 131 | * [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] or set of [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] (DimensionRelationship) | ||
| 132 | * Set of [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] specified by a GroupKey (GroupRelationship – this is retained for compatibility reasons – or +groupKey of the DimensionRelationship) | ||
| 133 | * Observation (ObservationRelationship) | ||
| 134 | * In addition to the positioning of an //AttributeComponent// within a //[[DataSet>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]//, another relationship indicates the [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]](s) for which the //AttributeComponent// is reported. Regardless of the position of the //AttributeComponent// within the //[[DataSet>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]//, the //AttributeComponent// may concern one, more than one, or all [[Measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] included in the [[DSD>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. This is expressed using the MeasureRelationship class, which relates a DataAttribute to one or more [[Measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]]. Lack of the MeasureRelationship defaults to a relationship to all [[Measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]]. | ||
| 135 | |||
| 136 | [[image:image55.png]] | ||
| 137 | |||
| 138 | **Figure 29: Attribute Attachment Defined in the Data Structure Definition** | ||
| 139 | |||
| 140 | 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. | ||
| 141 | |||
| 142 | (% style="width:1142.83px" %) | ||
| 143 | |**Relationship**|(% style="width:537px" %)**Meaning**|(% style="width:434px" %)**Location in Data Set at which the Attribute is reported** | ||
| 144 | |DataflowRelationship|(% style="width:537px" %)The value of the [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is fixed for all data contained in the [[dataset>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]. The [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] value applies to all data defined by the underlying [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]].|(% style="width:434px" %)The [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is reported at the [[Dataset>>doc:sdmx:Glossary 2\.1.Data set.WebHome]] level. | ||
| 145 | |[[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] (1..n)|(% style="width:537px" %)The value of the [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] will vary with the value(s) of the referenced [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]](s). In this case, Group(s) to which the [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] should be attached may optionally be specified.|(% style="width:434px" %)The [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is reported at the lowest (% style="color:#e74c3c" %)l(%%)evel of the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] to which the [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is related, otherwise at the level of the Group if Attachment Group(s) is specified. | ||
| 146 | |Group|(% style="width:537px" %)The value of the [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] varies with combination of values for all of the [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] contained in the Group. This is added as a convenience to listing all [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] and the attachment Group, but should only be used when the [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] value varies based on all Group [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] values.|(% style="width:434px" %)The [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is reported at the level of Group. | ||
| 147 | |Observation|(% style="width:537px" %)The value of the [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] varies with the observed value.|(% style="width:434px" %)The [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is reported at the level of Observation. | ||
| 148 | |||
| 149 | [[image:image56.png]] | ||
| 150 | |||
| 151 | **Figure 30: Representation of DSD Components** | ||
| 152 | |||
| 153 | Each of [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]], TimeDimension, [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]], DataAttribute and MetadataAttribute can have a [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] specified (using the localRepresentation association). If this is not specified in the DataStructureDefinition then the [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] specified for [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] (coreRepresentation) is used. [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]], and DataAttribute may be also represented by multilingual text (as seen in the [[DataSet>>doc:sdmx:Glossary 2\.1.Data set.WebHome]] diagram further down). An exception is the MetadataAttribute, where its [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] is specified in the MetadataStructureDefinition. | ||
| 154 | |||
| 155 | A DataStructureDefinition can be extended to form a derived DataStructureDefinition. This is supported in the StructureMap. | ||
| 156 | |||
| 157 | ==== 5.3.2.2 Definitions ==== | ||
| 158 | |||
| 159 | (% style="width:981.835px" %) | ||
| 160 | |(% style="width:204px" %)**Class**|(% style="width:236px" %)**Feature**|(% style="width:538px" %)**Description** | ||
| 161 | |(% style="width:204px" %)StructureUsage|(% style="width:236px" %) |(% style="width:538px" %)See “[[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Base”. | ||
| 162 | |(% style="width:204px" %)[[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]]|(% style="width:236px" %)((( | ||
| 163 | Inherits from | ||
| 164 | |||
| 165 | //StructureUsage// | ||
| 166 | )))|(% style="width:538px" %)Abstract concept (i.e., the structure without any data) of a flow of data that providers will provide for different [[reference periods>>doc:sdmx:Glossary 2\.1.Reference period.WebHome]]. | ||
| 167 | |(% style="width:204px" %) |(% style="width:236px" %)/structure|(% style="width:538px" %)Associates a [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] to the [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. | ||
| 168 | |(% style="width:204px" %) |(% style="width:236px" %)dimensionConstraint|(% style="width:538px" %)A list of [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] which the [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] uses. This is only required when the referenced DataStructureDefinition has the evolvingStructure property set to true and when the association to the DataStructureDefinition in on the latest minor version{{footnote}}Referencing the latest minor version of the Data Structure is achieved by the reference including the plus operator on the minor version to indicate it links to the latest stable version, for example 2.0+.0 will resolve to the highest version 2.x.y.{{/footnote}}. | ||
| 169 | |(% style="width:204px" %)DataStructureDefinition|(% style="width:236px" %) |(% style="width:538px" %)A collection of metadata concepts, their structure and usage when used to collect or disseminate data. | ||
| 170 | |(% style="width:204px" %) |(% style="width:236px" %)/grouping|(% style="width:538px" %)An association to a set of metadata concepts that have an identified structural role in a [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. | ||
| 171 | |(% style="width:204px" %) |(% style="width:236px" %)evolvingStructure|(% style="width:538px" %)An optional boolean property, defaulting to false. When true the DataStructureDefinition may have new [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] added without having to change its major [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] number. | ||
| 172 | |(% style="width:204px" %)GroupDimensionDescriptor|(% style="width:236px" %)((( | ||
| 173 | Inherits from | ||
| 174 | //ComponentList// | ||
| 175 | )))|(% style="width:538px" %)A set of metadata concepts that define a partial key derived from the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] Descriptor in a [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. | ||
| 176 | |(% style="width:204px" %) |(% style="width:236px" %)/[[components>>doc:sdmx:Glossary 2\.1.Component.WebHome]]|(% style="width:538px" %)An association to the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] [[components>>doc:sdmx:Glossary 2\.1.Component.WebHome]] that comprise the group. | ||
| 177 | |(% style="width:204px" %)DimensionDescriptor|(% style="width:236px" %)((( | ||
| 178 | Inherits from | ||
| 179 | //ComponentList// | ||
| 180 | )))|(% style="width:538px" %)An ordered set of metadata concepts that, combined, classify a statistical [[series>>doc:sdmx:Glossary 2\.1.Series.WebHome]], and whose values, when combined (the key) in an instance such as a [[data set>>doc:sdmx:Glossary 2\.1.Data set.WebHome]], uniquely identify a specific observation. | ||
| 181 | |(% style="width:204px" %) |(% style="width:236px" %)/[[components>>doc:sdmx:Glossary 2\.1.Component.WebHome]]|(% style="width:538px" %)An association to the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] and Time [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] comprising the Key Descriptor. | ||
| 182 | |(% style="width:204px" %)AttributeDescriptor|(% style="width:236px" %)((( | ||
| 183 | Inherits from | ||
| 184 | //ComponentList// | ||
| 185 | )))|(% style="width:538px" %)A set metadata concepts that define the [[Attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] of a [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. | ||
| 186 | |(% style="width:204px" %) |(% style="width:236px" %)/[[components>>doc:sdmx:Glossary 2\.1.Component.WebHome]]|(% style="width:538px" %)An association to a Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] [[component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]. | ||
| 187 | |(% style="width:204px" %)MeasureDescriptor|(% style="width:236px" %)((( | ||
| 188 | Inherits from | ||
| 189 | //ComponentList// | ||
| 190 | )))|(% style="width:538px" %)A metadata concept that defines the [[Measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] of a [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. | ||
| 191 | |(% style="width:204px" %) |(% style="width:236px" %)/[[components>>doc:sdmx:Glossary 2\.1.Component.WebHome]]|(% style="width:538px" %)An association to a [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] [[component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]. | ||
| 192 | |(% style="width:204px" %)//DimensionComponent//|(% style="width:236px" %)((( | ||
| 193 | Inherits from | ||
| 194 | //[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]// | ||
| 195 | Sub class | ||
| 196 | [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] | ||
| 197 | TimeDimension | ||
| 198 | )))|(% style="width:538px" %)An abstract class representing any [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] that can be used for identifying observations. | ||
| 199 | |(% style="width:211px" %) |(% style="width:235px" %)Order|(% style="width:534px" %)Specifies the order of the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] [[Components>>doc:sdmx:Glossary 2\.1.Component.WebHome]] within the [[DSD>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. The property is used to indicate the position of the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] and determines the Key for identifying observations, or [[series>>doc:sdmx:Glossary 2\.1.Series.WebHome]]. The Time [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]], when specified, must be the last within the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] Descriptor. | ||
| 200 | |(% style="width:211px" %)[[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]]|(% style="width:235px" %)((( | ||
| 201 | Inherits from | ||
| 202 | //DimensionComponent// | ||
| 203 | )))|(% style="width:534px" %)A metadata concept used (most probably together with other metadata concepts) to classify a statistical [[series>>doc:sdmx:Glossary 2\.1.Series.WebHome]], e.g., a statistical concept indicating a certain [[economic activity>>doc:sdmx:Glossary 2\.1.Economic activity.WebHome]] or a geographical [[reference area>>doc:sdmx:Glossary 2\.1.Reference area.WebHome]]. | ||
| 204 | |(% style="width:211px" %) |(% style="width:235px" %)/role|(% style="width:534px" %)Association to the [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] that specifies the role that that the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] plays in the [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. | ||
| 205 | |(% style="width:211px" %) |(% style="width:235px" %)/conceptIdentity|(% style="width:534px" %)An association to the metadata concept which defines the semantic of the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]]. | ||
| 206 | |(% style="width:211px" %)TimeDimension|(% style="width:235px" %)((( | ||
| 207 | Inherits from | ||
| 208 | //DimensionComponent// | ||
| 209 | )))|(% style="width:534px" %)A metadata concept that identifies the [[component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] in the key structure that has the role of “time”. | ||
| 210 | |(% style="width:211px" %)DataAttribute|(% style="width:235px" %)((( | ||
| 211 | Inherits from | ||
| 212 | //[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]// | ||
| 213 | )))|(% style="width:534px" %)A characteristic of an object or entity. | ||
| 214 | |(% style="width:211px" %) |(% style="width:235px" %)/role|(% style="width:534px" %)Association to the [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] that specifies the role that that the Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] plays in the [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. | ||
| 215 | |(% style="width:211px" %) |(% style="width:235px" %)minOccurs|(% style="width:534px" %)Defines the minimum required occurrences for the [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]. When equals to zero, the [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is conditional. | ||
| 216 | |(% style="width:211px" %) |(% style="width:235px" %)maxOccurs|(% style="width:534px" %)Defines the maximum allowed occurrences for the [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]. | ||
| 217 | |(% style="width:211px" %) |(% style="width:235px" %)Usage|(% style="width:534px" %)Defines whether a Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] must be reported or not. | ||
| 218 | |(% style="width:211px" %) |(% style="width:235px" %)+relatedTo|(% style="width:534px" %)Association to an [[Attribute Relationship>>doc:sdmx:Glossary 2\.1.Attribute relationship.WebHome]]. | ||
| 219 | |(% style="width:211px" %) |(% style="width:235px" %)/conceptIdentity|(% style="width:534px" %)An association to the [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] which defines the semantic of the [[component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]. | ||
| 220 | |(% style="width:211px" %)[[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]]|(% style="width:235px" %)((( | ||
| 221 | Inherits from | ||
| 222 | //[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]// | ||
| 223 | )))|(% style="width:534px" %)The metadata concept that is the phenomenon to be measured in a [[data set>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]. In a [[data set>>doc:sdmx:Glossary 2\.1.Data set.WebHome]] the instance of the [[measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] is often called the observation. | ||
| 224 | |(% style="width:211px" %) |(% style="width:235px" %)/conceptIdentity|(% style="width:534px" %)An association to the [[Concept>>doc:sdmx:Glossary 2\.1.Concept.WebHome]] which carries the values of the [[measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]]. | ||
| 225 | |(% style="width:211px" %) |(% style="width:235px" %)minOccurs|(% style="width:534px" %)Defines the minimum required occurrences for the [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]]. When equals to zero, the [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] is conditional. | ||
| 226 | |(% style="width:211px" %) |(% style="width:235px" %)maxOccurs|(% style="width:534px" %)Defines the maximum allowed occurrences for the [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]]. | ||
| 227 | |(% style="width:211px" %) |(% style="width:235px" %)Usage|(% style="width:534px" %)Defines whether a [[Measure>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] must be reported or not. | ||
| 228 | |(% style="width:211px" %)//AttributeRelationship//|(% style="width:235px" %)((( | ||
| 229 | Abstract Class | ||
| 230 | Sub classes | ||
| 231 | ObservationRelationship | ||
| 232 | GroupRelationship DimensionRelationship | ||
| 233 | )))|(% style="width:534px" %)Specifies the type of [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] to which a Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] can be attached in a [[Data Set>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]. | ||
| 234 | |(% style="width:211px" %)ObservationRelationship|(% style="width:235px" %) |(% style="width:534px" %)The Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is related to the observations of the [[Data Set>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]. | ||
| 235 | |(% style="width:211px" %)GroupRelationship|(% style="width:235px" %) |(% style="width:534px" %)The Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is related to a Group [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] Descriptor construct. | ||
| 236 | |(% style="width:211px" %) |(% style="width:235px" %)+groupKey|(% style="width:534px" %)An association to the Group [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] Descriptor | ||
| 237 | |(% style="width:211px" %)DimensionRelationship|(% style="width:235px" %) |(% style="width:534px" %)The Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is related to a set of [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]]. | ||
| 238 | |(% style="width:211px" %) |(% style="width:235px" %)+[[dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]]|(% style="width:534px" %)Association to the set of [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] to which the Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is related. | ||
| 239 | |(% style="width:211px" %) |(% style="width:235px" %)+groupKey|(% style="width:534px" %)Association to the Group [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] Descriptor which specifies the set of [[Dimensions>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] to which the Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is attached. | ||
| 240 | |(% style="width:211px" %)MeasureRelationship|(% style="width:235px" %) |(% style="width:534px" %)The [[Measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] that a Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is reported for. | ||
| 241 | |(% style="width:211px" %) |(% style="width:235px" %)+[[measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]]|(% style="width:534px" %)Association to the set of [[Measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]] to which a Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is related to. | ||
| 242 | |(% style="width:211px" %)SentinelValuesType|(% style="width:235px" %) |(% style="width:534px" %)This [[facet>>doc:sdmx:Glossary 2\.1.Facet.WebHome]] indicates that an [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] or a [[Measure>>doc:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.Facet.WebHome]]. | ||
| 243 | |(% style="width:211px" %)SentinelValue|(% style="width:235px" %) |(% style="width:534px" %)A value that has a special meaning within the text format [[representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] of the [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]. | ||
| 244 | |(% style="width:211px" %) |(% style="width:235px" %)+name|(% style="width:534px" %)An association of a Sentinel Value to a multilingual name. | ||
| 245 | |(% style="width:211px" %) |(% style="width:235px" %)+description|(% style="width:534px" %)An association of a Sentinel Value to a multilingual description. | ||
| 246 | |||
| 247 | The explanation of the classes, [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]], and associations comprising the [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] is described in the section on the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Base. | ||
| 248 | |||
| 249 | == 5.4 Data Set – Relationship View == | ||
| 250 | |||
| 251 | === 5.4.1 Context === | ||
| 252 | |||
| 253 | A data set comprises the collection of data values and associated metadata that are collected or disseminated according to a known DataStructureDefinition. | ||
| 254 | |||
| 255 | === 5.4.2 Class Diagram === | ||
| 256 | |||
| 257 | [[image:image57.png]] | ||
| 258 | |||
| 259 | **Figure 31: Class Diagram of the Data Set** | ||
| 260 | |||
| 261 | === 5.4.3 Explanation of the Diagram === | ||
| 262 | |||
| 263 | ==== 5.4.3.1 Narrative – Data Set ==== | ||
| 264 | |||
| 265 | 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. | ||
| 266 | |||
| 267 | An organisation playing the role of DataProvider can be responsible for one or more //DataSet//. | ||
| 268 | |||
| 269 | 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. | ||
| 270 | |||
| 271 | 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 DimensionDescriptor of the DataStructureDefinition, together with associated //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. | ||
| 272 | |||
| 273 | 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//). | ||
| 274 | |||
| 275 | 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. | ||
| 276 | |||
| 277 | 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). | ||
| 278 | |||
| 279 | 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. | ||
| 280 | |||
| 281 | 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. | ||
| 282 | |||
| 283 | The //AttributeValue// links to the object type (SeriesKey, GroupKey, Observation) to which it is associated. | ||
| 284 | |||
| 285 | ==== 5.4.3.2 Definitions ==== | ||
| 286 | |||
| 287 | (% style="width:964.835px" %) | ||
| 288 | |(% style="width:200px" %)**Class**|(% style="width:285px" %)**Feature**|(% style="width:454px" %)**Description** | ||
| 289 | |(% style="width:200px" %)//DataSet//|(% style="width:285px" %)((( | ||
| 290 | Abstract Class | ||
| 291 | Sub classes | ||
| 292 | StructureSpecificDataSet | ||
| 293 | )))|(% style="width:454px" %)An organised collection of data. | ||
| 294 | |(% style="width:200px" %) |(% style="width:285px" %)reportingBegin|(% style="width:454px" %)A specific time period in a known system of time periods that identifies the start period of a report. | ||
| 295 | |(% style="width:200px" %) |(% style="width:285px" %)reportingEnd|(% style="width:454px" %)A specific time period in a known system of time periods that identifies the end period of a report. | ||
| 296 | |(% style="width:200px" %) |(% style="width:285px" %)dataExtractionDate|(% style="width:454px" %)A specific time period that identifies the date and time that the data are extracted from a data source. | ||
| 297 | |(% style="width:200px" %) |(% style="width:285px" %)validFrom|(% style="width:454px" %)Indicates the inclusive start time indicating the validity of the information in the data set. | ||
| 298 | |(% style="width:200px" %) |(% style="width:285px" %)validTo|(% style="width:454px" %)Indicates the inclusive end time indicating the validity of the information in the data set. | ||
| 299 | |(% style="width:200px" %) |(% style="width:285px" %)publicationYear|(% style="width:454px" %)Specifies the year of publication of the data or metadata in terms of whatever provisioning agreements might be in force. | ||
| 300 | |(% style="width:200px" %) |(% style="width:285px" %)publicationPeriod|(% style="width:454px" %)Specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force. | ||
| 301 | |(% style="width:200px" %) |(% style="width:285px" %)setId|(% style="width:454px" %)Provides an identification of the data set. | ||
| 302 | |(% style="width:200px" %) |(% style="width:285px" %)action|(% style="width:454px" %)Defines the action to be taken by the recipient system (information, append, replace, delete) | ||
| 303 | |(% style="width:200px" %) |(% style="width:285px" %)describedBy|(% style="width:454px" %)((( | ||
| 304 | Associates a Dataflow and thereby a Data Structure Definition to the data set. | ||
| 305 | ))) | ||
| 306 | |(% style="width:200px" %) |(% style="width:285px" %)+structuredBy|(% style="width:454px" %)((( | ||
| 307 | 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. | ||
| 308 | ))) | ||
| 309 | |(% style="width:200px" %) |(% style="width:285px" %)+publishedBy|(% style="width:454px" %)Associates the Data Provider that reports/publishes the data. | ||
| 310 | |(% style="width:200px" %)StructureSpecificDataSet|(% style="width:285px" %) |(% style="width:454px" %)An XML specific data format structure that contains data corresponding to one specific Data Structure Definition. | ||
| 311 | |(% style="width:200px" %)//Key//|(% style="width:285px" %)((( | ||
| 312 | Abstract class | ||
| 313 | Sub classes | ||
| 314 | SeriesKey | ||
| 315 | GroupKey | ||
| 316 | )))|(% style="width:454px" %)Comprises the cross product of values of dimensions that identify uniquely an Observation. | ||
| 317 | |(% style="width:200px" %) |(% style="width:285px" %)keyValues|(% style="width:454px" %)Association to the individual Key Values that comprise the Key. | ||
| 318 | |(% style="width:200px" %) |(% style="width:285px" %)+attachedAttribute|(% style="width:454px" %)Association to the Attribute Values relating to the Series Key or Group Key. | ||
| 319 | |(% style="width:200px" %)//KeyValue//|(% style="width:285px" %)((( | ||
| 320 | Abstract class | ||
| 321 | Sub classes | ||
| 322 | TimeKeyValue | ||
| 323 | CodedKeyValue | ||
| 324 | UncodedKeyValue | ||
| 325 | )))|(% style="width:454px" %)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. | ||
| 326 | |(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)((( | ||
| 327 | Association to the key component in the Data Structure Definition for which this Key Value is a valid representation. | ||
| 328 | Note that this is conceptual association as the key component is identified explicitly in the data set. | ||
| 329 | ))) | ||
| 330 | |(% style="width:200px" %)TimeKeyValue|(% style="width:285px" %)((( | ||
| 331 | Inherits from | ||
| 332 | //KeyValue// | ||
| 333 | )))|(% style="width:454px" %)The value of the Time Dimension component of the key. | ||
| 334 | |(% style="width:200px" %)CodedKeyValue|(% style="width:285px" %)((( | ||
| 335 | Inherits from | ||
| 336 | //KeyValue// | ||
| 337 | )))|(% style="width:454px" %)The value of a coded component of the key. The value is the Code to which this class is associated. | ||
| 338 | |(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)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. | ||
| 339 | |(% style="width:200px" %)UnCodedKeyValue|(% style="width:285px" %)((( | ||
| 340 | Inherits from | ||
| 341 | //KeyValue// | ||
| 342 | )))|(% style="width:454px" %)The value of an uncoded component of the key. | ||
| 343 | |(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the key component. | ||
| 344 | |(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)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). | ||
| 345 | |(% style="width:200px" %)GroupKey|(% style="width:285px" %)((( | ||
| 346 | Inherits from | ||
| 347 | //Key// | ||
| 348 | )))|(% style="width:454px" %)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. | ||
| 349 | |(% style="width:200px" %) |(% style="width:285px" %)+describedBy|(% style="width:454px" %)Associates the Group Dimension Descriptor defined in the Data Structure Definition. | ||
| 350 | |(% style="width:200px" %)SeriesKey|(% style="width:285px" %)((( | ||
| 351 | Inherits from | ||
| 352 | //Key// | ||
| 353 | )))|(% style="width:454px" %)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. | ||
| 354 | |(% style="width:200px" %) |(% style="width:285px" %)+describedBy|(% style="width:454px" %)Associates the Dimension Descriptor defined in the Data Structure Definition. | ||
| 355 | |(% style="width:200px" %)Observation|(% style="width:285px" %) |(% style="width:454px" %)The value(s) of the observed phenomenon in the context of the Key Values comprising the key. | ||
| 356 | |(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)((( | ||
| 357 | Associates the Measure(s) defined in the Data Structure Definition. | ||
| 358 | |||
| 359 | The source multiplicity (1..*) indicates that more than one values may be provided for a Measure, if the latter allows it. | ||
| 360 | ))) | ||
| 361 | |(% style="width:200px" %) |(% style="width:285px" %)+attachedAttribute|(% style="width:454px" %)Association to the Attribute Values relating to the Observation. | ||
| 362 | |(% style="width:200px" %) |(% style="width:285px" %)+observationDimension|(% style="width:454px" %)Association to the Key Value that holds the value of the “Dimension at the Observation Level”. | ||
| 363 | |(% style="width:200px" %)//ObservationValue//|(% style="width:285px" %)((( | ||
| 364 | Abstract class | ||
| 365 | Sub classes | ||
| 366 | //UncodedObservationValue// | ||
| 367 | CodedObservation | ||
| 368 | )))|(% style="width:454px" %) | ||
| 369 | |(% style="width:200px" %)//UncodedObservationValue//|(% style="width:285px" %)((( | ||
| 370 | Abstract class | ||
| 371 | Inherits from | ||
| 372 | //ObservationValue// | ||
| 373 | Sub classes | ||
| 374 | OtherUncodedMeasureValue | ||
| 375 | TextMeasureValue | ||
| 376 | )))|(% style="width:454px" %) | ||
| 377 | |(% style="width:200px" %)OtherUncodedMeasureValue|(% style="width:285px" %)((( | ||
| 378 | Inherits from | ||
| 379 | //UncodedObservationValue// | ||
| 380 | )))|(% style="width:454px" %)An observation that has a text value. | ||
| 381 | |(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the Uncoded Observation. | ||
| 382 | |(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)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). | ||
| 383 | |(% style="width:200px" %)TextMeasureValue|(% style="width:285px" %)((( | ||
| 384 | Inherits from | ||
| 385 | //UncodedObservationValue// | ||
| 386 | )))|(% style="width:454px" %)An observation that has a localised text value | ||
| 387 | |(% style="width:200px" %) |(% style="width:285px" %)text|(% style="width:454px" %)The localised text values. | ||
| 388 | |(% style="width:200px" %)CodedObservation|(% style="width:285px" %)((( | ||
| 389 | Inherits from | ||
| 390 | //ObservationValue// | ||
| 391 | )))|(% style="width:454px" %)An Observation that takes its value from a code in a Code list. | ||
| 392 | |(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)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. | ||
| 393 | |(% style="width:200px" %)//AttributeValue//|(% style="width:285px" %)((( | ||
| 394 | Abstract class | ||
| 395 | Sub classes | ||
| 396 | //DataAttributeValue// //MetadataAttributeValue// | ||
| 397 | )))|(% style="width:454px" %)Represents the value for any Attribute reported in the Dataset, i.e., Data or Metadata Attribute. | ||
| 398 | |(% style="width:200px" %)//DataAttributeValue//|(% style="width:285px" %)((( | ||
| 399 | Abstract class | ||
| 400 | Inherits from | ||
| 401 | //AttributeValue// | ||
| 402 | Sub classes | ||
| 403 | //UncodedAttributeValue | ||
| 404 | CodedAttributeValue// | ||
| 405 | )))|(% style="width:454px" %)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. | ||
| 406 | |(% style="width:200px" %) |(% style="width:285px" %)+valueFor|(% style="width:454px" %)((( | ||
| 407 | 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. | ||
| 408 | The source multiplicity (1..*) indicates the possibility to provide more than one values for a Data Attribute, if the latter allows it. | ||
| 409 | ))) | ||
| 410 | |(% style="width:200px" %)//MetadataAttributeValue//|(% style="width:285px" %)((( | ||
| 411 | (explained further in section “Metadata Set”) | ||
| 412 | )))|(% style="width:454px" %)The value of a Metadata Attribute, as specified in the Metadata Structure Definition, which is linked in the Data Structure Definition | ||
| 413 | |(% style="width:200px" %)//UncodedAttributeValue//|(% style="width:285px" %)((( | ||
| 414 | Inherits from | ||
| 415 | //AttributeValue// | ||
| 416 | Sub classes | ||
| 417 | OtherUncodedAttributeValue | ||
| 418 | TextAttributeValue | ||
| 419 | )))|(% style="width:454px" %) | ||
| 420 | |(% style="width:200px" %)OtherUncodedAttributeValue|(% style="width:285px" %)((( | ||
| 421 | Inherits from | ||
| 422 | //UncodedObservationValue// | ||
| 423 | )))|(% style="width:454px" %)An attribute value that has a text value | ||
| 424 | |(% style="width:200px" %) |(% style="width:285px" %)value|(% style="width:454px" %)The value of the Uncoded attribute. | ||
| 425 | |(% style="width:200px" %) |(% style="width:285px" %)startTime|(% style="width:454px" %)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). | ||
| 426 | |(% style="width:200px" %)TextAttributeValue|(% style="width:285px" %)((( | ||
| 427 | Inherits from | ||
| 428 | //UncodedAttributeValue// | ||
| 429 | )))|(% style="width:454px" %)An attribute that has a localised text value | ||
| 430 | |(% style="width:200px" %) |(% style="width:285px" %)text|(% style="width:454px" %)The localised text values. | ||
| 431 | |(% style="width:200px" %)CodedAttributeValue|(% style="width:285px" %)((( | ||
| 432 | Inherits from | ||
| 433 | //AttributeValue// | ||
| 434 | )))|(% style="width:454px" %)An attribute that takes it value from a Code in Code list. | ||
| 435 | |(% style="width:200px" %) |(% style="width:285px" %)+valueOf|(% style="width:454px" %)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. | ||
| 436 | |||
| 437 | ---- | ||
| 438 | |||
| 439 | {{putFootnotes/}} |