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

From version 4.6
edited by Helena
on 2025/06/24 14:52
Change comment: There is no comment for this version
To version 10.1
edited by Helena
on 2025/06/24 15:20
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -8,7 +8,7 @@
8 8  
9 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 version is now that all data can be exchanged as either an un-grouped collection of 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.
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 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  
... ... @@ -26,9 +26,10 @@
26 26  
27 27  Referenced Namespaces:
28 28  
29 -|**Namespace**|**Prefix**
30 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
31 -|http:~/~/www.w3.org/2001/XMLSchema|xs
29 +(% style="width:610.294px" %)
30 +|(% style="width:487px" %)**Namespace**|(% style="width:120px" %)**Prefix**
31 +|(% style="width:487px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:120px" %)com
32 +|(% style="width:487px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:120px" %)xs
32 32  
33 33  Contents:
34 34  13 Complex Types
... ... @@ -50,30 +50,33 @@
50 50  
51 51  Attribute Documentation:
52 52  
53 -|**Name**|**Type**|**Documentation**
54 -|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).
55 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
56 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
57 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
58 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
59 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
60 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
61 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
62 -|publicationPeriod|com: ObservationalTimePer iodType|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).
54 +(% style="width:1011.29px" %)
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 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).
57 +|setID|com:IDType|(% style="width:597px" %)The setID provides an identification of the data or metadata set.
58 +|action|com:ActionType|(% style="width:597px" %)The action attribute 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.
60 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:597px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
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.
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.
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 published on a quarterly basis).
63 63  
64 64  Element Documentation:
65 65  
66 -|**Name**|**Type**|**Documentation**
67 -|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.
68 -|DataProvider|com: DataProviderReferenc eType|DataProvider contains a reference to the provider for the data set.
69 -|Attributes|ValuesType|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.
70 -|Group|GroupType|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.
71 -|Series|SeriesType|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.
72 -|Obs|ObsOnlyType|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).
68 +(% style="width:1016.29px" %)
69 +|**Name**|**Type**|(% style="width:642px" %)**Documentation**
70 +|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.
71 +|DataProvider|com: DataProviderReferenceType|(% style="width:642px" %)DataProvider contains a reference to the provider for the data set.
72 +|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.
73 +|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.
74 +|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.
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 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).
73 73  
74 74  **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.
75 75  
76 76  Derivation:
80 +
77 77  * //com:AnnotableType// (extension) 
78 78  ** GroupType
79 79  
... ... @@ -85,15 +85,17 @@
85 85  
86 86  Attribute Documentation:
87 87  
88 -|**Name**|**Type**|**Documentation**
89 -|type|com:IDType|The type attribute holds the identifier assigned to the group in the data structure definition for which attribute values are being provided.
92 +(% style="width:1010.29px" %)
93 +|**Name**|**Type**|(% style="width:709px" %)**Documentation**
94 +|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.
90 90  
91 91  Element Documentation:
92 92  
93 -|**Name**|**Type**|**Documentation**
94 -|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.
95 -|GroupKey|ValuesType|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.
96 -|Attributes|ValuesType|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.
98 +(% style="width:1014.29px" %)
99 +|**Name**|**Type**|(% style="width:704px" %)**Documentation**
100 +|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.
101 +|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.
102 +|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.
97 97  
98 98  **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.
99 99  
... ... @@ -106,12 +106,14 @@
106 106  com:Annotations?, SeriesKey, Attributes?, Obs*
107 107  
108 108  Element Documentation:
109 -|**Name**|**Type**|**Documentation**
110 -|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.
111 -|SeriesKey|ValuesType|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.
112 -|Attributes|ValuesType|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.
113 -|Obs|ObsType|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.
114 114  
116 +(% style="width:999.294px" %)
117 +|**Name**|**Type**|(% style="width:689px" %)**Documentation**
118 +|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.
119 +|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.
120 +|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.
121 +|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 +
115 115  **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.
116 116  
117 117  Derivation:
... ... @@ -123,12 +123,14 @@
123 123  com:Annotations?, ObsKey, ObsValue?, Attributes?
124 124  
125 125  Element Documentation:
126 -|**Name**|**Type**|**Documentation**
127 -|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.
128 -|ObsKey|ValuesType|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.
129 -|ObsValue|ObsValueType|ObsValue type contains the value for the observation.
130 -|Attributes|ValuesType|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).
131 131  
135 +(% style="width:996.294px" %)
136 +|**Name**|**Type**|(% style="width:651px" %)**Documentation**
137 +|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.
138 +|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 +|ObsValue|ObsValueType|(% style="width:651px" %)ObsValue type contains the value for the observation.
140 +|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 +
132 132  **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.
133 133  
134 134  Derivation:
... ... @@ -140,12 +140,14 @@
140 140  com:Annotations?, ObsDimension, ObsValue?, Attributes?
141 141  
142 142  Element Documentation:
143 -|**Name**|**Type**|**Documentation**
144 -|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.
145 -|ObsDimension|BaseValueType|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.
146 -|ObsValue|ObsValueType|ObsValue type contains the value for the observation.
147 -|Attributes|ValuesType|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).
148 148  
154 +(% style="width:1004.29px" %)
155 +|**Name**|**Type**|(% style="width:694px" %)**Documentation**
156 +|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.
157 +|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 +|ObsValue|ObsValueType|(% style="width:694px" %)ObsValue type contains the value for the observation.
159 +|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 +
149 149  **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.
150 150  
151 151  Content:
... ... @@ -152,9 +152,11 @@
152 152  Value+
153 153  
154 154  Element Documentation:
155 -|**Name**|**Type**|**Documentation**
156 -|Value|ComponentValueType|Value contains a component value and a reference to the component for which a value is being provided.
157 157  
168 +(% style="width:1008.29px" %)
169 +|**Name**|(% style="width:185px" %)**Type**|(% style="width:692px" %)**Documentation**
170 +|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 +
158 158  **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.
159 159  
160 160  Attributes:
... ... @@ -164,10 +164,12 @@
164 164  {Empty}
165 165  
166 166  Attribute Documentation:
167 -|**Name**|**Type**|**Documentation**
168 -|id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
169 -|value|xs:anySimpleType|The value attribute contains the provided component value.
170 170  
182 +(% style="width:1003.29px" %)
183 +|**Name**|(% style="width:194px" %)**Type**|(% style="width:664px" %)**Documentation**
184 +|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.
185 +|value|(% style="width:194px" %)xs:anySimpleType|(% style="width:664px" %)The value attribute contains the provided component value.
186 +
171 171  **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.
172 172  
173 173  Derivation:
... ... @@ -182,13 +182,16 @@
182 182  {Empty}
183 183  
184 184  Attribute Documentation:
185 -|**Name**|**Type**|**Documentation**
186 -|id (fixed: OBS_VALUE)|com:NCNameIDType|The id attribute contains a fixed reference to the primary measure component of the data structure definition.
187 -|value|xs:string|The value attribute contains the provided component value.
188 188  
202 +(% style="width:1004.29px" %)
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 contains a fixed reference to the primary measure component of the data structure definition.
205 +|(% style="width:190px" %)value|(% style="width:213px" %)xs:string|(% style="width:598px" %)The value attribute contains the provided component value.
206 +
189 189  **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.
190 190  
191 191  Derivation:
210 +
192 192  * BaseValueType (restriction) 
193 193  ** ComponentValueType
194 194  
... ... @@ -199,13 +199,16 @@
199 199  {Empty}
200 200  
201 201  Attribute Documentation:
202 -|**Name**|**Type**|**Documentation**
203 -|id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
204 -|value|xs:string|The value attribute contains the provided component value.
205 205  
222 +(% style="width:1008.29px" %)
223 +|**Name**|(% style="width:184px" %)**Type**|(% style="width:679px" %)**Documentation**
224 +|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.
225 +|value|(% style="width:184px" %)xs:string|(% style="width:679px" %)The value attribute contains the provided component value.
226 +
206 206  **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.
207 207  
208 208  Derivation:
230 +
209 209  * //com:AnnotableType// (extension) 
210 210  ** DataSetType (restriction) 
211 211  *** TimeSeriesDataSetType
... ... @@ -217,29 +217,33 @@
217 217  com:Annotations?, DataProvider?, Attributes?, Group*, Series*
218 218  
219 219  Attribute Documentation:
220 -|**Name**|**Type**|**Documentation**
221 -|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).
222 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
223 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
224 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
225 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
226 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
227 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
228 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
229 -|publicationPeriod|com: ObservationalTimePer iodType|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).
230 230  
243 +(% style="width:1004.29px" %)
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 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).
246 +|setID|com:IDType|(% style="width:590px" %)The setID provides an identification of the data or metadata set.
247 +|action|com:ActionType|(% style="width:590px" %)The action attribute 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.
249 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:590px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
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.
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.
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 published on a quarterly basis).
254 +
231 231  Element Documentation:
232 232  
233 -|**Name**|**Type**|**Documentation**
234 -|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.
235 -|DataProvider|com: DataProviderReferenc eType|DataProvider contains a reference to the provider for the data set.
236 -|Attributes|ValuesType|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.
237 -|Group|GroupType|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.
238 -|Series|TimeSeriesType|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.
257 +(% style="width:999.294px" %)
258 +|**Name**|**Type**|(% style="width:622px" %)**Documentation**
259 +|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.
260 +|DataProvider|com: DataProviderReferenceType|(% style="width:622px" %)DataProvider contains a reference to the provider for the data set.
261 +|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.
262 +|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.
263 +|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.
239 239  
240 240  **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.
241 241  
242 242  Derivation:
268 +
243 243  * //com:AnnotableType// (extension) 
244 244  ** SeriesType (restriction) 
245 245  *** TimeSeriesType
... ... @@ -248,15 +248,18 @@
248 248  com:Annotations?, SeriesKey, Attributes?, Obs*
249 249  
250 250  Element Documentation:
251 -|**Name**|**Type**|**Documentation**
252 -|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.
253 -|SeriesKey|ValuesType|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.
254 -|Attributes|ValuesType|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.
255 -|Obs|TimeSeriesObsType|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.
256 256  
278 +(% style="width:1012.29px" %)
279 +|**Name**|**Type**|(% style="width:695px" %)**Documentation**
280 +|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.
281 +|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.
282 +|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.
283 +|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 +
257 257  **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.
258 258  
259 259  Derivation:
288 +
260 260  * //com:AnnotableType// (extension) 
261 261  ** ObsType (restriction) 
262 262  *** TimeSeriesObsType
... ... @@ -265,15 +265,18 @@
265 265  com:Annotations?, ObsDimension, ObsValue?, Attributes?
266 266  
267 267  Element Documentation:
268 -|**Name**|**Type**|**Documentation**
269 -|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.
270 -|ObsDimension|TimeValueType|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.
271 -|ObsValue|ObsValueType|ObsValue type contains the value for the observation.
272 -|Attributes|ValuesType|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).
273 273  
298 +(% style="width:1019.29px" %)
299 +|**Name**|**Type**|(% style="width:709px" %)**Documentation**
300 +|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.
301 +|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 +|ObsValue|ObsValueType|(% style="width:709px" %)ObsValue type contains the value for the observation.
303 +|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 +
274 274  **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.
275 275  
276 276  Derivation:
308 +
277 277  * BaseValueType (restriction) 
278 278  ** TimeValueType
279 279  
... ... @@ -284,32 +284,36 @@
284 284  {Empty}
285 285  
286 286  Attribute Documentation:
287 -|**Name**|**Type**|**Documentation**
288 -|id (fixed: TIME_PERIOD)|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
289 -|value|com: ObservationalTimePer iodType|The value attribute contains the provided component value.
290 290  
320 +(% style="width:1013.29px" %)
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 contains the identifier for the component for which a value is being provided.
323 +|(% style="width:205px" %)value|(% style="width:277px" %)com: ObservationalTimePer iodType|(% style="width:528px" %)The value attribute contains the provided component value.
324 +
291 291  == 2.2 Structure Specific Data Namespace ==
292 292  
293 293  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific**
294 294  
295 -=== Summary ===
329 +=== 2.2.1 Summary ===
296 296  
297 297  Referenced Namespaces:
298 -|**Namespace**|**Prefix**
299 -| |
300 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
301 -|http:~/~/www.w3.org/2001/XMLSchema|xs
302 302  
333 +(% style="width:1027.29px" %)
334 +|(% style="width:475px" %)**Namespace**|(% style="width:549px" %)**Prefix**
335 +|(% style="width:475px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:549px" %)com
336 +|(% style="width:475px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:549px" %)xs
337 +
303 303  Contents:
304 304  7 Complex Types
305 305  1 Simple Type
306 306  
307 -=== Complex Types ===
342 +=== 2.2.2 Complex Types ===
308 308  
309 309  **//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.
310 310  
311 311  Derivation:
312 -* //com:AnnotableType// (extension) 
347 +
348 +* //com:AnnotableType// (extension)
313 313  ** //DataSetType//
314 314  
315 315  Attributes:
... ... @@ -319,31 +319,35 @@
319 319  com:Annotations?, DataProvider?, Group*, (Series+ | Obs+)?
320 320  
321 321  Attribute Documentation:
322 -|**Name**|**Type**|**Documentation**
323 -|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).
324 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
325 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
326 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
327 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
328 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
329 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
330 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
331 -|publicationPeriod|com: ObservationalTimePer iodType|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).
332 -|dataScope|DataScopeType|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.
333 -|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 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.
334 334  
359 +(% style="width:1005.29px" %)
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 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).
362 +|(% style="width:199px" %)setID|(% style="width:216px" %)com:IDType|(% style="width:521px" %)The setID provides an identification of the data or metadata set.
363 +|(% style="width:199px" %)action|(% style="width:216px" %)com:ActionType|(% style="width:521px" %)The action attribute 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.
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.
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.
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.
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 published on a quarterly basis).
370 +|(% 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.
371 +|(% 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 +
335 335  Element Documentation:
336 336  
337 -|**Name**|**Type**|**Documentation**
338 -|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.
339 -|DataProvider|com: DataProviderReferenc eType|DataProvider contains a reference to the provider for the data set.
340 -|Group|//GroupType//|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.
341 -|Series|//SeriesType//|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.
342 -|Obs|//ObsType//|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).
375 +(% style="width:1005.29px" %)
376 +|**Name**|**Type**|(% style="width:630px" %)**Documentation**
377 +|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.
378 +|DataProvider|com: DataProviderReferenceType|(% style="width:630px" %)DataProvider contains a reference to the provider for the data set.
379 +|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.
380 +|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.
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 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).
343 343  
344 344  **//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.
345 345  
346 346  Derivation:
386 +
347 347  * //com:AnnotableType// (extension) 
348 348  ** //GroupType//
349 349  
... ... @@ -354,10 +354,12 @@
354 354  com:Annotations?
355 355  
356 356  Attribute Documentation:
357 -|**Name**|**Type**|**Documentation**
358 -|type|com:IDType|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.
359 -|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 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.
360 360  
398 +(% style="width:1008.29px" %)
399 +|**Name**|**Type**|(% style="width:621px" %)**Documentation**
400 +|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.
401 +|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 +
361 361  Element Documentation:
362 362  
363 363  |**Name**|**Type**|**Documentation**
... ... @@ -366,6 +366,7 @@
366 366  **//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.
367 367  
368 368  Derivation:
411 +
369 369  * //com:AnnotableType// (extension) 
370 370  ** //SeriesType//
371 371  
... ... @@ -376,10 +376,12 @@
376 376  com:Annotations?, Obs*
377 377  
378 378  Attribute Documentation:
379 -|**Name**|**Type**|**Documentation**
380 -|TIME_PERIOD|com: ObservationalTimePer iodType|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.
381 -|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.
382 382  
423 +(% style="width:1002.29px" %)
424 +|**Name**|**Type**|(% style="width:533px" %)**Documentation**
425 +|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.
426 +|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 +
383 383  Element Documentation:
384 384  
385 385  |**Name**|**Type**|**Documentation**
... ... @@ -389,6 +389,7 @@
389 389  **//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.
390 390  
391 391  Derivation:
437 +
392 392  * //com:AnnotableType// (extension) 
393 393  ** //ObsType//
394 394  
... ... @@ -399,12 +399,14 @@
399 399  com:Annotations?
400 400  
401 401  Attribute Documentation:
402 -|**Name**|**Type**|**Documentation**
403 -|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.
404 -|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.
405 -|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.
406 -|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.
407 407  
449 +(% style="width:1014.29px" %)
450 +|**Name**|**Type**|(% style="width:505px" %)**Documentation**
451 +|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.
452 +|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.
453 +|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.
454 +|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 +
408 408  Element Documentation:
409 409  
410 410  |**Name**|**Type**|**Documentation**
... ... @@ -413,6 +413,7 @@
413 413  **//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.
414 414  
415 415  Derivation:
464 +
416 416  * //com:AnnotableType// (extension) 
417 417  ** //DataSetType// (restriction) 
418 418  *** //TimeSeriesDataSetType//
... ... @@ -424,30 +424,34 @@
424 424  com:Annotations?, DataProvider?, Group*, Series*
425 425  
426 426  Attribute Documentation:
427 -|**Name**|**Type**|**Documentation**
428 -|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).
429 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
430 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
431 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
432 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
433 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
434 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
435 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
436 -|publicationPeriod|com: ObservationalTimePer iodType|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).
437 -|dataScope|DataScopeType|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.
438 -|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 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.
439 439  
477 +(% style="width:1003.29px" %)
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 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).
480 +|(% style="width:213px" %)setID|(% style="width:274px" %)com:IDType|(% style="width:461px" %)The setID provides an identification of the data or metadata set.
481 +|(% style="width:213px" %)action|(% style="width:274px" %)com:ActionType|(% style="width:461px" %)The action attribute 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.
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.
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.
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.
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 published on a quarterly basis).
488 +|(% 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.
489 +|(% 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 +
440 440  Element Documentation:
441 441  
442 -|**Name**|**Type**|**Documentation**
443 -|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.
444 -|DataProvider|com: DataProviderReferenc eType|DataProvider contains a reference to the provider for the data set.
445 -|Group|//GroupType//|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.
446 -|Series|TimeSeriesType|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.
493 +(% style="width:1007.29px" %)
494 +|**Name**|**Type**|(% style="width:632px" %)**Documentation**
495 +|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.
496 +|DataProvider|com: DataProviderReferenceType|(% style="width:632px" %)DataProvider contains a reference to the provider for the data set.
497 +|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.
498 +|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.
447 447  
448 448  **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.
449 449  
450 450  Derivation:
503 +
451 451  * //com:AnnotableType// (extension) 
452 452  ** //SeriesType// (restriction) 
453 453  *** TimeSeriesType
... ... @@ -459,18 +459,22 @@
459 459  com:Annotations?, Obs*
460 460  
461 461  Attribute Documentation:
462 -|**Name**|**Type**|**Documentation**
463 -|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.
464 464  
516 +(% style="width:1004.29px" %)
517 +|**Name**|**Type**|(% style="width:617px" %)**Documentation**
518 +|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 +
465 465  Element Documentation:
466 466  
467 -|**Name**|**Type**|**Documentation**
468 -|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.
469 -|Obs|//TimeSeriesObsType//|
522 +(% style="width:1003.29px" %)
523 +|**Name**|**Type**|(% style="width:593px" %)**Documentation**
524 +|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 +|Obs|//TimeSeriesObsType//|(% style="width:593px" %)
470 470  
471 471  **//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.
472 472  
473 473  Derivation:
530 +
474 474  * //com:AnnotableType// (extension) 
475 475  ** //ObsType// (restriction) 
476 476  *** //TimeSeriesObsType//
... ... @@ -482,47 +482,57 @@
482 482  com:Annotations?
483 483  
484 484  Attribute Documentation:
485 -|**Name**|**Type**|**Documentation**
486 -|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.
487 -|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 -|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.
489 489  
543 +(% style="width:1005.29px" %)
544 +|**Name**|**Type**|(% style="width:496px" %)**Documentation**
545 +|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.
546 +|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.
547 +|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 +
490 490  Element Documentation:
491 -|**Name**|**Type**|**Documentation**
492 -|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.
493 493  
494 -=== Simple Types ===
551 +(% style="width:1013.29px" %)
552 +|**Name**|**Type**|(% style="width:603px" %)**Documentation**
553 +|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.
495 495  
555 +=== 2.2.3 Simple Types ===
556 +
496 496  **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.
497 497  
498 498  Derived by restriction of xs:string .
499 499  
500 500  Enumerations:
501 -|**Value**|**Documentation**
502 -|DataStructure|The data set conforms simply to the data structure definition as it is defined, without regard to any constraints.
503 -|ConstrainedDataStructure|The data set conforms to the known allowable content constraints applied to the data structure definition.
504 -|Dataflow|The data set conforms to the known allowable content constraints applied to the dataflow.
505 -|ProvisionAgreement|The data set conforms to the known allowable content constraints applied to the provision agreement.
506 506  
507 -== Generic Metadata Namespace ==
563 +(% style="width:1020.29px" %)
564 +|(% style="width:208px" %)**Value**|(% style="width:809px" %)**Documentation**
565 +|(% 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.
566 +|(% style="width:208px" %)ConstrainedDataStructure|(% style="width:809px" %)The data set conforms to the known allowable content constraints applied to the data structure definition.
567 +|(% style="width:208px" %)Dataflow|(% style="width:809px" %)The data set conforms to the known allowable content constraints applied to the dataflow.
568 +|(% style="width:208px" %)ProvisionAgreement|(% style="width:809px" %)The data set conforms to the known allowable content constraints applied to the provision agreement.
508 508  
570 +== 2.3 Generic Metadata Namespace ==
571 +
509 509  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic**
510 510  
511 -=== Summary ===
574 +=== 2.3.1 Summary ===
512 512  
513 513  Referenced Namespaces:
514 -|**Namespace**|**Prefix**
515 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
516 -|http:~/~/www.w3.org/2001/XMLSchema|xs
517 517  
578 +(% style="width:694.294px" %)
579 +|(% style="width:492px" %)**Namespace**|(% style="width:199px" %)**Prefix**
580 +|(% style="width:492px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:199px" %)com
581 +|(% style="width:492px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:199px" %)xs
582 +
518 518  Contents:
584 +
519 519  6 Complex Types
520 520  
521 -=== Complex Types ===
587 +=== 2.3.2 Complex Types ===
522 522  
523 523  **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.
524 524  
525 525  Derivation:
592 +
526 526  * //com:AnnotableType// (extension) 
527 527  ** MetadataSetType
528 528  
... ... @@ -533,166 +533,164 @@
533 533  com:Annotations?, com:Name*, DataProvider?, Report+
534 534  
535 535  Attribute Documentation:
536 -|**Name**|**Type**|**Documentation**
537 -|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).
538 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
539 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
540 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
541 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
542 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
543 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
544 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
545 -|publicationPeriod|com: ObservationalTimePer iodType|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).
546 546  
604 +(% style="width:1006.29px" %)
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 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).
607 +|setID|com:IDType|(% style="width:592px" %)The setID provides an identification of the data or metadata set.
608 +|action|com:ActionType|(% style="width:592px" %)The action attribute 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.
610 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:592px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
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.
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.
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 published on a quarterly basis).
615 +
547 547  Element Documentation:
548 548  
549 -|**Name**|**Type**|**Documentation**
550 -|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.
551 -|com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object.
552 -|DataProvider|com: DataProviderReferenc eType|DataProviderReference provides a references to an organisation with the role of data provider that is providing this metadata set.
553 -|Report|ReportType|Report contains the details of a the reported metadata, including the identification of the target and the report attributes.
618 +(% style="width:1006.29px" %)
619 +|**Name**|(% style="width:268px" %)**Type**|(% style="width:562px" %)**Documentation**
620 +|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 +|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 that is providing this metadata set.
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.
554 554  
555 555  **ReportType: **ReportType contains a set of report attributes and identifies a target objects] to which they apply.
556 556  
557 557  Derivation:
558 558  
559 -//com:AnnotableType// (extension) 
560 - ReportType
629 +* //com:AnnotableType// (extension) 
630 +** ReportType
561 561  
562 562  Attributes:
563 -
564 564  id
565 565  
566 566  Content:
567 -
568 568  com:Annotations?, Target, AttributeSet
569 569  
570 570  Attribute Documentation:
571 571  
572 -|**Name**|**Type**|**Documentation**
573 -|id|com:IDType|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.
640 +(% style="width:1003.29px" %)
641 +|**Name**|**Type**|(% style="width:788px" %)**Documentation**
642 +|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.
574 574  
575 575  Element Documentation:
576 576  
577 -|**Name**|**Type**|**Documentation**
578 -|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.
579 -|Target|TargetType|Target contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply.
580 -|AttributeSet|AttributeSetType|AttributeSet contains the reported metadata attribute values for the reported metadata.
646 +(% style="width:1003.29px" %)
647 +|**Name**|**Type**|(% style="width:593px" %)**Documentation**
648 +|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 +|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 values for the reported metadata.
581 581  
582 582  **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.
583 583  
584 584  Attributes:
585 -
586 586  id
587 587  
588 588  Content:
589 -
590 590  ReferenceValue+
591 591  
592 592  Attribute Documentation:
593 593  
594 -|**Name**|**Type**|**Documentation**
595 -|id|com:IDType|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.
662 +(% style="width:1003.29px" %)
663 +|**Name**|**Type**|(% style="width:805px" %)**Documentation**
664 +|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.
596 596  
597 597  Element Documentation:
598 598  
599 -|**Name**|**Type**|**Documentation**
600 -|ReferenceValue|ReferenceValueType|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.
668 +(% style="width:1009.29px" %)
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, or a report period.
601 601  
602 602  **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.
603 603  
604 604  Attributes:
605 -
606 606  id
607 607  
608 608  Content:
609 -
610 610  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
611 611  
612 612  Attribute Documentation:
613 613  
614 -|**Name**|**Type**|**Documentation**
615 -|id|com:IDType|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.
682 +(% style="width:1013.29px" %)
683 +|**Name**|**Type**|(% style="width:847px" %)**Documentation**
684 +|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.
616 616  
617 617  Element Documentation:
618 618  
619 -|**Name**|**Type**|**Documentation**
620 -|ObjectReference|com: ObjectReferenceType|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.
621 -|DataKey|com:DataKeyType|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.
622 -|DataSetReference|com:SetReferenceType|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.
623 -|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|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.
624 -|ReportPeriod|com: ObservationalTimePer iodType|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.
688 +(% style="width:1017.29px" %)
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. An identifiable object target will utilize this option as the representation of the target reference value.
691 +|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.
692 +|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.
693 +|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.
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 of the target reference value.
625 625  
626 626  **AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata attributes.
627 627  
628 628  Content:
629 -
630 630  ReportedAttribute+
631 631  
632 632  Element Documentation:
633 633  
634 -|**Name**|**Type**|**Documentation**
635 -|ReportedAttribute|ReportedAttributeTyp e|ReportedAttribute provides the details of a reported attribute, including a value and/or child reported attributes.
703 +(% style="width:1023.29px" %)
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, including a value and/or child reported attributes.
636 636  
637 637  **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.
638 638  
639 639  Derivation:
640 640  
641 -//com:AnnotableType// (extension) 
642 - ReportedAttributeType
711 +* //com:AnnotableType// (extension) 
712 +** ReportedAttributeType
643 643  
644 644  Attributes:
645 -
646 646  id, value?
647 647  
648 648  Content:
649 -
650 650  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
651 651  
652 652  Attribute Documentation:
653 653  
654 -|**Name**|**Type**|**Documentation**
655 -|id|com:IDType|The id attribute identifies the metadata attribute that the value is being reported for.
656 -|value|xs:string|The value attribute holds any simple value for the metadata attribute.
722 +(% style="width:996.294px" %)
723 +|**Name**|(% style="width:170px" %)**Type**|(% style="width:657px" %)**Documentation**
724 +|id|(% style="width:170px" %)com:IDType|(% style="width:657px" %)The id attribute identifies the metadata attribute that the value is being reported for.
725 +|value|(% style="width:170px" %)xs:string|(% style="width:657px" %)The value attribute holds any simple value for the metadata attribute.
657 657  
658 658  Element Documentation:
659 659  
660 -|**Name**|**Type**|**Documentation**
661 -|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.
662 -|com:Text|com:TextType|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.
663 -|com:StructuredText|com:XHTMLType|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.
664 -|AttributeSet|AttributeSetType|AttributeSet contains the reported metadata attribute values for the child metadata attributes.
729 +(% style="width:999.294px" %)
730 +|**Name**|**Type**|(% style="width:670px" %)**Documentation**
731 +|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.
732 +|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.
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. 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.
734 +|AttributeSet|AttributeSetType|(% style="width:670px" %)AttributeSet contains the reported metadata attribute values for the child metadata attributes.
665 665  
666 -1.
667 -11. Structure Specific Metadata Namespace
736 +== 2.4 Structure Specific Metadata Namespace ==
668 668  
669 669  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific**
670 670  
671 -1.
672 -11.
673 -111. Summary
740 +=== 2.4.1 Summary ===
674 674  
675 675  Referenced Namespaces:
676 676  
677 -|**Namespace**|**Prefix**
678 -| |
679 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
680 -|http:~/~/www.w3.org/2001/XMLSchema|xs
744 +(% style="width:654.294px" %)
745 +|(% style="width:492px" %)**Namespace**|(% style="width:159px" %)**Prefix**
746 +|(% style="width:492px" %) |(% style="width:159px" %)
747 +|(% style="width:492px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:159px" %)com
748 +|(% style="width:492px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:159px" %)xs
681 681  
682 682  Contents:
683 -
684 684  5 Complex Types
685 685  
686 -1.
687 -11.
688 -111. Complex Types
753 +=== 2.4.2 Complex Types ===
689 689  
690 690  **//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.
691 691  
692 692  Derivation:
693 693  
694 -//com:AnnotableType// (extension) 
695 - //MetadataSetType//
759 +* //com:AnnotableType// (extension) 
760 +** //MetadataSetType//
696 696  
697 697  Attributes:
698 698  
... ... @@ -699,153 +699,154 @@
699 699  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
700 700  
701 701  Content:
702 -
703 703  com:Annotations?, com:Name*, DataProvider?, Report+
704 704  
705 705  Attribute Documentation:
706 706  
707 -|**Name**|**Type**|**Documentation**
708 -|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).
709 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
710 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
711 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
712 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
713 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
714 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
715 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
716 -|publicationPeriod|com: ObservationalTimePer iodType|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).
771 +(% style="width:1003.29px" %)
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 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).
774 +|setID|com:IDType|(% style="width:607px" %)The setID provides an identification of the data or metadata set.
775 +|action|com:ActionType|(% style="width:607px" %)The action attribute 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.
777 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:607px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
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.
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.
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 published on a quarterly basis).
717 717  
718 718  Element Documentation:
719 719  
720 -|**Name**|**Type**|**Documentation**
721 -|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.
722 -|com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object.
723 -|DataProvider|com: DataProviderReferenc eType|>DataProviderReference provides a references to an organisation with the role of data provider that is providing this metadata set.
724 -|Report|//ReportType//|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.
785 +(% style="width:1006.29px" %)
786 +|**Name**|**Type**|(% style="width:631px" %)**Documentation**
787 +|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 +|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 that is providing this metadata set.
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. 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.
725 725  
726 726  **//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.
727 727  
728 728  Derivation:
729 729  
730 -//com:AnnotableType// (extension) 
731 - //ReportType//
796 +* //com:AnnotableType// (extension) 
797 +** //ReportType//
732 732  
733 733  Attributes:
734 -
735 735  id?
736 736  
737 737  Content:
738 -
739 739  com:Annotations?, Target, AttributeSet
740 740  
741 741  Attribute Documentation:
742 742  
743 -|**Name**|**Type**|**Documentation**
744 -|id|com:IDType|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.
807 +(% style="width:1003.29px" %)
808 +|**Name**|**Type**|(% style="width:837px" %)**Documentation**
809 +|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.
745 745  
746 746  Element Documentation:
747 747  
748 -|**Name**|**Type**|**Documentation**
749 -|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.
750 -|Target|//TargetType//|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.
751 -|AttributeSet|xs:anyType|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.
813 +(% style="width:1005.29px" %)
814 +|**Name**|**Type**|(% style="width:695px" %)**Documentation**
815 +|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.
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 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 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.
752 752  
753 753  **//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.
754 754  
755 755  Attributes:
756 -
757 757  id?
758 758  
759 759  Content:
760 -
761 761  ReferenceValue+
762 762  
763 763  Attribute Documentation:
764 764  
765 -|**Name**|**Type**|**Documentation**
766 -|id|com:IDType|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.
829 +(% style="width:999.294px" %)
830 +|**Name**|**Type**|(% style="width:833px" %)**Documentation**
831 +|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.
767 767  
768 768  Element Documentation:
769 769  
770 -|**Name**|**Type**|**Documentation**
771 -|ReferenceValue|//ReferenceValueType//|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.
835 +(% style="width:999.294px" %)
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, 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.
772 772  
773 773  **//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.
774 774  
775 775  Attributes:
776 -
777 777  id?
778 778  
779 779  Content:
780 -
781 781  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
782 782  
783 783  Attribute Documentation:
784 784  
785 -|**Name**|**Type**|**Documentation**
786 -|id|com:IDType|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.
849 +(% style="width:1013.29px" %)
850 +|**Name**|**Type**|(% style="width:847px" %)**Documentation**
851 +|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.
787 787  
788 788  Element Documentation:
789 789  
790 -|**Name**|**Type**|**Documentation**
791 -|ObjectReference|//com:ReferenceType//|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.
792 -|DataKey|com:DataKeyType|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.
793 -|DataSetReference|com:SetReferenceType|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.
794 -|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|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.
795 -|ReportPeriod|com: ObservationalTimePer iodType|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.
855 +(% style="width:1000.29px" %)
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. 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.
858 +|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.
859 +|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.
860 +|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.
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 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.
796 796  
797 797  **//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.
798 798  
799 799  Derivation:
800 800  
801 -//com:AnnotableType// (extension) 
802 - //ReportedAttributeType//
867 +* //com:AnnotableType// (extension) 
868 +** //ReportedAttributeType//
803 803  
804 804  Attributes:
805 -
806 806  id?, value?, isMetadataAttribute?
807 807  
808 808  Content:
809 -
810 810  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
811 811  
812 812  Attribute Documentation:
813 813  
814 -|**Name**|**Type**|**Documentation**
815 -|id|com:IDType|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.
816 -|value|xs:anySimpleType|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.
817 -|isMetadataAttribute (fixed: true)|xs:boolean|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.
878 +(% style="width:999.294px" %)
879 +|**Name**|**Type**|(% style="width:660px" %)**Documentation**
880 +|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.
881 +|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.
882 +|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.
818 818  
819 819  Element Documentation:
820 820  
821 -|**Name**|**Type**|**Documentation**
822 -|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.
823 -|com:Text|com:TextType|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.
824 -|com:StructuredText|com:XHTMLType|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.
825 -|AttributeSet|xs:anyType|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.
886 +(% style="width:997.294px" %)
887 +|**Name**|**Type**|(% style="width:668px" %)**Documentation**
888 +|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.
889 +|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.
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. 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.
891 +|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.
826 826  
827 -1. Mapping to Structure-Specific Schemas
828 -11. General
893 += 3. Mapping to Structure-Specific Schemas =
829 829  
895 +== 3.1 General ==
896 +
830 830  Data structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces;
831 831  
832 -Data  - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific
899 +Data - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific
833 833  
834 834  Metadata - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific
835 835  
836 836  For a metadata structure, only a single schema will be created for the entire structure definition. For data structures, many variations of the base schema are possible, each specific as to how the data is organised. This will be discussed in more details in the specific rules for the data structure schemas.
837 837  
838 -1.
839 -11.
840 -111. Basic Terminology
905 +=== 3.1.1 Basic Terminology ===
841 841  
842 842  In the subsequent sections, the following namespace prefixes are used:
843 843  
844 -|**Namespace**|**Prefix**
845 -|http:~/~/www.w3.org/2001/XMLSchema|xs
846 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|common
847 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/ v2_1/data/structurespecific|dsd
848 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/ v2_1/metadata/structurespecific|msd
909 +(% style="width:763.294px" %)
910 +|(% style="width:623px" %)**Namespace**|(% style="width:137px" %)**Prefix**
911 +|(% style="width:623px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:137px" %)xs
912 +|(% style="width:623px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:137px" %)common
913 +|(% style="width:623px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/ v2_1/data/structurespecific|(% style="width:137px" %)dsd
914 +|(% style="width:623px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/ v2_1/metadata/structurespecific|(% style="width:137px" %)msd
849 849  
850 850  It is assumed that in order to use this guide, the reader is familiar with schema terminology. However, for convenience the following is list of the terminology used here:
851 851  
... ... @@ -883,8 +883,7 @@
883 883  
884 884  **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).
885 885  
886 -1.
887 -11. Namespace Rules
952 +== 3.2 Namespace Rules ==
888 888  
889 889  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.
890 890  
... ... @@ -892,22 +892,19 @@
892 892  
893 893  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".
894 894  
895 -1.
896 -11. General Rules
960 +== 3.3 General Rules ==
897 897  
898 898  The following section details the general rules which apply to all structure specific schema creation.
899 899  
900 -1.
901 -11.
902 -111. Component Name Determination
964 +=== 3.3.1 Component Name Determination ===
903 903  
904 904  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:
905 905  
906 906  1. If the component defines an identifier, the element or attribute name is the value of that identifier
907 907  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).
908 -11.
909 -111. Representation Determination
910 910  
971 +=== 3.3.2 Representation Determination ===
972 +
911 911  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).
912 912  
913 913  The representation of a component is determined by the following precedence:
... ... @@ -920,103 +920,89 @@
920 920  
921 921  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.
922 922  
923 -1.
924 -11.
925 -111. Simple / Primitive Type Determination
985 +=== 3.3.3 Simple / Primitive Type Determination ===
926 926  
927 -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>>path:#_Representation_Determination:]].
987 +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.
928 928  
929 929  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.
930 930  
931 -1.
932 -11.
933 -111. Representation with Enumeration
991 +=== 3.3.4 Representation with Enumeration ===
934 934  
935 935  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:
936 936  
995 +> <xs:simpleType name="ESTAT.CL_COUNTRY.1.0">
996 +> <xs:restriction base="common:IDType">
997 +> <xs:enumeration value="BE">
998 +> <xs:annotation>
999 +> <xs:documentation xml:lang="en">Belgium</xs:documentation>
1000 +> </xs:annotation>
1001 +> </xs:enumeration>
937 937  
938 -<xs:simpleType name="ESTAT.CL_COUNTRY.1.0">
1003 +=== 3.3.5 Representation with Text Format ===
939 939  
940 -<xs:restriction base="common:IDType">
941 -
942 -<xs:enumeration value="BE">
943 -
944 -<xs:annotation>
945 -
946 -<xs:documentation xml:lang="en">Belgium</xs:documentation>
947 -
948 -</xs:annotation>
949 -
950 -</xs:enumeration>
951 -
952 -
953 -1.
954 -11.
955 -111. Representation with Text Format
956 -
957 957  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:
958 958  
959 -|**SDMX Data Type**|**XML Schema Data Type**
960 -|String|xs:string
961 -|AlphaNumeric|common:AlphaNumericType
962 -|Alpha|common:AlphaType
963 -|Numeric|common:NumericType
964 -|BigInteger|xs:integer
965 -|Integer|xs:int
966 -|Long|xs:long
967 -|Short|xs:short
968 -|Decimal|xs:decimal
969 -|Float|xs:float
970 -|Double|xs:double
971 -|Boolean|xs:boolean
972 -|URI|xs:anyURI
973 -|Count|xs:integer
974 -|InclusiveValueRange|xs:decimal
975 -|ExclusiveValueRange|xs: decimal
976 -|Incremental|xs: decimal
977 -|ObservationalTimePeriod|common:ObservationalTimePeriodType
978 -|StandardTimePeriod|common:StandardTimePeriodType
979 -|BasicTimePeriod|common:BasicTimePeriodType
980 -|GregorianTimePeriod|common:GregorianTimePeriodType
981 -|GregorianYear|xs:gYear
982 -|GregorianYearMonth|xs:gYearMonth
983 -|GregorianDay|xs:date
984 -|ReportingTimePeriod|common:ReportingTimePeriodType
985 -|ReportingYear|common:ReportingYearType
986 -|ReportingSemester|common:ReportingSemesterType
987 -|ReportingTrimester|common:ReportingTrimesterType
988 -|ReportingQuarter|common:ReportingQuarterType
989 -|ReportingMonth|common:ReportingMonthType
990 -|ReportingWeek|common:ReportingWeekType
991 -|ReportingDay|common:ReportingDayType
992 -|DateTime|xs:dateTime
993 -|TimeRange|common:TimeRangeType
994 -|Month|xs:gMonth
995 -|MonthDay|xs:gMonthDay
996 -|Day|xs:gDay
997 -|Time|xs:time
998 -|Duration|xs:duration
999 -|XHTML|N/A[[~[1~]>>path:#_ftn1]]
1000 -|KeyValues|N/A^^1^^
1001 -|IdentifiableReference|N/A^^1^^
1002 -|DataSetReference|N/A^^1^^
1003 -|AttachmentConstraintReference|N/A^^1^^
1007 +(% style="width:698.294px" %)
1008 +|(% style="width:286px" %)**SDMX Data Type**|(% style="width:409px" %)**XML Schema Data Type**
1009 +|(% style="width:286px" %)String|(% style="width:409px" %)xs:string
1010 +|(% style="width:286px" %)AlphaNumeric|(% style="width:409px" %)common:AlphaNumericType
1011 +|(% style="width:286px" %)Alpha|(% style="width:409px" %)common:AlphaType
1012 +|(% style="width:286px" %)Numeric|(% style="width:409px" %)common:NumericType
1013 +|(% style="width:286px" %)BigInteger|(% style="width:409px" %)xs:integer
1014 +|(% style="width:286px" %)Integer|(% style="width:409px" %)xs:int
1015 +|(% style="width:286px" %)Long|(% style="width:409px" %)xs:long
1016 +|(% style="width:286px" %)Short|(% style="width:409px" %)xs:short
1017 +|(% style="width:286px" %)Decimal|(% style="width:409px" %)xs:decimal
1018 +|(% style="width:286px" %)Float|(% style="width:409px" %)xs:float
1019 +|(% style="width:286px" %)Double|(% style="width:409px" %)xs:double
1020 +|(% style="width:286px" %)Boolean|(% style="width:409px" %)xs:boolean
1021 +|(% style="width:286px" %)URI|(% style="width:409px" %)xs:anyURI
1022 +|(% style="width:286px" %)Count|(% style="width:409px" %)xs:integer
1023 +|(% style="width:286px" %)InclusiveValueRange|(% style="width:409px" %)xs:decimal
1024 +|(% style="width:286px" %)ExclusiveValueRange|(% style="width:409px" %)xs: decimal
1025 +|(% style="width:286px" %)Incremental|(% style="width:409px" %)xs: decimal
1026 +|(% style="width:286px" %)ObservationalTimePeriod|(% style="width:409px" %)common:ObservationalTimePeriodType
1027 +|(% style="width:286px" %)StandardTimePeriod|(% style="width:409px" %)common:StandardTimePeriodType
1028 +|(% style="width:286px" %)BasicTimePeriod|(% style="width:409px" %)common:BasicTimePeriodType
1029 +|(% style="width:286px" %)GregorianTimePeriod|(% style="width:409px" %)common:GregorianTimePeriodType
1030 +|(% style="width:286px" %)GregorianYear|(% style="width:409px" %)xs:gYear
1031 +|(% style="width:286px" %)GregorianYearMonth|(% style="width:409px" %)xs:gYearMonth
1032 +|(% style="width:286px" %)GregorianDay|(% style="width:409px" %)xs:date
1033 +|(% style="width:286px" %)ReportingTimePeriod|(% style="width:409px" %)common:ReportingTimePeriodType
1034 +|(% style="width:286px" %)ReportingYear|(% style="width:409px" %)common:ReportingYearType
1035 +|(% style="width:286px" %)ReportingSemester|(% style="width:409px" %)common:ReportingSemesterType
1036 +|(% style="width:286px" %)ReportingTrimester|(% style="width:409px" %)common:ReportingTrimesterType
1037 +|(% style="width:286px" %)ReportingQuarter|(% style="width:409px" %)common:ReportingQuarterType
1038 +|(% style="width:286px" %)ReportingMonth|(% style="width:409px" %)common:ReportingMonthType
1039 +|(% style="width:286px" %)ReportingWeek|(% style="width:409px" %)common:ReportingWeekType
1040 +|(% style="width:286px" %)ReportingDay|(% style="width:409px" %)common:ReportingDayType
1041 +|(% style="width:286px" %)DateTime|(% style="width:409px" %)xs:dateTime
1042 +|(% style="width:286px" %)TimeRange|(% style="width:409px" %)common:TimeRangeType
1043 +|(% style="width:286px" %)Month|(% style="width:409px" %)xs:gMonth
1044 +|(% style="width:286px" %)MonthDay|(% style="width:409px" %)xs:gMonthDay
1045 +|(% style="width:286px" %)Day|(% style="width:409px" %)xs:gDay
1046 +|(% style="width:286px" %)Time|(% style="width:409px" %)xs:time
1047 +|(% style="width:286px" %)Duration|(% style="width:409px" %)xs:duration
1048 +|(% style="width:286px" %)XHTML|(% style="width:409px" %)N/A{{footnote}}These types are only used in complex types and will be discussed within their appropriate context.{{/footnote}}
1049 +|(% style="width:286px" %)KeyValues|(% style="width:409px" %)N/A^^1^^
1050 +|(% style="width:286px" %)IdentifiableReference|(% style="width:409px" %)N/A^^1^^
1051 +|(% style="width:286px" %)DataSetReference|(% style="width:409px" %)N/A^^1^^
1052 +|(% style="width:286px" %)AttachmentConstraintReference|(% style="width:409px" %)N/A^^1^^
1004 1004  
1005 1005  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):
1006 1006  
1007 -|**SDMX Facet**|**XML Schema Facet**
1008 -|minLength|xs:minLength
1009 -|maxLength|xs:maxLength
1010 -|minValue[[~[2~]>>path:#_ftn2]]|if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
1011 -|maxValue^^2^^|if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive
1012 -|decimals^^2^^|xs:fractionDigits
1013 -|pattern|xs:pattern
1056 +(% style="width:773.294px" %)
1057 +|(% style="width:291px" %)**SDMX Facet**|(% style="width:479px" %)**XML Schema Facet**
1058 +|(% style="width:291px" %)minLength|(% style="width:479px" %)xs:minLength
1059 +|(% style="width:291px" %)maxLength|(% style="width:479px" %)xs:maxLength
1060 +|(% style="width:291px" %)minValue{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric{{/footnote}}|(% style="width:479px" %)if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
1061 +|(% style="width:291px" %)maxValue^^2^^|(% style="width:479px" %)if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive
1062 +|(% style="width:291px" %)decimals^^2^^|(% style="width:479px" %)xs:fractionDigits
1063 +|(% style="width:291px" %)pattern|(% style="width:479px" %)xs:pattern
1014 1014  
1015 1015  Any other facets are informational only, and will not affect the determined type.
1016 1016  
1017 -1.
1018 -11.
1019 -111. //Type Names//
1067 +=== 3.3.6 Type Names ===
1020 1020  
1021 1021  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.
1022 1022  
... ... @@ -1025,130 +1025,143 @@
1025 1025  * If the type is based on a text format of a component local representation, and;
1026 1026  ** 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]
1027 1027  ** 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]
1028 -**1. Type Reuse
1029 1029  
1077 +=== 3.3.7 Type Reuse ===
1078 +
1030 1030  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.
1031 1031  
1032 1032  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:
1033 1033  
1034 -Does the component define a local type?
1083 +> Does the component define a local type?
1084 +> Yes: Is that type enumerated?
1085 +> Yes: Type is the qualified type name for the item scheme
1086 +> No: Generate simple type for text format
1087 +> No: Type is the qualified name for the concept from which the component takes its semantic.
1035 1035  
1036 -Yes: Is that type enumerated?
1037 -
1038 -Yes: Type is the qualified type name for the item scheme
1039 -
1040 -No: Generate simple type for text format
1041 -
1042 -No: Type is the qualified name for the concept from which the component takes its semantic.
1043 -
1044 1044  Only the constructs that will be detailed in the data and metadata structure-specific rules below are required to be in the specified target namespace of the structure-specific schema. So long as any other generated type conforms to the rules specified, it may exist in any namespace.
1045 1045  
1046 -1.
1047 -11. Data Structure Specific Schema
1091 +== 3.4 Data Structure Specific Schema ==
1048 1048  
1049 1049  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.
1050 1050  
1051 1051  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.
1052 1052  
1053 -1.
1054 -11.
1055 -111. DataSetType
1097 +=== 3.4.1 DataSetType ===
1056 1056  
1057 1057  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:
1058 1058  
1059 -1. A sequence consisting of:
1060 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1061 -11. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
1062 -11. 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.
1063 -11. A choice with a minimum occurrence of 0 consisting of:
1064 -111. 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)
1065 -111. 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)
1066 -1. 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
1067 -1. An attribute for each attribute defined in the data structured definition that declares an attribute relationship of None. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional
1068 -11.
1069 -111. GroupType
1101 +~1. A sequence consisting of:
1070 1070  
1103 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1104 +* b. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
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 +* d. A choice with a minimum occurrence of 0 consisting of:
1107 +** 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)
1108 +** 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)
1109 +
1110 +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
1111 +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
1112 +
1113 +=== 3.4.2 GroupType ===
1114 +
1071 1071  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:
1072 1072  
1073 -1. A sequence consisting of:
1074 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1075 -1. An attribute for each dimension referenced by the group. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is required
1076 -1. 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
1077 -1. 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>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional
1078 -1. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group
1117 +~1. A sequence consisting of:
1079 1079  
1119 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1120 +
1121 +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
1122 +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
1123 +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
1124 +5. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group
1125 +
1080 1080  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:
1081 1081  
1082 -1. A sequence consisting of:
1083 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1084 -1. An attribute named type with a type of Group.ID, and a usage of optional
1085 -1. An anyAttribute declaration with a namespace of ~#~#local
1128 +~1. A sequence consisting of:
1086 1086  
1130 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1131 +
1132 +2. An attribute named type with a type of Group.ID, and a usage of optional
1133 +3. An anyAttribute declaration with a namespace of ~#~#local
1134 +
1087 1087  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.
1088 1088  
1089 1089  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:
1090 1090  
1091 -1. A sequence consisting of:
1092 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1093 -1. An attribute for each dimension referenced by the group. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is required
1094 -1. 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
1095 -1. 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>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional
1096 -1. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group
1097 -11.
1098 -111. SeriesType
1139 +~1. A sequence consisting of:
1099 1099  
1141 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1142 +
1143 +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
1144 +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
1145 +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
1146 +5. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group
1147 +
1148 +=== 3.4.3 SeriesType ===
1149 +
1100 1100  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:
1101 1101  
1102 -1. A sequence consisting of:
1103 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1104 -11. 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)
1105 -1. An attribute for each dimension defined by the data structure definition, except for the dimension at the observation level. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is required
1106 -1. 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
1107 -1. 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>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional
1108 -11.
1109 -111. ObsType
1152 +~1. A sequence consisting of:
1110 1110  
1154 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1155 +
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 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
1158 +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
1159 +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 +
1161 +=== 3.4.4 ObsType ===
1162 +
1111 1111  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:
1112 1112  
1113 -1. A sequence consisting of:
1114 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1115 -1. 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
1116 -1. 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>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is required
1117 -1. An attribute for the primary measure (OBS_VALUE) defined by the data structure definition. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] is defined according to the general rules defined in the previous section, and the usage is optional
1118 -1. 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>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional
1119 -1. 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
1165 +~1. A sequence consisting of:
1120 1120  
1167 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1168 +
1169 +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
1170 +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
1171 +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
1172 +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
1173 +
1174 +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
1175 +
1121 1121  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:
1122 1122  
1123 -1. A sequence consisting of:
1124 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1125 -1. 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>>path:#_Component_Name_Determination]] 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
1126 -1. 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.
1127 -11. Metadata Structure Specific Schema
1178 +~1. A sequence consisting of:
1128 1128  
1180 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1181 +
1182 +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
1183 +
1184 +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.
1185 +
1186 +== 3.5 Metadata Structure Specific Schema ==
1187 +
1129 1129  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.
1130 1130  
1131 1131  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.
1132 1132  
1133 -1.
1134 -11.
1135 -111. MetadataSetType
1192 +=== 3.5.1 MetadataSetType ===
1136 1136  
1137 1137  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:
1138 1138  
1139 -1. A sequence consisting of:
1140 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1141 -11. An element reference to common:Name, with a minimum occurrence of 0 and a maximum occurrence of unbounded
1142 -11. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
1143 -11. A local element named Report with a type ReportType, a form of unqualified, a minimum occurrence of 0, and a maximum occurrence of unbounded.
1144 -111. TargetType
1196 +~1. A sequence consisting of:
1145 1145  
1198 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1199 +* b. An element reference to common:Name, with a minimum occurrence of 0 and a maximum occurrence of unbounded
1200 +* c. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
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 +
1203 +=== 3.5.2 TargetType ===
1204 +
1146 1146  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:
1147 1147  
1148 -1. A sequence consisting of:
1149 -11. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1150 -1. An attribute named id with a type of Target.ID, and a usage of optional
1207 +~1. A sequence consisting of:
1151 1151  
1209 +* a. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1210 +
1211 +2. An attribute named id with a type of Target.ID, and a usage of optional
1212 +
1152 1152  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.
1153 1153  
1154 1154  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.
... ... @@ -1155,38 +1155,44 @@
1155 1155  
1156 1156  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:
1157 1157  
1158 -1. A choice consisting of:
1159 -11. A local element named ObjectReference with a type of common:ReferenceType, and a form of unqualified
1160 -11. A local element named DataKey with a type of common:DataKeyType, and a form of unqualified
1161 -11. A local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified
1162 -11. A local element named ReportPeriod with a type of common:ObservationalTimePeriodType, and a form of unqualified
1163 -1. An attribute named id with the type defined previously as [metadata target identifier].TargetObject.ID, and a usage of optional
1219 +~1. A choice consisting of:
1164 1164  
1221 +* a. A local element named ObjectReference with a type of common:ReferenceType, and a form of unqualified
1222 +* b. A local element named DataKey with a type of common:DataKeyType, and a form of unqualified
1223 +* c. A local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified
1224 +* d. A local element named ReportPeriod with a type of common:ObservationalTimePeriodType, and a form of unqualified
1225 +
1226 +2. An attribute named id with the type defined previously as [metadata target identifier].TargetObject.ID, and a usage of optional
1227 +
1165 1165  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:
1166 1166  
1167 -1. A sequence consisting of:
1168 -11. 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
1230 +~1. A sequence consisting of:
1169 1169  
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 +
1170 1170  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:
1171 1171  
1172 -1. A choice consisting of:
1173 -11. 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:
1174 -11. 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
1175 -11. 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
1176 -11. If the target object is a constraint target, a local element named ConstraintReference with a type of common:AttachmentConstraintReferenceType, and a form of unqualified
1177 -11. 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
1178 -1. 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
1236 +~1. A choice consisting of:
1179 1179  
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 +* 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 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 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 according to the general rules defined in the previous section
1243 +
1244 +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
1245 +
1180 1180  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:
1181 1181  
1182 -1. A choice consisting of:
1183 -11. A sequence consisting of
1184 -111. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref
1185 -111. 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
1186 -11. 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
1187 -111.
1188 -1111. Identifiable Object Target Type Determination
1248 +~1. A choice consisting of:
1189 1189  
1250 +* a. A sequence consisting of
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 agency].[item scheme identifier].[item scheme version].URN
1253 +* 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 +
1255 +==== 3.5.2.1 Identifiable Object Target Type Determination ====
1256 +
1190 1190  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.
1191 1191  
1192 1192  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.
... ... @@ -1203,19 +1203,21 @@
1203 1203  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
1204 1204  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
1205 1205  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.
1206 -11.
1207 -111. ReportType
1208 1208  
1274 +=== 3.5.3 ReportType ===
1275 +
1209 1209  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.
1210 1210  
1211 1211  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:
1212 1212  
1213 -1. A sequence consisting of:
1214 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1215 -11. A local element named Target with the type previously defined as TargetType and a form of unqualified
1216 -11. A local element named AttributeSet with no type assigned and a form of unqualified
1217 -1. An attribute named id with a type previously defined as Report.ID, and a usage of optional
1280 +~1. A sequence consisting of:
1218 1218  
1282 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1283 +* b. A local element named Target with the type previously defined as TargetType and a form of unqualified
1284 +* c. A local element named AttributeSet with no type assigned and a form of unqualified
1285 +
1286 +2. An attribute named id with a type previously defined as Report.ID, and a usage of optional
1287 +
1219 1219  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.
1220 1220  
1221 1221  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.
... ... @@ -1222,10 +1222,12 @@
1222 1222  
1223 1223  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:
1224 1224  
1225 -1. A sequence consisting of:
1226 -11. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1227 -1. An attribute named id with the type previously created as [report structure identifier].Target.ID, and a use of optional
1294 +~1. A sequence consisting of:
1228 1228  
1296 +* a. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1297 +
1298 +2. An attribute named id with the type previously created as [report structure identifier].Target.ID, and a use of optional
1299 +
1229 1229  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:
1230 1230  
1231 1231  1. A reference to the content group that was previously created as [metadata target identifier] for this metadata target
... ... @@ -1233,54 +1233,51 @@
1233 1233  
1234 1234  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:
1235 1235  
1236 -1. A sequence consisting of:
1237 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1238 -11. If the isPresentational flag is not set to true:
1239 -111. If the [[determined representation>>path:#_Representation_Determination:]] has data type of XHTML, an element reference to common:StructuredText with a maximum occurrence of unbounded
1240 -111. If the [[determined representation>>path:#_Representation_Determination:]] has is not XHTML, but has a facet of isMultiLinguale, an element reference to common: Text with a maximum occurrence of unbounded
1241 -11. 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
1242 -1. 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
1243 -1. If the isPresentational flag is not set to true, and the [[determined representation>>path:#_Representation_Determination:]] 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
1307 +~1. A sequence consisting of:
1308 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1309 +* b. If the isPresentational flag is not set to true:
1310 +* c. If the determined representation has data type of XHTML, an element reference to common:StructuredText with a maximum occurrence of unbounded
1311 +** 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
1312 +** 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
1244 1244  
1314 +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
1315 +
1316 +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
1317 +
1245 1245  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:
1246 1246  
1247 -1. A sequence consisting of:
1248 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1249 -11. 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:
1250 -111. A selector with an xpath of "*"
1251 -111. A field with an xpath of "@id"
1320 +~1. A sequence consisting of:
1252 1252  
1253 -1.
1254 -11. 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
1255 -1. An attribute named id with the type previously defined as Report.ID, a use of optional, and a fixed value of [report structure identifier]
1256 -11.
1257 -111.
1258 -1111. Attribute Set Complex Type Creation
1322 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1323 +* 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:
1324 +** i. A selector with an xpath of "*"
1325 +** ii. A field with an xpath of "@id"
1326 +* 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
1259 1259  
1328 +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]
1329 +
1330 +==== 3.5.3.1 Attribute Set Complex Type Creation ====
1331 +
1260 1260  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:
1261 1261  
1262 -1. A sequence consisting of:
1263 -11. 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].
1334 +~1. A sequence consisting of:
1264 1264  
1265 -1. Special data functions
1266 -11. Updates
1336 +* 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].
1267 1267  
1268 -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.
1338 += 4. Special data functions =
1269 1269  
1340 +== 4.1 Updates ==
1270 1270  
1342 +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.
1343 +
1271 1271  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.
1272 1272  
1273 -1.
1274 -11. Deletes
1346 +== 4.2 Deletes ==
1275 1275  
1276 1276  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.
1277 1277  
1278 -
1279 1279  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.
1280 1280  
1281 -
1282 1282  ----
1283 1283  
1284 -[[~[1~]>>path:#_ftnref1]] These types are only used in complex types and will be discussed within their appropriate context.
1285 -
1286 -[[~[2~]>>path:#_ftnref2]] Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric
1354 +{{putFootnotes/}}