Changes for page Part IV. Data and Metadata Namespaces
Last modified by Artur on 2025/09/10 11:19
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Tags
-
... ... @@ -1,1 +1,0 @@ 1 -Annotation|Attribute|Attribute relationship|Category|Code list|Component|Concept scheme|Data provider|Data set|Data structure definition|Dataflow|Dimension|Facet|Group key|Hierarchy|Incremental update|Item scheme|Measure|Metadata set|Metadata structure definition|Observation value|Provision agreement|Reference metadata|Representation|SDMX Information Model|Series key|Statistical data and metadata exchange - Content
-
... ... @@ -6,15 +6,15 @@ 6 6 7 7 The first change in the data and metadata message is one of terminology. In order to foster consistency in the standard, the names and namespaces of the data and metadata message have been changed. The namespaces now have a uniform format of /data/format and /metadata/format, where format is either generic or structured (i.e. the structure specific formats). This also applies to the message names as well, where the names follow the pattern of FormatData (e.g. StructuredData and GenericMetadata). 8 8 9 -The various data messages which existed in the standard have been harmonised into two general formats; generic and structured data. The generic data is much like it has been previously, only slightly modified to conform with the harmonised view on data. The structured data combined the principles of the previous (% style="color:#e74c3c" %)versions(%%)compact and cross sectional formats into one more generalised format.9 +The various data messages which existed in the standard have been harmonised into two general formats; generic and structured data. The generic data is much like it has been previously, only slightly modified to conform with the harmonised view on data. The structured data combined the principles of the previous versions compact and cross sectional formats into one more generalised format. 10 10 11 -The major shift from the previous (% style="color:#e74c3c" %)version(%%)is now that all data can be exchanged as either an un-grouped collection oData structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces;f observations, each specifying a full key or it can be exchanged as data grouped into series with any single[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]placed at the observation(% style="color:#e74c3c" %)level(%%). This in effect, combined the abilities of the time series and cross sectional formats in the a single data format. This format also allows for multiple[[measure>>doc:sdmx:Glossary.Measure.WebHome]]to be expressed when the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is the[[measure>>doc:sdmx:Glossary.Measure.WebHome]][[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the data structured. The key differences from the previous(% style="color:#e74c3c" %)versions(%%)is that this all is possible in a single[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] specific format, as well as being possible in the generic format as well. The goal was to make the structures as homogenous as possible.11 +The major shift from the previous version is now that all data can be exchanged as either an un-grouped collection oData structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces;f observations, each specifying a full key or it can be exchanged as data grouped into series with any single dimension placed at the observation level. This in effect, combined the abilities of the time series and cross sectional formats in the a single data format. This format also allows for multiple measure to be expressed when the observation dimension is the measure dimension defined in the data structured. The key differences from the previous versions is that this all is possible in a single data structure definition specific format, as well as being possible in the generic format as well. The goal was to make the structures as homogenous as possible. 12 12 13 -Another shift from the previous (% style="color:#e74c3c" %)version(%%)in the manner in which the base data structure specific format is defined. In previous(% style="color:#e74c3c" %)versions(%%)there was not structure defined, so one had to understand all of the requirements and read the specification in order to understand what could be expected in any structure specific format. In this(% style="color:#e74c3c" %)version(%%), that issue has been addressed. The base structures now impose a strict format on the data structure specific schemas. This is achieved much like the referencing structure in the common namespace through the use of unqualified elements. By the elements not existing in a namespace, the structure specific schemas can place the necessary restrictions of them while still being forced to adhere to prescribed structure. This means that not only are the structures able to perform the validation that is required, but that the messages will be much simpler to process as the format will always use the same element names.13 +Another shift from the previous version in the manner in which the base data structure specific format is defined. In previous versions there was not structure defined, so one had to understand all of the requirements and read the specification in order to understand what could be expected in any structure specific format. In this version, that issue has been addressed. The base structures now impose a strict format on the data structure specific schemas. This is achieved much like the referencing structure in the common namespace through the use of unqualified elements. By the elements not existing in a namespace, the structure specific schemas can place the necessary restrictions of them while still being forced to adhere to prescribed structure. This means that not only are the structures able to perform the validation that is required, but that the messages will be much simpler to process as the format will always use the same element names. 14 14 15 -Finally, in order to allow for systems which wish to not process the new more flexible data format, time series only variations of both the generic and structured [[data sets>>doc:sdmx:Glossary.Dataset.WebHome]] exist. It is important to note that these structures are derived via restriction from the more generalised format. This means that a[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]in the general format with the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)will have exactly the same content as a time series only[[data set>>doc:sdmx:Glossary.Dataset.WebHome]].The result of this is that there is no additional burden for processing the time series specific format it a system can process the more generalised format. These time series only[[data sets>>doc:sdmx:Glossary.Dataset.WebHome]]allow for time series only data messages to exist. These messages make it simple for system which, in the previous(% style="color:#e74c3c" %)version(%%)of the standard, only used the time series formats to continue to do so.15 +Finally, in order to allow for systems which wish to not process the new more flexible data format, time series only variations of both the generic and structured data sets exist. It is important to note that these structures are derived via restriction from the more generalised format. This means that a data set in the general format with the time dimension at the observation level will have exactly the same content as a time series only data set. The result of this is that there is no additional burden for processing the time series specific format it a system can process the more generalised format. These time series only data sets allow for time series only data messages to exist. These messages make it simple for system which, in the previous version of the standard, only used the time series formats to continue to do so. 16 16 17 -These same principles have been applied to the reference data messages as well. In the previous (% style="color:#e74c3c" %)version(%%)of the standard there were major differences between the generic and metadata structure-specific formats; some of the differences caused some[[metadata sets>>doc:sdmx:Glossary.Metadataset.WebHome]]were incompatible between(% style="color:#e74c3c" %)versions(%%). In this(% style="color:#e74c3c" %)version(%%)the structures of the generic and metadata structure specific formats have been harmonised to the point where they are nearly identical. Yet, the structured format still provides the strong validation against the metadata structure that is intended. And, as with the data, the base metadata structure specific format now imposes a stricter structure on the generated schemas, making the structure specific instance simpler to process in a generic manner.17 +These same principles have been applied to the reference data messages as well. In the previous version of the standard there were major differences between the generic and metadata structure-specific formats; some of the differences caused some metadata sets were incompatible between versions. In this version the structures of the generic and metadata structure specific formats have been harmonised to the point where they are nearly identical. Yet, the structured format still provides the strong validation against the metadata structure that is intended. And, as with the data, the base metadata structure specific format now imposes a stricter structure on the generated schemas, making the structure specific instance simpler to process in a generic manner. 18 18 19 19 = 2. Schema Documentation = 20 20 ... ... @@ -36,7 +36,7 @@ 36 36 37 37 === 2.1.2 Complex Types === 38 38 39 -**DataSetType: **DataSetType defines the structure of the generic [[data set>>doc:sdmx:Glossary.Dataset.WebHome]].Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The organisation used is dependent on the structure specification in the header of the data message (which is referenced via the structureRef[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). The structure specification states which data occurs at the observation(% style="color:#e74c3c" %)level(%%). If this[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is "AllDimensions" then the[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] must consist of a collection of un-grouped observations; otherwise the[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]will contain a collection of series with the observations in the series disambiguated by the specified[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%). This[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]is capable of containing data (observed values) and/or documentation ([[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values). It is assumed that each series or un-grouped observation will be distinct in its purpose. For example, if series contains both data and documentation, it assumed that each series will have a unique key. If the series contains only data or only documentation, then it is possible that another series with the same key might exist, but with not with the same purpose (i.e. to provide data or documentation) as the first series.39 +**DataSetType: **DataSetType defines the structure of the generic data set. Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The organisation used is dependent on the structure specification in the header of the data message (which is referenced via the structureRef attribute). The structure specification states which data occurs at the observation level. If this dimension is "AllDimensions" then the data set must consist of a collection of un-grouped observations; otherwise the data set will contain a collection of series with the observations in the series disambiguated by the specified dimension at the observation level. This data set is capable of containing data (observed values) and/or documentation (attribute values). It is assumed that each series or un-grouped observation will be distinct in its purpose. For example, if series contains both data and documentation, it assumed that each series will have a unique key. If the series contains only data or only documentation, then it is possible that another series with the same key might exist, but with not with the same purpose (i.e. to provide data or documentation) as the first series. 40 40 41 41 Derivation: 42 42 ... ... @@ -43,284 +43,258 @@ 43 43 * //com:AnnotableType// (extension) 44 44 ** DataSetType 45 45 46 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:46 +Attributes: 47 47 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 48 48 49 49 Content: 50 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, DataProvider?,[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?, Group*, (Series+ | Obs+)?50 +com:Annotations?, DataProvider?, Attributes?, Group*, (Series+ | Obs+)? 51 51 52 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 53 - 52 +Attribute Documentation: 54 54 (% style="width:1011.29px" %) 55 55 |**Name**|**Type**|(% style="width:597px" %)**Documentation** 56 -|structureRef|xs:IDREF|(% style="width:597px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] message. The structural specification details which structure the data or[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]conforms to, as well as providing additional information such as how the data is structure (e.g. which[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]occurs at the observation(% style="color:#e74c3c" %)level(%%)for a[[data set>>doc:sdmx:Glossary.Data set.WebHome]]).57 -|setID|com:IDType|(% style="width:597px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].58 -|action|com:ActionType|(% style="width:597px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates whether the file is appending, replacing, or deleting.59 -|reportingBeginDate|com: BasicTimePeriodType|(% style="width:597px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].60 -|reportingEndDate|com: BasicTimePeriodType|(% style="width:597px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].61 -|validFromDate|xs:dateTime|(% style="width:597px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].62 -|validToDate|xs:dateTime|(% style="width:597px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].55 +|structureRef|xs:IDREF|(% style="width:597px" %)The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set). 56 +|setID|com:IDType|(% style="width:597px" %)The setID provides an identification of the data or metadata set. 57 +|action|com:ActionType|(% style="width:597px" %)The action attribute indicates whether the file is appending, replacing, or deleting. 58 +|reportingBeginDate|com: BasicTimePeriodType|(% style="width:597px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set. 59 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:597px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set. 60 +|validFromDate|xs:dateTime|(% style="width:597px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set. 61 +|validToDate|xs:dateTime|(% style="width:597px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set. 63 63 |publicationYear|xs:gYear|(% style="width:597px" %)The publicationYear holds the ISO 8601 four-digit year. 64 -|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:597px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]published on a quarterly basis).63 +|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:597px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis). 65 65 66 66 Element Documentation: 67 - 68 68 (% style="width:1016.29px" %) 69 69 |**Name**|**Type**|(% style="width:642px" %)**Documentation** 70 -|com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:642px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.71 -|DataProvider|com: DataProviderReferenceType|(% style="width:642px" %)DataProvider contains a reference to the provider for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].72 -| [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:642px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]contains the collection of[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]which do not have an[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]]with any other[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]].73 -|Group|GroupType|(% style="width:642px" %)Group contains a references to a defined group in the [[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]along with its key (if necessary) and values for the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which are associated with the group. An[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is associated to a group by either an explicit group relationship or by a group attachment when the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]has a relationship with a[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]which is a member of this group.74 -|Series|SeriesType|(% style="width:642px" %)Series contains a collection of observations that share a common key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]values). The key of a series is every[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]which is declared in the structure specification to be at the observation(% style="color:#e74c3c" %)level(%%). In addition to the key and observations, the series contains values for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which have a relationship with any[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]that is part of the[[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]does not specify an attachment group or also has a relationship with the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]declared to be at the observation(% style="color:#e74c3c" %)level(%%).75 -|Obs|ObsOnlyType|(% style="width:642px" %)Obs is an un-grouped observation. This observation has a key which is a set of values for all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]declared in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].In addition to the key, the value of the observation can be provided along with values for all[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which have an association with the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]]or any[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](so long as it does not specify a group attachment).68 +|com:Annotations|com:AnnotationsType|(% style="width:642px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 69 +|DataProvider|com: DataProviderReferenceType|(% style="width:642px" %)DataProvider contains a reference to the provider for the data set. 70 +|Attributes|ValuesType|(% style="width:642px" %)Attributes contains the collection of attribute values for attributes defined in the data structure definition which do not have an attribute relationship with any other data structure definition components. 71 +|Group|GroupType|(% style="width:642px" %)Group contains a references to a defined group in the data structure definition along with its key (if necessary) and values for the attributes which are associated with the group. An attribute is associated to a group by either an explicit group relationship or by a group attachment when the attribute has a relationship with a dimension which is a member of this group. 72 +|Series|SeriesType|(% style="width:642px" %)Series contains a collection of observations that share a common key (set of dimension values). The key of a series is every dimension defined in the data structure definition, save the dimension which is declared in the structure specification to be at the observation level. In addition to the key and observations, the series contains values for attributes which have a relationship with any dimension that is part of the series key, so long as the attribute does not specify an attachment group or also has a relationship with the dimension declared to be at the observation level. 73 +|Obs|ObsOnlyType|(% style="width:642px" %)Obs is an un-grouped observation. This observation has a key which is a set of values for all dimensions declared in the data structure definition. In addition to the key, the value of the observation can be provided along with values for all attributes which have an association with the primary measure or any dimension (so long as it does not specify a group attachment). 76 76 77 -**GroupType: **GroupType defines a structure which is used to communicate [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values for a group defined in a[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].The group can consist of either a subset of the[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]defined by the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], or an association to an attachment(% style="color:#e74c3c" %)constraint(%%), which in turn defines key sets to which[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]can be attached. In the case that the group is based on an attachment(% style="color:#e74c3c" %)constraint(%%), only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the(% style="color:#e74c3c" %)constraint(%%)and apply the values provided for the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]appropriately.75 +**GroupType: **GroupType defines a structure which is used to communicate attribute values for a group defined in a data structure definition. The group can consist of either a subset of the dimensions defined by the data structure definition, or an association to an attachment constraint, which in turn defines key sets to which attributes can be attached. In the case that the group is based on an attachment constraint, only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the constraint and apply the values provided for the attributes appropriately. 78 78 79 79 Derivation: 80 - 81 81 * //com:AnnotableType// (extension) 82 82 ** GroupType 83 83 84 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:81 +Attributes: 85 85 type 86 86 87 87 Content: 88 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, GroupKey?,[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]85 +com:Annotations?, GroupKey?, Attributes 89 89 90 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 91 - 87 +Attribute Documentation: 92 92 (% style="width:1010.29px" %) 93 93 |**Name**|**Type**|(% style="width:709px" %)**Documentation** 94 -|type|com:IDType|(% style="width:709px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds the identifier assigned to the group in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] for which[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values are being provided.90 +|type|com:IDType|(% style="width:709px" %)The type attribute holds the identifier assigned to the group in the data structure definition for which attribute values are being provided. 95 95 96 96 Element Documentation: 97 - 98 98 (% style="width:1014.29px" %) 99 99 |**Name**|**Type**|(% style="width:704px" %)**Documentation** 100 -|com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:704px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.101 -|GroupKey|ValuesType|(% style="width:704px" %)GroupKey contains the values for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined as being a member of the referenced group in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].A value must be provided for every group[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].This is optional, and not used if the group is defined as an association to an attachment(% style="color:#e74c3c" %)constraint(%%)rather than a subset of the[[data structure definition>>doc:sdmx:Glossary.Datastructuredefinition.WebHome]] [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]].102 -| [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:704px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]contains the set of[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values which are reported for group. The[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values provided here apply to all data matching the partial key defined by the[[group key>>doc:sdmx:Glossary.Groupkey.WebHome]] or the key sets of the associated attachment(% style="color:#e74c3c" %)constraint(%%).95 +|com:Annotations|com:AnnotationsType|(% style="width:704px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 96 +|GroupKey|ValuesType|(% style="width:704px" %)GroupKey contains the values for each dimension defined as being a member of the referenced group in the data structure definition. A value must be provided for every group dimension. This is optional, and not used if the group is defined as an association to an attachment constraint rather than a subset of the data structure definition dimensions. 97 +|Attributes|ValuesType|(% style="width:704px" %)Attributes contains the set of attribute values which are reported for group. The attribute values provided here apply to all data matching the partial key defined by the group key or the key sets of the associated attachment constraint. 103 103 104 -**SeriesType: **SeriesType defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]declared to be at the observation(% style="color:#e74c3c" %)level(%%)for this[[data set>>doc:sdmx:Glossary.Dataset.WebHome]].In addition to observations, values can be provided for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which are associated with the[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]which make up this[[series key>>doc:sdmx:Glossary.Serieskey.WebHome]](so long as the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]do not specify a group attachment or also have an relationship with the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]). It is possible for the series to contain only observations or only[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values, or both.99 +**SeriesType: **SeriesType defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition, save the dimension declared to be at the observation level for this data set. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both. 105 105 106 106 Derivation: 107 - 108 108 * //com:AnnotableType// (extension) 109 109 ** SeriesType 110 110 111 111 Content: 112 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, SeriesKey,[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?, Obs*106 +com:Annotations?, SeriesKey, Attributes?, Obs* 113 113 114 114 Element Documentation: 115 - 116 116 (% style="width:999.294px" %) 117 117 |**Name**|**Type**|(% style="width:689px" %)**Documentation** 118 -|com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:689px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.119 -|SeriesKey|ValuesType|(% style="width:689px" %)SeriesKey contains the values for each all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for that which is declared to be at the observation(% style="color:#e74c3c" %)level(%%)for this[[data set>>doc:sdmx:Glossary.Dataset.WebHome]].This key is required, and every[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]must be provided a value.120 -| [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:689px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]contains the values for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which are associated with the[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]which make up the[[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]do not also specify an attachment group or have a relationship with the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].121 -|Obs|ObsType|(% style="width:689px" %)Obs contains an observation which shares the dimensionality of the [[series key>>doc:sdmx:Glossary.Serieskey.WebHome]].These observations are disambiguated from one another within this series by a single[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]value provided for each[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].The[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]which provides this observation key is declared in the structure specification for the[[data set>>doc:sdmx:Glossary.Data set.WebHome]], which is provided in the header of the data message.111 +|com:Annotations|com:AnnotationsType|(% style="width:689px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 112 +|SeriesKey|ValuesType|(% style="width:689px" %)SeriesKey contains the values for each all dimensions defined in the data structure definition, except for that which is declared to be at the observation level for this data set. This key is required, and every dimension must be provided a value. 113 +|Attributes|ValuesType|(% style="width:689px" %)Attributes contains the values for attributes which are associated with the dimensions which make up the series key, so long as the attributes do not also specify an attachment group or have a relationship with the observation dimension. 114 +|Obs|ObsType|(% style="width:689px" %)Obs contains an observation which shares the dimensionality of the series key. These observations are disambiguated from one another within this series by a single dimension value provided for each dimension. The dimension which provides this observation key is declared in the structure specification for the data set, which is provided in the header of the data message. 122 122 123 -**ObsOnlyType: **ObsOnlyType defines the structure for an un-grouped observation. Unlike a group observation, an un-grouped must provided a full set of values for every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]declared in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].The observation can contain an observed value and/or a collection of[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values.116 +**ObsOnlyType: **ObsOnlyType defines the structure for an un-grouped observation. Unlike a group observation, an un-grouped must provided a full set of values for every dimension declared in the data structure definition. The observation can contain an observed value and/or a collection of attribute values. 124 124 125 125 Derivation: 126 - 127 127 * //com:AnnotableType// (extension) 128 128 ** ObsOnlyType 129 129 130 130 Content: 131 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ObsKey, ObsValue?,[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?123 +com:Annotations?, ObsKey, ObsValue?, Attributes? 132 132 133 133 Element Documentation: 134 - 135 135 (% style="width:996.294px" %) 136 136 |**Name**|**Type**|(% style="width:651px" %)**Documentation** 137 -|com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:651px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.138 -|ObsKey|ValuesType|(% style="width:651px" %)ObsKey contains the values for every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].A value must be provided for each[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].This key serves to disambiguate the un-grouped observation within the[[data set>>doc:sdmx:Glossary.Data set.WebHome]].128 +|com:Annotations|com:AnnotationsType|(% style="width:651px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 129 +|ObsKey|ValuesType|(% style="width:651px" %)ObsKey contains the values for every dimension defined in the data structure definition. A value must be provided for each dimension. This key serves to disambiguate the un-grouped observation within the data set. 139 139 |ObsValue|ObsValueType|(% style="width:651px" %)ObsValue type contains the value for the observation. 140 -| [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:651px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]contains the set of values reported for the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which have an association with the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]]or any[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]](so long as an attachment group is not also specified).131 +|Attributes|ValuesType|(% style="width:651px" %)Attributes contains the set of values reported for the attributes which have an association with the primary measure or any dimension in the data structure definition (so long as an attachment group is not also specified). 141 141 142 -**ObsType: **ObsType defines the structure of a grouped observation. The observation must be provided a value for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]which is declared to be at the observation(% style="color:#e74c3c" %)level(%%)for this[[data set>>doc:sdmx:Glossary.Dataset.WebHome]].This[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]value). The observation can contain an observed value and/or[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values.133 +**ObsType: **ObsType defines the structure of a grouped observation. The observation must be provided a value for the dimension which is declared to be at the observation level for this data set. This dimension value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same dimension value). The observation can contain an observed value and/or attribute values. 143 143 144 144 Derivation: 145 - 146 146 * //com:AnnotableType// (extension) 147 147 ** ObsType 148 148 149 149 Content: 150 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ObsDimension, ObsValue?,[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?140 +com:Annotations?, ObsDimension, ObsValue?, Attributes? 151 151 152 152 Element Documentation: 153 - 154 154 (% style="width:1004.29px" %) 155 155 |**Name**|**Type**|(% style="width:694px" %)**Documentation** 156 -|com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:694px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.157 -|ObsDimension|BaseValueType|(% style="width:694px" %)ObsDimension holds the key for the grouped observation, i.e. the value of the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].Note that in this element, the reference to the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is optional, since it can be inferred from the structure specification for the[[data set>>doc:sdmx:Glossary.Dataset.WebHome]].This saves having to repeat the value unnecessarily. It is assumed that any application processing the[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]will have the information from the structure specification available, so that if a[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]identifier is not supplied here, the proper reference can be applied.145 +|com:Annotations|com:AnnotationsType|(% style="width:694px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 146 +|ObsDimension|BaseValueType|(% style="width:694px" %)ObsDimension holds the key for the grouped observation, i.e. the value of the observation dimension. Note that in this element, the reference to the dimension is optional, since it can be inferred from the structure specification for the data set. This saves having to repeat the value unnecessarily. It is assumed that any application processing the data set will have the information from the structure specification available, so that if a dimension identifier is not supplied here, the proper reference can be applied. 158 158 |ObsValue|ObsValueType|(% style="width:694px" %)ObsValue type contains the value for the observation. 159 -| [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:694px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]contains the set of values reported for the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which have an association with the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]]or the observations[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](so long as an attachment group is not also specified).148 +|Attributes|ValuesType|(% style="width:694px" %)Attributes contains the set of values reported for the attributes which have an association with the primary measure or the observations dimension (so long as an attachment group is not also specified). 160 160 161 -**ValuesType: **ValuesType is a general structure which contains a collection of [[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]]values. This type is used to provide both key and[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]collection values.150 +**ValuesType: **ValuesType is a general structure which contains a collection of data structure definition component values. This type is used to provide both key and attribute collection values. 162 162 163 163 Content: 164 164 Value+ 165 165 166 166 Element Documentation: 167 - 168 168 (% style="width:1008.29px" %) 169 169 |**Name**|(% style="width:185px" %)**Type**|(% style="width:692px" %)**Documentation** 170 -|Value|(% style="width:185px" %)ComponentValueType|(% style="width:692px" %)Value contains a [[component>>doc:sdmx:Glossary.Component.WebHome]]value and a reference to the[[component>>doc:sdmx:Glossary.Component.WebHome]]for which a value is being provided.158 +|Value|(% style="width:185px" %)ComponentValueType|(% style="width:692px" %)Value contains a component value and a reference to the component for which a value is being provided. 171 171 172 -**BaseValueType: **BaseValueType is a general structure which contains a reference to a [[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]]and a value for that[[component>>doc:sdmx:Glossary.Component.WebHome]].In this structure the reference to the[[component>>doc:sdmx:Glossary.Component.WebHome]]is optional to allow for usages where the actual reference might be provided in another context.160 +**BaseValueType: **BaseValueType is a general structure which contains a reference to a data structure definition component and a value for that component. In this structure the reference to the component is optional to allow for usages where the actual reference might be provided in another context. 173 173 174 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:162 +Attributes: 175 175 id?, value 176 176 177 177 Content: 178 178 {Empty} 179 179 180 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 181 - 168 +Attribute Documentation: 182 182 (% style="width:1003.29px" %) 183 183 |**Name**|(% style="width:194px" %)**Type**|(% style="width:664px" %)**Documentation** 184 -|id|(% style="width:194px" %)com:NCNameIDType|(% style="width:664px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]contains the identifier for the[[component>>doc:sdmx:Glossary.Component.WebHome]]for which a value is being provided.185 -|value|(% style="width:194px" %)xs:anySimpleType|(% style="width:664px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]contains the provided[[component>>doc:sdmx:Glossary.Component.WebHome]]value.171 +|id|(% style="width:194px" %)com:NCNameIDType|(% style="width:664px" %)The id attribute contains the identifier for the component for which a value is being provided. 172 +|value|(% style="width:194px" %)xs:anySimpleType|(% style="width:664px" %)The value attribute contains the provided component value. 186 186 187 -**ObsValueType: **ObsValueType is a derivation of the BaseValueType which is used to provide an [[observation value>>doc:sdmx:Glossary.Observationvalue.WebHome]].Since an[[observation value>>doc:sdmx:Glossary.Observationvalue.WebHome]]is always associated with the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]], and the identifier for the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]]is fixed, the[[component>>doc:sdmx:Glossary.Component.WebHome]]reference for this structure is fixed. Note that this means that it is not necessary to provide a value in an instance as the fixed value will be provided in the post validation information set.174 +**ObsValueType: **ObsValueType is a derivation of the BaseValueType which is used to provide an observation value. Since an observation value is always associated with the data structure definition primary measure, and the identifier for the primary measure is fixed, the component reference for this structure is fixed. Note that this means that it is not necessary to provide a value in an instance as the fixed value will be provided in the post validation information set. 188 188 189 189 Derivation: 190 - 191 191 * BaseValueType (restriction) 192 192 ** ObsValueType 193 193 194 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:180 +Attributes: 195 195 id?, value 196 196 197 197 Content: 198 198 {Empty} 199 199 200 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 201 - 186 +Attribute Documentation: 202 202 (% style="width:1004.29px" %) 203 203 |(% style="width:190px" %)**Name**|(% style="width:213px" %)**Type**|(% style="width:598px" %)**Documentation** 204 -|(% style="width:190px" %)id (fixed: OBS_VALUE)|(% style="width:213px" %)com:NCNameIDType|(% style="width:598px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]contains a fixed reference to the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]][[component>>doc:sdmx:Glossary.Component.WebHome]]of the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].205 -|(% style="width:190px" %)value|(% style="width:213px" %)xs:string|(% style="width:598px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]contains the provided[[component>>doc:sdmx:Glossary.Component.WebHome]]value.189 +|(% style="width:190px" %)id (fixed: OBS_VALUE)|(% style="width:213px" %)com:NCNameIDType|(% style="width:598px" %)The id attribute contains a fixed reference to the primary measure component of the data structure definition. 190 +|(% style="width:190px" %)value|(% style="width:213px" %)xs:string|(% style="width:598px" %)The value attribute contains the provided component value. 206 206 207 -**ComponentValueType: **ComponentValueType is a derivation of the BaseValueType which requires that the [[component>>doc:sdmx:Glossary.Component.WebHome]]reference be provided. This is used when the identification of the[[component>>doc:sdmx:Glossary.Component.WebHome]]cannot be inferred from another context.192 +**ComponentValueType: **ComponentValueType is a derivation of the BaseValueType which requires that the component reference be provided. This is used when the identification of the component cannot be inferred from another context. 208 208 209 209 Derivation: 210 - 211 211 * BaseValueType (restriction) 212 212 ** ComponentValueType 213 213 214 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:198 +Attributes: 215 215 id, value 216 216 217 217 Content: 218 218 {Empty} 219 219 220 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 221 - 204 +Attribute Documentation: 222 222 (% style="width:1008.29px" %) 223 223 |**Name**|(% style="width:184px" %)**Type**|(% style="width:679px" %)**Documentation** 224 -|id|(% style="width:184px" %)com:NCNameIDType|(% style="width:679px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]contains the identifier for the[[component>>doc:sdmx:Glossary.Component.WebHome]]for which a value is being provided.225 -|value|(% style="width:184px" %)xs:string|(% style="width:679px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]contains the provided[[component>>doc:sdmx:Glossary.Component.WebHome]]value.207 +|id|(% style="width:184px" %)com:NCNameIDType|(% style="width:679px" %)The id attribute contains the identifier for the component for which a value is being provided. 208 +|value|(% style="width:184px" %)xs:string|(% style="width:679px" %)The value attribute contains the provided component value. 226 226 227 -**TimeSeriesDataSetType: **TimeSeriesDataSetType is a derivation of the base DataSetType of the generic format the restricts the [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]toonly allow for grouped observations where the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)is the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]of the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].This means that unlike the base[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] structure, there can be no un-grouped observations. Because this derivation is achieved using restriction,[[data sets>>doc:sdmx:Glossary.Dataset.WebHome]]conforming to this type will inherently conform to the base[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] structure as well. In fact, data structured here will be identical to data in the base[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]when the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].This means that the data contained in this structure can be processed in exactly the same manner as the base structure.210 +**TimeSeriesDataSetType: **TimeSeriesDataSetType is a derivation of the base DataSetType of the generic format the restricts the data set to only allow for grouped observations where the dimension at the observation level is the time dimension of the data structure definition. This means that unlike the base data set structure, there can be no un-grouped observations. Because this derivation is achieved using restriction, data sets conforming to this type will inherently conform to the base data set structure as well. In fact, data structured here will be identical to data in the base data set when the time dimension is the observation dimension. This means that the data contained in this structure can be processed in exactly the same manner as the base structure. 228 228 229 229 Derivation: 230 - 231 231 * //com:AnnotableType// (extension) 232 232 ** DataSetType (restriction) 233 233 *** TimeSeriesDataSetType 234 234 235 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:217 +Attributes: 236 236 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 237 237 238 238 Content: 239 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, DataProvider?,[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?, Group*, Series*221 +com:Annotations?, DataProvider?, Attributes?, Group*, Series* 240 240 241 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 242 - 223 +Attribute Documentation: 243 243 (% style="width:1004.29px" %) 244 244 |**Name**|**Type**|(% style="width:590px" %)**Documentation** 245 -|structureRef|xs:IDREF|(% style="width:590px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] message. The structural specification details which structure the data or[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]conforms to, as well as providing additional information such as how the data is structure (e.g. which[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]occurs at the observation(% style="color:#e74c3c" %)level(%%)for a[[data set>>doc:sdmx:Glossary.Data set.WebHome]]).246 -|setID|com:IDType|(% style="width:590px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].247 -|action|com:ActionType|(% style="width:590px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates whether the file is appending, replacing, or deleting.248 -|reportingBeginDate|com: BasicTimePeriodType|(% style="width:590px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].249 -|reportingEndDate|com: BasicTimePeriodType|(% style="width:590px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].250 -|validFromDate|xs:dateTime|(% style="width:590px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].251 -|validToDate|xs:dateTime|(% style="width:590px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].226 +|structureRef|xs:IDREF|(% style="width:590px" %)The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set). 227 +|setID|com:IDType|(% style="width:590px" %)The setID provides an identification of the data or metadata set. 228 +|action|com:ActionType|(% style="width:590px" %)The action attribute indicates whether the file is appending, replacing, or deleting. 229 +|reportingBeginDate|com: BasicTimePeriodType|(% style="width:590px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set. 230 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:590px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set. 231 +|validFromDate|xs:dateTime|(% style="width:590px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set. 232 +|validToDate|xs:dateTime|(% style="width:590px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set. 252 252 |publicationYear|xs:gYear|(% style="width:590px" %)The publicationYear holds the ISO 8601 four-digit year. 253 -|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:590px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]published on a quarterly basis).234 +|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:590px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis). 254 254 255 255 Element Documentation: 256 - 257 257 (% style="width:999.294px" %) 258 258 |**Name**|**Type**|(% style="width:622px" %)**Documentation** 259 -|com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:622px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.260 -|DataProvider|com: DataProviderReferenceType|(% style="width:622px" %)DataProvider contains a reference to the provider for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].261 -| [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:622px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]contains the collection of[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]which do not have an[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]]with any other[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]].262 -|Group|GroupType|(% style="width:622px" %)Group contains a references to a defined group in the [[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]along with its key (if necessary) and values for the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which are associated with the group. An[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is associated to a group by either an explicit group relationship or by a group attachment when the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]has a relationship with a[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]which is a member of this group.263 -|Series|TimeSeriesType|(% style="width:622px" %)Series contains a collection of observations that share a common key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]values). The key of a series is every[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].In addition to the key and observations, the series contains values for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which have a relationship with any[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]that is part of the[[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]does not specify an attachment group or also has a relationship with the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].239 +|com:Annotations|com:AnnotationsType|(% style="width:622px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 240 +|DataProvider|com: DataProviderReferenceType|(% style="width:622px" %)DataProvider contains a reference to the provider for the data set. 241 +|Attributes|ValuesType|(% style="width:622px" %)Attributes contains the collection of attribute values for attributes defined in the data structure definition which do not have an attribute relationship with any other data structure definition components. 242 +|Group|GroupType|(% style="width:622px" %)Group contains a references to a defined group in the data structure definition along with its key (if necessary) and values for the attributes which are associated with the group. An attribute is associated to a group by either an explicit group relationship or by a group attachment when the attribute has a relationship with a dimension which is a member of this group. 243 +|Series|TimeSeriesType|(% style="width:622px" %)Series contains a collection of observations that share a common key (set of dimension values). The key of a series is every dimension defined in the data structure definition, save the time dimension. In addition to the key and observations, the series contains values for attributes which have a relationship with any dimension that is part of the series key, so long as the attribute does not specify an attachment group or also has a relationship with the time dimension. 264 264 265 -**TimeSeriesType: **TimeSeriesType defines a structure which is used to group a collection of observations which have a key in common, organised by time. The key for a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].In addition to observations, values can be provided for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which are associated with the[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]which make up this[[series key>>doc:sdmx:Glossary.Serieskey.WebHome]](so long as the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]do not specify a group attachment or also have an relationship with the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]). It is possible for the series to contain only observations or only[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values, or both.245 +**TimeSeriesType: **TimeSeriesType defines a structure which is used to group a collection of observations which have a key in common, organised by time. The key for a series is every dimension defined in the data structure definition, save the time dimension. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the time dimension). It is possible for the series to contain only observations or only attribute values, or both. 266 266 267 267 Derivation: 268 - 269 269 * //com:AnnotableType// (extension) 270 270 ** SeriesType (restriction) 271 271 *** TimeSeriesType 272 272 273 273 Content: 274 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, SeriesKey,[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?, Obs*253 +com:Annotations?, SeriesKey, Attributes?, Obs* 275 275 276 276 Element Documentation: 277 - 278 278 (% style="width:1012.29px" %) 279 279 |**Name**|**Type**|(% style="width:695px" %)**Documentation** 280 -|com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:695px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.281 -|SeriesKey|ValuesType|(% style="width:695px" %)SeriesKey contains the values for each all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for that which is declared to be at the observation(% style="color:#e74c3c" %)level(%%)for this[[data set>>doc:sdmx:Glossary.Dataset.WebHome]].This key is required, and every[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]must be provided a value.282 -| [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:695px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]contains the values for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which are associated with the[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]which make up the[[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]do not also specify an attachment group or have a relationship with the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].283 -|Obs|TimeSeriesObsType|(% style="width:695px" %)Obs contains an observation which shares the dimensionality of the [[series key>>doc:sdmx:Glossary.Serieskey.WebHome]].These observations are disambiguated from one another within this series by a time value.258 +|com:Annotations|com:AnnotationsType|(% style="width:695px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 259 +|SeriesKey|ValuesType|(% style="width:695px" %)SeriesKey contains the values for each all dimensions defined in the data structure definition, except for that which is declared to be at the observation level for this data set. This key is required, and every dimension must be provided a value. 260 +|Attributes|ValuesType|(% style="width:695px" %)Attributes contains the values for attributes which are associated with the dimensions which make up the series key, so long as the attributes do not also specify an attachment group or have a relationship with the observation dimension. 261 +|Obs|TimeSeriesObsType|(% style="width:695px" %)Obs contains an observation which shares the dimensionality of the series key. These observations are disambiguated from one another within this series by a time value. 284 284 285 -**TimeSeriesObsType: **TimeSeriesObsType defines the structure of a time series observation. The observation must be provided a value for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].This time value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same time value). The observation can contain an observed value and/or[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values.263 +**TimeSeriesObsType: **TimeSeriesObsType defines the structure of a time series observation. The observation must be provided a value for the time dimension. This time value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same time value). The observation can contain an observed value and/or attribute values. 286 286 287 287 Derivation: 288 - 289 289 * //com:AnnotableType// (extension) 290 290 ** ObsType (restriction) 291 291 *** TimeSeriesObsType 292 292 293 293 Content: 294 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ObsDimension, ObsValue?,[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]?271 +com:Annotations?, ObsDimension, ObsValue?, Attributes? 295 295 296 296 Element Documentation: 297 - 298 298 (% style="width:1019.29px" %) 299 299 |**Name**|**Type**|(% style="width:709px" %)**Documentation** 300 -|com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com:AnnotationsType|(% style="width:709px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.301 -|ObsDimension|TimeValueType|(% style="width:709px" %)ObsDimension holds the key for the grouped observation, i.e. the value of the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].Note that in this element, the reference to the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is optional, since it can be inferred from the structure specification for the[[data set>>doc:sdmx:Glossary.Dataset.WebHome]].This saves having to repeat the value unnecessarily. It is assumed that any application processing the[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]will have the information from the structure specification available, so that if a[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]identifier is not supplied here, the proper reference can be applied.276 +|com:Annotations|com:AnnotationsType|(% style="width:709px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 277 +|ObsDimension|TimeValueType|(% style="width:709px" %)ObsDimension holds the key for the grouped observation, i.e. the value of the observation dimension. Note that in this element, the reference to the dimension is optional, since it can be inferred from the structure specification for the data set. This saves having to repeat the value unnecessarily. It is assumed that any application processing the data set will have the information from the structure specification available, so that if a dimension identifier is not supplied here, the proper reference can be applied. 302 302 |ObsValue|ObsValueType|(% style="width:709px" %)ObsValue type contains the value for the observation. 303 -| [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]|ValuesType|(% style="width:709px" %)[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]contains the set of values reported for the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which have an association with the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]]or the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](so long as an attachment group is not also specified).279 +|Attributes|ValuesType|(% style="width:709px" %)Attributes contains the set of values reported for the attributes which have an association with the primary measure or the time dimension (so long as an attachment group is not also specified). 304 304 305 -**TimeValueType: **TimeValueType is a derivation of the BaseValueType which is used to provide a value for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].Since the identifier for the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is fixed, the[[component>>doc:sdmx:Glossary.Component.WebHome]]reference for this structure is fixed. Note that this means that it is not necessary to provide a value in an instance as the fixed value will be provided in the post validation information set.281 +**TimeValueType: **TimeValueType is a derivation of the BaseValueType which is used to provide a value for the time dimension. Since the identifier for the time dimension is fixed, the component reference for this structure is fixed. Note that this means that it is not necessary to provide a value in an instance as the fixed value will be provided in the post validation information set. 306 306 307 307 Derivation: 308 - 309 309 * BaseValueType (restriction) 310 310 ** TimeValueType 311 311 312 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:287 +Attributes: 313 313 id?, value 314 314 315 315 Content: 316 316 {Empty} 317 317 318 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 319 - 293 +Attribute Documentation: 320 320 (% style="width:1013.29px" %) 321 321 |(% style="width:205px" %)**Name**|(% style="width:277px" %)**Type**|(% style="width:528px" %)**Documentation** 322 -|(% style="width:205px" %)id (fixed: TIME_PERIOD)|(% style="width:277px" %)com:NCNameIDType|(% style="width:528px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]contains the identifier for the[[component>>doc:sdmx:Glossary.Component.WebHome]]for which a value is being provided.323 -|(% style="width:205px" %)value|(% style="width:277px" %)com: ObservationalTimePer iodType|(% style="width:528px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]contains the provided[[component>>doc:sdmx:Glossary.Component.WebHome]]value.296 +|(% style="width:205px" %)id (fixed: TIME_PERIOD)|(% style="width:277px" %)com:NCNameIDType|(% style="width:528px" %)The id attribute contains the identifier for the component for which a value is being provided. 297 +|(% style="width:205px" %)value|(% style="width:277px" %)com: ObservationalTimePer iodType|(% style="width:528px" %)The value attribute contains the provided component value. 324 324 325 325 == 2.2 Structure Specific Data Namespace == 326 326 ... ... @@ -341,49 +341,45 @@ 341 341 342 342 === 2.2.2 Complex Types === 343 343 344 -**//DataSetType//: **DataSetType is the abstract type which defines the base structure for any [[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] specific[[data set>>doc:sdmx:Glossary.Dataset.WebHome]].A derived[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] type will be created that is specific to a[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]and the details of the organisation of the data (i.e. which[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]and whether explicit[[measures>>doc:sdmx:Glossary.Measure.WebHome]]should be used). Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The derived[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] type will restrict this choice to be either grouped or un-grouped observations. If this[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is "AllDimensions" then the derived[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] type must consist of a collection of un-grouped observations; otherwise the[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]will contain a collection of series with the observations in the series disambiguated by the specified[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%). This[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]is capable of containing data (observed values) and/or documentation ([[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values) and can be used for[[incremental updates>>doc:sdmx:Glossary.Incrementalupdate.WebHome]] and deletions (i.e. only the relevant updates or deletes are exchanged). It is assumed that each series or un-grouped observation will be distinct in its purpose. For example, if series contains both data and documentation, it assumed that each series will have a unique key. If the series contains only data or only documentation, then it is possible that another series with the same key might exist, but with not with the same purpose (i.e. to provide data or documentation) as the first series. This base type is designed such that derived types can be processed in a generic manner; it assures that[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] specific data will have a consistent structure. The group, series, and observation elements are unqualified, meaning that they are not qualified with a namespace in an instance. This means that in the derived[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] types, the elements will always be the same, regardless of the target namespace of the schemas which defines these derived types. This allows for consistent processing of the structure without regard to what the namespace might be for the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] specific schema. The[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]can contain values for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which do not have an[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]]with any[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]].These[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values will exist in XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]in this element based on this type ([[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]). This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] type will refine this structure so that the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]are explicit. The XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be given a name based on the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be unqualified (meaning they do not have a namespace associated with them). To allow for generic processing, it is required that the only unqualified XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]in the derived[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] type (outside of the standard[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) be for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]declared in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].If additional[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].318 +**//DataSetType//: **DataSetType is the abstract type which defines the base structure for any data structure definition specific data set. A derived data set type will be created that is specific to a data structure definition and the details of the organisation of the data (i.e. which dimension is the observation dimension and whether explicit measures should be used). Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The derived data set type will restrict this choice to be either grouped or un-grouped observations. If this dimension is "AllDimensions" then the derived data set type must consist of a collection of un-grouped observations; otherwise the data set will contain a collection of series with the observations in the series disambiguated by the specified dimension at the observation level. This data set is capable of containing data (observed values) and/or documentation (attribute values) and can be used for incremental updates and deletions (i.e. only the relevant updates or deletes are exchanged). It is assumed that each series or un-grouped observation will be distinct in its purpose. For example, if series contains both data and documentation, it assumed that each series will have a unique key. If the series contains only data or only documentation, then it is possible that another series with the same key might exist, but with not with the same purpose (i.e. to provide data or documentation) as the first series. This base type is designed such that derived types can be processed in a generic manner; it assures that data structure definition specific data will have a consistent structure. The group, series, and observation elements are unqualified, meaning that they are not qualified with a namespace in an instance. This means that in the derived data set types, the elements will always be the same, regardless of the target namespace of the schemas which defines these derived types. This allows for consistent processing of the structure without regard to what the namespace might be for the data structure definition specific schema. The data set can contain values for attributes which do not have an attribute relationship with any data structure definition components. These attribute values will exist in XML attributes in this element based on this type (DataSet). This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived data set type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). To allow for generic processing, it is required that the only unqualified XML attributes in the derived data set type (outside of the standard data set attributes) be for attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition attribute. 345 345 346 346 Derivation: 347 - 348 348 * //com:AnnotableType// (extension) 349 349 ** //DataSetType// 350 350 351 - [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:324 +Attributes: 352 352 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY? 353 353 354 354 Content: 355 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, DataProvider?, Group*, (Series+ | Obs+)?328 +com:Annotations?, DataProvider?, Group*, (Series+ | Obs+)? 356 356 357 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 358 - 330 +Attribute Documentation: 359 359 (% style="width:1005.29px" %) 360 360 |(% style="width:199px" %)**Name**|(% style="width:216px" %)**Type**|(% style="width:521px" %)**Documentation** 361 -|(% style="width:199px" %)structureRef|(% style="width:216px" %)xs:IDREF|(% style="width:521px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] message. The structural specification details which structure the data or[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]conforms to, as well as providing additional information such as how the data is structure (e.g. which[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]occurs at the observation(% style="color:#e74c3c" %)level(%%)for a[[data set>>doc:sdmx:Glossary.Data set.WebHome]]).362 -|(% style="width:199px" %)setID|(% style="width:216px" %)com:IDType|(% style="width:521px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].363 -|(% style="width:199px" %)action|(% style="width:216px" %)com:ActionType|(% style="width:521px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates whether the file is appending, replacing, or deleting.364 -|(% style="width:199px" %)reportingBeginDate|(% style="width:216px" %)com: BasicTimePeriodType|(% style="width:521px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].365 -|(% style="width:199px" %)reportingEndDate|(% style="width:216px" %)com: BasicTimePeriodType|(% style="width:521px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].366 -|(% style="width:199px" %)validFromDate|(% style="width:216px" %)xs:dateTime|(% style="width:521px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].367 -|(% style="width:199px" %)validToDate|(% style="width:216px" %)xs:dateTime|(% style="width:521px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].333 +|(% style="width:199px" %)structureRef|(% style="width:216px" %)xs:IDREF|(% style="width:521px" %)The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set). 334 +|(% style="width:199px" %)setID|(% style="width:216px" %)com:IDType|(% style="width:521px" %)The setID provides an identification of the data or metadata set. 335 +|(% style="width:199px" %)action|(% style="width:216px" %)com:ActionType|(% style="width:521px" %)The action attribute indicates whether the file is appending, replacing, or deleting. 336 +|(% style="width:199px" %)reportingBeginDate|(% style="width:216px" %)com: BasicTimePeriodType|(% style="width:521px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set. 337 +|(% style="width:199px" %)reportingEndDate|(% style="width:216px" %)com: BasicTimePeriodType|(% style="width:521px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set. 338 +|(% style="width:199px" %)validFromDate|(% style="width:216px" %)xs:dateTime|(% style="width:521px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set. 339 +|(% style="width:199px" %)validToDate|(% style="width:216px" %)xs:dateTime|(% style="width:521px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set. 368 368 |(% style="width:199px" %)publicationYear|(% style="width:216px" %)xs:gYear|(% style="width:521px" %)The publicationYear holds the ISO 8601 four-digit year. 369 -|(% style="width:199px" %)publicationPeriod|(% style="width:216px" %)com: ObservationalTimePeriodType|(% style="width:521px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]published on a quarterly basis).370 -|(% style="width:199px" %)dataScope|(% style="width:216px" %)DataScopeType|(% style="width:521px" %)The dataScope [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates the scope at which the data is meant to be validated. These scopes are hierarchical and are (from the top down); DataStructure, ConstrainedDataStructure,[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], and ProvisionAgreement. the[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]of these scopes represent the cascading(% style="color:#e74c3c" %)level(%%)of(% style="color:#e74c3c" %)constraints(%%), which can restrict the valid values for[[components>>doc:sdmx:Glossary.Component.WebHome]].For example, a data structure defines a[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]with a coded[[representation>>doc:sdmx:Glossary.Representation.WebHome]].A[[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]]might have a(% style="color:#e74c3c" %)constraint(%%)associated with it which further restricts the values allowed from the referenced[[code list>>doc:sdmx:Glossary.Codelist.WebHome]]toa subset of the values allowed by the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].A[[provision agreement>>doc:sdmx:Glossary.Provisionagreement.WebHome]] that is based on the[[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]might also have a(% style="color:#e74c3c" %)constraint(%%), which further restricts the subset of the[[codelist>>doc:sdmx:Glossary.Codelist.WebHome]]from the[[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].Therefore, the allowed content becomes stricter lower in the[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]].Data that is given a scope of one value is stated to be valid at that(% style="color:#e74c3c" %)level(%%)and all(% style="color:#e74c3c" %)levels(%%)below it. Therefore, this scope serves to state that data that is meant to be structured simply against the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] is not meant to be validated against the a[[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], where(% style="color:#e74c3c" %)constraints(%%)might be applied.371 -|(% style="width:199px" %)REPORTING_YEAR_START_DAY|(% style="width:216px" %)xs:gMonthDay|(% style="width:521px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explict[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the reporting year start day, which provides context to the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]when its value contains a reporting period (e.g. 2010-Q1). This[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is used to state the month and day that the reporting year begins (e.g. 07-01 for July 1st). In the absence of an explicit value provided in this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and[[representation>>doc:sdmx:Glossary.Representation.WebHome]].The derived[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] type may either require or prohibit this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]and if so, the[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]] and assignment status assigned to it.341 +|(% style="width:199px" %)publicationPeriod|(% style="width:216px" %)com: ObservationalTimePeriodType|(% style="width:521px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis). 342 +|(% style="width:199px" %)dataScope|(% style="width:216px" %)DataScopeType|(% style="width:521px" %)The dataScope attribute indicates the scope at which the data is meant to be validated. These scopes are hierarchical and are (from the top down); DataStructure, ConstrainedDataStructure, Dataflow, and ProvisionAgreement. the hierarchy of these scopes represent the cascading level of constraints, which can restrict the valid values for components. For example, a data structure defines a dimension with a coded representation. A data flow might have a constraint associated with it which further restricts the values allowed from the referenced code list to a subset of the values allowed by the data structure definition. A provision agreement that is based on the dataflow might also have a constraint, which further restricts the subset of the codelist from the dataflow. Therefore, the allowed content becomes stricter lower in the hierarchy. Data that is given a scope of one value is stated to be valid at that level and all levels below it. Therefore, this scope serves to state that data that is meant to be structured simply against the data structure definition is not meant to be validated against the a dataflow, where constraints might be applied. 343 +|(% style="width:199px" %)REPORTING_YEAR_START_DAY|(% style="width:216px" %)xs:gMonthDay|(% style="width:521px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived data set type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it. 372 372 373 373 Element Documentation: 374 - 375 375 (% style="width:1005.29px" %) 376 376 |**Name**|**Type**|(% style="width:630px" %)**Documentation** 377 -|com:Annotations|com:AnnotationsType|(% style="width:630px" %) [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.378 -|DataProvider|com: DataProviderReferenceType|(% style="width:630px" %)DataProvider contains a reference to the provider for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].379 -|Group|//GroupType//|(% style="width:630px" %)Group contains a references to a defined group in the [[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]along with its key (if necessary) and values for the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which are associated with the group. An[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is associated to a group by either an explicit group relationship or by a group attachment when the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]has a relationship with a[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]which is a member of this group.380 -|Series|//SeriesType//|(% style="width:630px" %)Series contains a collection of observations that share a common key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]values). The key of a series is every[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%). In addition to the key and observations, the series contains values for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which have a relationship with any[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]that is part of the[[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]does not specify an attachment group or also has a relationship with the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]declared to be at the observation(% style="color:#e74c3c" %)level(%%).381 -|Obs|//ObsType//|(% style="width:630px" %)Obs is an un-grouped observation. This observation has a key which is a set of values for all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]declared in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].In addition to the key, the value of the observation can be provided along with values for all[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which have an association with the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]]or any[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](so long as it does not specify a group attachment).348 +|com:Annotations|com:AnnotationsType|(% style="width:630px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 349 +|DataProvider|com: DataProviderReferenceType|(% style="width:630px" %)DataProvider contains a reference to the provider for the data set. 350 +|Group|//GroupType//|(% style="width:630px" %)Group contains a references to a defined group in the data structure definition along with its key (if necessary) and values for the attributes which are associated with the group. An attribute is associated to a group by either an explicit group relationship or by a group attachment when the attribute has a relationship with a dimension which is a member of this group. 351 +|Series|//SeriesType//|(% style="width:630px" %)Series contains a collection of observations that share a common key (set of dimension values). The key of a series is every dimension defined in the data structure definition, save the dimension at the observation level. In addition to the key and observations, the series contains values for attributes which have a relationship with any dimension that is part of the series key, so long as the attribute does not specify an attachment group or also has a relationship with the dimension declared to be at the observation level. 352 +|Obs|//ObsType//|(% style="width:630px" %)Obs is an un-grouped observation. This observation has a key which is a set of values for all dimensions declared in the data structure definition. In addition to the key, the value of the observation can be provided along with values for all attributes which have an association with the primary measure or any dimension (so long as it does not specify a group attachment). 382 382 383 -**//GroupType//: **GroupType is the abstract type which defines a structure which is used to communicate [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values for a group defined in a[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].The group can consist of either a subset of the[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]defined by the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], or an association to an attachment(% style="color:#e74c3c" %)constraint(%%), which in turn defines key sets to which[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]can be attached. In the case that the group is based on an attachment(% style="color:#e74c3c" %)constraint(%%), only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the(% style="color:#e74c3c" %)constraint(%%)and apply the values provided for the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]appropriately.[[Data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] schemas will drive types based on this for each group defined in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].Both the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]values which make up the key (if applicable) and the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values associated with the group will be represented with XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived group type will refine this structure so that the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]are explicit. The XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be given a name based on the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be unqualified (meaning they do not have a namespace associated with them). The[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be required while the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be optional. To allow for generic processing, it is required that the only unqualified XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]in the derived group type be for the group[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]and[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]declared in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].If additional[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a[[data structure definition>>doc:sdmx:Glossary.Datastructuredefinition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]or[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].354 +**//GroupType//: **GroupType is the abstract type which defines a structure which is used to communicate attribute values for a group defined in a data structure definition. The group can consist of either a subset of the dimensions defined by the data structure definition, or an association to an attachment constraint, which in turn defines key sets to which attributes can be attached. In the case that the group is based on an attachment constraint, only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the constraint and apply the values provided for the attributes appropriately. Data structure definition schemas will drive types based on this for each group defined in the data structure definition. Both the dimension values which make up the key (if applicable) and the attribute values associated with the group will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived group type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the group dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute. 384 384 385 385 Derivation: 386 - 387 387 * //com:AnnotableType// (extension) 388 388 ** //GroupType// 389 389 ... ... @@ -391,24 +391,21 @@ 391 391 type?, REPORTING_YEAR_START_DAY? 392 392 393 393 Content: 394 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?364 +com:Annotations? 395 395 396 396 Attribute Documentation: 397 - 398 398 (% style="width:1008.29px" %) 399 399 |**Name**|**Type**|(% style="width:621px" %)**Documentation** 400 -|type|com:IDType|(% style="width:621px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]reference the identifier of the group as defined in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].This is optional, but derived group types will provide a fixed value for this so that it always available in the post validation information set. This allows the group to be processed in a generic manner.401 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:621px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explict[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the reporting year start day, which provides context to the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]when its value contains a reporting period (e.g. 2010-Q1). This[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is used to state the month and day that the reporting year begins (e.g. 07-01 for July 1st). In the absence of an explicit value provided in this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and[[representation>>doc:sdmx:Glossary.Representation.WebHome]].The derived group types may either require or prohibit this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]and if so, the[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]] and assignment status assigned to it.369 +|type|com:IDType|(% style="width:621px" %)The type attribute reference the identifier of the group as defined in the data structure definition. This is optional, but derived group types will provide a fixed value for this so that it always available in the post validation information set. This allows the group to be processed in a generic manner. 370 +|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:621px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived group types may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it. 402 402 403 403 Element Documentation: 404 - 405 405 |**Name**|**Type**|**Documentation** 406 -|com:Annotations|com:AnnotationsType| [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.374 +|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 407 407 408 -**//SeriesType//: **SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]declared to be at the observation(% style="color:#e74c3c" %)level(%%)for this[[data set>>doc:sdmx:Glossary.Dataset.WebHome]].In addition to observations, values can be provided for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which are associated with the[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]which make up this[[series key>>doc:sdmx:Glossary.Serieskey.WebHome]](so long as the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]do not specify a group attachment or also have an relationship with the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]). It is possible for the series to contain only observations or only[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values, or both.[[Data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] schemas will drive a type based on this that is specific to the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]and the variation of the format being expressed in the schema. Both the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]values which make up the key and the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values associated with the key[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]will be represented with XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]are explicit. The XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be given a name based on the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be unqualified (meaning they do not have a namespace associated with them). The[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be required while the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be optional. To allow for generic processing, it is required that the only unqualified XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]in the derived group type be for the series[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]and[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]declared in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].If additional[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a[[data structure definition>>doc:sdmx:Glossary.Datastructuredefinition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]or[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].376 +**//SeriesType//: **SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition, save the dimension declared to be at the observation level for this data set. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both. Data structure definition schemas will drive a type based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. Both the dimension values which make up the key and the attribute values associated with the key dimensions will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute. 409 409 410 410 Derivation: 411 - 412 412 * //com:AnnotableType// (extension) 413 413 ** //SeriesType// 414 414 ... ... @@ -416,25 +416,22 @@ 416 416 TIME_PERIOD?, REPORTING_YEAR_START_DAY? 417 417 418 418 Content: 419 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Obs*386 +com:Annotations?, Obs* 420 420 421 421 Attribute Documentation: 422 - 423 423 (% style="width:1002.29px" %) 424 424 |**Name**|**Type**|(% style="width:533px" %)**Documentation** 425 -|TIME_PERIOD|com: ObservationalTimePer iodType|(% style="width:533px" %)The TIME_PERIOD [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explict[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].This is declared in the base schema since it has a fixed identifier and[[representation>>doc:sdmx:Glossary.Representation.WebHome]].The derived series type will either require or prohibit this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether time is the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].If the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]specifies a more specific[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of time the derived type will restrict the type definition to the appropriate type.426 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:533px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explict[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the reporting year start day, which provides context to the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]when its value contains a reporting period (e.g. 2010-Q1). This[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is used to state the month and day that the reporting year begins (e.g. 07-01 for July 1st). In the absence of an explicit value provided in this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and[[representation>>doc:sdmx:Glossary.Representation.WebHome]].The derived series type may either require or prohibit this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]and if so, the[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]] and assignment status assigned to it.391 +|TIME_PERIOD|com: ObservationalTimePer iodType|(% style="width:533px" %)The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type. 392 +|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:533px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived series type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it. 427 427 428 428 Element Documentation: 429 - 430 430 |**Name**|**Type**|**Documentation** 431 -|com:Annotations|com:AnnotationsType| [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.396 +|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 432 432 |Obs|//ObsType//| 433 433 434 -**//ObsType//: **ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]which is declared to be at the observation(% style="color:#e74c3c" %)level(%%)if the observation is grouped, or a full set of values for all[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]value in a series). The observation can contain an observed value and/or[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values.[[Data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] schemas will drive a type or types based on this that is specific to the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]and the variation of the format being expressed in the schema. The[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]value(s) which make up the key and the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values associated with the key[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](s) or the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]]will be represented with XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]are explicit. The XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be given a name based on the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be unqualified (meaning they do not have a namespace associated with them). The[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]XML[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]](s) will be required while the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be optional. To allow for generic processing, it is required that the only unqualified XML[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]in the derived observation type be for the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](s) and[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]declared in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].If additional[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a[[data structure definition>>doc:sdmx:Glossary.Datastructuredefinition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]or[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].If the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] specific schema requires that explicit[[measures>>doc:sdmx:Glossary.Measure.WebHome]]be used (only possible when the[[measure>>doc:sdmx:Glossary.Measure.WebHome]][[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is specified at the observation), then there will be types derived for each[[measure>>doc:sdmx:Glossary.Measure.WebHome]]defined by the[[measure>>doc:sdmx:Glossary.Measure.WebHome]][[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].In this case, the types will be specific to each[[measure>>doc:sdmx:Glossary.Measure.WebHome]], which is to say that the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]](i.e. the observed value) will be restricted to that which is specified by the specific[[measure>>doc:sdmx:Glossary.Measure.WebHome]].399 +**//ObsType//: **ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values. Data structure definition schemas will drive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attribute(s) will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived observation type be for the observation dimension(s) and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute. If the data structure definition specific schema requires that explicit measures be used (only possible when the measure dimension is specified at the observation), then there will be types derived for each measure defined by the measure dimension. In this case, the types will be specific to each measure, which is to say that the representation of the primary measure (i.e. the observed value) will be restricted to that which is specified by the specific measure. 435 435 436 436 Derivation: 437 - 438 438 * //com:AnnotableType// (extension) 439 439 ** //ObsType// 440 440 ... ... @@ -442,26 +442,23 @@ 442 442 type?, TIME_PERIOD?, REPORTING_YEAR_START_DAY?, OBS_VALUE? 443 443 444 444 Content: 445 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?409 +com:Annotations? 446 446 447 447 Attribute Documentation: 448 - 449 449 (% style="width:1014.29px" %) 450 450 |**Name**|**Type**|(% style="width:505px" %)**Documentation** 451 -|type|com:IDType|(% style="width:505px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is used when the derived format requires that explicit[[measure>>doc:sdmx:Glossary.Measure.WebHome]]be used. In this case, the derived type based on the[[measure>>doc:sdmx:Glossary.Measure.WebHome]]will fix this value to be the identification of the[[measure>>doc:sdmx:Glossary.Measure.WebHome]](% style="color:#e74c3c" %)concept(%%). This will not be required, but since it is fixed it will be available in the post validation information set which will allow for generic processing of the data. If explicit[[measures>>doc:sdmx:Glossary.Measure.WebHome]]are not used, then the derived type will prohibit the use of this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].452 -|TIME_PERIOD|com: ObservationalTimePeriodType|(% style="width:505px" %)The TIME_PERIOD [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explicit[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].This is declared in the base schema since it has a fixed identifier and[[representation>>doc:sdmx:Glossary.Representation.WebHome]].The derived series type will either require or prohibit this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether time is the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].If the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]specifies a more specific[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of time the derived type will restrict the type definition to the appropriate type.453 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:505px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explict[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the reporting year start day, which provides context to the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]when its value contains a reporting period (e.g. 2010-Q1). This[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is used to state the month and day that the reporting year begins (e.g. 07-01 for July 1st). In the absence of an explicit value provided in this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and[[representation>>doc:sdmx:Glossary.Representation.WebHome]].The derived observation type may either require or prohibit this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]and if so, the[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]] and assignment status assigned to it.454 -|OBS_VALUE|xs:anySimpleType|(% style="width:505px" %)The OBS_VALUE [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explicit[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]], which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is un-typed, since the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the observed value can vary widely. Derived types will restrict this to be a type based on the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]].In the case that an explicit[[measure>>doc:sdmx:Glossary.Measure.WebHome]]is used, the derived type for a given[[measure>>doc:sdmx:Glossary.Measure.WebHome]]might further restrict the type of the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]]to be more specific to the core[[representation>>doc:sdmx:Glossary.Representation.WebHome]]for the[[measure>>doc:sdmx:Glossary.Measure.WebHome]](% style="color:#e74c3c" %)concept(%%). Note that it is required that in the case of multiple[[measures>>doc:sdmx:Glossary.Measure.WebHome]]being used, that the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]]is broad enough to handle the various[[representations>>doc:sdmx:Glossary.Representation.WebHome]]of the[[measure>>doc:sdmx:Glossary.Measure.WebHome]](% style="color:#e74c3c" %)concepts(%%).414 +|type|com:IDType|(% style="width:505px" %)The type attribute is used when the derived format requires that explicit measure be used. In this case, the derived type based on the measure will fix this value to be the identification of the measure concept. This will not be required, but since it is fixed it will be available in the post validation information set which will allow for generic processing of the data. If explicit measures are not used, then the derived type will prohibit the use of this attribute. 415 +|TIME_PERIOD|com: ObservationalTimePeriodType|(% style="width:505px" %)The TIME_PERIOD attribute is an explicit attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type. 416 +|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:505px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived observation type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it. 417 +|OBS_VALUE|xs:anySimpleType|(% style="width:505px" %)The OBS_VALUE attribute is an explicit attribute for the primary measure, which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This attribute is un-typed, since the representation of the observed value can vary widely. Derived types will restrict this to be a type based on the representation of the primary measure. In the case that an explicit measure is used, the derived type for a given measure might further restrict the type of the primary measure to be more specific to the core representation for the measure concept. Note that it is required that in the case of multiple measures being used, that the representation of the primary measure is broad enough to handle the various representations of the measure concepts. 455 455 456 456 Element Documentation: 457 - 458 458 |**Name**|**Type**|**Documentation** 459 -|com:Annotations|com:AnnotationsType| [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.421 +|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 460 460 461 -**//TimeSeriesDataSetType//: **TimeSeriesDataSetType is the abstract type which defines the base structure for any [[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] specific time series based[[data set>>doc:sdmx:Glossary.Dataset.WebHome]].A derived[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] type will be created that is specific to a[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].Unlike the base format, only one variation of this is allowed for a[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].This variation is the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]as the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].Data is organised into a collection of time series. Because this derivation is achieved using restriction,[[data sets>>doc:sdmx:Glossary.Dataset.WebHome]]conforming to this type will inherently conform to the base[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] structure as well. In fact, data structure specific here will be identical to data in the base[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]when the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], even for the derived[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] types. This means that the data contained in this structure can be processed in exactly the same manner as the base structure. The same rules for derivation as the base[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] type apply to this specialized[[data set>>doc:sdmx:Glossary.Data set.WebHome]].423 +**//TimeSeriesDataSetType//: **TimeSeriesDataSetType is the abstract type which defines the base structure for any data structure definition specific time series based data set. A derived data set type will be created that is specific to a data structure definition. Unlike the base format, only one variation of this is allowed for a data structure definition. This variation is the time dimension as the observation dimension. Data is organised into a collection of time series. Because this derivation is achieved using restriction, data sets conforming to this type will inherently conform to the base data set structure as well. In fact, data structure specific here will be identical to data in the base data set when the time dimension is the observation dimension, even for the derived data set types. This means that the data contained in this structure can be processed in exactly the same manner as the base structure. The same rules for derivation as the base data set type apply to this specialized data set. 462 462 463 463 Derivation: 464 - 465 465 * //com:AnnotableType// (extension) 466 466 ** //DataSetType// (restriction) 467 467 *** //TimeSeriesDataSetType// ... ... @@ -470,37 +470,34 @@ 470 470 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY? 471 471 472 472 Content: 473 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, DataProvider?, Group*, Series*434 +com:Annotations?, DataProvider?, Group*, Series* 474 474 475 475 Attribute Documentation: 476 - 477 477 (% style="width:1003.29px" %) 478 478 |(% style="width:213px" %)**Name**|(% style="width:274px" %)**Type**|(% style="width:461px" %)**Documentation** 479 -|(% style="width:213px" %)structureRef|(% style="width:274px" %)xs:IDREF|(% style="width:461px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] message. The structural specification details which structure the data or[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]conforms to, as well as providing additional information such as how the data is structure (e.g. which[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]occurs at the observation(% style="color:#e74c3c" %)level(%%)for a[[data set>>doc:sdmx:Glossary.Data set.WebHome]]).480 -|(% style="width:213px" %)setID|(% style="width:274px" %)com:IDType|(% style="width:461px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].481 -|(% style="width:213px" %)action|(% style="width:274px" %)com:ActionType|(% style="width:461px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates whether the file is appending, replacing, or deleting.482 -|(% style="width:213px" %)reportingBeginDate|(% style="width:274px" %)com: BasicTimePeriodType|(% style="width:461px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].483 -|(% style="width:213px" %)reportingEndDate|(% style="width:274px" %)com: BasicTimePeriodType|(% style="width:461px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].484 -|(% style="width:213px" %)validFromDate|(% style="width:274px" %)xs:dateTime|(% style="width:461px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].485 -|(% style="width:213px" %)validToDate|(% style="width:274px" %)xs:dateTime|(% style="width:461px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].439 +|(% style="width:213px" %)structureRef|(% style="width:274px" %)xs:IDREF|(% style="width:461px" %)The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set). 440 +|(% style="width:213px" %)setID|(% style="width:274px" %)com:IDType|(% style="width:461px" %)The setID provides an identification of the data or metadata set. 441 +|(% style="width:213px" %)action|(% style="width:274px" %)com:ActionType|(% style="width:461px" %)The action attribute indicates whether the file is appending, replacing, or deleting. 442 +|(% style="width:213px" %)reportingBeginDate|(% style="width:274px" %)com: BasicTimePeriodType|(% style="width:461px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set. 443 +|(% style="width:213px" %)reportingEndDate|(% style="width:274px" %)com: BasicTimePeriodType|(% style="width:461px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set. 444 +|(% style="width:213px" %)validFromDate|(% style="width:274px" %)xs:dateTime|(% style="width:461px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set. 445 +|(% style="width:213px" %)validToDate|(% style="width:274px" %)xs:dateTime|(% style="width:461px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set. 486 486 |(% style="width:213px" %)publicationYear|(% style="width:274px" %)xs:gYear|(% style="width:461px" %)The publicationYear holds the ISO 8601 four-digit year. 487 -|(% style="width:213px" %)publicationPeriod|(% style="width:274px" %)com: ObservationalTimePeriodType|(% style="width:461px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]published on a quarterly basis).488 -|(% style="width:213px" %)dataScope|(% style="width:274px" %)DataScopeType|(% style="width:461px" %)The dataScope [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates the scope at which the data is meant to be validated. These scopes are hierarchical and are (from the top down); DataStructure, ConstrainedDataStructure,[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], and ProvisionAgreement. the[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]of these scopes represent the cascading(% style="color:#e74c3c" %)level(%%)of(% style="color:#e74c3c" %)constraints(%%), which can restrict the valid values for[[components>>doc:sdmx:Glossary.Component.WebHome]].For example, a data structure defines a[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]with a coded[[representation>>doc:sdmx:Glossary.Representation.WebHome]].A[[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]]might have a(% style="color:#e74c3c" %)constraint(%%)associated with it which further restricts the values allowed from the referenced[[code list>>doc:sdmx:Glossary.Codelist.WebHome]]toa subset of the values allowed by the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]].A[[provision agreement>>doc:sdmx:Glossary.Provisionagreement.WebHome]] that is based on the[[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]might also have a(% style="color:#e74c3c" %)constraint(%%), which further restricts the subset of the[[codelist>>doc:sdmx:Glossary.Codelist.WebHome]]from the[[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].Therefore, the allowed content becomes stricter lower in the[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]].Data that is given a scope of one value is stated to be valid at that(% style="color:#e74c3c" %)level(%%)and all(% style="color:#e74c3c" %)levels(%%)below it. Therefore, this scope serves to state that data that is meant to be structured simply against the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] is not meant to be validated against the a[[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], where(% style="color:#e74c3c" %)constraints(%%)might be applied.489 -|(% style="width:213px" %)REPORTING_YEAR_START_DAY|(% style="width:274px" %)xs:gMonthDay|(% style="width:461px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explict[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the reporting year start day, which provides context to the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]when its value contains a reporting period (e.g. 2010-Q1). This[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is used to state the month and day that the reporting year begins (e.g. 07-01 for July 1st). In the absence of an explicit value provided in this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and[[representation>>doc:sdmx:Glossary.Representation.WebHome]].The derived[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] type may either require or prohibit this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]and if so, the[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]] and assignment status assigned to it.447 +|(% style="width:213px" %)publicationPeriod|(% style="width:274px" %)com: ObservationalTimePeriodType|(% style="width:461px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis). 448 +|(% style="width:213px" %)dataScope|(% style="width:274px" %)DataScopeType|(% style="width:461px" %)The dataScope attribute indicates the scope at which the data is meant to be validated. These scopes are hierarchical and are (from the top down); DataStructure, ConstrainedDataStructure, Dataflow, and ProvisionAgreement. the hierarchy of these scopes represent the cascading level of constraints, which can restrict the valid values for components. For example, a data structure defines a dimension with a coded representation. A data flow might have a constraint associated with it which further restricts the values allowed from the referenced code list to a subset of the values allowed by the data structure definition. A provision agreement that is based on the dataflow might also have a constraint, which further restricts the subset of the codelist from the dataflow. Therefore, the allowed content becomes stricter lower in the hierarchy. Data that is given a scope of one value is stated to be valid at that level and all levels below it. Therefore, this scope serves to state that data that is meant to be structured simply against the data structure definition is not meant to be validated against the a dataflow, where constraints might be applied. 449 +|(% style="width:213px" %)REPORTING_YEAR_START_DAY|(% style="width:274px" %)xs:gMonthDay|(% style="width:461px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived data set type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it. 490 490 491 491 Element Documentation: 492 - 493 493 (% style="width:1007.29px" %) 494 494 |**Name**|**Type**|(% style="width:632px" %)**Documentation** 495 -|com:Annotations|com:AnnotationsType|(% style="width:632px" %) [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.496 -|DataProvider|com: DataProviderReferenceType|(% style="width:632px" %)DataProvider contains a reference to the provider for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].497 -|Group|//GroupType//|(% style="width:632px" %)Group contains a references to a defined group in the [[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]along with its key (if necessary) and values for the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which are associated with the group. An[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is associated to a group by either an explicit group relationship or by a group attachment when the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]has a relationship with a[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]which is a member of this group.498 -|Series|TimeSeriesType|(% style="width:632px" %)Series contains a collection of observations that share a common key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]values). The key of a series is every[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%). In addition to the key and observations, the series contains values for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which have a relationship with any[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]that is part of the[[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]does not specify an attachment group or also has a relationship with the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]declared to be at the observation(% style="color:#e74c3c" %)level(%%).454 +|com:Annotations|com:AnnotationsType|(% style="width:632px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 455 +|DataProvider|com: DataProviderReferenceType|(% style="width:632px" %)DataProvider contains a reference to the provider for the data set. 456 +|Group|//GroupType//|(% style="width:632px" %)Group contains a references to a defined group in the data structure definition along with its key (if necessary) and values for the attributes which are associated with the group. An attribute is associated to a group by either an explicit group relationship or by a group attachment when the attribute has a relationship with a dimension which is a member of this group. 457 +|Series|TimeSeriesType|(% style="width:632px" %)Series contains a collection of observations that share a common key (set of dimension values). The key of a series is every dimension defined in the data structure definition, save the dimension at the observation level. In addition to the key and observations, the series contains values for attributes which have a relationship with any dimension that is part of the series key, so long as the attribute does not specify an attachment group or also has a relationship with the dimension declared to be at the observation level. 499 499 500 -**TimeSeriesType: **TimeSeriesType defines an abstract structure which is used to group a collection of observations which have a key in common, organised by time. The key for a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined in the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].In addition to observations, values can be provided for[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which are associated with the[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]which make up this[[series key>>doc:sdmx:Glossary.Serieskey.WebHome]](so long as the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]do not specify a group attachment or also have an relationship with the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]). It is possible for the series to contain only observations or only[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values, or both. The same rules for derivation as the base series type apply to this specialized series.459 +**TimeSeriesType: **TimeSeriesType defines an abstract structure which is used to group a collection of observations which have a key in common, organised by time. The key for a series is every dimension defined in the data structure definition, save the time dimension. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the time dimension). It is possible for the series to contain only observations or only attribute values, or both. The same rules for derivation as the base series type apply to this specialized series. 501 501 502 502 Derivation: 503 - 504 504 * //com:AnnotableType// (extension) 505 505 ** //SeriesType// (restriction) 506 506 *** TimeSeriesType ... ... @@ -509,25 +509,22 @@ 509 509 REPORTING_YEAR_START_DAY? 510 510 511 511 Content: 512 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Obs*470 +com:Annotations?, Obs* 513 513 514 514 Attribute Documentation: 515 - 516 516 (% style="width:1004.29px" %) 517 517 |**Name**|**Type**|(% style="width:617px" %)**Documentation** 518 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:617px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explict[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the reporting year start day, which provides context to the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]when its value contains a reporting period (e.g. 2010-Q1). This[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is used to state the month and day that the reporting year begins (e.g. 07-01 for July 1st). In the absence of an explicit value provided in this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and[[representation>>doc:sdmx:Glossary.Representation.WebHome]].The derived series type may either require or prohibit this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]and if so, the[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]] and assignment status assigned to it.475 +|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:617px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived series type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it. 519 519 520 520 Element Documentation: 521 - 522 522 (% style="width:1003.29px" %) 523 523 |**Name**|**Type**|(% style="width:593px" %)**Documentation** 524 -|com:Annotations|com:AnnotationsType|(% style="width:593px" %) [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.480 +|com:Annotations|com:AnnotationsType|(% style="width:593px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 525 525 |Obs|//TimeSeriesObsType//|(% style="width:593px" %) 526 526 527 -**//TimeSeriesObsType//: **TimeSeriesObsType defines the abstract structure of a time series observation. The observation must be provided a value for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].This time value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same time value). The observation can contain an observed value and/or[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values. The same rules for derivation as the base observation type apply to this specialized observation.483 +**//TimeSeriesObsType//: **TimeSeriesObsType defines the abstract structure of a time series observation. The observation must be provided a value for the time dimension. This time value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same time value). The observation can contain an observed value and/or attribute values. The same rules for derivation as the base observation type apply to this specialized observation. 528 528 529 529 Derivation: 530 - 531 531 * //com:AnnotableType// (extension) 532 532 ** //ObsType// (restriction) 533 533 *** //TimeSeriesObsType// ... ... @@ -536,25 +536,23 @@ 536 536 TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE? 537 537 538 538 Content: 539 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?494 +com:Annotations? 540 540 541 541 Attribute Documentation: 542 - 543 543 (% style="width:1005.29px" %) 544 544 |**Name**|**Type**|(% style="width:496px" %)**Documentation** 545 -|TIME_PERIOD|com: ObservationalTimePeriodType|(% style="width:496px" %)The TIME_PERIOD [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explicit[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].This is declared in the base schema since it has a fixed identifier and[[representation>>doc:sdmx:Glossary.Representation.WebHome]].Since this data is structured to be time series only, this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is always required. If the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]specifies a more specific[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of time the derived type will restrict the type definition to the appropriate type.546 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:496px" %)The REPORTING_YEAR_START_DAY [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explict[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the reporting year start day, which provides context to the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]when its value contains a reporting period (e.g. 2010-Q1). This[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is used to state the month and day that the reporting year begins (e.g. 07-01 for July 1st). In the absence of an explicit value provided in this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and[[representation>>doc:sdmx:Glossary.Representation.WebHome]].The derived observation type may either require or prohibit this[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether the data structure declared the reporting year start day[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]and if so, the[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]] and assignment status assigned to it.547 -|OBS_VALUE|xs:anySimpleType|(% style="width:496px" %)The OBS_VALUE [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is an explicit[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]], which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is un-typed, since the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the observed value can vary widely. Derived types will restrict this to be a type based on the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]].In the case that an explicit[[measure>>doc:sdmx:Glossary.Measure.WebHome]]is used, the derived type for a given[[measure>>doc:sdmx:Glossary.Measure.WebHome]]might further restrict the type of the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]]to be more specific to the core[[representation>>doc:sdmx:Glossary.Representation.WebHome]]for the[[measure>>doc:sdmx:Glossary.Measure.WebHome]](% style="color:#e74c3c" %)concept(%%). Note that it is required that in the case of multiple[[measures>>doc:sdmx:Glossary.Measure.WebHome]]being used, that the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the primary[[measure>>doc:sdmx:Glossary.Measure.WebHome]]is broad enough to handle the various[[representations>>doc:sdmx:Glossary.Representation.WebHome]]of the[[measure>>doc:sdmx:Glossary.Measure.WebHome]](% style="color:#e74c3c" %)concepts(%%).499 +|TIME_PERIOD|com: ObservationalTimePeriodType|(% style="width:496px" %)The TIME_PERIOD attribute is an explicit attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. Since this data is structured to be time series only, this attribute is always required. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type. 500 +|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:496px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived observation type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it. 501 +|OBS_VALUE|xs:anySimpleType|(% style="width:496px" %)The OBS_VALUE attribute is an explicit attribute for the primary measure, which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This attribute is un-typed, since the representation of the observed value can vary widely. Derived types will restrict this to be a type based on the representation of the primary measure. In the case that an explicit measure is used, the derived type for a given measure might further restrict the type of the primary measure to be more specific to the core representation for the measure concept. Note that it is required that in the case of multiple measures being used, that the representation of the primary measure is broad enough to handle the various representations of the measure concepts. 548 548 549 549 Element Documentation: 550 - 551 551 (% style="width:1013.29px" %) 552 552 |**Name**|**Type**|(% style="width:603px" %)**Documentation** 553 -|com:Annotations|com:AnnotationsType|(% style="width:603px" %) [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.506 +|com:Annotations|com:AnnotationsType|(% style="width:603px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 554 554 555 555 === 2.2.3 Simple Types === 556 556 557 -**DataScopeType: **DataScopeType is an enumeration of the possible validity scopes for a [[data set>>doc:sdmx:Glossary.Dataset.WebHome]].These scopes indicate the(% style="color:#e74c3c" %)level(%%)at which the data is stated to be valid.510 +**DataScopeType: **DataScopeType is an enumeration of the possible validity scopes for a data set. These scopes indicate the level at which the data is stated to be valid. 558 558 559 559 Derived by restriction of xs:string . 560 560 ... ... @@ -562,10 +562,10 @@ 562 562 563 563 (% style="width:1020.29px" %) 564 564 |(% style="width:208px" %)**Value**|(% style="width:809px" %)**Documentation** 565 -|(% style="width:208px" %)DataStructure|(% style="width:809px" %)The [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]conforms simply to the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]as it is defined, without regard to any(% style="color:#e74c3c" %)constraints(%%).566 -|(% style="width:208px" %)ConstrainedDataStructure|(% style="width:809px" %)The [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]conforms to the known allowable content(% style="color:#e74c3c" %)constraints(%%)applied to the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].567 -|(% style="width:208px" %) [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:809px" %)The[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]conforms to the known allowable content(% style="color:#e74c3c" %)constraints(%%)applied to the[[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].568 -|(% style="width:208px" %)ProvisionAgreement|(% style="width:809px" %)The [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]conforms to the known allowable content(% style="color:#e74c3c" %)constraints(%%)applied to the[[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].518 +|(% style="width:208px" %)DataStructure|(% style="width:809px" %)The data set conforms simply to the data structure definition as it is defined, without regard to any constraints. 519 +|(% style="width:208px" %)ConstrainedDataStructure|(% style="width:809px" %)The data set conforms to the known allowable content constraints applied to the data structure definition. 520 +|(% style="width:208px" %)Dataflow|(% style="width:809px" %)The data set conforms to the known allowable content constraints applied to the dataflow. 521 +|(% style="width:208px" %)ProvisionAgreement|(% style="width:809px" %)The data set conforms to the known allowable content constraints applied to the provision agreement. 569 569 570 570 == 2.3 Generic Metadata Namespace == 571 571 ... ... @@ -586,10 +586,9 @@ 586 586 587 587 === 2.3.2 Complex Types === 588 588 589 -**MetadataSetType: **MetadataSetType describes the structure for a [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]], which contains a collection of reported metadata against a set of values for a given full or partial target identifier, as described in a[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]].The[[metadata set>>doc:sdmx:Glossary.Metadataset.WebHome]] may contain reported metadata for multiple report structures defined in a[[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].542 +**MetadataSetType: **MetadataSetType describes the structure for a metadata set, which contains a collection of reported metadata against a set of values for a given full or partial target identifier, as described in a metadata structure definition. The metadata set may contain reported metadata for multiple report structures defined in a metadata structure definition. 590 590 591 591 Derivation: 592 - 593 593 * //com:AnnotableType// (extension) 594 594 ** MetadataSetType 595 595 ... ... @@ -597,35 +597,33 @@ 597 597 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 598 598 599 599 Content: 600 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name*, DataProvider?, Report+552 +com:Annotations?, com:Name*, DataProvider?, Report+ 601 601 602 602 Attribute Documentation: 603 603 604 604 (% style="width:1006.29px" %) 605 605 |**Name**|**Type**|(% style="width:592px" %)**Documentation** 606 -|structureRef|xs:IDREF|(% style="width:592px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] message. The structural specification details which structure the data or[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]conforms to, as well as providing additional information such as how the data is structure (e.g. which[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]occurs at the observation(% style="color:#e74c3c" %)level(%%)for a[[data set>>doc:sdmx:Glossary.Data set.WebHome]]).607 -|setID|com:IDType|(% style="width:592px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].608 -|action|com:ActionType|(% style="width:592px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates whether the file is appending, replacing, or deleting.609 -|reportingBeginDate|com: BasicTimePeriodType|(% style="width:592px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].610 -|reportingEndDate|com: BasicTimePeriodType|(% style="width:592px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].611 -|validFromDate|xs:dateTime|(% style="width:592px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].612 -|validToDate|xs:dateTime|(% style="width:592px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].558 +|structureRef|xs:IDREF|(% style="width:592px" %)The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set). 559 +|setID|com:IDType|(% style="width:592px" %)The setID provides an identification of the data or metadata set. 560 +|action|com:ActionType|(% style="width:592px" %)The action attribute indicates whether the file is appending, replacing, or deleting. 561 +|reportingBeginDate|com: BasicTimePeriodType|(% style="width:592px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set. 562 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:592px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set. 563 +|validFromDate|xs:dateTime|(% style="width:592px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set. 564 +|validToDate|xs:dateTime|(% style="width:592px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set. 613 613 |publicationYear|xs:gYear|(% style="width:592px" %)The publicationYear holds the ISO 8601 four-digit year. 614 -|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:592px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]published on a quarterly basis).566 +|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:592px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis). 615 615 616 616 Element Documentation: 617 - 618 618 (% style="width:1006.29px" %) 619 619 |**Name**|(% style="width:268px" %)**Type**|(% style="width:562px" %)**Documentation** 620 -|com:Annotations|(% style="width:268px" %)com:AnnotationsType|(% style="width:562px" %) [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.571 +|com:Annotations|(% style="width:268px" %)com:AnnotationsType|(% style="width:562px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 621 621 |com:Name|(% style="width:268px" %)com:TextType|(% style="width:562px" %)Name is a reusable element, used for providing a human-readable name for an object. 622 -|DataProvider|(% style="width:268px" %)com: DataProviderReferenceType|(% style="width:562px" %)DataProviderReference provides a references to an organisation with the role of [[data provider>>doc:sdmx:Glossary.Dataprovider.WebHome]]that is providing this[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].623 -|Report|(% style="width:268px" %)ReportType|(% style="width:562px" %)Report contains the details of a the reported metadata, including the identification of the target and the report [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].573 +|DataProvider|(% style="width:268px" %)com: DataProviderReferenceType|(% style="width:562px" %)DataProviderReference provides a references to an organisation with the role of data provider that is providing this metadata set. 574 +|Report|(% style="width:268px" %)ReportType|(% style="width:562px" %)Report contains the details of a the reported metadata, including the identification of the target and the report attributes. 624 624 625 -**ReportType: **ReportType contains a set of report [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]and identifies a target objects] to which they apply.576 +**ReportType: **ReportType contains a set of report attributes and identifies a target objects] to which they apply. 626 626 627 627 Derivation: 628 - 629 629 * //com:AnnotableType// (extension) 630 630 ** ReportType 631 631 ... ... @@ -633,21 +633,19 @@ 633 633 id 634 634 635 635 Content: 636 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Target, AttributeSet586 +com:Annotations?, Target, AttributeSet 637 637 638 638 Attribute Documentation: 639 - 640 640 (% style="width:1003.29px" %) 641 641 |**Name**|**Type**|(% style="width:788px" %)**Documentation** 642 -|id|com:IDType|(% style="width:788px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds the identifier of the report structure as defined in the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]].This identifies the report structure which defines the structure of metadata that is being reported.591 +|id|com:IDType|(% style="width:788px" %)The id attribute holds the identifier of the report structure as defined in the metadata structure definition. This identifies the report structure which defines the structure of metadata that is being reported. 643 643 644 644 Element Documentation: 645 - 646 646 (% style="width:1003.29px" %) 647 647 |**Name**|**Type**|(% style="width:593px" %)**Documentation** 648 -|com:Annotations|com:AnnotationsType|(% style="width:593px" %) [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.596 +|com:Annotations|com:AnnotationsType|(% style="width:593px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 649 649 |Target|TargetType|(% style="width:593px" %)Target contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply. 650 -|AttributeSet|AttributeSetType|(% style="width:593px" %)AttributeSet contains the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values for the reported metadata.598 +|AttributeSet|AttributeSetType|(% style="width:593px" %)AttributeSet contains the reported metadata attribute values for the reported metadata. 651 651 652 652 **TargetType: **TargetType defines the structure of a target. It contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply. 653 653 ... ... @@ -658,18 +658,16 @@ 658 658 ReferenceValue+ 659 659 660 660 Attribute Documentation: 661 - 662 662 (% style="width:1003.29px" %) 663 663 |**Name**|**Type**|(% style="width:805px" %)**Documentation** 664 -|id|com:IDType|(% style="width:805px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds the identifier of the metadata target as defined in the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]].This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata.611 +|id|com:IDType|(% style="width:805px" %)The id attribute holds the identifier of the metadata target as defined in the metadata structure definition. This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata. 665 665 666 666 Element Documentation: 667 - 668 668 (% style="width:1009.29px" %) 669 669 |**Name**|**Type**|(% style="width:710px" %)**Documentation** 670 -|ReferenceValue|ReferenceValueType|(% style="width:710px" %)ReferenceValue contains a value for a target reference object reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], or a report period.616 +|ReferenceValue|ReferenceValueType|(% style="width:710px" %)ReferenceValue contains a value for a target reference object reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period. 671 671 672 -**ReferenceValueType: **ReferenceValueType defines the structure of a target object reference value. A target reference value will either be a reference to an identifiable object, a data key, a reference to a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], or a report period.618 +**ReferenceValueType: **ReferenceValueType defines the structure of a target object reference value. A target reference value will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period. 673 673 674 674 Attributes: 675 675 id ... ... @@ -678,36 +678,33 @@ 678 678 (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod) 679 679 680 680 Attribute Documentation: 681 - 682 682 (% style="width:1013.29px" %) 683 683 |**Name**|**Type**|(% style="width:847px" %)**Documentation** 684 -|id|com:IDType|(% style="width:847px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds the identifier of the target reference object as defined in the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]].This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata.629 +|id|com:IDType|(% style="width:847px" %)The id attribute holds the identifier of the target reference object as defined in the metadata structure definition. This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata. 685 685 686 686 Element Documentation: 687 687 688 688 (% style="width:1017.29px" %) 689 689 |**Name**|**Type**|(% style="width:522px" %)**Documentation** 690 -|ObjectReference|com: ObjectReferenceType|(% style="width:522px" %)ObjectReference provides a reference to an identifiable object in the [[SDMX information model>>doc:sdmx:Glossary.SDMXInformation Model.WebHome]].An identifiable object target will utilize this option as the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the target reference value.691 -|DataKey|com:DataKeyType|(% style="width:522px" %)ObjectReference provides a set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]references and values for those[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the target reference value.692 -|DataSetReference|com:SetReferenceType|(% style="width:522px" %)DataSetReference provides a reference to a [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]for the purpose of reporting metadata against the data. A[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] target will utilize this option as the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the target reference value.693 -|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|(% style="width:522px" %)ConstraintContentReference provides a reference to an attachment (% style="color:#e74c3c" %)constraint(%%)for the purpose of reporting metadata against the data identified in the key sets and/or cube regions identified by the(% style="color:#e74c3c" %)constraint(%%). A(% style="color:#e74c3c" %)constraint(%%)target will utilize this option as the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the target reference value.694 -|ReportPeriod|com: ObservationalTimePer iodType|(% style="width:522px" %)ReportPeriod provides a report period for the purpose of qualifying the target reporting period of reported metadata. A report period target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the target reference value.635 +|ObjectReference|com: ObjectReferenceType|(% style="width:522px" %)ObjectReference provides a reference to an identifiable object in the SDMX information model. An identifiable object target will utilize this option as the representation of the target reference value. 636 +|DataKey|com:DataKeyType|(% style="width:522px" %)ObjectReference provides a set of dimension references and values for those dimension for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the representation of the target reference value. 637 +|DataSetReference|com:SetReferenceType|(% style="width:522px" %)DataSetReference provides a reference to a data set for the purpose of reporting metadata against the data. A data set target will utilize this option as the representation of the target reference value. 638 +|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|(% style="width:522px" %)ConstraintContentReference provides a reference to an attachment constraint for the purpose of reporting metadata against the data identified in the key sets and/or cube regions identified by the constraint. A constraint target will utilize this option as the representation of the target reference value. 639 +|ReportPeriod|com: ObservationalTimePer iodType|(% style="width:522px" %)ReportPeriod provides a report period for the purpose of qualifying the target reporting period of reported metadata. A report period target will utilize this option as the representation of the target reference value. 695 695 696 -**AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].641 +**AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata attributes. 697 697 698 698 Content: 699 699 ReportedAttribute+ 700 700 701 701 Element Documentation: 702 - 703 703 (% style="width:1023.29px" %) 704 704 |(% style="width:150px" %)**Name**|(% style="width:202px" %)**Type**|(% style="width:668px" %)**Documentation** 705 -|(% style="width:150px" %)ReportedAttribute|(% style="width:202px" %)ReportedAttributeType|(% style="width:668px" %)ReportedAttribute provides the details of a reported [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], including a value and/or child reported[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].649 +|(% style="width:150px" %)ReportedAttribute|(% style="width:202px" %)ReportedAttributeType|(% style="width:668px" %)ReportedAttribute provides the details of a reported attribute, including a value and/or child reported attributes. 706 706 707 -**ReportedAttributeType: **ReportedAttributeType defines the structure for a reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].A value for the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]can be supplied as either a single value, or multi-lingual text values (either structured or unstructured). An optional set of child metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]is also available if the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]definition defines nested metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].651 +**ReportedAttributeType: **ReportedAttributeType defines the structure for a reported metadata attribute. A value for the attribute can be supplied as either a single value, or multi-lingual text values (either structured or unstructured). An optional set of child metadata attributes is also available if the metadata attribute definition defines nested metadata attributes. 708 708 709 709 Derivation: 710 - 711 711 * //com:AnnotableType// (extension) 712 712 ** ReportedAttributeType 713 713 ... ... @@ -715,23 +715,21 @@ 715 715 id, value? 716 716 717 717 Content: 718 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, (com:Text+ | com:StructuredText+)?, AttributeSet?661 +com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet? 719 719 720 720 Attribute Documentation: 721 - 722 722 (% style="width:996.294px" %) 723 723 |**Name**|(% style="width:170px" %)**Type**|(% style="width:657px" %)**Documentation** 724 -|id|(% style="width:170px" %)com:IDType|(% style="width:657px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]identifies the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]that the value is being reported for.725 -|value|(% style="width:170px" %)xs:string|(% style="width:657px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds any simple value for the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].666 +|id|(% style="width:170px" %)com:IDType|(% style="width:657px" %)The id attribute identifies the metadata attribute that the value is being reported for. 667 +|value|(% style="width:170px" %)xs:string|(% style="width:657px" %)The value attribute holds any simple value for the metadata attribute. 726 726 727 727 Element Documentation: 728 - 729 729 (% style="width:999.294px" %) 730 730 |**Name**|**Type**|(% style="width:670px" %)**Documentation** 731 -|com:Annotations|com:AnnotationsType|(% style="width:670px" %) [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.732 -|com:Text|com:TextType|(% style="width:670px" %)Text is used to supply parallel multi-lingual textual values for the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].This will be used if the text format of the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]has a type of string and the multi-lingual value is set to true.733 -|com:StructuredText|com:XHTMLType|(% style="width:670px" %)StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].This will be used if the text format of the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]has a type of XHTML and the multi-lingual value is set to true.734 -|AttributeSet|AttributeSetType|(% style="width:670px" %)AttributeSet contains the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values for the child metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].672 +|com:Annotations|com:AnnotationsType|(% style="width:670px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 673 +|com:Text|com:TextType|(% style="width:670px" %)Text is used to supply parallel multi-lingual textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of string and the multi-lingual value is set to true. 674 +|com:StructuredText|com:XHTMLType|(% style="width:670px" %)StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of XHTML and the multi-lingual value is set to true. 675 +|AttributeSet|AttributeSetType|(% style="width:670px" %)AttributeSet contains the reported metadata attribute values for the child metadata attributes. 735 735 736 736 == 2.4 Structure Specific Metadata Namespace == 737 737 ... ... @@ -752,10 +752,9 @@ 752 752 753 753 === 2.4.2 Complex Types === 754 754 755 -**//MetadataSetType//: **MetadataSetType is an abstract base type the forms the basis for a metadata structure specific [[metadata set>>doc:sdmx:Glossary.Metadataset.WebHome]].It is restricted by the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema to meet its needs.696 +**//MetadataSetType//: **MetadataSetType is an abstract base type the forms the basis for a metadata structure specific metadata set. It is restricted by the metadata structure definition specific schema to meet its needs. 756 756 757 757 Derivation: 758 - 759 759 * //com:AnnotableType// (extension) 760 760 ** //MetadataSetType// 761 761 ... ... @@ -764,35 +764,32 @@ 764 764 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? 765 765 766 766 Content: 767 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name*, DataProvider?, Report+707 +com:Annotations?, com:Name*, DataProvider?, Report+ 768 768 769 769 Attribute Documentation: 770 - 771 771 (% style="width:1003.29px" %) 772 772 |**Name**|**Type**|(% style="width:607px" %)**Documentation** 773 -|structureRef|xs:IDREF|(% style="width:607px" %)The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] message. The structural specification details which structure the data or[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]conforms to, as well as providing additional information such as how the data is structure (e.g. which[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]occurs at the observation(% style="color:#e74c3c" %)level(%%)for a[[data set>>doc:sdmx:Glossary.Data set.WebHome]]).774 -|setID|com:IDType|(% style="width:607px" %)The setID provides an identification of the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].775 -|action|com:ActionType|(% style="width:607px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]indicates whether the file is appending, replacing, or deleting.776 -|reportingBeginDate|com: BasicTimePeriodType|(% style="width:607px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].777 -|reportingEndDate|com: BasicTimePeriodType|(% style="width:607px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].778 -|validFromDate|xs:dateTime|(% style="width:607px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].779 -|validToDate|xs:dateTime|(% style="width:607px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].712 +|structureRef|xs:IDREF|(% style="width:607px" %)The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set). 713 +|setID|com:IDType|(% style="width:607px" %)The setID provides an identification of the data or metadata set. 714 +|action|com:ActionType|(% style="width:607px" %)The action attribute indicates whether the file is appending, replacing, or deleting. 715 +|reportingBeginDate|com: BasicTimePeriodType|(% style="width:607px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set. 716 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:607px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set. 717 +|validFromDate|xs:dateTime|(% style="width:607px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set. 718 +|validToDate|xs:dateTime|(% style="width:607px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set. 780 780 |publicationYear|xs:gYear|(% style="width:607px" %)The publicationYear holds the ISO 8601 four-digit year. 781 -|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:607px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]published on a quarterly basis).720 +|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:607px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis). 782 782 783 783 Element Documentation: 784 - 785 785 (% style="width:1006.29px" %) 786 786 |**Name**|**Type**|(% style="width:631px" %)**Documentation** 787 -|com:Annotations|com:AnnotationsType|(% style="width:631px" %) [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.725 +|com:Annotations|com:AnnotationsType|(% style="width:631px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 788 788 |com:Name|com:TextType|(% style="width:631px" %)Name is a reusable element, used for providing a human-readable name for an object. 789 -|DataProvider|com: DataProviderReferenceType|(% style="width:631px" %)>DataProviderReference provides a references to an organisation with the role of [[data provider>>doc:sdmx:Glossary.Dataprovider.WebHome]]that is providing this[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].790 -|Report|//ReportType//|(% style="width:631px" %)Report contains the details of a the reported metadata, including the identification of the target and the report [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].This element is unqualified so that the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema can refine the type of the element such that it requires types built according to the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]].This allows the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]]tovalidate the structure of the reported metadata against the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]]while still allowing the content to be processed in a generic manner.727 +|DataProvider|com: DataProviderReferenceType|(% style="width:631px" %)>DataProviderReference provides a references to an organisation with the role of data provider that is providing this metadata set. 728 +|Report|//ReportType//|(% style="width:631px" %)Report contains the details of a the reported metadata, including the identification of the target and the report attributes. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that it requires types built according to the metadata structure definition. This allows the metadata structure definition to validate the structure of the reported metadata against the metadata structure definition while still allowing the content to be processed in a generic manner. 791 791 792 -**//ReportType//: **ReportType is an abstract base type the forms the basis for a [[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific report, based on the defined report structures. This type is restricted in the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema so that the Target and AttributeSet conform to the prescribed report structure.730 +**//ReportType//: **ReportType is an abstract base type the forms the basis for a metadata structure definition specific report, based on the defined report structures. This type is restricted in the metadata structure definition specific schema so that the Target and AttributeSet conform to the prescribed report structure. 793 793 794 794 Derivation: 795 - 796 796 * //com:AnnotableType// (extension) 797 797 ** //ReportType// 798 798 ... ... @@ -800,23 +800,21 @@ 800 800 id? 801 801 802 802 Content: 803 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Target, AttributeSet740 +com:Annotations?, Target, AttributeSet 804 804 805 805 Attribute Documentation: 806 - 807 807 (% style="width:1003.29px" %) 808 808 |**Name**|**Type**|(% style="width:837px" %)**Documentation** 809 -|id|com:IDType|(% style="width:837px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds the identifier of the report structure as defined in the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]].This identifies the report structure which defines the structure of metadata that is being reported. This is optional and not expected to be supplied as the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema will specify a fixed value such that the reference to the report structure will always be available if required for processing.745 +|id|com:IDType|(% style="width:837px" %)The id attribute holds the identifier of the report structure as defined in the metadata structure definition. This identifies the report structure which defines the structure of metadata that is being reported. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the report structure will always be available if required for processing. 810 810 811 811 Element Documentation: 812 - 813 813 (% style="width:1005.29px" %) 814 814 |**Name**|**Type**|(% style="width:695px" %)**Documentation** 815 -|com:Annotations|com:AnnotationsType|(% style="width:695px" %) [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.816 -|Target|//TargetType//|(% style="width:695px" %)Target contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply. This element is unqualified so that the [[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema can refine the type of the element such that the references values can be validated against those defined in the metadata targets for the report structure.817 -|AttributeSet|xs:anyType|(% style="width:695px" %)AttributeSet contains the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values for the reported metadata. This element is unqualified and un-typed so that it can refined by the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema to validate that the reported metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]conform to those prescribed by the report structure. The content of this must be element only, and these elements must always represent a reported[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].Since this can not be strictly enforced in XML Schema, additional steps have been added to make generic processing of this element simpler. When processing this element, any element found with the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]isMetadataAttribute in this target namespace is assumed to be a reported metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]and can be processed as such.750 +|com:Annotations|com:AnnotationsType|(% style="width:695px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 751 +|Target|//TargetType//|(% style="width:695px" %)Target contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that the references values can be validated against those defined in the metadata targets for the report structure. 752 +|AttributeSet|xs:anyType|(% style="width:695px" %)AttributeSet contains the reported metadata attribute values for the reported metadata. This element is unqualified and un-typed so that it can refined by the metadata structure definition specific schema to validate that the reported metadata attributes conform to those prescribed by the report structure. The content of this must be element only, and these elements must always represent a reported attribute. Since this can not be strictly enforced in XML Schema, additional steps have been added to make generic processing of this element simpler. When processing this element, any element found with the attribute isMetadataAttribute in this target namespace is assumed to be a reported metadata attribute and can be processed as such. 818 818 819 -**//TargetType//: **TargetType is an abstract base type that forms the basis of a the metadata report's metadata target value. This type is restricted in the [[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema so that the ReferenceValue elements conform to the targets specified in the metadata target defined in the[[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].754 +**//TargetType//: **TargetType is an abstract base type that forms the basis of a the metadata report's metadata target value. This type is restricted in the metadata structure definition specific schema so that the ReferenceValue elements conform to the targets specified in the metadata target defined in the metadata structure definition. 820 820 821 821 Attributes: 822 822 id? ... ... @@ -825,18 +825,16 @@ 825 825 ReferenceValue+ 826 826 827 827 Attribute Documentation: 828 - 829 829 (% style="width:999.294px" %) 830 830 |**Name**|**Type**|(% style="width:833px" %)**Documentation** 831 -|id|com:IDType|(% style="width:833px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds the identifier of the metadata target as defined in the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]].This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata. This is optional and not expected to be supplied as the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema will specify a fixed value such that the reference to the metadata target will always be available if required for processing.765 +|id|com:IDType|(% style="width:833px" %)The id attribute holds the identifier of the metadata target as defined in the metadata structure definition. This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the metadata target will always be available if required for processing. 832 832 833 833 Element Documentation: 834 - 835 835 (% style="width:999.294px" %) 836 836 |**Name**|**Type**|(% style="width:700px" %)**Documentation** 837 -|ReferenceValue|//ReferenceValueType//|(% style="width:700px" %)ReferenceValue contains a value for a target reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], or a report period. This element is unqualified so that the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema can refine the type of the element such that value can be validated against the format defined in the[[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].770 +|ReferenceValue|//ReferenceValueType//|(% style="width:700px" %)ReferenceValue contains a value for a target reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that value can be validated against the format defined in the metadata structure definition. 838 838 839 -**//ReferenceValueType//: **ReferenceValueType is an abstract base type that forms the basis of a target reference value. A target reference value will either be a reference to an identifiable object, a data key, a reference to a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], or a report period. The choice of these options will be refined to only one according to the definition of the target in the[[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].772 +**//ReferenceValueType//: **ReferenceValueType is an abstract base type that forms the basis of a target reference value. A target reference value will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period. The choice of these options will be refined to only one according to the definition of the target in the metadata structure definition. 840 840 841 841 Attributes: 842 842 id? ... ... @@ -845,25 +845,22 @@ 845 845 (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod) 846 846 847 847 Attribute Documentation: 848 - 849 849 (% style="width:1013.29px" %) 850 850 |**Name**|**Type**|(% style="width:847px" %)**Documentation** 851 -|id|com:IDType|(% style="width:847px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds the identifier of the target reference object reference as defined in the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]].This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata. This is optional and not expected to be supplied as the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema will specify a fixed value such that the reference to the target object definition will always be available if required for processing.783 +|id|com:IDType|(% style="width:847px" %)The id attribute holds the identifier of the target reference object reference as defined in the metadata structure definition. This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the target object definition will always be available if required for processing. 852 852 853 853 Element Documentation: 854 - 855 855 (% style="width:1000.29px" %) 856 856 |**Name**|**Type**|(% style="width:563px" %)**Documentation** 857 -|ObjectReference|//com:ReferenceType//|(% style="width:563px" %)ObjectReference provides a reference to an identifiable object in the [[SDMX information model>>doc:sdmx:Glossary.SDMXInformation Model.WebHome]].An identifiable object target will utilize this option as the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the target reference value. This element is unqualified so that the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema can refine the type of the element such that the type of reference is valid according to the object type specified in the identifiable object target in the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]].At the very least, the reference will be specific to the type of object being referenced so that a complete set of reference fields must be provided. In cases where an item object is restricted to be from a particular scheme, this type will be further restricted so that only a valid item reference can be supplied. The structure of this reference is such that it can be generically processed without needing to know what the intended target object type is prior to processing, as this information is part of the reference.858 -|DataKey|com:DataKeyType|(% style="width:563px" %)ObjectReference provides a set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]references and values for those[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the target reference value. It is not expect that the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema would refine this, but none the less, it is an unqualified element.859 -|DataSetReference|com:SetReferenceType|(% style="width:563px" %)DataSetReference provides a reference to a [[data set>>doc:sdmx:Glossary.Dataset.WebHome]]for the purpose of reporting metadata against the data. A[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] target will utilize this option as the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the target reference value.860 -|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|(% style="width:563px" %)ConstraintContentReference provides a reference to an attachment (% style="color:#e74c3c" %)constraint(%%)for the purpose of reporting metadata against the data identified in the key sets and/or cube regions identified by the(% style="color:#e74c3c" %)constraint(%%). A(% style="color:#e74c3c" %)constraint(%%)target will utilize this option as the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the target reference value.861 -|ReportPeriod|com: ObservationalTimePeriodType|(% style="width:563px" %)ReportPeriod provides a report period for the purpose of qualifying the target reporting period of reported metadata. A report period target will utilize this option as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the target reference value. It is not expect that the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema would refine this, but none the less, it is an unqualified element. This element is unqualified so that the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema can refine the type of the element such that the specific type of time value prescribed in the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] can be validated.788 +|ObjectReference|//com:ReferenceType//|(% style="width:563px" %)ObjectReference provides a reference to an identifiable object in the SDMX information model. An identifiable object target will utilize this option as the representation of the target reference value. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that the type of reference is valid according to the object type specified in the identifiable object target in the metadata structure definition. At the very least, the reference will be specific to the type of object being referenced so that a complete set of reference fields must be provided. In cases where an item object is restricted to be from a particular scheme, this type will be further restricted so that only a valid item reference can be supplied. The structure of this reference is such that it can be generically processed without needing to know what the intended target object type is prior to processing, as this information is part of the reference. 789 +|DataKey|com:DataKeyType|(% style="width:563px" %)ObjectReference provides a set of dimension references and values for those dimension for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the representation of the target reference value. It is not expect that the metadata structure definition specific schema would refine this, but none the less, it is an unqualified element. 790 +|DataSetReference|com:SetReferenceType|(% style="width:563px" %)DataSetReference provides a reference to a data set for the purpose of reporting metadata against the data. A data set target will utilize this option as the representation of the target reference value. 791 +|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|(% style="width:563px" %)ConstraintContentReference provides a reference to an attachment constraint for the purpose of reporting metadata against the data identified in the key sets and/or cube regions identified by the constraint. A constraint target will utilize this option as the representation of the target reference value. 792 +|ReportPeriod|com: ObservationalTimePeriodType|(% style="width:563px" %)ReportPeriod provides a report period for the purpose of qualifying the target reporting period of reported metadata. A report period target will utilize this option as the representation of the target reference value. It is not expect that the metadata structure definition specific schema would refine this, but none the less, it is an unqualified element. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that the specific type of time value prescribed in the metadata structure definition can be validated. 862 862 863 -**//ReportedAttributeType//: **ReportedAttributeType is an abstract base type that forms the basis for a metadata structure specific metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].A value for the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]can be supplied as either a single value, or multi-lingual text values (either structured or unstructured). An optional set of child metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]is also available if the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]definition defines nested metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].The[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema will refine this type for each metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]such that the content can be validation against what is defined in the[[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].794 +**//ReportedAttributeType//: **ReportedAttributeType is an abstract base type that forms the basis for a metadata structure specific metadata attribute. A value for the attribute can be supplied as either a single value, or multi-lingual text values (either structured or unstructured). An optional set of child metadata attributes is also available if the metadata attribute definition defines nested metadata attributes. The metadata structure definition specific schema will refine this type for each metadata attribute such that the content can be validation against what is defined in the metadata structure definition. 864 864 865 865 Derivation: 866 - 867 867 * //com:AnnotableType// (extension) 868 868 ** //ReportedAttributeType// 869 869 ... ... @@ -871,24 +871,22 @@ 871 871 id?, value?, isMetadataAttribute? 872 872 873 873 Content: 874 -com: [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, (com:Text+ | com:StructuredText+)?, AttributeSet?804 +com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet? 875 875 876 876 Attribute Documentation: 877 - 878 878 (% style="width:999.294px" %) 879 879 |**Name**|**Type**|(% style="width:660px" %)**Documentation** 880 -|id|com:IDType|(% style="width:660px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]identifies the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]that the value is being reported for. This is optional and not expected to be supplied as the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema will specify a fixed value such that the reference to the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]will always be available if required for processing.881 -|value|xs:anySimpleType|(% style="width:660px" %)The value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]holds any simple value for the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].This[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is un-typed such that the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema can specify any simple type according the text format / local[[representation>>doc:sdmx:Glossary.Representation.WebHome]]defined by the[[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].882 -|isMetadataAttribute (fixed: true)|xs:boolean|(% style="width:660px" %)The isMetadataAttribute [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is a fixed boolean (true) and is intended to designate to processing applications that a given element represents a reported[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].This[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is qualified (meaning that it will be qualified in an instance with the target namespace) to ensure that it can be properly identified by applications. The purpose of this is to allow applications to identify elements with unknown names as reported[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]so that they may process a[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific instance without knowledge of the underlying[[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].809 +|id|com:IDType|(% style="width:660px" %)The id attribute identifies the metadata attribute that the value is being reported for. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the metadata attribute will always be available if required for processing. 810 +|value|xs:anySimpleType|(% style="width:660px" %)The value attribute holds any simple value for the metadata attribute. This attribute is un-typed such that the metadata structure definition specific schema can specify any simple type according the text format / local representation defined by the metadata structure definition. 811 +|isMetadataAttribute (fixed: true)|xs:boolean|(% style="width:660px" %)The isMetadataAttribute attribute is a fixed boolean (true) and is intended to designate to processing applications that a given element represents a reported attribute. This attribute is qualified (meaning that it will be qualified in an instance with the target namespace) to ensure that it can be properly identified by applications. The purpose of this is to allow applications to identify elements with unknown names as reported attributes so that they may process a metadata structure definition specific instance without knowledge of the underlying metadata structure definition. 883 883 884 884 Element Documentation: 885 - 886 886 (% style="width:997.294px" %) 887 887 |**Name**|**Type**|(% style="width:668px" %)**Documentation** 888 -|com:Annotations|com:AnnotationsType|(% style="width:668px" %) [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]is a reusable element the provides for a collection of[[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].It has been made global so that restrictions of types that extend AnnotatableType my reference it.889 -|com:Text|com:TextType|(% style="width:668px" %)Text is used to supply parallel multi-lingual textual values for the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].This will be used if the text format of the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]has a type of string and the multi-lingual value is set to true.890 -|com:StructuredText|com:XHTMLType|(% style="width:668px" %)StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].This will be used if the text format of the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]has a type of XHTML and the multi-lingual value is set to true. If the multi-lingual flag is not set to true, it is expected that the maximum occurrence of this will be refined to be 1 in the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema.891 -|AttributeSet|xs:anyType|(% style="width:668px" %)AttributeSet contains the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values for the child metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].This element is unqualified and un-typed so that it can refined by the[[metadata structure definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]] specific schema to validate that the reported metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]conform to those prescribed by the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]definition. The content of this must be element only, and these elements must always represent a reported[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].Since this can not be strictly enforced in XML Schema, additional steps have been added to make generic processing of this element simpler. When processing this element, any element found with the[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]isMetadataAttribute in this target namespace is assumed to be a reported metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]and can be processed as such.816 +|com:Annotations|com:AnnotationsType|(% style="width:668px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType my reference it. 817 +|com:Text|com:TextType|(% style="width:668px" %)Text is used to supply parallel multi-lingual textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of string and the multi-lingual value is set to true. 818 +|com:StructuredText|com:XHTMLType|(% style="width:668px" %)StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of XHTML and the multi-lingual value is set to true. If the multi-lingual flag is not set to true, it is expected that the maximum occurrence of this will be refined to be 1 in the metadata structure definition specific schema. 819 +|AttributeSet|xs:anyType|(% style="width:668px" %)AttributeSet contains the reported metadata attribute values for the child metadata attributes. This element is unqualified and un-typed so that it can refined by the metadata structure definition specific schema to validate that the reported metadata attributes conform to those prescribed by the metadata attribute definition. The content of this must be element only, and these elements must always represent a reported attribute. Since this can not be strictly enforced in XML Schema, additional steps have been added to make generic processing of this element simpler. When processing this element, any element found with the attribute isMetadataAttribute in this target namespace is assumed to be a reported metadata attribute and can be processed as such. 892 892 893 893 = 3. Mapping to Structure-Specific Schemas = 894 894 ... ... @@ -917,45 +917,45 @@ 917 917 918 918 **Schema:** Refers to the format specific schema in general, and in particular the root xs:schema element of that schema file. 919 919 920 -**Global Element:** Refers to an element definition at the top (% style="color:#e74c3c" %)level(%%)of the schema (i.e. an xs:element element in the root xs:schema element). It will define a name and type (name and type[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and possibly a substitution group (substitutionGroup[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).848 +**Global Element:** Refers to an element definition at the top level of the schema (i.e. an xs:element element in the root xs:schema element). It will define a name and type (name and type attributes) and possibly a substitution group (substitutionGroup attribute). 921 921 922 -**Local Element:** Refers to an element definition within a complex type (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). A local element must define a name and type (name and type [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).850 +**Local Element:** Refers to an element definition within a complex type (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). A local element must define a name and type (name and type attributes) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute). 923 923 924 924 **Qualified/Unqualified Element:** A qualified element is an element that must be referred to by the namespace in which it was defined. An unqualified element does not have a namespace associated with it. The structure specific schemas make use of unqualified elements to that the structure specific schemas can restrict the base content to meet the specific needs of the structure, while maintaining as much of the original document structure as possible. 925 925 926 -**Element Reference:** Refers to an element definition within a complex type that is a reference to a global element (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). An element reference must reference a global element (via its ref [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).854 +**Element Reference:** Refers to an element definition within a complex type that is a reference to a global element (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). An element reference must reference a global element (via its ref attribute) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute). 927 927 928 -**Complex Type:** Refers to a complex type definition. In this context, all complex type definitions occur at the top (% style="color:#e74c3c" %)level(%%)of the schema (i.e. an xs:complexType element in the root xs:schema element). A complex type must define a name (name[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and may be made abstract (via the abstract[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]’s boolean value).856 +**Complex Type:** Refers to a complex type definition. In this context, all complex type definitions occur at the top level of the schema (i.e. an xs:complexType element in the root xs:schema element). A complex type must define a name (name attribute) and may be made abstract (via the abstract attribute’s boolean value). 929 929 930 -**Simple Type:** Refers to a simple type definition. In this context, all simple type definitions occur at the top (% style="color:#e74c3c" %)level(%%)of the schema (i.e. an xs:simpleType element in the root xs:schema element). In this context, a simple type will always be defined via a restriction (an xs:restriction element in the xs:simpleType element). The restriction will reference a base type.858 +**Simple Type:** Refers to a simple type definition. In this context, all simple type definitions occur at the top level of the schema (i.e. an xs:simpleType element in the root xs:schema element). In this context, a simple type will always be defined via a restriction (an xs:restriction element in the xs:simpleType element). The restriction will reference a base type. 931 931 932 932 **Anonymous Type:** A complex or simple type definition which occurs within an element definition. The method is sometimes referred to a the "Russian-doll" technique as it creates nested constructs. Anonymous types are not given names and cannot be abstract. The can however, be derived from other types. 933 933 934 934 **Content Group:** A group which defines a content model for reuse. This is contained in the xs:group element, and is defined at the root of the schema. It allows for a common sequence or choice of elements to be reused across multiple types without having to redefine the sequence or choice in each type. 935 935 936 -**Uniqueness (% style="color:#e74c3c" %)Constraint(%%):** A uniqueness(% style="color:#e74c3c" %)constraint(%%)is defined within an element and is used to force descendent elements to be unique based on some criteria of it fields (elements or[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). This is defined in an element, and has content of an and multiple elements. The selector designates the descendants that must be unique (with an xpath[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and the field specifies which property of the selected element must be unique (also with an xpath[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]])864 +**Uniqueness Constraint:** A uniqueness constraint is defined within an element and is used to force descendent elements to be unique based on some criteria of it fields (elements or attributes). This is defined in an <xs:unique> element, and has content of an <xs:selector> and multiple <xs:field> elements. The selector designates the descendants that must be unique (with an xpath attribute) and the field specifies which property of the selected element must be unique (also with an xpath attribute) 937 937 938 -**Extension:** Refers to the definition of a complex type that is an extension of another complex type. The extension will always make a reference to a base. In the schema, this is defined within the xs:complexType element as a child xs:complexContent element containing an xs:extension element (with a base [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).866 +**Extension:** Refers to the definition of a complex type that is an extension of another complex type. The extension will always make a reference to a base. In the schema, this is defined within the xs:complexType element as a child xs:complexContent element containing an xs:extension element (with a base attribute). 939 939 940 -**Restriction:** Refers to the definition of a simple or complex type that is a restriction of another type of the same variety. The restriction will always make a reference to a base. In the schema, this is defined with an xs:restriction element (with a base [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).868 +**Restriction:** Refers to the definition of a simple or complex type that is a restriction of another type of the same variety. The restriction will always make a reference to a base. In the schema, this is defined with an xs:restriction element (with a base attribute). 941 941 942 -**Sequence:** Refers to a sequence of elements that may be defined as the root of a complex type content model, or as part of the content of a choice or another sequence. This is defined as an xs:sequence element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).870 +**Sequence:** Refers to a sequence of elements that may be defined as the root of a complex type content model, or as part of the content of a choice or another sequence. This is defined as an xs:sequence element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute). 943 943 944 -**Choice:** Refers to a choice of elements that may be defined as the root of a complex type content model, or as part of the content of a sequence or another choice. This is defined as an xs:choice element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).872 +**Choice:** Refers to a choice of elements that may be defined as the root of a complex type content model, or as part of the content of a sequence or another choice. This is defined as an xs:choice element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute). 945 945 946 -** [[Facet>>doc:sdmx:Glossary.Facet.WebHome]]:** Refers to a single detail of a simple type restriction. This is represented by elements such as xs:minInclusive, xs:totalDigits, xs:minLength, and is contained in the xs:restriction element of a simple type definition. The value of the[[facet>>doc:sdmx:Glossary.Facet.WebHome]]is contained in a value[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]of the particular element.874 +**Facet:** Refers to a single detail of a simple type restriction. This is represented by elements such as xs:minInclusive, xs:totalDigits, xs:minLength, and is contained in the xs:restriction element of a simple type definition. The value of the facet is contained in a value attribute of the particular element. 947 947 948 -**Enumeration:** Refers to an enumerated value of a simple type definition. It is represented by an xs:enumeration element contained within an xs:restriction element of a simple type definition. An enumeration defines a value (in the value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and documentation (in xs:documentation elements contained in an xs:[[annotation>>doc:sdmx:Glossary.Annotation.WebHome]]element).876 +**Enumeration:** Refers to an enumerated value of a simple type definition. It is represented by an xs:enumeration element contained within an xs:restriction element of a simple type definition. An enumeration defines a value (in the value attribute) and documentation (in xs:documentation elements contained in an xs:annotation element). 949 949 950 -**XML [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]:** Refers to the definition of an XML[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for a complex type (i.e. and xs:[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]element in a xs:complexType element). An[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]must define a name and type (name and type[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a usage (use[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).878 +**XML Attribute:** Refers to the definition of an XML attribute for a complex type (i.e. and xs:attribute element in a xs:complexType element). An attribute must define a name and type (name and type attributes) and may also specify a usage (use attribute). 951 951 952 952 == 3.2 Namespace Rules == 953 953 954 -Each format specific schema will specify its namespace in the target namespace of the schema (the targetNamespace [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]of the schema). This document also assumes that the root namespace (that which is defined by the xmlns[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) of the schema will be the same as the target namespace. Therefore any types or global elements referenced in these descriptions without a namespace prefix are assumed to be in the format specific namespace.882 +Each format specific schema will specify its namespace in the target namespace of the schema (the targetNamespace attribute of the schema). This document also assumes that the root namespace (that which is defined by the xmlns attribute) of the schema will be the same as the target namespace. Therefore any types or global elements referenced in these descriptions without a namespace prefix are assumed to be in the format specific namespace. 955 955 956 956 The format specific schemas will incorporate the core format namespace and the common namespace by importing the schemas (via the xs:import element). If necessary, additional namespaces may be imported and referenced. 957 957 958 -For the purpose of the descriptions here, the default element form for the schema (as specified in the elementFormDefault [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]of the schema) is “qualified", and the default[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]form (as specified in the attributeFormDefault[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]of the schema) is "unqualified".886 +For the purpose of the descriptions here, the default element form for the schema (as specified in the elementFormDefault attribute of the schema) is “qualified", and the default attribute form (as specified in the attributeFormDefault attribute of the schema) is "unqualified". 959 959 960 960 == 3.3 General Rules == 961 961 ... ... @@ -963,34 +963,34 @@ 963 963 964 964 === 3.3.1 Component Name Determination === 965 965 966 -When required to create an XML element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], the name for a[[component>>doc:sdmx:Glossary.Component.WebHome]]is always its identifier. However, the identifier may be inherited. Therefore, the general rules is as follows:894 +When required to create an XML element or attribute, the name for a component is always its identifier. However, the identifier may be inherited. Therefore, the general rules is as follows: 967 967 968 -1. If the [[component>>doc:sdmx:Glossary.Component.WebHome]]defines an identifier, the element or[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]name is the value of that identifier969 -1. Otherwise, the element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]name is the identifier of the(% style="color:#e74c3c" %)concept(%%)from which it takes its semantic (Note that this is technically the[[component>>doc:sdmx:Glossary.Component.WebHome]]identifer).896 +1. If the component defines an identifier, the element or attribute name is the value of that identifier 897 +1. Otherwise, the element or attribute name is the identifier of the concept from which it takes its semantic (Note that this is technically the component identifer). 970 970 971 971 === 3.3.2 Representation Determination === 972 972 973 -Every [[component>>doc:sdmx:Glossary.Component.WebHome]]has a[[representation>>doc:sdmx:Glossary.Representation.WebHome]]associated with it, whether it is defined as a local[[representation>>doc:sdmx:Glossary.Representation.WebHome]]in the[[component>>doc:sdmx:Glossary.Component.WebHome]]definition, or it is inherited from the(% style="color:#e74c3c" %)concept(%%)from which the[[component>>doc:sdmx:Glossary.Component.WebHome]]takes it semantic (as defined in the(% style="color:#e74c3c" %)concept(%%)identity of the[[component>>doc:sdmx:Glossary.Component.WebHome]]).901 +Every component has a representation associated with it, whether it is defined as a local representation in the component definition, or it is inherited from the concept from which the component takes it semantic (as defined in the concept identity of the component). 974 974 975 -The [[representation>>doc:sdmx:Glossary.Representation.WebHome]]of a[[component>>doc:sdmx:Glossary.Component.WebHome]]is determined by the following precedence:903 +The representation of a component is determined by the following precedence: 976 976 977 -1. The local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]defined by the[[component>>doc:sdmx:Glossary.Component.WebHome]]978 -1. The core [[representation>>doc:sdmx:Glossary.Representation.WebHome]]defined in the(% style="color:#e74c3c" %)concept(%%)from which the[[component>>doc:sdmx:Glossary.Component.WebHome]]takes its semantic979 -1. A default [[representation>>doc:sdmx:Glossary.Representation.WebHome]]of an un-faceted text format with a data type of String.905 +1. The local representation defined by the component 906 +1. The core representation defined in the concept from which the component takes its semantic 907 +1. A default representation of an un-faceted text format with a data type of String. 980 980 981 -The [[representation>>doc:sdmx:Glossary.Representation.WebHome]]will either define a text format, or an enumeration with an enumeration format.909 +The representation will either define a text format, or an enumeration with an enumeration format. 982 982 983 -A text format consists of a data type and an optional collection of [[facets>>doc:sdmx:Glossary.Facet.WebHome]].It is the combination of these which determine the exact nature of the[[component>>doc:sdmx:Glossary.Component.WebHome]][[representation>>doc:sdmx:Glossary.Representation.WebHome]].An enumeration consists of a reference to an[[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], for which an enumerated list of possible values can be created.911 +A text format consists of a data type and an optional collection of facets. It is the combination of these which determine the exact nature of the component representation. An enumeration consists of a reference to an item scheme, for which an enumerated list of possible values can be created. 984 984 985 985 === 3.3.3 Simple / Primitive Type Determination === 986 986 987 -For any given [[representation>>doc:sdmx:Glossary.Representation.WebHome]], there exist rules for determining the simple or primitive type which should be used to validate the value. There are no specific requirements to how a simple type is named or if it is referenced or used as an anonymous type. This section simply serves to state the requirements of the type for a[[component>>doc:sdmx:Glossary.Component.WebHome]]based on its determined[[representation>>doc:sdmx:Glossary.Representation.WebHome]].915 +For any given representation, there exist rules for determining the simple or primitive type which should be used to validate the value. There are no specific requirements to how a simple type is named or if it is referenced or used as an anonymous type. This section simply serves to state the requirements of the type for a component based on its determined representation. 988 988 989 -For example, a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]may inherit its[[representation>>doc:sdmx:Glossary.Representation.WebHome]]for a(% style="color:#e74c3c" %)concept(%%), and the data type of a[[representation>>doc:sdmx:Glossary.Representation.WebHome]]data type may be a String. The simplest solution would be to use the xs:string primitive type. However, an implementer may have chosen to generate simple types for all(% style="color:#e74c3c" %)concepts(%%)to avoid having to look up the(% style="color:#e74c3c" %)concept(%%)core[[representation>>doc:sdmx:Glossary.Representation.WebHome]]for very[[component>>doc:sdmx:Glossary.Component.WebHome]].In this case, the type may be given a name based on the(% style="color:#e74c3c" %)concept(%%)and be a simple derivation from the xs:string type that places no further restrictions. The result would be that the type that is actually used for the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], although named after the(% style="color:#e74c3c" %)concept(%%), is effectively the required xs:string. These rules are meant to allow such flexibility in how types are created. The only requirement is that the type meet the requirements stated here.917 +For example, a dimension may inherit its representation for a concept, and the data type of a representation data type may be a String. The simplest solution would be to use the xs:string primitive type. However, an implementer may have chosen to generate simple types for all concepts to avoid having to look up the concept core representation for very component. In this case, the type may be given a name based on the concept and be a simple derivation from the xs:string type that places no further restrictions. The result would be that the type that is actually used for the dimension, although named after the concept, is effectively the required xs:string. These rules are meant to allow such flexibility in how types are created. The only requirement is that the type meet the requirements stated here. 990 990 991 991 === 3.3.4 Representation with Enumeration === 992 992 993 -A [[representation>>doc:sdmx:Glossary.Representation.WebHome]]which defines an enumeration will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each item in the[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]].The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required. Example:921 +A representation which defines an enumeration will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each item in the item scheme. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required. Example: 994 994 995 995 > <xs:simpleType name="ESTAT.CL_COUNTRY.1.0"> 996 996 > <xs:restriction base="common:IDType"> ... ... @@ -1002,7 +1002,7 @@ 1002 1002 1003 1003 === 3.3.5 Representation with Text Format === 1004 1004 1005 -A [[representation>>doc:sdmx:Glossary.Representation.WebHome]]which defines a text format will result in a simple type or primitive type. The first step is to determine the base type from the text format data type:933 +A representation which defines a text format will result in a simple type or primitive type. The first step is to determine the base type from the text format data type: 1006 1006 1007 1007 (% style="width:698.294px" %) 1008 1008 |(% style="width:286px" %)**SDMX Data Type**|(% style="width:409px" %)**XML Schema Data Type** ... ... @@ -1051,7 +1051,7 @@ 1051 1051 |(% style="width:286px" %)DataSetReference|(% style="width:409px" %)N/A^^1^^ 1052 1052 |(% style="width:286px" %)AttachmentConstraintReference|(% style="width:409px" %)N/A^^1^^ 1053 1053 1054 -If the text format does not specify any further [[facets>>doc:sdmx:Glossary.Facet.WebHome]], then the determined type is the listed type or a type which derives from the listed type without placing any addition restrictions on it. However, if one or more[[facets>>doc:sdmx:Glossary.Facet.WebHome]]are specified, then a simple type based on the listed type is necessary. The simple type derives via restriction from the listed type and adds[[facets>>doc:sdmx:Glossary.Facet.WebHome]]according to the following table (the values are(% style="color:#e74c3c" %)mapped(%%)as is):982 +If the text format does not specify any further facets, then the determined type is the listed type or a type which derives from the listed type without placing any addition restrictions on it. However, if one or more facets are specified, then a simple type based on the listed type is necessary. The simple type derives via restriction from the listed type and adds facets according to the following table (the values are mapped as is): 1055 1055 1056 1056 (% style="width:773.294px" %) 1057 1057 |(% style="width:291px" %)**SDMX Facet**|(% style="width:479px" %)**XML Schema Facet** ... ... @@ -1062,23 +1062,23 @@ 1062 1062 |(% style="width:291px" %)decimals^^2^^|(% style="width:479px" %)xs:fractionDigits 1063 1063 |(% style="width:291px" %)pattern|(% style="width:479px" %)xs:pattern 1064 1064 1065 -Any other [[facets>>doc:sdmx:Glossary.Facet.WebHome]]are informational only, and will not affect the determined type.993 +Any other facets are informational only, and will not affect the determined type. 1066 1066 1067 1067 === 3.3.6 Type Names === 1068 1068 1069 1069 These rules will only dictate type names where absolutely necessary. In all other cases, it is the decision of the implementer as to how to name or use the type. It is also the implementer's requirement to ensure that any type name is properly unique within its scope. To assist in this, the following recommendations are offered for naming types such that they are unique. 1070 1070 1071 -* It the type is an enumeration from an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], the recommended name is~[[[Item Scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]Class].[Maintenance Agency].~[[[Item Scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]ID].~[[[Item Scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]] (% style="color:#e74c3c" %)Version(%%)]1072 -* If the type is based on a text format of a (% style="color:#e74c3c" %)concept(%%)core[[representation>>doc:sdmx:Glossary.Representation.WebHome]], the recommended name is(% style="color:#e74c3c" %)Concept(%%).[Maintenance Agency].~[[[Concept Scheme>>doc:sdmx:Glossary.Conceptscheme.WebHome]]ID].~[[[Concept Scheme>>doc:sdmx:Glossary.Conceptscheme.WebHome]] (% style="color:#e74c3c" %)Version(%%)].[(% style="color:#e74c3c" %)Concept(%%)ID]1073 -* If the type is based on a text format of a [[component>>doc:sdmx:Glossary.Component.WebHome]]local[[representation>>doc:sdmx:Glossary.Representation.WebHome]], and;1074 -** The [[component>>doc:sdmx:Glossary.Component.WebHome]]id is required to be unique for all[[components>>doc:sdmx:Glossary.Component.WebHome]]within the scope of the structure which defines it (e.g. a[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]), the recommended name is~[[[Component>>doc:sdmx:Glossary.Component.WebHome]]ID]1075 -** The [[component>>doc:sdmx:Glossary.Component.WebHome]]id is only required to be unique within the[[component>>doc:sdmx:Glossary.Component.WebHome]]list and which defines it (e.g. a metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]), the recommend name is~[[[Component>>doc:sdmx:Glossary.Component.WebHome]]List ID].[Parent[[Component>>doc:sdmx:Glossary.Component.WebHome]]ID]*.~[[[Component>>doc:sdmx:Glossary.Component.WebHome]]ID]999 +* It the type is an enumeration from an item scheme, the recommended name is [Item Scheme Class].[Maintenance Agency].[Item Scheme ID].[Item Scheme Version] 1000 +* If the type is based on a text format of a concept core representation, the recommended name is Concept.[Maintenance Agency].[Concept Scheme ID].[Concept Scheme Version].[Concept ID] 1001 +* If the type is based on a text format of a component local representation, and; 1002 +** The component id is required to be unique for all components within the scope of the structure which defines it (e.g. a dimension), the recommended name is [Component ID] 1003 +** The component id is only required to be unique within the component list and which defines it (e.g. a metadata attribute), the recommend name is [Component List ID].[Parent Component ID]*.[Component ID] 1076 1076 1077 1077 === 3.3.7 Type Reuse === 1078 1078 1079 1079 It is possible that organisations that manage a large number of structure specific schemas my wish to take advantage of the reuse of previously defined type in order to simply the structure specific schema creation and lessen the number of schema elements which are created. The structure specific formats are designed in such a way that this would be allowed without any adverse affects. 1080 1080 1081 -For example, an organisation my create predefined types for all of [[codelists>>doc:sdmx:Glossary.Codelist.WebHome]]and[[concept schemes>>doc:sdmx:Glossary.Conceptscheme.WebHome]]which their structures utilize. These could be contained in a common schema with any namespace deemed appropriate. This would allow the structure specific schemas generation process to recognize the reused[[components>>doc:sdmx:Glossary.Component.WebHome]]and not be concerned with regenerating types. The logical flow for setting the[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of a[[component>>doc:sdmx:Glossary.Component.WebHome]]might be as follows:1009 +For example, an organisation my create predefined types for all of codelists and concept schemes which their structures utilize. These could be contained in a common schema with any namespace deemed appropriate. This would allow the structure specific schemas generation process to recognize the reused components and not be concerned with regenerating types. The logical flow for setting the representation of a component might be as follows: 1082 1082 1083 1083 > Does the component define a local type? 1084 1084 > Yes: Is that type enumerated? ... ... @@ -1090,112 +1090,97 @@ 1090 1090 1091 1091 == 3.4 Data Structure Specific Schema == 1092 1092 1093 -Separate schemas will be created for the data structure depending on which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]occurs at the observation(% style="color:#e74c3c" %)level(%%), and whether explicit[[measures>>doc:sdmx:Glossary.Measure.WebHome]]are used in the case that the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is the[[measure>>doc:sdmx:Glossary.Measure.WebHome]][[dimension>>doc:sdmx:Glossary.Dimension.WebHome]].The recommended target namespace of the data structured specific schema is: [Data Structure URN]:ObsLevelDim:[Observation[[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]](:explicit)?. Note that the explicit trailer is only used when the[[measure>>doc:sdmx:Glossary.Measure.WebHome]][[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]is used at the observation(% style="color:#e74c3c" %)level(%%)and the explicit[[measure>>doc:sdmx:Glossary.Measure.WebHome]](% style="color:#e74c3c" %)concepts(%%)are to be used.1021 +Separate schemas will be created for the data structure depending on which dimension occurs at the observation level, and whether explicit measures are used in the case that the observation dimension is the measure dimension. The recommended target namespace of the data structured specific schema is: [Data Structure URN]:ObsLevelDim:[Observation Dimensions](:explicit)?. Note that the explicit trailer is only used when the measure dimension is used at the observation level and the explicit measure concepts are to be used. 1094 1094 1095 -The rules for generating the data structure specific-schema are broken into sections based on the (% style="color:#e74c3c" %)level(%%)within the structure (i.e.[[data set>>doc:sdmx:Glossary.Data set.WebHome]], group, series, observation). Each section will state the rules for each variation of the structure specific format.1023 +The rules for generating the data structure specific-schema are broken into sections based on the level within the structure (i.e. data set, group, series, observation). Each section will state the rules for each variation of the structure specific format. 1096 1096 1097 1097 === 3.4.1 DataSetType === 1098 1098 1099 -A complex type named DataSetType must be created. Its content model will be derived via restriction. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)is the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](TIME_PERIOD) the base type of the restriction is[[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:TimeSeriesDataSetType. Otherwise, the base type of the restriction is[[dsd>>doc:sdmx:Glossary.Datastructure definition.WebHome]]:DataSetType. The complex type content model will be as follows:1027 +A complex type named DataSetType must be created. Its content model will be derived via restriction. If the dimension at the observation level is the time dimension (TIME_PERIOD) the base type of the restriction is dsd:TimeSeriesDataSetType. Otherwise, the base type of the restriction is dsd:DataSetType. The complex type content model will be as follows: 1100 1100 1101 1101 ~1. A sequence consisting of: 1102 - 1103 -* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 1030 +* a. An element reference to common:Annotations, with a minimum occurrence of 0 1104 1104 * b. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0 1105 1105 * c. If the data structure defines groups, a local element named Group with a form of unqualified, a minimum occurrence of 0, and a maximum occurrence of unbounded. The type of this element should be the type that is described in the GroupType section which follows. 1106 1106 * d. A choice with a minimum occurrence of 0 consisting of: 1107 -** i. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is not AllDimensions, a local element named Series with a form of unqualified, a maximum occurrence of unbounded, and a type of SeriesType (as defined in the SeriesType section which follows) 1108 -** ii. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is AllDimensions, a local element named Obs with a form of unqualified, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows) 1034 +** i. If the dimension at the observation level is not AllDimensions, a local element named Series with a form of unqualified, a maximum occurrence of unbounded, and a type of SeriesType (as defined in the SeriesType section which follows) 1035 +** ii. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows) 1036 +2. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship of None, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited 1037 +3. An attribute for each attribute defined in the data structured definition that declares an attribute relationship of None. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional 1109 1109 1110 -2. If the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or if it is declared but does not declare an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of None, an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited 1111 -3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the [[data structured definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of None. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 1112 - 1113 1113 === 3.4.2 GroupType === 1114 1114 1115 -If the [[data structure definition>>doc:sdmx:Glossary.Datastructuredefinition.WebHome]] defines only one group, a complex type with its name taken from the identifier of the lone group must be defined. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the[[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:GroupType. The complex type content model will be as follows:1041 +If the data structure definition defines only one group, a complex type with its name taken from the identifier of the lone group must be defined. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the dsd:GroupType. The complex type content model will be as follows: 1116 1116 1117 1117 ~1. A sequence consisting of: 1044 +* a. An element reference to common:Annotations, with a minimum occurrence of 0 1045 +2. An attribute for each dimension referenced by the group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required 1046 +3. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship with the group and does not specify the group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited 1047 +4. An attribute for each attribute defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional 1048 +5. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group 1118 1118 1119 - *a.Anelementreferenceto common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]],withaminimumoccurrence of01050 +If the data structure definitions defines more than one group, an abstract complex type with name GroupType must be created. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the dsd:GroupType. The complex type content model will be as follows: 1120 1120 1121 -2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] referenced by the group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 1122 -3. If the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or if it is declared but does not declare an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group and does not specify the group as an attachment group, an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited 1123 -4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group or specifies the group as an attachment group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 1124 -5. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group 1125 - 1126 -If the [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]] defines more than one group, an abstract complex type with name GroupType must be created. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:GroupType. The complex type content model will be as follows: 1127 - 1128 1128 ~1. A sequence consisting of: 1053 +* a. An element reference to common:Annotations, with a minimum occurrence of 0 1054 +2. An attribute named type with a type of Group.ID, and a usage of optional 1055 +3. An anyAttribute declaration with a namespace of ~#~#local 1129 1129 1130 - * a.Anelement referencetocommon:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]],withaminimumoccurrenceof01057 +A simple type named Group.ID must be created. This should restrict the common:IDType. For each group defined by the data structure definition, an enumeration will be created within the restriction with a value of the group identifier. 1131 1131 1132 -2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of Group.ID, and a usage of optional 1133 -3. An anyAttribute declaration with a namespace of local 1059 +For each group defined in the data structure definition, a complex type with its name taken from the group identifier is defined. Its content model will be derived via restriction of the previously defined GroupType. The complex type content model will be as follows: 1134 1134 1135 -A simple type named Group.ID must be created. This should restrict the common:IDType. For each group defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], an enumeration will be created within the restriction with a value of the group identifier. 1136 - 1137 -For each group defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], a complex type with its name taken from the group identifier is defined. Its content model will be derived via restriction of the previously defined GroupType. The complex type content model will be as follows: 1138 - 1139 1139 ~1. A sequence consisting of: 1062 +* a. An element reference to common:Annotations, with a minimum occurrence of 0 1063 +2. An attribute for each dimension referenced by the group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required 1064 +3. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship with the group and does not specify the group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited 1065 +4. An attribute for each attribute defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional 1066 +5. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group 1140 1140 1141 -* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 1142 - 1143 -2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] referenced by the group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 1144 -3. If the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or if it is declared but does not declare an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group and does not specify the group as an attachment group, an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited 1145 -4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group or specifies the group as an attachment group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 1146 -5. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group 1147 - 1148 1148 === 3.4.3 SeriesType === 1149 1149 1150 -If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation is not AllDimensions, a complex type name SeriesType must be created. Its content model will be derived via restriction. If the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)is the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](TIME_PERIOD) the base type of the restriction is[[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:TimeSeriesType. Otherwise, the base type of the restriction is[[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:SeriesType. The complex type content model will be as follows:1070 +If the dimension at the observation is not AllDimensions, a complex type name SeriesType must be created. Its content model will be derived via restriction. If the dimension at the observation level is the time dimension (TIME_PERIOD) the base type of the restriction is dsd:TimeSeriesType. Otherwise, the base type of the restriction is dsd:SeriesType. The complex type content model will be as follows: 1151 1151 1152 1152 ~1. A sequence consisting of: 1153 - 1154 -* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 1155 - 1073 +* a. An element reference to common:Annotations, with a minimum occurrence of 0 1156 1156 2. A local element named Obs with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows) 1157 -3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for each[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]defined by the[[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%). The XML[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]name and type are defined according to the general rules defined in the previous section, and the usage is required1158 -4. If the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is not declared in the[[data structure definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] or if it is declared and declares an[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]] of None, or with a group, or the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%), or specifies a group as an attachment group, an[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited1159 -5. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]for each[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]defined in the data structure that declares an[[attribute relationship>>doc:sdmx:Glossary.Attributerelationship.WebHome]]with any[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]outside of the[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)(so long as it does not also declare an attachment group). The XML[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]name and type are defined according to the general rules defined in the previous section, and the usage is optional.1075 +3. An attribute for each dimension defined by the data structure definition, except for the dimension at the observation level. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required 1076 +4. If the reporting year start day attribute is not declared in the data structure definition or if it is declared and declares an attribute relationship of None, or with a group, or the dimension at the observation level, or specifies a group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited 1077 +5. An attribute for each attribute defined in the data structure that declares an attribute relationship with any dimension outside of the dimension at the observation level (so long as it does not also declare an attachment group). The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional. 1160 1160 1161 1161 === 3.4.4 ObsType === 1162 1162 1163 -A complex type name ObsType must be created. Its content model will be derived via restriction. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]at the observation(% style="color:#e74c3c" %)level(%%)is the time[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](TIME_PERIOD) the base type of the restriction is[[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:TimeSeriesObsType. Otherwise, the base type of the restriction is[[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:ObsType. If the explicit[[measure>>doc:sdmx:Glossary.Measure.WebHome]]option is used, this complex type must be abstract. The complex type content model will be as follows:1081 +A complex type name ObsType must be created. Its content model will be derived via restriction. If the dimension at the observation level is the time dimension (TIME_PERIOD) the base type of the restriction is dsd:TimeSeriesObsType. Otherwise, the base type of the restriction is dsd:ObsType. If the explicit measure option is used, this complex type must be abstract. The complex type content model will be as follows: 1164 1164 1165 1165 ~1. A sequence consisting of: 1084 +* a. An element reference to common:Annotations, with a minimum occurrence of 0 1085 +2. If the dimension at the observation level is not the time dimension (TIME_PERIOD) an attribute named TIME_PERIOD with a type of common:TimePeriodType and a usage of prohibited 1086 +3. If the dimension at the observation level is not the time dimension (TIME_PERIOD) an attribute for the dimension at the observation level. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required 1087 +4. An attribute for the primary measure (OBS_VALUE) defined by the data structure definition. The XML attribute name and type is defined according to the general rules defined in the previous section, and the usage is optional 1088 +5. An attribute for each attribute defined in the data structure that declares an attribute relationship with the dimension at the observation level or the primary measure (OBS_VALUE). The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional 1166 1166 1167 - *a.An elementreference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]],with aminimumoccurrence of01090 +An attribute named type. If the explicit measure option is not used, this attribute must have a type of common:IDType and a usage of prohibited. If the explicit measure option is used, this attribute must have a type of the simple type generated for the representation of the measure dimension that is the dimension at the observation level (this will be an simple type with enumerations with values of the concept identifiers which make up the concept scheme that is the representation of the measure dimension) a and a usage of optional 1168 1168 1169 -2. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is not the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME_PERIOD) an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named TIME_PERIOD with a type of common:TimePeriodType and a usage of prohibited 1170 -3. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is not the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME_PERIOD) an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 1171 -4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (OBS_VALUE) defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type is defined according to the general rules defined in the previous section, and the usage is optional 1172 -5. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) or the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (OBS_VALUE). The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 1092 +If the explicit measure option is used, then complex type must be created for every concept which make up the representation of the measure dimension which is the dimension at the observation level. The name of this complex type will be taken from the identifier of the concept. Its content model will be derived via restriction of the ObsType. The complex type content model will be as follows: 1173 1173 1174 -An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type. If the explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] option is not used, this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a type of common:IDType and a usage of prohibited. If the explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] option is used, this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a type of the simple type generated for the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) (this will be an simple type with enumerations with values of the (% style="color:#e74c3c" %)concept(%%) identifiers which make up the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] that is the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]) a and a usage of optional 1175 - 1176 -If the explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] option is used, then complex type must be created for every (% style="color:#e74c3c" %)concept(%%) which make up the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). The name of this complex type will be taken from the identifier of the (% style="color:#e74c3c" %)concept(%%). Its content model will be derived via restriction of the ObsType. The complex type content model will be as follows: 1177 - 1178 1178 ~1. A sequence consisting of: 1095 +* a. An element reference to common:Annotations, with a minimum occurrence of 0 1096 +2. If the core representation of the Concept differs from that of the primary measure, an attribute for the primary measure (OBS_VALUE) defined by the data structure definition, except for the dimension at the observation level. The XML name is defined according to the general rules defined in the previous section, and the usage is optional. The type of the attribute is the type that is generated for the core representation of the measure concept. Note that this representation type must have an explicit derivation from the type resulting from the primary measure. For example, if the primary measure type is xyz:CodeType, then the simple type which is defined for the core representation of the concept must restrict xyz:CodeType or one another type which restricts it 1179 1179 1180 - * a. An element referencecommon:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]],withaminimumoccurrenceof01098 +3. An attribute named type with a type of the simple type generated for the representation of the measure dimension that is the dimension at the observation level, a usage of optional, and a fixed value of the concept identifier. 1181 1181 1182 -2. If the core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the (% style="color:#e74c3c" %)Concept(%%) differs from that of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]], an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (OBS_VALUE) defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). The XML name is defined according to the general rules defined in the previous section, and the usage is optional. The type of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is the type that is generated for the core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)concept(%%). Note that this [[representation>>doc:sdmx:Glossary.Representation.WebHome]] type must have an explicit derivation from the type resulting from the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. For example, if the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] type is xyz:CodeType, then the simple type which is defined for the core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the (% style="color:#e74c3c" %)concept(%%) must restrict xyz:CodeType or one another type which restricts it 1183 - 1184 -3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of the simple type generated for the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%), a usage of optional, and a fixed value of the (% style="color:#e74c3c" %)concept(%%) identifier. 1185 - 1186 1186 == 3.5 Metadata Structure Specific Schema == 1187 1187 1188 1188 One schema will be created for each metadata structure. This schema will define the contents of all report structures defined by the metadata structure. The recommended target namespace of the data structured specific schema is the URN of the metadata structure. 1189 1189 1190 -The rules for generating the data structure specific-schema are broken into sections based on the (% style="color:#e74c3c" %)level(%%)within the structure (i.e.[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]], metadata targets, reports, metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). These rules will recommend names for generated types, and will refer back to these names throughout the description. These names are simply recommendations that should produce a unique name, but there is no requirement to use them. When a name is required, it will be made clear this is the case.1104 +The rules for generating the data structure specific-schema are broken into sections based on the level within the structure (i.e. metadata set, metadata targets, reports, metadata attributes). These rules will recommend names for generated types, and will refer back to these names throughout the description. These names are simply recommendations that should produce a unique name, but there is no requirement to use them. When a name is required, it will be made clear this is the case. 1191 1191 1192 1192 === 3.5.1 MetadataSetType === 1193 1193 1194 -A complex type that must be named MetadataSetType must be created. Its content model will be derived via restriction of the base type, [[msd>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]]:MetadataSetType. The complex type content model will be as follows:1108 +A complex type that must be named MetadataSetType must be created. Its content model will be derived via restriction of the base type, msd:MetadataSetType. The complex type content model will be as follows: 1195 1195 1196 1196 ~1. A sequence consisting of: 1197 - 1198 -* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 1111 +* a. An element reference to common:Annotations, with a minimum occurrence of 0 1199 1199 * b. An element reference to common:Name, with a minimum occurrence of 0 and a maximum occurrence of unbounded 1200 1200 * c. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0 1201 1201 * d. A local element named Report with a type ReportType, a form of unqualified, a minimum occurrence of 0, and a maximum occurrence of unbounded. ... ... @@ -1202,153 +1202,137 @@ 1202 1202 1203 1203 === 3.5.2 TargetType === 1204 1204 1205 -An abstract complex type with a recommended name of TargetType must be created. Its content model will be derived via restriction of the [[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:TargetType. The complex type content model will be as follows:1118 +An abstract complex type with a recommended name of TargetType must be created. Its content model will be derived via restriction of the msd:TargetType. The complex type content model will be as follows: 1206 1206 1207 1207 ~1. A sequence consisting of: 1121 +* a. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded 1122 +2. An attribute named id with a type of Target.ID, and a usage of optional 1208 1208 1209 - * a.A localelementnamedReferenceValuewithatype of[[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:ReferenceValueType,aformof unqualified,andamaximumoccurrenceofunbounded1124 +A simple type with a recommended name of Target.ID must be created. This should restrict the common:IDType. For each report structure defined by the metadata structure definition, an enumeration will be created within the restriction with a value of the report structure identifier. 1210 1210 1211 -2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with a type of Target.ID, and a usage of optional 1212 - 1213 -A simple type with a recommended name of Target.ID must be created. This should restrict the common:IDType. For each report structure defined by the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], an enumeration will be created within the restriction with a value of the report structure identifier. 1214 - 1215 1215 A simple type with a recommended name of [metadata target identifier].TargetObject.ID must be created. This should restrict the Target.ID type. For each target object defined by the metadata target, an enumeration will be created within the restriction with a value of the target object identifier. 1216 1216 1217 -An abstract complex type with a recommended name of [metadata target identifier].ReferenceValueType will be created. Its content model will be derived via restriction of the [[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:ReferenceValueType. The complex type content model will be as follows:1128 +An abstract complex type with a recommended name of [metadata target identifier].ReferenceValueType will be created. Its content model will be derived via restriction of the msd:ReferenceValueType. The complex type content model will be as follows: 1218 1218 1219 1219 ~1. A choice consisting of: 1220 - 1221 1221 * a. A local element named ObjectReference with a type of common:ReferenceType, and a form of unqualified 1222 1222 * b. A local element named DataKey with a type of common:DataKeyType, and a form of unqualified 1223 1223 * c. A local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified 1224 1224 * d. A local element named ReportPeriod with a type of common:ObservationalTimePeriodType, and a form of unqualified 1135 +2. An attribute named id with the type defined previously as [metadata target identifier].TargetObject.ID, and a usage of optional 1225 1225 1226 - 2.An[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]namedidwiththetypedefinedpreviouslyas[metadata target identifier].TargetObject.ID,anda usageofoptional1137 +For each metadata target defined in the metadata structure definition, a content group with a recommended name of [metadata target identifier] with be defined. Its content model will be as follows: 1227 1227 1228 -For each metadata target defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], a content group with a recommended name of [metadata target identifier] with be defined. Its content model will be as follows: 1229 - 1230 1230 ~1. A sequence consisting of: 1231 - 1232 1232 * a. A local element named ReferenceValue with the type previously defined as [metadata target identifier].ReferenceValueType, a form of unqualified, and a minimum and maximum occurrence of the number of target objects defined within the metadata target 1233 1233 1234 1234 For each target object defined by the metadata target, a complex type that must be named [metadata target identifier].[target object identifier] must be created. Its content model will be derived via restriction of the type previously created as [metadata target identifier].ReferenceValueType type created prior to this. The complex type content model will be as follows: 1235 1235 1236 1236 ~1. A choice consisting of: 1237 - 1238 1238 * a. If the target object is an identifiable object target, a local element named ObjectReference with a type determined as defined in Identifiable Object Target Type Determination: 1239 1239 * b. If the target object is an key descriptor values target, a local element named DataKey with a type of common:DataKeyType, and a form of unqualified 1240 -* c. If the target object is a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] target, a local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified 1241 -* d. If the target object is a (% style="color:#e74c3c" %)constraint(%%) target, a local element named ConstraintReference with a type of common:AttachmentConstraintReferenceType, and a form of unqualified 1242 -* e. If the target object is report period target, a local element named ReportPeriod with a form of unqualified, and a [[type>>path:#_Simple_/_Primitive]] as defined based on the data type of the local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] according to the general rules defined in the previous section 1147 +* c. If the target object is a data set target, a local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified 1148 +* d. If the target object is a constraint target, a local element named ConstraintReference with a type of common:AttachmentConstraintReferenceType, and a form of unqualified 1149 +* e. If the target object is report period target, a local element named ReportPeriod with a form of unqualified, and a [[type>>path:#_Simple_/_Primitive]] as defined based on the data type of the local representation according to the general rules defined in the previous section 1150 +2. An attribute named id with a type previously created as [metadata target identifier].TargetObject.ID, a usage of optional, and fixed value of the target object identifier 1243 1243 1244 -2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with a type previously created as [metadata target identifier].TargetObject.ID, a usage of optional, and fixed value of the target object identifier 1245 - 1246 1246 The final complex type (which will be the determined type) is derived by restriction from the reference type determined above. The suggested name of this type is [metadata target identifier].[target object identifier].Reference. The content model of this type will be as follows: 1247 1247 1248 1248 ~1. A choice consisting of: 1249 - 1250 1250 * a. A sequence consisting of 1251 1251 ** i. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref 1252 -** ii. A local element named URN, with a form of unqualified, a minimum occurrence of 0, and the type defined above as ~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]agency].~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]identifier].~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]] (% style="color:#e74c3c" %)version(%%)].URN1253 -* b. A local element named URN, with a form of unqualified, and the type defined above as ~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]agency].~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]identifier].~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]] (% style="color:#e74c3c" %)version(%%)].URN1157 +** ii. A local element named URN, with a form of unqualified, a minimum occurrence of 0, and the type defined above as [item scheme agency].[item scheme identifier].[item scheme version].URN 1158 +* b. A local element named URN, with a form of unqualified, and the type defined above as [item scheme agency].[item scheme identifier].[item scheme version].URN 1254 1254 1255 1255 ==== 3.5.2.1 Identifiable Object Target Type Determination ==== 1256 1256 1257 -An identifiable object target is meant to reference an [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]identifiable object. In the metadata structure specific schema, the complex type which defines the reference is restricted according to the local[[representation>>doc:sdmx:Glossary.Representation.WebHome]]and object type of the identifiable object target. If the identifiable object target does not provide an enumeration in its local[[representation>>doc:sdmx:Glossary.Representation.WebHome]], then the complex type for the target object is the specific reference type from the common namespace, based on the object type defined by the target object. For example, if the object type is DataProivder, the type will be common:DataProviderReferenceType. The general rule for the name of this type is common:[object type]ReferenceType.1162 +An identifiable object target is meant to reference an SDMX identifiable object. In the metadata structure specific schema, the complex type which defines the reference is restricted according to the local representation and object type of the identifiable object target. If the identifiable object target does not provide an enumeration in its local representation, then the complex type for the target object is the specific reference type from the common namespace, based on the object type defined by the target object. For example, if the object type is DataProivder, the type will be common:DataProviderReferenceType. The general rule for the name of this type is common:[object type]ReferenceType. 1258 1258 1259 -If the target object defines an enumeration in its local [[representation>>doc:sdmx:Glossary.Representation.WebHome]], then the declared object type must be for the items contained the enumeration's referenced[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]].If this is not true, the reference type as defined above is the type for the target object.1164 +If the target object defines an enumeration in its local representation, then the declared object type must be for the items contained the enumeration's referenced item scheme. If this is not true, the reference type as defined above is the type for the target object. 1260 1260 1261 -If the object type does correspond with the enumeration [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], then the type is complex type which restricts the reference to the allowable values. In order to construct this type, the following must be created:1166 +If the object type does correspond with the enumeration item scheme, then the type is complex type which restricts the reference to the allowable values. In order to construct this type, the following must be created: 1262 1262 1263 -A simple type which enumerates with URNs of the items contained in the [[items scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]referenced from the enumeration. The recommended name is~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]agency].~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]identifier].~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]] (% style="color:#e74c3c" %)version(%%)].URN. This simple type should restrict the xs:anyURI type an contain enumerations with values of the URN of every item defined by the scheme.1168 +A simple type which enumerates with URNs of the items contained in the items scheme referenced from the enumeration. The recommended name is [item scheme agency].[item scheme identifier].[item scheme version].URN. This simple type should restrict the xs:anyURI type an contain enumerations with values of the URN of every item defined by the scheme. 1264 1264 1265 -A second simple type which enumerates the IDs of the items contained in the [[items scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]referenced from the enumeration. The recommended name is~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]agency].~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]identifier].~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]] (% style="color:#e74c3c" %)version(%%)].ID. This simple type should restrict the either the common:NestedIDType for hierarchical items or the common:IDType for flat items. The restriction should contain enumerations with values of the ID of every item defined by the scheme. For hierarchical items (such as[[categories>>doc:sdmx:Glossary.Category.WebHome]]), the id should be nested to reflect the full path (e.g. A.C.D.F).1170 +A second simple type which enumerates the IDs of the items contained in the items scheme referenced from the enumeration. The recommended name is [item scheme agency].[item scheme identifier].[item scheme version].ID. This simple type should restrict the either the common:NestedIDType for hierarchical items or the common:IDType for flat items. The restriction should contain enumerations with values of the ID of every item defined by the scheme. For hierarchical items (such as categories), the id should be nested to reflect the full path (e.g. A.C.D.F). 1266 1266 1267 -A complex type which restricts the full set of reference fields for the item to be reference must be created. The recommended name is [metadata target].[target object].Ref. This type is derived via restriction of the type which defines the full set of reference fields for the item referenced by the target object. For example, if the object type is [[Category>>doc:sdmx:Glossary.Category.WebHome]], the type that is the base of the restriction is common:CategoryRefType. . The general rule for the name of this type is common:[object type]RefType. The content model of this type must be as follows:1172 +A complex type which restricts the full set of reference fields for the item to be reference must be created. The recommended name is [metadata target].[target object].Ref. This type is derived via restriction of the type which defines the full set of reference fields for the item referenced by the target object. For example, if the object type is Category, the type that is the base of the restriction is common:CategoryRefType. . The general rule for the name of this type is common:[object type]RefType. The content model of this type must be as follows: 1268 1268 1269 -1. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]named agencyID with a type of common:NestNCNameIDType, a use of required, and a fixed value of the[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]referenced from the enumeration1270 -1. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]named maintinableParentID with a type of common:IDType, a use of required, and a fixed value of the identifier of the[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]referenced from the enumeration1271 -1. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]named maintainableParentVersion with a type of common:VersionType, a use of optional, and a fixed value of the(% style="color:#e74c3c" %)version(%%)of the[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]referenced from the enumeration1272 -1. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]named id, with a use of option, and the type defined above as~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]agency].~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]identifier].~[[[item scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]] (% style="color:#e74c3c" %)version(%%)].ID.1174 +1. An attribute named agencyID with a type of common:NestNCNameIDType, a use of required, and a fixed value of the item scheme referenced from the enumeration 1175 +1. An attribute named maintinableParentID with a type of common:IDType, a use of required, and a fixed value of the identifier of the item scheme referenced from the enumeration 1176 +1. An attribute named maintainableParentVersion with a type of common:VersionType, a use of optional, and a fixed value of the version of the item scheme referenced from the enumeration 1177 +1. An attribute named id, with a use of option, and the type defined above as [item scheme agency].[item scheme identifier].[item scheme version].ID. 1273 1273 1274 1274 === 3.5.3 ReportType === 1275 1275 1276 -A simple type with a recommend name of Report.ID must be created. This must restrict the common:IDType. For each report structure defined by the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], an enumeration will be created within the restriction with a value of the report structure identifier.1181 +A simple type with a recommend name of Report.ID must be created. This must restrict the common:IDType. For each report structure defined by the metadata structure definition, an enumeration will be created within the restriction with a value of the report structure identifier. 1277 1277 1278 -An abstract complex type with a recommended name of ReportType must be created. Its content model will be derived via restriction of the [[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:ReportType. The complex type content model will be as follows:1183 +An abstract complex type with a recommended name of ReportType must be created. Its content model will be derived via restriction of the msd:ReportType. The complex type content model will be as follows: 1279 1279 1280 1280 ~1. A sequence consisting of: 1281 - 1282 -* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 1186 +* a. An element reference to common:Annotations, with a minimum occurrence of 0 1283 1283 * b. A local element named Target with the type previously defined as TargetType and a form of unqualified 1284 1284 * c. A local element named AttributeSet with no type assigned and a form of unqualified 1189 +2. An attribute named id with a type previously defined as Report.ID, and a usage of optional 1285 1285 1286 - 2.An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]namedidwith a type previouslydefinedasReport.ID,andausage ofoptional1191 +For each report structure defined in the metadata structure definition, a complex type with its name taken from the report structure identifier must be defined. In order to construct this type, some other complex type must be defined first. 1287 1287 1288 -For each report structure defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], a complex type with its name taken from the report structure identifier must be defined. In order to construct this type, some other complex type must be defined first. 1289 - 1290 1290 A simple type with a recommended name of [report structure identifier].Target.ID must be created. This must restrict the type previously created as Target.ID. For each metadata target referenced by the report structure, an enumeration will be created within the restriction with a value of the metadata target identifier. 1291 1291 1292 1292 An abstract complex type must be create, with a recommended name of [report structure identifier].TargetType. Its content model will be derived by restriction of the type previously created as TargetType. The content model of this type must be as follows: 1293 1293 1294 1294 ~1. A sequence consisting of: 1198 +* a. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded 1199 +2. An attribute named id with the type previously created as [report structure identifier].Target.ID, and a use of optional 1295 1295 1296 -* a. A local element named ReferenceValue with a type of [[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded 1297 - 1298 -2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with the type previously created as [report structure identifier].Target.ID, and a use of optional 1299 - 1300 1300 For each metadata target referenced from the report structure, a complex type that must be named [report structure identifier].[metadata target identifier] must be created. This type must derived its content by restriction of the type previously defined as [report structure identifier].TargetType. The content model is as follows: 1301 1301 1302 1302 1. A reference to the content group that was previously created as [metadata target identifier] for this metadata target 1303 -1. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]named id with the type create previously as [report structure identifier].Target.ID, a use of optional, and a fixed value of [metadata target identifier]1204 +1. An attribute named id with the type create previously as [report structure identifier].Target.ID, a use of optional, and a fixed value of [metadata target identifier] 1304 1304 1305 -For every metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]defined by the report structure a complex type must be created with the recommended name of [report structure identifier].[nested metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]identifier]. Note that the recommend name assumes the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]identifier is the nested identifier for the full[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]in which the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]was defined. This content model of this type is derived from restriction of the[[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:ReportedAttributeType. The content of this must consists be as follows:1206 +For every metadata attribute defined by the report structure a complex type must be created with the recommended name of [report structure identifier].[nested metadata attribute identifier]. Note that the recommend name assumes the metadata attribute identifier is the nested identifier for the full hierarchy in which the metadata attribute was defined. This content model of this type is derived from restriction of the msd:ReportedAttributeType. The content of this must consists be as follows: 1306 1306 1307 1307 ~1. A sequence consisting of: 1209 +a. An element reference to common:Annotations, with a minimum occurrence of 0 1210 +* a. If the isPresentational flag is not set to true: 1211 +* b. If the determined representation has data type of XHTML, an element reference to common:StructuredText with a maximum occurrence of unbounded 1212 +** i. If the determined representation has is not XHTML, but has a facet of isMultiLinguale, an element reference to common: Text with a maximum occurrence of unbounded 1213 +** ii. If the metadata attribute defines which child metadata attributes, a local element named AttributeSet with a form of unqualified, and a type as defined according to the rules defined in Attribute Set Complex Type Creation 1214 +2. An attribute named id with a type of common:IDType, a use of optional, and a fixed value of [metadata attribute identifier], where this identifier is not nested 1308 1308 1309 -* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 1310 -* b. If the isPresentational flag is not set to true: 1311 -* c. If the determined [[representation>>doc:sdmx:Glossary.Representation.WebHome]] has data type of XHTML, an element reference to common:StructuredText with a maximum occurrence of unbounded 1312 -** i. If the determined [[representation>>doc:sdmx:Glossary.Representation.WebHome]] has is not XHTML, but has a [[facet>>doc:sdmx:Glossary.Facet.WebHome]] of isMultiLinguale, an element reference to common: Text with a maximum occurrence of unbounded 1313 -** ii. If the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defines which child metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], a local element named AttributeSet with a form of unqualified, and a type as defined according to the rules defined in [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Set Complex Type Creation 1216 +If the isPresentational flag is not set to true, and the determined representation is not XHTML and does not have a facet of isMultiLingual, an attribute named value where the [[type>>path:#_Simple_/_Primitive]] is defined according to the general rules defined in the previous section, and the use is required 1314 1314 1315 -2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with a type of common:IDType, a use of optional, and a fixed value of [metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifier], where this identifier is not nested 1316 - 1317 -If the isPresentational flag is not set to true, and the determined [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is not XHTML and does not have a [[facet>>doc:sdmx:Glossary.Facet.WebHome]] of isMultiLingual, an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named value where the [[type>>path:#_Simple_/_Primitive]] is defined according to the general rules defined in the previous section, and the use is required 1318 - 1319 1319 For each report structure defined in the metadata structure, a complex type that must be named [report structure identifier] must be created. Its content model will be derived via restriction of the previously defined ReportType. The complex type content model will be as follows: 1320 1320 1321 1321 ~1. A sequence consisting of: 1322 - 1323 -* a. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 1324 -* b. A local element named Target with the type previously defined as [report structure identifier].TargetType, and a form of unqualified. This element must define a uniqueness (% style="color:#e74c3c" %)constraint(%%) with a recommended name of [report structure identifier].Target.ReferenceValue.Unique. This uniqueness (% style="color:#e74c3c" %)constraint(%%) must contain: 1221 +* a. An element reference to common:Annotations, with a minimum occurrence of 0 1222 +* b. A local element named Target with the type previously defined as [report structure identifier].TargetType, and a form of unqualified. This element must define a uniqueness constraint with a recommended name of [report structure identifier].Target.ReferenceValue.Unique. This uniqueness constraint must contain: 1325 1325 ** i. A selector with an xpath of "*" 1326 1326 ** ii. A field with an xpath of "@id" 1327 -* c. A local element named AttributeSet with a form of unqualified and a type as defined according to the rules defined in [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Set Complex Type Creation 1225 +* c. A local element named AttributeSet with a form of unqualified and a type as defined according to the rules defined in Attribute Set Complex Type Creation 1226 +2. An attribute named id with the type previously defined as Report.ID, a use of optional, and a fixed value of [report structure identifier] 1328 1328 1329 -2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with the type previously defined as Report.ID, a use of optional, and a fixed value of [report structure identifier] 1330 - 1331 1331 ==== 3.5.3.1 Attribute Set Complex Type Creation ==== 1332 1332 1333 -An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]set is created for a report structure or a metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]which contains child metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].This type is a complex type with a recommend name of [report structure identifier].[nested metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]identifier].AttributeSet, where the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]section only applies to[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]sets created for metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]and is assumed to consist of the full[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]of the metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s definition. This complex type must consists of:1230 +An attribute set is created for a report structure or a metadata attribute which contains child metadata attributes. This type is a complex type with a recommend name of [report structure identifier].[nested metadata attribute identifier].AttributeSet, where the metadata attribute section only applies to attribute sets created for metadata attributes and is assumed to consist of the full hierarchy of the metadata attribute's definition. This complex type must consists of: 1334 1334 1335 1335 ~1. A sequence consisting of: 1233 +* a. A local element for each metadata attribute defined as a direct child of the object for which the attribute set is being created. The recommended name of this element is [metadata attribute identifier] and it has a form of unqualified. If the metadata attribute defines a minOccurs and maxOccurs, these values are translated to this element. The type of this element is the type previously created as [report structure identifier].[nested metadata attribute identifier]. 1336 1336 1337 -* a. A local element for each metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined as a direct child of the object for which the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] set is being created. The recommended name of this element is [metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifier] and it has a form of unqualified. If the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defines a minOccurs and maxOccurs, these values are translated to this element. The type of this element is the type previously created as [report structure identifier].[nested metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifier]. 1338 - 1339 1339 = 4. Special data functions = 1340 1340 1341 1341 == 4.1 Updates == 1342 1342 1343 -Both the generic and the structure-specific data messages allow for incremental updating of data. This purpose is noted in the action for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], which is either inherited from the header of the data message or explicitly stated at the[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] (% style="color:#e74c3c" %)level(%%).1239 +Both the generic and the structure-specific data messages allow for incremental updating of data. This purpose is noted in the action for the data set, which is either inherited from the header of the data message or explicitly stated at the data set level. 1344 1344 1345 -A [[dataset>>doc:sdmx:Glossary.Dataset.WebHome]]with an action of Append is assumed to be an[[incremental update>>doc:sdmx:Glossary.Incrementalupdate.WebHome]].This means that one the information provided explicitly in the message should be altered. Any data[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]or[[observation value>>doc:sdmx:Glossary.Observationvalue.WebHome]]that is to be changed must be provided. However, the absence of an[[observation value>>doc:sdmx:Glossary.Observationvalue.WebHome]] or a data[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]at any(% style="color:#e74c3c" %)level(%%)does not imply deletion; instead it is simply implied that the value is to remain unchanged. Therefore, it is valid and acceptable to send a data message with an action of Append which contains only a Series elements with[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]values. In this case, the values for the[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]will be updated. Note that it is not permissible to update data[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]using partial keys (outside of those associated with defined groups). In order to update an[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], a full key must always be provided even if the message format does not require this.1241 +A dataset with an action of Append is assumed to be an incremental update. This means that one the information provided explicitly in the message should be altered. Any data attribute or observation value that is to be changed must be provided. However, the absence of an observation value or a data attribute at any level does not imply deletion; instead it is simply implied that the value is to remain unchanged. Therefore, it is valid and acceptable to send a data message with an action of Append which contains only a Series elements with attribute values. In this case, the values for the attributes will be updated. Note that it is not permissible to update data attributes using partial keys (outside of those associated with defined groups). In order to update an attribute, a full key must always be provided even if the message format does not require this. 1346 1346 1243 + 1347 1347 == 4.2 Deletes == 1348 1348 1349 -Both the generic and the structure-specific data messages allow for incremental deletion of data. This purpose is noted in the action for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], which is either inherited from the header of the data message or explicitly stated at the[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] (% style="color:#e74c3c" %)level(%%).1246 +Both the generic and the structure-specific data messages allow for incremental deletion of data. This purpose is noted in the action for the data set, which is either inherited from the header of the data message or explicitly stated at the data set level. 1350 1350 1351 -A [[dataset>>doc:sdmx:Glossary.Dataset.WebHome]]with an action of Delete is assumed to be an incremental deletion. The deletion is assumed to take place of the lowest(% style="color:#e74c3c" %)level(%%)of detail provided in the message. For example, if a delete message is sent with only a[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] element, the entire[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]will be deleted. On the other hand, if that[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]contains a data[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], only that data[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]value will be deleted. This same dynamic continues through the[[data set>>doc:sdmx:Glossary.Dataset.WebHome]] [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]].A[[data set>>doc:sdmx:Glossary.Dataset.WebHome]]containing only a series with no data[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]or observations will result in that entire series (all observations and data[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) being deleted. If the series contains data[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], only the supplied data[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]for that series will be deleted. Finally, if a series contains observations, then only the specified observations will be deleted. If an entire observation is to be deleted (value and data[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]), only the observation[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]should be provided. If only the[[observation value>>doc:sdmx:Glossary.Observationvalue.WebHome]] or particular data[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]are to be deleted, then these should be specified for the observation. Note that a group can only be used to delete the data[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]associated with it. Although the format might not require it, a full key must be provided to delete a series or observation. It is not permissible to wild card a key in order to delete more than one series or observation. Finally, to delete a data[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]or[[observation value>>doc:sdmx:Glossary.Observationvalue.WebHome]]it is recommended that the value to be deleted be supplied; however, it is only required that any valid value be provided.1248 +A dataset with an action of Delete is assumed to be an incremental deletion. The deletion is assumed to take place of the lowest level of detail provided in the message. For example, if a delete message is sent with only a data set element, the entire data set will be deleted. On the other hand, if that data set contains a data attribute, only that data attribute value will be deleted. This same dynamic continues through the data set hierarchy. A data set containing only a series with no data attributes or observations will result in that entire series (all observations and data attributes) being deleted. If the series contains data attributes, only the supplied data attributes for that series will be deleted. Finally, if a series contains observations, then only the specified observations will be deleted. If an entire observation is to be deleted (value and data attributes), only the observation dimension should be provided. If only the observation value or particular data attributes are to be deleted, then these should be specified for the observation. Note that a group can only be used to delete the data attributes associated with it. Although the format might not require it, a full key must be provided to delete a series or observation. It is not permissible to wild card a key in order to delete more than one series or observation. Finally, to delete a data attribute or observation value it is recommended that the value to be deleted be supplied; however, it is only required that any valid value be provided. 1352 1352 1353 1353 ---- 1354 1354