Changes for page Part IV. Data and Metadata Namespaces

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

From 4.4 to 4.3 From 4.7 to 4.6

From version 4.6

edited by Helena
on 2025/06/24 14:52

Change comment: There is no comment for this version

To version 4.4

edited by Helena
on 2025/06/24 14:50

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -389,16 +389,20 @@
  **//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.
  Derivation:
--* //com:AnnotableType// (extension)
--** //ObsType//
++//com:AnnotableType// (extension)
++   //ObsType//
++
  Attributes:
++
  type?, TIME_PERIOD?, REPORTING_YEAR_START_DAY?, OBS_VALUE?
  Content:
++
  com:Annotations?
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |type|com:IDType|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.
  |TIME_PERIOD|com: ObservationalTimePer iodType|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.
@@ -413,17 +413,21 @@
  **//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.
  Derivation:
--* //com:AnnotableType// (extension)
--** //DataSetType// (restriction)
--*** //TimeSeriesDataSetType//
++//com:AnnotableType// (extension)
++   //DataSetType// (restriction)
++         //TimeSeriesDataSetType//
++
  Attributes:
++
  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?
  Content:
++
  com:Annotations?, DataProvider?, Group*, Series*
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |structureRef|xs:IDREF|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).
  |setID|com:IDType|The setID provides an identification of the data or metadata set.
@@ -448,17 +448,21 @@
  **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.
  Derivation:
--* //com:AnnotableType// (extension)
--** //SeriesType// (restriction)
--*** TimeSeriesType
++//com:AnnotableType// (extension)
++   //SeriesType// (restriction)
++         TimeSeriesType
++
  Attributes:
++
  REPORTING_YEAR_START_DAY?
  Content:
++
  com:Annotations?, Obs*
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |REPORTING_YEAR_START_DAY|xs:gMonthDay|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.
@@ -471,17 +471,21 @@
  **//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.
  Derivation:
--* //com:AnnotableType// (extension)
--** //ObsType// (restriction)
--*** //TimeSeriesObsType//
++//com:AnnotableType// (extension)
++   //ObsType// (restriction)
++         //TimeSeriesObsType//
++
  Attributes:
++
  TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE?
  Content:
++
  com:Annotations?
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |TIME_PERIOD|com: ObservationalTimePer iodType|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.
  |REPORTING_YEAR_START_DAY|xs:gMonthDay|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.
@@ -488,10 +488,13 @@
  |OBS_VALUE|xs:anySimpleType|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.
  Element Documentation:
++
  |**Name**|**Type**|**Documentation**
  |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.
--=== Simple Types ===
++1.
++11.
++111. Simple Types
  **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.
@@ -498,6 +498,7 @@
  Derived by restriction of xs:string .
  Enumerations:
++
  |**Value**|**Documentation**
  |DataStructure|The data set conforms simply to the data structure definition as it is defined, without regard to any constraints.
  |ConstrainedDataStructure|The data set conforms to the known allowable content constraints applied to the data structure definition.
@@ -504,35 +504,46 @@
  |Dataflow|The data set conforms to the known allowable content constraints applied to the dataflow.
  |ProvisionAgreement|The data set conforms to the known allowable content constraints applied to the provision agreement.
--== Generic Metadata Namespace ==
++1.
++11. Generic Metadata Namespace
  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic**
--=== Summary ===
++1.
++11.
++111. Summary
  Referenced Namespaces:
++
  |**Namespace**|**Prefix**
  |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
  |http:~/~/www.w3.org/2001/XMLSchema|xs
  Contents:
++
 Complex Types
--=== Complex Types ===
++1.
++11.
++111. Complex Types
  **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.
  Derivation:
--* //com:AnnotableType// (extension)
--** MetadataSetType
++//com:AnnotableType// (extension)
++   MetadataSetType
++
  Attributes:
++
  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
  Content:
++
  com:Annotations?, com:Name*, DataProvider?, Report+
  Attribute Documentation:
++
  |**Name**|**Type**|**Documentation**
  |structureRef|xs:IDREF|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).
  |setID|com:IDType|The setID provides an identification of the data or metadata set.