Skip to Content

Changes for page 12 Constraints

Last modified by Artur on 2025/09/10 11:19
From version 6.2
edited by Helena
on 2025/05/15 11:04
Change comment: There is no comment for this version
To version 7.3
edited by Helena
on 2025/05/16 14:00
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -29,23 +29,14 @@
29 29  Any artefact that inherits from the //ConstrainableArtefact// interface can have constraints defined. The artefacts that can have constraint metadata attached are:
30 30  
31 31  Dataflow
32 -
33 33  ProvisionAgreement
34 -
35 35  DataProvider – this is restricted to release calendar
36 -
37 37  DataStructureDefinition
38 -
39 39  Metadataflow
40 -
41 41  MetaDataProvider – this is restricted to release calendar
42 -
43 43  MetadataProvisionAgreement
44 -
45 45  MetadataSetMetadataStructureDefinition
46 -
47 47  SimpleDataSource – this is a registered data source where the registration references the actual Data Set or Metadata Set
48 -
49 49  //QueryDataSource//
50 50  
51 51  Note that, because the //Constraint// can specify a subset of the component values implied by a specific //Structure// (such as a specific DataStructureDefinition or specific MetadataStructureDefinition), the //ConstrainableArtefact//s must be associated with a specific //Structure//. Therefore, whilst the //Constraint// itself may not be linked directly to a DataStructureDefinition or MetadataStructureDefinition, the artefact that it is constraining will be linked to a DataStructureDefinition or MetadataStructureDefinition. As a DataProvider or a MetadataProvider does not link to any one specific DSD or MSD the type of information that can be contained in a Constraint linked to a DataProvider/MetadataProvider is restricted to ReleaseCalendar.
... ... @@ -64,10 +64,8 @@
64 64  
65 65  The constraint mechanism allows specific constraints to be attached to a //ConstrainableArtefact//. With the exception of ReleaseCalendar these constraints specify a subset of the total set of values or keys that may be present in any of the //ConstrainableArtefacts//.
66 66  
67 -For instance, a DataStructureDefinition specifies, for each Dimension, the list of allowable code values. However, a specific Dataflow that uses the
58 +For instance, a DataStructureDefinition specifies, for each Dimension, the list of allowable code values. However, a specific Dataflow that uses the DataStructureDefinition may contain only a subset of the possible range of keys that is theoretically possible from the DataStructureDefinition definition (the total range of possibilities is sometimes called the Cartesian product of the dimension values). In addition to this, a DataProvider that is capable of supplying data according to the Dataflow has a ProvisionAgreement, and the DataProvider may also wish to supply constraint information which may further constrain the range of possibilities in order to describe the data that the provider can supply. It may also be useful to describe the content of a data source in terms of the KeySets or CubeRegions contained within it.
68 68  
69 -DataStructureDefinition may contain only a subset of the possible range of keys that is theoretically possible from the DataStructureDefinition definition (the total range of possibilities is sometimes called the Cartesian product of the dimension values). In addition to this, a DataProvider that is capable of supplying data according to the Dataflow has a ProvisionAgreement, and the DataProvider may also wish to supply constraint information which may further constrain the range of possibilities in order to describe the data that the provider can supply. It may also be useful to describe the content of a data source in terms of the KeySets or CubeRegions contained within it.
70 -
71 71  A //ConstrainableArtefact// can have two types of //Constraint//s:
72 72  
73 73  1. DataConstraint – is used as a mechanism to specify, either the available set of keys (DataKeySet), or set of component values (CubeRegion) in a //DataSource// such as a Simpledatasource or a database (//QueryDatasource//), or the allowable keys that can be constructed from a DataStructureDefinition. Multiple such DataConstraints may be present for a //ConstrainableArtefact//. For instance, there may be a DataConstraint that specifies the values allowed for the //ConstrainableArtefact //(role is allowableContent) which can be used for validation or for constructing a partial code list for one Dimension, while another provides the validation for another Dimension within the same DSD.
... ... @@ -102,7 +102,7 @@
102 102  
103 103  * "true": all children are included,
104 104  * "false" (default), or
105 -* "[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_7f83d17f.gif||alt="Shape31" height="55" width="97"]] excludeRoot", where all children are included, and the root Code is excluded (i.e. the referenced Code).
94 +* " excludeRoot", where all children are included, and the root Code is excluded (i.e. the referenced Code).
106 106  
107 107  It is possible to define for the DataKeySet, DataKey, CubeRegion, MetadataTargetRegion and MemberSelection whether the set is included (isIncluded = "true", default) or excluded (isIncluded = "false") from the Constraint definition. This attribute is useful if, for example, only a small sub-set of the possible values are not included in the set, then this smaller sub-set can be defined and excluded from the constraint. Note that if the child construct is “included” and the parent construct is “excluded” then the child construct is included in the list of constructs that are “excluded”.
108 108  
... ... @@ -112,7 +112,8 @@
112 112  
113 113  ==== 12.3.3.2 Definitions ====
114 114  
115 -|**Class**|**Feature**|**Description**
104 +(% style="width:908.294px" %)
105 +|**Class**|**Feature**|(% style="width:442px" %)**Description**
116 116  |//ConstrainableArt efact//|(((
117 117  Abstract Class Sub classes are:
118 118  
... ... @@ -124,13 +124,11 @@
124 124  
125 125  Metadataflow
126 126  
127 -MetadataProvisionAgreem
117 +MetadataProvisionAgreement
128 128  
129 -ent
130 -
131 131  MetadataSet
132 132  
133 -MetadataStructureDefini tion
121 +MetadataStructureDefinition
134 134  
135 135  ProvisionAgreement
136 136  
... ... @@ -137,8 +137,8 @@
137 137  //QueryDatasource//
138 138  
139 139  SimpleDatasource
140 -)))|An artefact that can have Constraints specified.
141 -| |content|Associates the metadata that constrains the content to be found in a data or metadata source linked to the Constrainable Artefact.
128 +)))|(% style="width:442px" %)An artefact that can have Constraints specified.
129 +| |content|(% style="width:442px" %)Associates the metadata that constrains the content to be found in a data or metadata source linked to the Constrainable Artefact.
142 142  |//Constraint//|(((
143 143  Inherits from
144 144  
... ... @@ -149,69 +149,64 @@
149 149  DataConstraint
150 150  
151 151  MetadataConstraint
152 -)))|Specifies a subset of the definition of the allowable or actual content of a data or metadata source that can be derived from the Structure that defines code lists and other valid content.
153 -| |+dataContentKeys|(((
140 +)))|(% style="width:442px" %)Specifies a subset of the definition of the allowable or actual content of a data or metadata source that can be derived from the Structure that defines code lists and other valid content.
141 +| |+dataContentKeys|(% style="width:442px" %)(((
154 154  Association to a subset of Data
155 155  
156 156  Key Sets (i.e., value combinations) that can be derived from the definition of the structure to which the Constrainable Artefact is linked.
157 157  )))
158 -| |+dataContentRegion|(((
146 +| |+dataContentRegion|(% style="width:442px" %)(((
159 159  Association to a subset of component values that can be derived from the Data Structure
160 160  
161 161  Definition to which the Constrainable Artefact is linked.
162 162  )))
163 -| |+metadataContentRegion|Association to a subset of component values that can be derived from the Metadata Structure Definition to which the Constrainable Artefact is linked.
164 -| |role|Association to the role that the Constraint plays
151 +| |+metadataContentRegion|(% style="width:442px" %)Association to a subset of component values that can be derived from the Metadata Structure Definition to which the Constrainable Artefact is linked.
152 +| |role|(% style="width:442px" %)Association to the role that the Constraint plays
165 165  |DataConstraint|(((
166 166  Inherits from
167 -
168 168  //Constraint//
169 -)))|Defines a Constraint in terms of the content that can be found in data sources linked to the Constrainable Artefact to which this constraint is associated.
170 -|ConstraintRoleTy pe| |Specifies the way the type of content of a Constraint in terms of its purpose.
171 -| |allowableContent|The Constraint contains a specification of the valid subset of the Component values or keys.
172 -| |actualContent|The Constraint contains a specification of the actual content of a data or metadata source in terms of the Component values or keys in the source.
156 +)))|(% style="width:442px" %)Defines a Constraint in terms of the content that can be found in data sources linked to the Constrainable Artefact to which this constraint is associated.
157 +|ConstraintRoleTy pe| |(% style="width:442px" %)Specifies the way the type of content of a Constraint in terms of its purpose.
158 +| |allowableContent|(% style="width:442px" %)The Constraint contains a specification of the valid subset of the Component values or keys.
159 +| |actualContent|(% style="width:442px" %)The Constraint contains a specification of the actual content of a data or metadata source in terms of the Component values or keys in the source.
173 173  |MetadataConstrai nt|(((
174 174  Inherits from
175 -
176 176  //Constraint//
177 -)))|Defines a Constraint in terms of the content that can be found in metadata sources linked to the Constrainable Artefact to which this constraint is associated.
178 -|DataKeySet| |A set of data keys.
179 -| |isIncluded|Indicates whether the Data Key Set is included in the constraint definition or excluded from the constraint definition.
180 -| |+keys|Association to the Data Keys in the set.
181 -| |+member|Association to the selection of a value subset for Attributes and Measures.
182 -|DataKey| |The values of a key in a data set.
183 -| |isIncluded|Indicates whether the Data Key is included in the constraint definition or excluded from the constraint definition.
184 -| |+keyValue|(((
163 +)))|(% style="width:442px" %)Defines a Constraint in terms of the content that can be found in metadata sources linked to the Constrainable Artefact to which this constraint is associated.
164 +|DataKeySet| |(% style="width:442px" %)A set of data keys.
165 +| |isIncluded|(% style="width:442px" %)Indicates whether the Data Key Set is included in the constraint definition or excluded from the constraint definition.
166 +| |+keys|(% style="width:442px" %)Association to the Data Keys in the set.
167 +| |+member|(% style="width:442px" %)Association to the selection of a value subset for Attributes and Measures.
168 +|DataKey| |(% style="width:442px" %)The values of a key in a data set.
169 +| |isIncluded|(% style="width:442px" %)Indicates whether the Data Key is included in the constraint definition or excluded from the constraint definition.
170 +| |+keyValue|(% style="width:442px" %)(((
185 185  Associates the Component
186 186  
187 187  Values that comprise the key.
188 188  )))
189 -| |validFrom|Date from which the Data Key is valid.
190 -| |validTo|Date from which the Data Key is superseded.
191 -|ComponentValue| |The identification and value of a Component of the key (e.g., Dimension)
192 -| |value|The value of Component
193 -| |+valueFor|Association to the Component (e.g., Dimension) in the Structure to which the Constrainable Artefact is linked.
194 -|TimeDimensionVal ue| |The value of the Time Dimension component.
195 -| |timeValue|The value of the time period.
196 -| |operator|(((
175 +| |validFrom|(% style="width:442px" %)Date from which the Data Key is valid.
176 +| |validTo|(% style="width:442px" %)Date from which the Data Key is superseded.
177 +|ComponentValue| |(% style="width:442px" %)The identification and value of a Component of the key (e.g., Dimension)
178 +| |value|(% style="width:442px" %)The value of Component
179 +| |+valueFor|(% style="width:442px" %)Association to the Component (e.g., Dimension) in the Structure to which the Constrainable Artefact is linked.
180 +|TimeDimensionVal ue| |(% style="width:442px" %)The value of the Time Dimension component.
181 +| |timeValue|(% style="width:442px" %)The value of the time period.
182 +| |operator|(% style="width:442px" %)(((
197 197  Indicates whether the specified value represents and exact time or time period, or whether the value should be handled as a range.
198 -
199 199  A value of greaterThan or greaterThanOrEqual indicates that the value is the beginning of a range (exclusive or inclusive, respectively).
200 -
201 201  A value of lessThan or lessThanOrEqual indicates that the value is the end or a range (exclusive or inclusive, respectively).
202 -
203 203  In the absence of the opposite bound being specified for the range, this bound is to be treated as infinite (e.g., any time period after the beginning of the provided time period for greaterThanOrEqual)
204 204  )))
205 -|CubeRegion| |A set of Components and their values that defines a subset or “slice” of the total range of possible content of a data structure to which the Constrainable Artefact is linked.
206 -| |isIncluded|Indicates whether the Cube Region is included in the constraint definition or excluded from the constraint definition.
207 -| |+member|Associates the set of Components that define the subset of values.
208 -|MetadataTargetRe gion| |A set of Components and their values that defines a subset or “slice” of the total range of possible content of a metadata structure to which the Constrainable Artefact is linked.
209 -| |isIncluded|Indicates whether the Metadata Target Region is included in the constraint definition or excluded from the constraint definition.
210 -| |+member|Associates the set of Components that define the subset of values.
211 -|MemberSelection| |A set of permissible values for one component of the axis.
212 -| |isIncluded|Indicates whether the Member Selection is included in the constraint definition or excluded from the constraint definition.
213 -| |removePrefix|Indicates whether the Codes should keep or not the prefix, as defined in the extension of Codelist.
214 -| |+valuesFor|Association to the Component in the Structure to which the Constrainable Artefact is linked, which defines the valid Representation for the Member Values.
188 +|CubeRegion| |(% style="width:442px" %)A set of Components and their values that defines a subset or “slice” of the total range of possible content of a data structure to which the Constrainable Artefact is linked.
189 +| |isIncluded|(% style="width:442px" %)Indicates whether the Cube Region is included in the constraint definition or excluded from the constraint definition.
190 +| |+member|(% style="width:442px" %)Associates the set of Components that define the subset of values.
191 +|MetadataTargetRe gion| |(% style="width:442px" %)A set of Components and their values that defines a subset or “slice” of the total range of possible content of a metadata structure to which the Constrainable Artefact is linked.
192 +| |isIncluded|(% style="width:442px" %)Indicates whether the Metadata Target Region is included in the constraint definition or excluded from the constraint definition.
193 +| |+member|(% style="width:442px" %)Associates the set of Components that define the subset of values.
194 +|MemberSelection| |(% style="width:442px" %)A set of permissible values for one component of the axis.
195 +| |isIncluded|(% style="width:442px" %)Indicates whether the Member Selection is included in the constraint definition or excluded from the constraint definition.
196 +| |removePrefix|(% style="width:442px" %)Indicates whether the Codes should keep or not the prefix, as defined in the extension of Codelist.
197 +| |+valuesFor|(% style="width:442px" %)Association to the Component in the Structure to which the Constrainable Artefact is linked, which defines the valid Representation for the Member Values.
215 215  |//SelectionValue//|(((
216 216  Abstract class. Sub classes are:
217 217  
... ... @@ -220,23 +220,23 @@
220 220  //TimeRangeValue//
221 221  
222 222  LocalisedMemberValue
223 -)))|A collection of values for the Member Selections that, combined with other Member Selections, comprise the value content of the Cube Region.
224 -| |validFrom|Date from which the Selection Value is valid.
225 -| |validTo|Date from which the Selection Value is superseded.
206 +)))|(% style="width:442px" %)A collection of values for the Member Selections that, combined with other Member Selections, comprise the value content of the Cube Region.
207 +| |validFrom|(% style="width:442px" %)Date from which the Selection Value is valid.
208 +| |validTo|(% style="width:442px" %)Date from which the Selection Value is superseded.
226 226  |MemberValue|(((
227 227  Inherits from
228 228  
229 229  //SelectionValue//
230 -)))|A single value of the set of values for the Member Selection.
231 -| |value|A value of the member.
232 -| |cascadeValues|Indicates that the child nodes of the member are included in the Member Selection (e.g., child codes)
213 +)))|(% style="width:442px" %)A single value of the set of values for the Member Selection.
214 +| |value|(% style="width:442px" %)A value of the member.
215 +| |cascadeValues|(% style="width:442px" %)Indicates that the child nodes of the member are included in the Member Selection (e.g., child codes)
233 233  |LocalisedMemberV alue|(((
234 234  Inherits from
235 235  
236 236  //SelectionValue//
237 -)))|A single localised value of the set of values for a Member Selection.
238 -| |value|A value of the member.
239 -| |locale|The locale that the values must adhere to in the dataset.
220 +)))|(% style="width:442px" %)A single localised value of the set of values for a Member Selection.
221 +| |value|(% style="width:442px" %)A value of the member.
222 +| |locale|(% style="width:442px" %)The locale that the values must adhere to in the dataset.
240 240  |//TimeRangeValue//|(((
241 241  Inherits from
242 242  
... ... @@ -249,43 +249,40 @@
249 249  AfterPeriod
250 250  
251 251  RangePeriod
252 -)))|A time value or values that specifies the date or dates for which the constrained selection is valid.
235 +)))|(% style="width:442px" %)A time value or values that specifies the date or dates for which the constrained selection is valid.
253 253  |BeforePeriod|(((
254 254  Inherits from
255 255  
256 256  //TimeRangeValue//
257 -)))|The period before which the constrained selection is valid.
258 -| |isInclusive|Indication of whether the date is inclusive in the period.
259 -| |period|The time period which acts as the latest possible reported period
240 +)))|(% style="width:442px" %)The period before which the constrained selection is valid.
241 +| |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
242 +| |period|(% style="width:442px" %)The time period which acts as the latest possible reported period
260 260  |AfterPeriod|(((
261 261  Inherits from
262 262  
263 263  //TimeRangeValue//
264 -)))|The period after which the constrained selection is valid.
265 -| |isInclusive|Indication of whether the date is inclusive in the period.
266 -| |period|The time period which acts as the earliest possible reported period
267 -|RangePeriod| |The start and end periods in a date range.
268 -| |+start|Association to the Start Period.
269 -| |+end|Association to the End Period.
247 +)))|(% style="width:442px" %)The period after which the constrained selection is valid.
248 +| |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
249 +| |period|(% style="width:442px" %)The time period which acts as the earliest possible reported period
250 +|RangePeriod| |(% style="width:442px" %)The start and end periods in a date range.
251 +| |+start|(% style="width:442px" %)Association to the Start Period.
252 +| |+end|(% style="width:442px" %)Association to the End Period.
270 270  |StartPeriod|(((
271 271  Inherits from
272 272  
273 273  //TimeRangeValue//
274 -)))|The period from which the constrained selection is valid.
275 -| |isInclusive|Indication of whether the date is inclusive in the period.
276 -| |period|The time period which acts as the start of the range
257 +)))|(% style="width:442px" %)The period from which the constrained selection is valid.
258 +| |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
259 +| |period|(% style="width:442px" %)The time period which acts as the start of the range
277 277  |EndPeriod|(((
278 278  Inherits from
279 279  
280 280  //TimeRangeValue//
281 -)))|The period to which the constrained selection is valid.
282 -| |isInclusive|Indication of whether the date is inclusive in the period.
283 -| |period|The time period which acts as the end of the range
284 -|ReleaseCalendar| |The schedule of publication or reporting of the data or metadata
285 -| |periodicity|The time period between the releases of the data or metadata
286 -| |offset|Interval between January 1^^st^^ and the first release of the data
287 -| |tolerance|Period after which the data or metadata may be deemed late.
288 -
289 -
290 -
264 +)))|(% style="width:442px" %)The period to which the constrained selection is valid.
265 +| |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
266 +| |period|(% style="width:442px" %)The time period which acts as the end of the range
267 +|ReleaseCalendar| |(% style="width:442px" %)The schedule of publication or reporting of the data or metadata
268 +| |periodicity|(% style="width:442px" %)The time period between the releases of the data or metadata
269 +| |offset|(% style="width:442px" %)Interval between January 1^^st^^ and the first release of the data
270 +| |tolerance|(% style="width:442px" %)Period after which the data or metadata may be deemed late.
291 291