Skip to Content

Changes for page 10 Constraints

Last modified by Artur on 2025/09/10 11:19
From version 8.1
edited by Helena
on 2025/05/22 13:55
Change comment: There is no comment for this version
To version 6.2
edited by Helena
on 2025/05/22 11:59
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -44,8 +44,6 @@
44 44  
45 45  === {{id name="_Toc371067"/}}10.3.1 Relationship Class Diagram – high level view ===
46 46  
47 -[[image:1747904434659-835.png]]
48 -
49 49  **Figure 38: Relationship class diagram showing constraint metadata**
50 50  
51 51  === {{id name="_Toc371068"/}}10.3.2 Explanation of the Diagram ===
... ... @@ -65,12 +65,8 @@
65 65  
66 66  === {{id name="_Toc371069"/}}10.3.3 Relationship Class Diagram – Detail ===
67 67  
68 -[[image:1747904480223-768.png]]
69 -
70 70  **Figure 39: Constraints - Key Set Constraints**
71 71  
72 -[[image:1747904523939-355.png]]
73 -
74 74  **Figure 40: Constraints - Cube Region and Metadata Target Region Constraints**
75 75  
76 76  ==== 10.3.3.1 Explanation of the Diagram ====
... ... @@ -79,7 +79,10 @@
79 79  
80 80  A //Constraint// has a choice of two ways of specifying value sub sets:
81 81  
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 +1. As a set of keys that can be present in the DataSet (DataKeySet) or MetadataSet
77 +
78 +(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.
79 +
83 83  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.
84 84  
85 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.
... ... @@ -86,47 +86,61 @@
86 86  
87 87  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”.
88 88  
89 -==== 10.3.3.2 Definitions ====
86 +**10.3.3.2 Definitions**
90 90  
91 -(% style="width:987.294px" %)
92 -|**Class**|**Feature**|(% style="width:471px" %)**Description**
88 +|**Class**|**Feature**|**Description**
93 93  |//Constrainable// //Artefact//|(((
94 94  Abstract Class Sub classes are:
91 +
95 95  DataflowDefinition
93 +
96 96  Metadataflow
95 +
97 97  Definition
97 +
98 98  ProvisionAgreement
99 +
99 99  DataProvider
101 +
100 100  //QueryDatasource//
103 +
101 101  SimpleDatasource
105 +
102 102  DataStructure
107 +
103 103  Definition
109 +
104 104  MetadataStructure
111 +
105 105  Definition
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.
113 +)))|An artefact that can have Constraints specified.
114 +| |content|Associates the metadata that constrains the content to be found in a data or metadata source linked to the Constrainable Artefact.
115 +| |attachment|Associates the metadata that constrains the valid content of a Constrainable Artefact to which metadata may be attached.
109 109  |//Constraint//|(((
110 110  Inherits from
118 +
111 111  //MaintainableArtefact//
120 +
112 112  Abstract class. Sub classes are:
122 +
113 113  AttachmentConstraint
124 +
114 114  ContentConstraint
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.
126 +)))|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.
127 +| |+availableDates//    //|Association to the time period that identifies the time range for which data or metadata are available in the data source.
128 +| |+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.
129 +| |+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
130 +| |+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.
131 +| |+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.
121 121  |ContentConstraint|(((
122 122  Inherits from
123 123  
124 124  //Constraint//
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.
136 +)))|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.
137 +| |+role|Association to the role that the Constraint plays
138 +|ConstraintRole| |Specifies the way the type of content of a Constraint in terms of its purpose.
139 +| |allowableContent|The Constraint contains a specification of the valid sub set of the Component values or keys.
140 +| |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.
130 130  |(((
131 131  Attachment
132 132  
... ... @@ -135,88 +135,108 @@
135 135  Inherits from
136 136  
137 137  //Constraint//
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" %)(((
149 +)))|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.
150 +|DataKeySet| |A set of data keys.
151 +| |isIncluded|Indicates whether the Data Key Set is included in the constraint definition or excluded from the constraint definition.
152 +| |+keys|Association to the Data Keys in the set.
153 +|MetadataKeySet| |A set of metadata keys.
154 +| |isIncluded|Indicates whether the Metadata Key Set is included in the constraint definition or excluded from the constraint definition.
155 +| |+keys|Association to the Metadata Keys in the set.
156 +|DataKey| |The values of a key in a data set.
157 +| |isIncluded|Indicates whether the Data Key is included in the constraint definition or excluded from the constraint definition.
158 +| |+keyValue|Associates the Component Values that comprise the key.
159 +|MetadataKey| |The values of a key in a metadata set.
160 +| |isIncluded|Indicates whether the Metdadata Key is included in the constraint definition or excluded from the constraint definition.
161 +| |+keyValue|Associates the Component Values that comprise the key.
162 +|ComponentValue| |The identification of and value of a Component of the key (e.g. Dimension)
163 +| |value|The value of Component
164 +| |+valueFor|Association to the Component (e.g. Dimension) in the Structure to which the Constrainable Artefact is linked.
165 +|TimeDimensionValue| |The value of the Time Dimension component.
166 +| |timeValue|The value of the time period.
167 +| |operator|(((
157 157  Indicates whether the specified value represents and exact time or time period, or whether the value should be handled as a range.
169 +
158 158  A value of greaterThan or greaterThanOrEqual indicates that the value is the beginning of a range (exclusive or inclusive, respectively).
171 +
159 159  A value of lessThan or lessThanOrEqual indicates that the value is the end or a range (exclusive or inclusive, respectively).
173 +
160 160  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)
161 161  )))
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.
176 +|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.
177 +| |isIncluded|Indicates whether the Cube Region is included in the constraint definition or excluded from the constraint definition.
178 +| |+member|Associates the set of Components that define the sub set of values.
179 +|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.
180 +| |isIncluded|Indicates whether the Metadata Target Region is included in the constraint definition or excluded from the constraint definition.
181 +| |+member|Associates the set of Components that define the sub set of values.
182 +|MemberSelection| |A set of permissible values for one component of the axis.
183 +| |isIncluded|Indicates whether the Member Selection is included in the constraint definition or excluded from the constraint definition.
184 +| |+valuesFor|Association to the Component in the Structure to which the Constrainable Artefact is linked, which defines the valid Representation for the Member Values.
171 171  |SelectionValue|(((
172 172  Abstract class. Sub classes are:
187 +
173 173  MemberValue
189 +
174 174  TimeRangeValue
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.
191 +)))|A collection of values for the Member Selections that, combined with other Member Selections, comprise the value content of the Cube Region.
176 176  |MemberValue|(((
177 177  Inherits from
194 +
178 178  SelectionValue
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)
196 +)))|A single value of the set of values for the Member Selection.
197 +| |value|A value of the member.
198 +| |cascadeValues|Indicates that the child nodes of the member are included in the Member Selection (e.g. child codes)
182 182  |//TimeRangeValue//|(((
183 183  Inherits from
201 +
184 184  SelectionValue
203 +
185 185  Abstract Class
205 +
186 186  Concrete Classes
207 +
187 187  BeforePeriod
209 +
188 188  AfterPeriod
211 +
189 189  RangePeriod
190 -)))|(% style="width:471px" %)A time value or values that specifies the date or dates for which the constrained selection is valid.
213 +)))|A time value or values that specifies the date or dates for which the constrained selection is valid.
191 191  |BeforePeriod|(((
192 192  Inherits from
216 +
193 193  //TimeRangeValue//
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.
218 +)))|The period before which the constrained selection is valid.
219 +| |isInclusive|Indication of whether the date is inclusive in the period.
196 196  |AfterPeriod|(((
197 197  Inherits from
222 +
198 198  //TimeRangeValue//
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.
224 +)))|The period after which the constrained selection is valid.
225 +| |isInclusive|Indication of whether the date is inclusive in the period.
226 +|RangePeriod| |The start and end periods in a date range.
227 +| |+start|Association to the Start Period.
228 +| |+end|Association to the End Period.
204 204  |StartPeriod|(((
205 205  Inherits from
231 +
206 206  //TimeRangeValue//
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.
233 +)))|The period from which the constrained selection is valid.
234 +| |isInclusive|Indication of whether the date is inclusive in the period.
209 209  |EndPeriod|(((
210 210  Inherits from
237 +
211 211  //TimeRangeValue//
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.
239 +)))|The period to which the constrained selection is valid.
240 +| |isInclusive|Indication of whether the date is inclusive in the period.
241 +|ReferencePeriod| |A set of dates that constrain the content that may be found in a data or metadata set.
242 +| |startDate|The start date of the period.
243 +| |endDate|The end date of the period.
244 +|ReleaseCalendar| |The schedule of publication or reporting of the data or metadata
245 +| |periodicity|The time period between the releases of the data or metadata
246 +| |offset|Interval between January 1^^st^^ and the first release of the data
247 +| |tolerance|Period after which the data or metadata may be deemed late.
221 221  
222 222  
250 +
251 +
252 +
253 +
1747904434659-835.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -37.4 KB
Content
1747904480223-768.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -41.6 KB
Content
1747904523939-355.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -43.6 KB
Content