Skip to Content

Changes for page 10 Constraints

Last modified by Artur on 2025/09/10 11:19
From version 2.1
edited by Helena
on 2025/05/19 23:53
Change comment: Created by office importer.
To version 8.1
edited by Helena
on 2025/05/22 13:55
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +10 Constraints
Parent
... ... @@ -1,0 +1,1 @@
1 +Methodology.SDMX 2\.1 Standards\. Section 2\. Information model\: UML conceptual design.WebHome
Content
... ... @@ -1,4 +1,6 @@
1 -= {{id name="_Toc371061"/}}10 Constraints =
1 +{{box title="**Contents**"}}
2 +{{toc/}}
3 +{{/box}}
2 2  
3 3  == {{id name="_Toc371062"/}}10.1 Scope ==
4 4  
... ... @@ -16,6 +16,8 @@
16 16  
17 17  === {{id name="_Toc371064"/}}10.2.1 Class Diagram of Constrainable Artefacts - Inheritance ===
18 18  
21 +[[image:1747904390682-586.png]]
22 +
19 19  **Figure 37: Inheritance class diagram of constrainable and provisioning artefacts**
20 20  
21 21  === {{id name="_Toc371065"/}}10.2.2 Explanation of the Diagram ===
... ... @@ -40,6 +40,8 @@
40 40  
41 41  === {{id name="_Toc371067"/}}10.3.1 Relationship Class Diagram – high level view ===
42 42  
47 +[[image:1747904434659-835.png]]
48 +
43 43  **Figure 38: Relationship class diagram showing constraint metadata**
44 44  
45 45  === {{id name="_Toc371068"/}}10.3.2 Explanation of the Diagram ===
... ... @@ -59,8 +59,12 @@
59 59  
60 60  === {{id name="_Toc371069"/}}10.3.3 Relationship Class Diagram – Detail ===
61 61  
68 +[[image:1747904480223-768.png]]
69 +
62 62  **Figure 39: Constraints - Key Set Constraints**
63 63  
72 +[[image:1747904523939-355.png]]
73 +
64 64  **Figure 40: Constraints - Cube Region and Metadata Target Region Constraints**
65 65  
66 66  ==== 10.3.3.1 Explanation of the Diagram ====
... ... @@ -69,71 +69,54 @@
69 69  
70 70  A //Constraint// has a choice of two ways of specifying value sub sets:
71 71  
72 -1. As a set of keys that can be present in the DataSet (DataKeySet) or MetadataSet
73 -
74 -(MetadataKeySet). Each DataKey or MetadataKey specifies a number of ComponentValues each of which reference a //Component// (e.g. Dimension, TargetObject). Each ComponentValue is a value that may be present for a //Component// of a structure when contained in a DataSet or MetadataSet. The MetadataKeySet must also identify the MetadataTarget as there can be many of each of these in a MetadataStructureDefinition. For the DataKeySet the equivalent identification is not necessary as there is only one DimensionDescriptor and one AttributeDescriptor.
75 -
82 +1. As a set of keys that can be present in the DataSet (DataKeySet) or MetadataSet (MetadataKeySet). Each DataKey or MetadataKey specifies a number of ComponentValues each of which reference a //Component// (e.g. Dimension, TargetObject). Each ComponentValue is a value that may be present for a //Component// of a structure when contained in a DataSet or MetadataSet. The MetadataKeySet must also identify the MetadataTarget as there can be many of each of these in a MetadataStructureDefinition. For the DataKeySet the equivalent identification is not necessary as there is only one DimensionDescriptor and one AttributeDescriptor.
76 76  1. As a set of CubeRegions or MetadataTaregetRegions 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// or MetadataSet.
77 77  
78 -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 or MetadataKeyValue is constrained to the components that comprise the key or identifier, whereas in (2) it can contain other component types (such as attributes). The value in ComponentValue.value and MemberValue.value must be consistent with the //Representation// declared for the //Component// in the DataStructureDefinition or MetadataStructureDefinition. Note that in all cases the “operator” on the value is deemed to be “equals”. Furthermore, it is possible in a MemberValue to specify that child values (e.g. child codes) are included in the constraint by means of the cascadeValues attribute.
85 +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 or MetadataKeyValue is constrained to the components that comprise the key or identifier, whereas in (2) it can contain other component types (such as attributes). The value in ComponentValue.value and MemberValue.value must be consistent with the //Representation// declared for the //Component// in the DataStructureDefinition or MetadataStructureDefinition. Note that in all cases the “operator” on the value is deemed to be “equals”. Furthermore, it is possible in a MemberValue to specify that child values (e.g. child codes) are included in the constraint by means of the cascadeValues attribute.
79 79  
80 80  It is possible to define for the DataKeySet, DataKey, MetadataKeySet, MetadataKey, CubeRegion, MetadataTargetRegion, and MemberSelection whether the set is included (isIncluded = “true”) 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”.
81 81  
82 -**10.3.3.2 Definitions**
89 +==== 10.3.3.2 Definitions ====
83 83  
84 -|**Class**|**Feature**|**Description**
91 +(% style="width:987.294px" %)
92 +|**Class**|**Feature**|(% style="width:471px" %)**Description**
85 85  |//Constrainable// //Artefact//|(((
86 86  Abstract Class Sub classes are:
87 -
88 88  DataflowDefinition
89 -
90 90  Metadataflow
91 -
92 92  Definition
93 -
94 94  ProvisionAgreement
95 -
96 96  DataProvider
97 -
98 98  //QueryDatasource//
99 -
100 100  SimpleDatasource
101 -
102 102  DataStructure
103 -
104 104  Definition
105 -
106 106  MetadataStructure
107 -
108 108  Definition
109 -)))|An artefact that can have Constraints specified.
110 -||content|Associates the metadata that constrains the content to be found in a data or metadata source linked to the Constrainable Artefact.
111 -||attachment|Associates the metadata that constrains the valid content of a Constrainable Artefact to which metadata may be attached.
106 +)))|(% style="width:471px" %)An artefact that can have Constraints specified.
107 +| |content|(% style="width:471px" %)Associates the metadata that constrains the content to be found in a data or metadata source linked to the Constrainable Artefact.
108 +| |attachment|(% style="width:471px" %)Associates the metadata that constrains the valid content of a Constrainable Artefact to which metadata may be attached.
112 112  |//Constraint//|(((
113 113  Inherits from
114 -
115 115  //MaintainableArtefact//
116 -
117 117  Abstract class. Sub classes are:
118 -
119 119  AttachmentConstraint
120 -
121 121  ContentConstraint
122 -)))|Specifies a sub set 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.
123 -||+availableDates//    //|Association to the time period that identifies the time range for which data or metadata are available in the data source.
124 -||+dataContentKeys|Association to a sub set of Data Key Sets (i.e. value combinations) that can be derived from the definition of the structure to which the Constrainable Artefact is linked.
125 -||+metadataContentKeys|Association to a sub set of Metdata Key Sets (i.e. value combinations) that can be derived from the definition of the Structure to which the Constrainable Artefact is linke
126 -||+dataContentRegion|Association to a sub set of component values that can be derived from the Data Structure Definition to which the Constrainable Artefact is linked.
127 -||+metadataContentRegion|Association to a sub set of component values that can be derived from the Metadata Structure Definition to which the Constrainable Artefact is linked.
115 +)))|(% style="width:471px" %)Specifies a sub set 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.
116 +| |+availableDates|(% style="width:471px" %)Association to the time period that identifies the time range for which data or metadata are available in the data source.
117 +| |+dataContentKeys|(% style="width:471px" %)Association to a sub set of Data Key Sets (i.e. value combinations) that can be derived from the definition of the structure to which the Constrainable Artefact is linked.
118 +| |+metadataContentKeys|(% style="width:471px" %)Association to a sub set of Metdata Key Sets (i.e. value combinations) that can be derived from the definition of the Structure to which the Constrainable Artefact is linke
119 +| |+dataContentRegion|(% style="width:471px" %)Association to a sub set of component values that can be derived from the Data Structure Definition to which the Constrainable Artefact is linked.
120 +| |+metadataContentRegion|(% style="width:471px" %)Association to a sub set of component values that can be derived from the Metadata Structure Definition to which the Constrainable Artefact is linked.
128 128  |ContentConstraint|(((
129 129  Inherits from
130 130  
131 131  //Constraint//
132 -)))|Defines a Constraint in terms of the content that can be found in data or metadata sources linked to the Constrainable Artefact to which this constraint is associated.
133 -||+role|Association to the role that the Constraint plays
134 -|ConstraintRole||Specifies the way the type of content of a Constraint in terms of its purpose.
135 -||allowableContent|The Constraint contains a specification of the valid sub set of the Component values or keys.
136 -||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.
125 +)))|(% style="width:471px" %)Defines a Constraint in terms of the content that can be found in data or metadata sources linked to the Constrainable Artefact to which this constraint is associated.
126 +| |+role|(% style="width:471px" %)Association to the role that the Constraint plays
127 +|ConstraintRole| |(% style="width:471px" %)Specifies the way the type of content of a Constraint in terms of its purpose.
128 +| |allowableContent|(% style="width:471px" %)The Constraint contains a specification of the valid sub set of the Component values or keys.
129 +| |actualContent|(% style="width:471px" %)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.
137 137  |(((
138 138  Attachment
139 139  
... ... @@ -142,108 +142,88 @@
142 142  Inherits from
143 143  
144 144  //Constraint//
145 -)))|Defines a Constraint in terms of the combination of component values that may be found in a data source, and to which a Constrainable Artefact may be associated in a structure definition.
146 -|DataKeySet||A set of data keys.
147 -||isIncluded|Indicates whether the Data Key Set is included in the constraint definition or excluded from the constraint definition.
148 -||+keys|Association to the Data Keys in the set.
149 -|MetadataKeySet||A set of metadata keys.
150 -||isIncluded|Indicates whether the Metadata Key Set is included in the constraint definition or excluded from the constraint definition.
151 -||+keys|Association to the Metadata Keys in the set.
152 -|DataKey||The values of a key in a data set.
153 -||isIncluded|Indicates whether the Data Key is included in the constraint definition or excluded from the constraint definition.
154 -||+keyValue|Associates the Component Values that comprise the key.
155 -|MetadataKey||The values of a key in a metadata set.
156 -||isIncluded|Indicates whether the Metdadata Key is included in the constraint definition or excluded from the constraint definition.
157 -||+keyValue|Associates the Component Values that comprise the key.
158 -|ComponentValue||The identification of and value of a Component of the key (e.g. Dimension)
159 -||value|The value of Component
160 -||+valueFor|Association to the Component (e.g. Dimension) in the Structure to which the Constrainable Artefact is linked.
161 -|TimeDimensionValue||The value of the Time Dimension component.
162 -||timeValue|The value of the time period.
163 -||operator|(((
138 +)))|(% style="width:471px" %)Defines a Constraint in terms of the combination of component values that may be found in a data source, and to which a Constrainable Artefact may be associated in a structure definition.
139 +|DataKeySet| |(% style="width:471px" %)A set of data keys.
140 +| |isIncluded|(% style="width:471px" %)Indicates whether the Data Key Set is included in the constraint definition or excluded from the constraint definition.
141 +| |+keys|(% style="width:471px" %)Association to the Data Keys in the set.
142 +|MetadataKeySet| |(% style="width:471px" %)A set of metadata keys.
143 +| |isIncluded|(% style="width:471px" %)Indicates whether the Metadata Key Set is included in the constraint definition or excluded from the constraint definition.
144 +| |+keys|(% style="width:471px" %)Association to the Metadata Keys in the set.
145 +|DataKey| |(% style="width:471px" %)The values of a key in a data set.
146 +| |isIncluded|(% style="width:471px" %)Indicates whether the Data Key is included in the constraint definition or excluded from the constraint definition.
147 +| |+keyValue|(% style="width:471px" %)Associates the Component Values that comprise the key.
148 +|MetadataKey| |(% style="width:471px" %)The values of a key in a metadata set.
149 +| |isIncluded|(% style="width:471px" %)Indicates whether the Metdadata Key is included in the constraint definition or excluded from the constraint definition.
150 +| |+keyValue|(% style="width:471px" %)Associates the Component Values that comprise the key.
151 +|ComponentValue| |(% style="width:471px" %)The identification of and value of a Component of the key (e.g. Dimension)
152 +| |value|(% style="width:471px" %)The value of Component
153 +| |+valueFor|(% style="width:471px" %)Association to the Component (e.g. Dimension) in the Structure to which the Constrainable Artefact is linked.
154 +|TimeDimensionValue| |(% style="width:471px" %)The value of the Time Dimension component.
155 +| |timeValue|(% style="width:471px" %)The value of the time period.
156 +| |operator|(% style="width:471px" %)(((
164 164  Indicates whether the specified value represents and exact time or time period, or whether the value should be handled as a range.
165 -
166 166  A value of greaterThan or greaterThanOrEqual indicates that the value is the beginning of a range (exclusive or inclusive, respectively).
167 -
168 168  A value of lessThan or lessThanOrEqual indicates that the value is the end or a range (exclusive or inclusive, respectively).
169 -
170 170  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)
171 171  )))
172 -|CubeRegion||A set of Components and their values that defines a sub set or “slice” of the total range of possible content of a data structure to which the Constrainable Artefact is linked.
173 -||isIncluded|Indicates whether the Cube Region is included in the constraint definition or excluded from the constraint definition.
174 -||+member|Associates the set of Components that define the sub set of values.
175 -|MetadataTargetRegion||A set of Components and their values that defines a sub set or “slice” of the total range of possible content of a metadata structure to which the Constrainable Artefact is linked.
176 -||isIncluded|Indicates whether the Metadata Target Region is included in the constraint definition or excluded from the constraint definition.
177 -||+member|Associates the set of Components that define the sub set of values.
178 -|MemberSelection||A set of permissible values for one component of the axis.
179 -||isIncluded|Indicates whether the Member Selection is included in the constraint definition or excluded from the constraint definition.
180 -||+valuesFor|Association to the Component in the Structure to which the Constrainable Artefact is linked, which defines the valid Representation for the Member Values.
162 +|CubeRegion| |(% style="width:471px" %)A set of Components and their values that defines a sub set or “slice” of the total range of possible content of a data structure to which the Constrainable Artefact is linked.
163 +| |isIncluded|(% style="width:471px" %)Indicates whether the Cube Region is included in the constraint definition or excluded from the constraint definition.
164 +| |+member|(% style="width:471px" %)Associates the set of Components that define the sub set of values.
165 +|MetadataTargetRegion| |(% style="width:471px" %)A set of Components and their values that defines a sub set or “slice” of the total range of possible content of a metadata structure to which the Constrainable Artefact is linked.
166 +| |isIncluded|(% style="width:471px" %)Indicates whether the Metadata Target Region is included in the constraint definition or excluded from the constraint definition.
167 +| |+member|(% style="width:471px" %)Associates the set of Components that define the sub set of values.
168 +|MemberSelection| |(% style="width:471px" %)A set of permissible values for one component of the axis.
169 +| |isIncluded|(% style="width:471px" %)Indicates whether the Member Selection is included in the constraint definition or excluded from the constraint definition.
170 +| |+valuesFor|(% style="width:471px" %)Association to the Component in the Structure to which the Constrainable Artefact is linked, which defines the valid Representation for the Member Values.
181 181  |SelectionValue|(((
182 182  Abstract class. Sub classes are:
183 -
184 184  MemberValue
185 -
186 186  TimeRangeValue
187 -)))|A collection of values for the Member Selections that, combined with other Member Selections, comprise the value content of the Cube Region.
175 +)))|(% style="width:471px" %)A collection of values for the Member Selections that, combined with other Member Selections, comprise the value content of the Cube Region.
188 188  |MemberValue|(((
189 189  Inherits from
190 -
191 191  SelectionValue
192 -)))|A single value of the set of values for the Member Selection.
193 -||value|A value of the member.
194 -||cascadeValues|Indicates that the child nodes of the member are included in the Member Selection (e.g. child codes)
179 +)))|(% style="width:471px" %)A single value of the set of values for the Member Selection.
180 +| |value|(% style="width:471px" %)A value of the member.
181 +| |cascadeValues|(% style="width:471px" %)Indicates that the child nodes of the member are included in the Member Selection (e.g. child codes)
195 195  |//TimeRangeValue//|(((
196 196  Inherits from
197 -
198 198  SelectionValue
199 -
200 200  Abstract Class
201 -
202 202  Concrete Classes
203 -
204 204  BeforePeriod
205 -
206 206  AfterPeriod
207 -
208 208  RangePeriod
209 -)))|A time value or values that specifies the date or dates for which the constrained selection is valid.
190 +)))|(% style="width:471px" %)A time value or values that specifies the date or dates for which the constrained selection is valid.
210 210  |BeforePeriod|(((
211 211  Inherits from
212 -
213 213  //TimeRangeValue//
214 -)))|The period before which the constrained selection is valid.
215 -||isInclusive|Indication of whether the date is inclusive in the period.
194 +)))|(% style="width:471px" %)The period before which the constrained selection is valid.
195 +| |isInclusive|(% style="width:471px" %)Indication of whether the date is inclusive in the period.
216 216  |AfterPeriod|(((
217 217  Inherits from
218 -
219 219  //TimeRangeValue//
220 -)))|The period after which the constrained selection is valid.
221 -||isInclusive|Indication of whether the date is inclusive in the period.
222 -|RangePeriod||The start and end periods in a date range.
223 -||+start|Association to the Start Period.
224 -||+end|Association to the End Period.
199 +)))|(% style="width:471px" %)The period after which the constrained selection is valid.
200 +| |isInclusive|(% style="width:471px" %)Indication of whether the date is inclusive in the period.
201 +|RangePeriod| |(% style="width:471px" %)The start and end periods in a date range.
202 +| |+start|(% style="width:471px" %)Association to the Start Period.
203 +| |+end|(% style="width:471px" %)Association to the End Period.
225 225  |StartPeriod|(((
226 226  Inherits from
227 -
228 228  //TimeRangeValue//
229 -)))|The period from which the constrained selection is valid.
230 -||isInclusive|Indication of whether the date is inclusive in the period.
207 +)))|(% style="width:471px" %)The period from which the constrained selection is valid.
208 +| |isInclusive|(% style="width:471px" %)Indication of whether the date is inclusive in the period.
231 231  |EndPeriod|(((
232 232  Inherits from
233 -
234 234  //TimeRangeValue//
235 -)))|The period to which the constrained selection is valid.
236 -||isInclusive|Indication of whether the date is inclusive in the period.
237 -|ReferencePeriod||A set of dates that constrain the content that may be found in a data or metadata set.
238 -||startDate|The start date of the period.
239 -||endDate|The end date of the period.
240 -|ReleaseCalendar||The schedule of publication or reporting of the data or metadata
241 -||periodicity|The time period between the releases of the data or metadata
242 -||offset|Interval between January 1^^st^^ and the first release of the data
243 -||tolerance|Period after which the data or metadata may be deemed late.
212 +)))|(% style="width:471px" %)The period to which the constrained selection is valid.
213 +| |isInclusive|(% style="width:471px" %)Indication of whether the date is inclusive in the period.
214 +|ReferencePeriod| |(% style="width:471px" %)A set of dates that constrain the content that may be found in a data or metadata set.
215 +| |startDate|(% style="width:471px" %)The start date of the period.
216 +| |endDate|(% style="width:471px" %)The end date of the period.
217 +|ReleaseCalendar| |(% style="width:471px" %)The schedule of publication or reporting of the data or metadata
218 +| |periodicity|(% style="width:471px" %)The time period between the releases of the data or metadata
219 +| |offset|(% style="width:471px" %)Interval between January 1^^st^^ and the first release of the data
220 +| |tolerance|(% style="width:471px" %)Period after which the data or metadata may be deemed late.
244 244  
245 245  
246 -
247 -
248 -
249 -
1747904390682-586.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +16.9 KB
Content
1747904434659-835.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +37.4 KB
Content
1747904480223-768.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +41.6 KB
Content
1747904523939-355.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +43.6 KB
Content
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,0 +1,1 @@
1 +11