Skip to Content

Changes for page 12 Constraints

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

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,4 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
1 += 12 Constraints =
4 4  
5 5  == 12.1 Scope ==
6 6  
... ... @@ -29,14 +29,23 @@
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
30 +
32 32  ProvisionAgreement
32 +
33 33  DataProvider – this is restricted to release calendar
34 +
34 34  DataStructureDefinition
36 +
35 35  Metadataflow
38 +
36 36  MetaDataProvider – this is restricted to release calendar
40 +
37 37  MetadataProvisionAgreement
42 +
38 38  MetadataSetMetadataStructureDefinition
44 +
39 39  SimpleDataSource – this is a registered data source where the registration references the actual Data Set or Metadata Set
46 +
40 40  //QueryDataSource//
41 41  
42 42  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.
... ... @@ -66,8 +66,10 @@
66 66  
67 67  In addition to DataKeySet and/or CubeRegion/MetadataTargetRegion a Constraint can have a ReleaseCalendar specifying when data or metadata are released for publication or reporting.
68 68  
69 -Note also that another possible type of a DataConstraint is available; that is a DataConstraint with the role of actualContent where it describes the data that an SDMX Web Service contains. This type of DataConstraint is not maintained in a Registry and is always a response to the data availability SDMX REST API. Thus, its identification is autogenerated by the service responding to a data availability request.
76 +Note also that another possible type of a DataConstraint is available; that is a
70 70  
78 +DataConstraint with the role of actualContent where it describes the data that an SDMX Web Service contains. This type of DataConstraint is not maintained in a Registry and is always a response to the data availability SDMX REST API. Thus, its identification is autogenerated by the service responding to a data availability request.
79 +
71 71  === 12.3.3 Relationship Class Diagram – Detail ===
72 72  
73 73  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_d166f6ab.jpg||height="708" width="619"]]
... ... @@ -83,7 +83,7 @@
83 83  1. As a set of keys that can be present in the //DataSet// (DataKeySet). Each DataKey specifies a number of ComponentValues each of which reference a //Component// (e.g., Dimension, DataAttribute). Each ComponentValue is a value that may be present for a //Component// of a structure when contained in a //DataSet//. In addition, each DataKeySet may also include MemberSelections for AttributeComponents or Measures.
84 84  1. As a set of CubeRegions each of which defines a “slice” of the total structure (MemberSelection) in terms of one or more MemberValues that may be present for a //Component// of a structure when contained in a //DataSet//.
85 85  
86 -The difference between (1) and (2) above is that in (1) a complete key is defined whereas in (2) above the “slice” defines a list of possible values for each of the// Component//s but does not specify specific key combinations. In addition, in (1) the association between //Component// and DataKeyValue is constrained to the components that comprise the key, whereas in (2) it can contain other component types (such as AttributeComponents or Measures). By adding MemberSelections to the DataKeySets of (1), AttributeComponents and Measures are constrained for the related DataKeys.
95 +The difference between (1) and (2) above is that in (1) a complete key is defined whereas in (2) above the “slice” defines a list of possible values for each of the// Component//s but does not specify specific key combinations. In addition, in (1) the association between //Component// and DataKeyValue is constrained to the components that comprise the key, whereas in (2) it can contain other component types (such as AttributeComponents or Measures). By adding MemberSelections to the DataKeySets of (1), AttributeComponents and Measures are constrained for the related DataKeys.
87 87  
88 88  A MetadataConstraint has only one way of specifying value subsets:
89 89  
... ... @@ -93,7 +93,7 @@
93 93  
94 94  * "true": all children are included,
95 95  * "false" (default), or
96 -* " excludeRoot", where all children are included, and the root Code is excluded (i.e. the referenced Code).
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).
97 97  
98 98  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”.
99 99  
... ... @@ -103,8 +103,7 @@
103 103  
104 104  ==== 12.3.3.2 Definitions ====
105 105  
106 -(% style="width:908.294px" %)
107 -|**Class**|**Feature**|(% style="width:442px" %)**Description**
115 +|**Class**|**Feature**|**Description**
108 108  |//ConstrainableArt efact//|(((
109 109  Abstract Class Sub classes are:
110 110  
... ... @@ -116,11 +116,13 @@
116 116  
117 117  Metadataflow
118 118  
119 -MetadataProvisionAgreement
127 +MetadataProvisionAgreem
120 120  
129 +ent
130 +
121 121  MetadataSet
122 122  
123 -MetadataStructureDefinition
133 +MetadataStructureDefini tion
124 124  
125 125  ProvisionAgreement
126 126  
... ... @@ -127,8 +127,8 @@
127 127  //QueryDatasource//
128 128  
129 129  SimpleDatasource
130 -)))|(% style="width:442px" %)An artefact that can have Constraints specified.
131 -| |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.
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.
132 132  |//Constraint//|(((
133 133  Inherits from
134 134  
... ... @@ -139,64 +139,69 @@
139 139  DataConstraint
140 140  
141 141  MetadataConstraint
142 -)))|(% 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.
143 -| |+dataContentKeys|(% style="width:442px" %)(((
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|(((
144 144  Association to a subset of Data
145 145  
146 146  Key Sets (i.e., value combinations) that can be derived from the definition of the structure to which the Constrainable Artefact is linked.
147 147  )))
148 -| |+dataContentRegion|(% style="width:442px" %)(((
158 +||+dataContentRegion|(((
149 149  Association to a subset of component values that can be derived from the Data Structure
150 150  
151 151  Definition to which the Constrainable Artefact is linked.
152 152  )))
153 -| |+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.
154 -| |role|(% style="width:442px" %)Association to the role that the Constraint plays
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
155 155  |DataConstraint|(((
156 156  Inherits from
167 +
157 157  //Constraint//
158 -)))|(% 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.
159 -|ConstraintRoleTy pe| |(% style="width:442px" %)Specifies the way the type of content of a Constraint in terms of its purpose.
160 -| |allowableContent|(% style="width:442px" %)The Constraint contains a specification of the valid subset of the Component values or keys.
161 -| |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.
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.
162 162  |MetadataConstrai nt|(((
163 163  Inherits from
175 +
164 164  //Constraint//
165 -)))|(% 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.
166 -|DataKeySet| |(% style="width:442px" %)A set of data keys.
167 -| |isIncluded|(% style="width:442px" %)Indicates whether the Data Key Set is included in the constraint definition or excluded from the constraint definition.
168 -| |+keys|(% style="width:442px" %)Association to the Data Keys in the set.
169 -| |+member|(% style="width:442px" %)Association to the selection of a value subset for Attributes and Measures.
170 -|DataKey| |(% style="width:442px" %)The values of a key in a data set.
171 -| |isIncluded|(% style="width:442px" %)Indicates whether the Data Key is included in the constraint definition or excluded from the constraint definition.
172 -| |+keyValue|(% style="width:442px" %)(((
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|(((
173 173  Associates the Component
174 174  
175 175  Values that comprise the key.
176 176  )))
177 -| |validFrom|(% style="width:442px" %)Date from which the Data Key is valid.
178 -| |validTo|(% style="width:442px" %)Date from which the Data Key is superseded.
179 -|ComponentValue| |(% style="width:442px" %)The identification and value of a Component of the key (e.g., Dimension)
180 -| |value|(% style="width:442px" %)The value of Component
181 -| |+valueFor|(% style="width:442px" %)Association to the Component (e.g., Dimension) in the Structure to which the Constrainable Artefact is linked.
182 -|TimeDimensionVal ue| |(% style="width:442px" %)The value of the Time Dimension component.
183 -| |timeValue|(% style="width:442px" %)The value of the time period.
184 -| |operator|(% style="width:442px" %)(((
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|(((
185 185  Indicates whether the specified value represents and exact time or time period, or whether the value should be handled as a range.
198 +
186 186  A value of greaterThan or greaterThanOrEqual indicates that the value is the beginning of a range (exclusive or inclusive, respectively).
200 +
187 187  A value of lessThan or lessThanOrEqual indicates that the value is the end or a range (exclusive or inclusive, respectively).
202 +
188 188  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)
189 189  )))
190 -|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.
191 -| |isIncluded|(% style="width:442px" %)Indicates whether the Cube Region is included in the constraint definition or excluded from the constraint definition.
192 -| |+member|(% style="width:442px" %)Associates the set of Components that define the subset of values.
193 -|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.
194 -| |isIncluded|(% style="width:442px" %)Indicates whether the Metadata Target Region is included in the constraint definition or excluded from the constraint definition.
195 -| |+member|(% style="width:442px" %)Associates the set of Components that define the subset of values.
196 -|MemberSelection| |(% style="width:442px" %)A set of permissible values for one component of the axis.
197 -| |isIncluded|(% style="width:442px" %)Indicates whether the Member Selection is included in the constraint definition or excluded from the constraint definition.
198 -| |removePrefix|(% style="width:442px" %)Indicates whether the Codes should keep or not the prefix, as defined in the extension of Codelist.
199 -| |+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.
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.
200 200  |//SelectionValue//|(((
201 201  Abstract class. Sub classes are:
202 202  
... ... @@ -205,23 +205,23 @@
205 205  //TimeRangeValue//
206 206  
207 207  LocalisedMemberValue
208 -)))|(% 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.
209 -| |validFrom|(% style="width:442px" %)Date from which the Selection Value is valid.
210 -| |validTo|(% style="width:442px" %)Date from which the Selection Value is superseded.
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.
211 211  |MemberValue|(((
212 212  Inherits from
213 213  
214 214  //SelectionValue//
215 -)))|(% style="width:442px" %)A single value of the set of values for the Member Selection.
216 -| |value|(% style="width:442px" %)A value of the member.
217 -| |cascadeValues|(% style="width:442px" %)Indicates that the child nodes of the member are included in the Member Selection (e.g., child codes)
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)
218 218  |LocalisedMemberV alue|(((
219 219  Inherits from
220 220  
221 221  //SelectionValue//
222 -)))|(% style="width:442px" %)A single localised value of the set of values for a Member Selection.
223 -| |value|(% style="width:442px" %)A value of the member.
224 -| |locale|(% style="width:442px" %)The locale that the values must adhere to in the dataset.
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.
225 225  |//TimeRangeValue//|(((
226 226  Inherits from
227 227  
... ... @@ -234,40 +234,43 @@
234 234  AfterPeriod
235 235  
236 236  RangePeriod
237 -)))|(% style="width:442px" %)A time value or values that specifies the date or dates for which the constrained selection is valid.
252 +)))|A time value or values that specifies the date or dates for which the constrained selection is valid.
238 238  |BeforePeriod|(((
239 239  Inherits from
240 240  
241 241  //TimeRangeValue//
242 -)))|(% style="width:442px" %)The period before which the constrained selection is valid.
243 -| |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
244 -| |period|(% style="width:442px" %)The time period which acts as the latest possible reported period
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
245 245  |AfterPeriod|(((
246 246  Inherits from
247 247  
248 248  //TimeRangeValue//
249 -)))|(% style="width:442px" %)The period after which the constrained selection is valid.
250 -| |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
251 -| |period|(% style="width:442px" %)The time period which acts as the earliest possible reported period
252 -|RangePeriod| |(% style="width:442px" %)The start and end periods in a date range.
253 -| |+start|(% style="width:442px" %)Association to the Start Period.
254 -| |+end|(% style="width:442px" %)Association to the End Period.
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.
255 255  |StartPeriod|(((
256 256  Inherits from
257 257  
258 258  //TimeRangeValue//
259 -)))|(% style="width:442px" %)The period from which the constrained selection is valid.
260 -| |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
261 -| |period|(% style="width:442px" %)The time period which acts as the start of the range
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
262 262  |EndPeriod|(((
263 263  Inherits from
264 264  
265 265  //TimeRangeValue//
266 -)))|(% style="width:442px" %)The period to which the constrained selection is valid.
267 -| |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
268 -| |period|(% style="width:442px" %)The time period which acts as the end of the range
269 -|ReleaseCalendar| |(% style="width:442px" %)The schedule of publication or reporting of the data or metadata
270 -| |periodicity|(% style="width:442px" %)The time period between the releases of the data or metadata
271 -| |offset|(% style="width:442px" %)Interval between January 1^^st^^ and the first release of the data
272 -| |tolerance|(% style="width:442px" %)Period after which the data or metadata may be deemed late.
273 -
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 +
291 +
SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_7f83d17f.gif
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -1.1 KB
Content
SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_e601fbfd.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -82.9 KB
Content