Changes for page 10 Constraints

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

From 2.3 to 2.2 From 6.4 to 6.3

From version 6.3

edited by Helena
on 2025/05/22 12:02

Change comment: There is no comment for this version

To version 2.3

edited by Artur
on 2025/05/20 14:28

Change comment: Update document after refactoring.

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)
Attachments (0 modified, 0 added, 4 removed)
Objects (0 modified, 0 added, 1 removed)
- SUZ.Methodology.Code.MethodologyClass[0]

Details

Page properties

Author

@@ -1,1 +1,1 @@
--xwiki:XWiki.helena
++xwiki:XWiki.arturkryazhev

Content

@@ -1,6 +1,4 @@
--{{box title="**Contents**"}}
--{{toc/}}
--{{/box}}
++= {{id name="_Toc371061"/}}10 Constraints =
  == {{id name="_Toc371062"/}}10.1 Scope ==
@@ -18,8 +18,6 @@
  === {{id name="_Toc371064"/}}10.2.1 Class Diagram of Constrainable Artefacts - Inheritance ===
--[[image:1747904390682-586.png]]
--
  **Figure 37: Inheritance class diagram of constrainable and provisioning artefacts**
  === {{id name="_Toc371065"/}}10.2.2 Explanation of the Diagram ===
@@ -44,8 +44,6 @@
  === {{id name="_Toc371067"/}}10.3.1 Relationship Class Diagram – high level view ===
--[[image:1747904434659-835.png]]
--
  **Figure 38: Relationship class diagram showing constraint metadata**
  === {{id name="_Toc371068"/}}10.3.2 Explanation of the Diagram ===
@@ -65,12 +65,8 @@
  === {{id name="_Toc371069"/}}10.3.3 Relationship Class Diagram – Detail ===
--[[image:1747904480223-768.png]]
--
  **Figure 39: Constraints - Key Set Constraints**
--[[image:1747904523939-355.png]]
--
  **Figure 40: Constraints - Cube Region and Metadata Target Region Constraints**
  ==== 10.3.3.1 Explanation of the Diagram ====
@@ -79,10 +79,13 @@
  A //Constraint// has a choice of two ways of specifying value sub sets:
--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.
++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.
++
 . 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.
--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.
++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.
  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”.
@@ -114,8 +114,8 @@
  Definition
  )))|An artefact that can have Constraints specified.
--| |content|Associates the metadata that constrains the content to be found in a data or metadata source linked to the Constrainable Artefact.
--| |attachment|Associates the metadata that constrains the valid content of a Constrainable Artefact to which metadata may be attached.
++||content|Associates the metadata that constrains the content to be found in a data or metadata source linked to the Constrainable Artefact.
++||attachment|Associates the metadata that constrains the valid content of a Constrainable Artefact to which metadata may be attached.
  |//Constraint//|(((
  Inherits from
@@ -127,20 +127,20 @@
  ContentConstraint
  )))|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.
--| |+availableDates// &nbsp;&nbsp;&nbsp;//|Association to the time period that identifies the time range for which data or metadata are available in the data source.
--| |+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.
--| |+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
--| |+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.
--| |+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.
++||+availableDates// &nbsp;&nbsp;&nbsp;//|Association to the time period that identifies the time range for which data or metadata are available in the data source.
++||+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.
++||+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
++||+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.
++||+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.
  |ContentConstraint|(((
  Inherits from
  //Constraint//
  )))|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.
--| |+role|Association to the role that the Constraint plays
--|ConstraintRole| |Specifies the way the type of content of a Constraint in terms of its purpose.
--| |allowableContent|The Constraint contains a specification of the valid sub set of the Component values or keys.
--| |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.
++||+role|Association to the role that the Constraint plays
++|ConstraintRole||Specifies the way the type of content of a Constraint in terms of its purpose.
++||allowableContent|The Constraint contains a specification of the valid sub set of the Component values or keys.
++||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.
  |(((
  Attachment
@@ -150,24 +150,24 @@
  //Constraint//
  )))|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.
--|DataKeySet| |A set of data keys.
--| |isIncluded|Indicates whether the Data Key Set is included in the constraint definition or excluded from the constraint definition.
--| |+keys|Association to the Data Keys in the set.
--|MetadataKeySet| |A set of metadata keys.
--| |isIncluded|Indicates whether the Metadata Key Set is included in the constraint definition or excluded from the constraint definition.
--| |+keys|Association to the Metadata Keys in the set.
--|DataKey| |The values of a key in a data set.
--| |isIncluded|Indicates whether the Data Key is included in the constraint definition or excluded from the constraint definition.
--| |+keyValue|Associates the Component Values that comprise the key.
--|MetadataKey| |The values of a key in a metadata set.
--| |isIncluded|Indicates whether the Metdadata Key is included in the constraint definition or excluded from the constraint definition.
--| |+keyValue|Associates the Component Values that comprise the key.
--|ComponentValue| |The identification of and value of a Component of the key (e.g. Dimension)
--| |value|The value of Component
--| |+valueFor|Association to the Component (e.g. Dimension) in the Structure to which the Constrainable Artefact is linked.
--|TimeDimensionValue| |The value of the Time Dimension component.
--| |timeValue|The value of the time period.
--| |operator|(((
++|DataKeySet||A set of data keys.
++||isIncluded|Indicates whether the Data Key Set is included in the constraint definition or excluded from the constraint definition.
++||+keys|Association to the Data Keys in the set.
++|MetadataKeySet||A set of metadata keys.
++||isIncluded|Indicates whether the Metadata Key Set is included in the constraint definition or excluded from the constraint definition.
++||+keys|Association to the Metadata Keys in the set.
++|DataKey||The values of a key in a data set.
++||isIncluded|Indicates whether the Data Key is included in the constraint definition or excluded from the constraint definition.
++||+keyValue|Associates the Component Values that comprise the key.
++|MetadataKey||The values of a key in a metadata set.
++||isIncluded|Indicates whether the Metdadata Key is included in the constraint definition or excluded from the constraint definition.
++||+keyValue|Associates the Component Values that comprise the key.
++|ComponentValue||The identification of and value of a Component of the key (e.g. Dimension)
++||value|The value of Component
++||+valueFor|Association to the Component (e.g. Dimension) in the Structure to which the Constrainable Artefact is linked.
++|TimeDimensionValue||The value of the Time Dimension component.
++||timeValue|The value of the time period.
++||operator|(((
  Indicates whether the specified value represents and exact time or time period, or whether the value should be handled as a range.
  A value of greaterThan or greaterThanOrEqual indicates that the value is the beginning of a range (exclusive or inclusive, respectively).
@@ -176,15 +176,15 @@
  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)
  )))
--|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.
--| |isIncluded|Indicates whether the Cube Region is included in the constraint definition or excluded from the constraint definition.
--| |+member|Associates the set of Components that define the sub set of values.
--|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.
--| |isIncluded|Indicates whether the Metadata Target Region is included in the constraint definition or excluded from the constraint definition.
--| |+member|Associates the set of Components that define the sub set of values.
--|MemberSelection| |A set of permissible values for one component of the axis.
--| |isIncluded|Indicates whether the Member Selection is included in the constraint definition or excluded from the constraint definition.
--| |+valuesFor|Association to the Component in the Structure to which the Constrainable Artefact is linked, which defines the valid Representation for the Member Values.
++|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.
++||isIncluded|Indicates whether the Cube Region is included in the constraint definition or excluded from the constraint definition.
++||+member|Associates the set of Components that define the sub set of values.
++|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.
++||isIncluded|Indicates whether the Metadata Target Region is included in the constraint definition or excluded from the constraint definition.
++||+member|Associates the set of Components that define the sub set of values.
++|MemberSelection||A set of permissible values for one component of the axis.
++||isIncluded|Indicates whether the Member Selection is included in the constraint definition or excluded from the constraint definition.
++||+valuesFor|Association to the Component in the Structure to which the Constrainable Artefact is linked, which defines the valid Representation for the Member Values.
  |SelectionValue|(((
  Abstract class. Sub classes are:
@@ -197,8 +197,8 @@
  SelectionValue
  )))|A single value of the set of values for the Member Selection.
--| |value|A value of the member.
--| |cascadeValues|Indicates that the child nodes of the member are included in the Member Selection (e.g. child codes)
++||value|A value of the member.
++||cascadeValues|Indicates that the child nodes of the member are included in the Member Selection (e.g. child codes)
  |//TimeRangeValue//|(((
  Inherits from
@@ -219,38 +219,38 @@
  //TimeRangeValue//
  )))|The period before which the constrained selection is valid.
--| |isInclusive|Indication of whether the date is inclusive in the period.
++||isInclusive|Indication of whether the date is inclusive in the period.
  |AfterPeriod|(((
  Inherits from
  //TimeRangeValue//
  )))|The period after which the constrained selection is valid.
--| |isInclusive|Indication of whether the date is inclusive in the period.
--|RangePeriod| |The start and end periods in a date range.
--| |+start|Association to the Start Period.
--| |+end|Association to the End Period.
++||isInclusive|Indication of whether the date is inclusive in the period.
++|RangePeriod||The start and end periods in a date range.
++||+start|Association to the Start Period.
++||+end|Association to the End Period.
  |StartPeriod|(((
  Inherits from
  //TimeRangeValue//
  )))|The period from which the constrained selection is valid.
--| |isInclusive|Indication of whether the date is inclusive in the period.
++||isInclusive|Indication of whether the date is inclusive in the period.
  |EndPeriod|(((
  Inherits from
  //TimeRangeValue//
  )))|The period to which the constrained selection is valid.
--| |isInclusive|Indication of whether the date is inclusive in the period.
--|ReferencePeriod| |A set of dates that constrain the content that may be found in a data or metadata set.
--| |startDate|The start date of the period.
--| |endDate|The end date of the period.
--|ReleaseCalendar| |The schedule of publication or reporting of the data or metadata
--| |periodicity|The time period between the releases of the data or metadata
--| |offset|Interval between January 1^^st^^ and the first release of the data
--| |tolerance|Period after which the data or metadata may be deemed late.
++||isInclusive|Indication of whether the date is inclusive in the period.
++|ReferencePeriod||A set of dates that constrain the content that may be found in a data or metadata set.
++||startDate|The start date of the period.
++||endDate|The end date of the period.
++|ReleaseCalendar||The schedule of publication or reporting of the data or metadata
++||periodicity|The time period between the releases of the data or metadata
++||offset|Interval between January 1^^st^^ and the first release of the data
++||tolerance|Period after which the data or metadata may be deemed late.
--
++

1747904390682-586.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.helena

Size

...	...	@@ -1,1 +1,0 @@
1		-16.9 KB

Content

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

SUZ.Methodology.Code.MethodologyClass[0]

index

...	...	@@ -1,1 +1,0 @@
1		-11