Skip to Content

Changes for page 12 Constraints

Last modified by Artur on 2025/09/10 11:19
From version 9.1
edited by Helena
on 2025/05/16 23:27
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
... ... @@ -4,15 +4,15 @@
4 4  
5 5  == 12.1 Scope ==
6 6  
7 -The scope of this section is to describe the support in the metamodel for specifying both the access to and the content of a [[data source>>doc:xwiki:Glossary.Data source.WebHome]]. The information may be stored in a resource such as a registry for use by applications wishing to locate data and metadata which are available via the Internet. The (% style="color:#2ecc71" %)//Constraint//(%%) is also used to specify a subset of a Codelist which may be used as a partial Codelist, relevant in the context of the [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] to which the (% style="color:#2ecc71" %)//Constraint//(%%) is attached e.g., DataStructureDefinition, [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]], ProvisionAgreement, MetadataStructureDefinition, [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]], MetadataProvisionAgreement.
7 +The scope of this section is to describe the support in the metamodel for specifying both the access to and the content of a data source. The information may be stored in a resource such as a registry for use by applications wishing to locate data and metadata which are available via the Internet. The //Constraint// is also used to specify a subset of a Codelist which may be used as a partial Codelist, relevant in the context of the artefact to which the //Constraint// is attached e.g., DataStructureDefinition, Dataflow, ProvisionAgreement, MetadataStructureDefinition, Metadataflow, MetadataProvisionAgreement.
8 8  
9 -Note that in this metamodel the term [[data source>>doc:xwiki:Glossary.Data source.WebHome]] refers to both data and metadata sources, and [[data provider>>doc:xwiki:Glossary.Data provider.WebHome]] refers to both data and metadata providers.
9 +Note that in this metamodel the term data source refers to both data and metadata sources, and data provider refers to both data and metadata providers.
10 10  
11 -A [[data source>>doc:xwiki:Glossary.Data source.WebHome]] may be a simple file of data or metadata (in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]], JSON or other format), or a database or [[metadata repository>>doc:xwiki:Glossary.Metadata repository.WebHome]]. A [[data source>>doc:xwiki:Glossary.Data source.WebHome]] may contain data for many data or [[metadata flows>>doc:xwiki:Glossary.Metadataflow.WebHome]] (called [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]], and [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] in the model), and the mechanisms described in this section allow an organisation to specify precisely the scope of the content of the [[data source>>doc:xwiki:Glossary.Data source.WebHome]] where this [[data source>>doc:xwiki:Glossary.Data source.WebHome]] is registered (SimpleDataSource, //QueryDataSource//).
11 +A data source may be a simple file of data or metadata (in SDMX-ML, JSON or other format), or a database or metadata repository. A data source may contain data for many data or metadata flows (called Dataflow, and Metadataflow in the model), and the mechanisms described in this section allow an organisation to specify precisely the scope of the content of the data source where this data source is registered (SimpleDataSource, //QueryDataSource//).
12 12  
13 -The [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]], themselves may be specified as containing only a subset of all the possible keys that could be derived from a DataStructureDefinition or MetadataStructureDefinition. Respectively, further subsets may be defined within a ProvisionAgreement and MetadataProvisionAgreement.
13 +The Dataflow and Metadataflow, themselves may be specified as containing only a subset of all the possible keys that could be derived from a DataStructureDefinition or MetadataStructureDefinition. Respectively, further subsets may be defined within a ProvisionAgreement and MetadataProvisionAgreement.
14 14  
15 -These specifications are called (% style="color:#2ecc71" %)//Constraint//(%%) in this model.
15 +These specifications are called //Constraint// in this model.
16 16  
17 17  == 12.2 Inheritance ==
18 18  
... ... @@ -26,7 +26,7 @@
26 26  
27 27  ==== 12.2.2.1 Narrative ====
28 28  
29 -Any [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] that inherits from the //ConstrainableArtefact// interface can have (% style="color:#2ecc71" %)constraints(%%) defined. The [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] that can have (% style="color:#2ecc71" %)constraint(%%) metadata attached are:
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 32  ProvisionAgreement
... ... @@ -36,10 +36,10 @@
36 36  MetaDataProvider – this is restricted to release calendar
37 37  MetadataProvisionAgreement
38 38  MetadataSetMetadataStructureDefinition
39 -SimpleDataSource – this is a registered [[data source>>doc:xwiki:Glossary.Data source.WebHome]] where the registration references the actual [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]] or Metadata Set
39 +SimpleDataSource – this is a registered data source where the registration references the actual Data Set or Metadata Set
40 40  //QueryDataSource//
41 41  
42 -Note that, because the (% style="color:#2ecc71" %)//Constraint//(%%) can specify a subset of the [[component>>doc:xwiki:Glossary.Component.WebHome]] 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 (% style="color:#2ecc71" %)//Constraint//(%%) itself may not be linked directly to a DataStructureDefinition or MetadataStructureDefinition, the [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] 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>>doc:xwiki:Glossary.Data structure definition.WebHome]] or [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] the type of information that can be contained in a (% style="color:#2ecc71" %)Constraint(%%) linked to a DataProvider/MetadataProvider is restricted to ReleaseCalendar.
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.
43 43  
44 44  == 12.3 Constraints ==
45 45  
... ... @@ -53,18 +53,18 @@
53 53  
54 54  ==== 12.3.2.1 Narrative ====
55 55  
56 -The (% style="color:#2ecc71" %)constraint(%%) mechanism allows specific (% style="color:#2ecc71" %)constraints(%%) to be attached to a //ConstrainableArtefact//. With the exception of ReleaseCalendar these (% style="color:#2ecc71" %)constraints(%%) specify a subset of the total set of values or keys that may be present in any of the //ConstrainableArtefacts//.
56 +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//.
57 57  
58 -For instance, a DataStructureDefinition specifies, for each [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], the list of allowable [[code>>doc:xwiki:Glossary.Code.WebHome]] values. However, a specific [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] 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>>doc:xwiki:Glossary.Dimension.WebHome]] values). In addition to this, a DataProvider that is capable of supplying data according to the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] has a ProvisionAgreement, and the DataProvider may also wish to supply (% style="color:#2ecc71" %)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>>doc:xwiki:Glossary.Data source.WebHome]] in terms of the KeySets or CubeRegions contained within it.
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.
59 59  
60 -A //ConstrainableArtefact// can have two types of (% style="color:#2ecc71" %)//Constraint//(%%)s:
60 +A //ConstrainableArtefact// can have two types of //Constraint//s:
61 61  
62 -1. DataConstraint – is used as a mechanism to specify, either the available set of keys (DataKeySet), or set of [[component>>doc:xwiki:Glossary.Component.WebHome]] 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>>doc:xwiki:Glossary.Code list.WebHome]] for one [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], while another provides the validation for another [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] within the same DSD.
63 -1. MetadataConstraint – is used as a mechanism to specify a set of [[component>>doc:xwiki:Glossary.Component.WebHome]] values (MetadatTargetRegion) in a //DataSource// such as a MetadataSet or a database (//QueryDatasource//). Multiple such MetadataConstraints may be present for a //ConstrainableArtefact//. For instance, there may be a MetadataConstraint that specifies the values allowed for the //ConstrainableArtefact //(role is allowableContent) which can be used for validation or for constructing a partial [[code list>>doc:xwiki:Glossary.Code list.WebHome]], whilst another MetadataConstraint can specify the actual content of a metadata source (role is actualContent).
62 +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.
63 +1. MetadataConstraint – is used as a mechanism to specify a set of component values (MetadatTargetRegion) in a //DataSource// such as a MetadataSet or a database (//QueryDatasource//). Multiple such MetadataConstraints may be present for a //ConstrainableArtefact//. For instance, there may be a MetadataConstraint that specifies the values allowed for the //ConstrainableArtefact //(role is allowableContent) which can be used for validation or for constructing a partial code list, whilst another MetadataConstraint can specify the actual content of a metadata source (role is actualContent).
64 64  
65 -In addition to DataKeySet and/or CubeRegion/MetadataTargetRegion a (% style="color:#2ecc71" %)Constraint(%%) can have a ReleaseCalendar specifying when data or metadata are released for publication or reporting.
65 +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.
66 66  
67 -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>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Web Service contains. This type of DataConstraint is not maintained in a Registry and is always a response to the data availability [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] REST API. Thus, its identification is autogenerated by the service responding to a data availability request.
67 +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.
68 68  
69 69  === 12.3.3 Relationship Class Diagram – Detail ===
70 70  
... ... @@ -74,28 +74,28 @@
74 74  
75 75  ==== 12.3.3.1 Explanation of the Diagram ====
76 76  
77 -A (% style="color:#2ecc71" %)//Constraint//(%%) is a //MaintainableArtefact//.
77 +A //Constraint// is a //MaintainableArtefact//.
78 78  
79 79  A DataConstraint has a choice of two ways of specifying value subsets:
80 80  
81 -1. As a set of keys that can be present in the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]// (DataKeySet). Each DataKey specifies a number of ComponentValues each of which reference a //[[Component>>doc:xwiki:Glossary.Component.WebHome]]// (e.g., [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], DataAttribute). Each ComponentValue is a value that may be present for a //[[Component>>doc:xwiki:Glossary.Component.WebHome]]// of a structure when contained in a //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//. In addition, each DataKeySet may also include MemberSelections for AttributeComponents or [[Measures>>doc:xwiki:Glossary.Measure.WebHome]].
82 -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>>doc:xwiki:Glossary.Component.WebHome]]// of a structure when contained in a //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//.
81 +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.
82 +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//.
83 83  
84 -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>>doc:xwiki:Glossary.Component.WebHome]]//s but does not specify specific key combinations. In addition, in (1) the association between //[[Component>>doc:xwiki:Glossary.Component.WebHome]]// and DataKeyValue is constrained to the [[components>>doc:xwiki:Glossary.Component.WebHome]] that comprise the key, whereas in (2) it can contain other [[component>>doc:xwiki:Glossary.Component.WebHome]] types (such as AttributeComponents or [[Measures>>doc:xwiki:Glossary.Measure.WebHome]]). By adding MemberSelections to the DataKeySets of (1), AttributeComponents and [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] are constrained for the related DataKeys.
84 +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.
85 85  
86 86  A MetadataConstraint has only one way of specifying value subsets:
87 87  
88 -~1. As a set of MetadataTargetRegions 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>>doc:xwiki:Glossary.Component.WebHome]]// of a structure when contained in a MetadataSet.
88 +~1. As a set of MetadataTargetRegions 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 MetadataSet.
89 89  
90 -In both CubeRegion and MetadataTargetRegion, the value in ComponentValue.value and MemberValue.value must be consistent with the //[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]// declared for the //[[Component>>doc:xwiki:Glossary.Component.WebHome]]// in the DataStructureDefinition ([[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] or DataAttribute) or MetadataStructureDefinition (MetadataAttribute). Note that in all cases the "operator" on the value is deemed to be "equals", unless the wildcard character is used '%'. In the latter case the "operation" is a partial matching, where the percentage character ('%') may match zero or more characters. Furthermore, it is possible in a MemberValue to specify that child values (e.g., child [[codes>>doc:xwiki:Glossary.Code.WebHome]]) are included in the (% style="color:#2ecc71" %)Constraint(%%) by means of the cascadeValues [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]]. The latter may take the following values:
90 +In both CubeRegion and MetadataTargetRegion, the value in ComponentValue.value and MemberValue.value must be consistent with the //Representation// declared for the //Component// in the DataStructureDefinition (Dimension or DataAttribute) or MetadataStructureDefinition (MetadataAttribute). Note that in all cases the "operator" on the value is deemed to be "equals", unless the wildcard character is used '%'. In the latter case the "operation" is a partial matching, where the percentage character ('%') may match zero or more characters. 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 latter may take the following values:
91 91  
92 92  * "true": all children are included,
93 93  * "false" (default), or
94 -* " excludeRoot", where all children are included, and the root [[Code>>doc:xwiki:Glossary.Code.WebHome]] is excluded (i.e. the referenced [[Code>>doc:xwiki:Glossary.Code.WebHome]]).
94 +* " excludeRoot", where all children are included, and the root Code is excluded (i.e. the referenced Code).
95 95  
96 -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 (% style="color:#2ecc71" %)Constraint(%%) definition. This [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] 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 (% style="color:#2ecc71" %)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”.
96 +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”.
97 97  
98 -In any MemberSelection that the corresponding //[[Component>>doc:xwiki:Glossary.Component.WebHome]]// was using Codelist with extensions, it is possible to remove the prefix that has been used, in order to refer to the original [[Codes>>doc:xwiki:Glossary.Code.WebHome]]. This is achieved via property removePrefix, which defaults to “false”.
98 +In any MemberSelection that the corresponding //Component// was using Codelist with extensions, it is possible to remove the prefix that has been used, in order to refer to the original Codes. This is achieved via property removePrefix, which defaults to “false”.
99 99  
100 100  In DataKeys and MemberValues it is possible, via the validFrom and validTo properties, to set a validity period for which the selected key or value is constrained.
101 101  
... ... @@ -103,140 +103,169 @@
103 103  
104 104  (% style="width:908.294px" %)
105 105  |**Class**|**Feature**|(% style="width:442px" %)**Description**
106 -|//ConstrainableArtefact//|(((
106 +|//ConstrainableArt efact//|(((
107 107  Abstract Class Sub classes are:
108 +
108 108  Dataflow
110 +
109 109  DataProvider
112 +
110 110  DataStructureDefinition
114 +
111 111  Metadataflow
116 +
112 112  MetadataProvisionAgreement
118 +
113 113  MetadataSet
120 +
114 114  MetadataStructureDefinition
122 +
115 115  ProvisionAgreement
124 +
116 116  //QueryDatasource//
126 +
117 117  SimpleDatasource
118 -)))|(% style="width:442px" %)An [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] that can have (% style="color:#2ecc71" %)Constraints(%%) specified.
119 -| |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>>doc:xwiki:Glossary.Artefact.WebHome]].
120 -|(%%)(% style="color:#2ecc71" %)//Constraint//|(((
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.
130 +|//Constraint//|(((
121 121  Inherits from
132 +
122 122  //MaintainableArtefact//
134 +
123 123  Abstract class Sub classes are:
136 +
124 124  DataConstraint
138 +
125 125  MetadataConstraint
126 -)))|(% 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>>doc:xwiki:Glossary.Code list.WebHome]] and other valid content.
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.
127 127  | |+dataContentKeys|(% style="width:442px" %)(((
128 128  Association to a subset of Data
129 129  
130 -Key Sets (i.e., value combinations) that can be derived from the definition of the structure to which the Constrainable [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] is linked.
144 +Key Sets (i.e., value combinations) that can be derived from the definition of the structure to which the Constrainable Artefact is linked.
131 131  )))
132 132  | |+dataContentRegion|(% style="width:442px" %)(((
133 -Association to a subset of [[component>>doc:xwiki:Glossary.Component.WebHome]] values that can be derived from the Data Structure
147 +Association to a subset of component values that can be derived from the Data Structure
134 134  
135 -Definition to which the Constrainable [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] is linked.
149 +Definition to which the Constrainable Artefact is linked.
136 136  )))
137 -| |+metadataContentRegion|(% style="width:442px" %)Association to a subset of [[component>>doc:xwiki:Glossary.Component.WebHome]] values that can be derived from the [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] to which the Constrainable [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] is linked.
138 -| |role|(% style="width:442px" %)Association to the role that the (% style="color:#2ecc71" %)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
139 139  |DataConstraint|(((
140 140  Inherits from
141 -(% style="color:#2ecc71" %)//Constraint//
142 -)))|(% style="width:442px" %)Defines a (% style="color:#2ecc71" %)Constraint(%%) in terms of the content that can be found in [[data sources>>doc:xwiki:Glossary.Data source.WebHome]] linked to the Constrainable [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] to which this (% style="color:#2ecc71" %)constraint(%%) is associated.
143 -|ConstraintRoleType| |(% style="width:442px" %)Specifies the way the type of content of a (% style="color:#2ecc71" %)Constraint(%%) in terms of its purpose.
144 -| |allowableContent|(% style="width:442px" %)The (% style="color:#2ecc71" %)Constraint(%%) contains a specification of the valid subset of the [[Component>>doc:xwiki:Glossary.Component.WebHome]] values or keys.
145 -| |actualContent|(% style="width:442px" %)The (% style="color:#2ecc71" %)Constraint(%%) contains a specification of the actual content of a data or metadata source in terms of the [[Component>>doc:xwiki:Glossary.Component.WebHome]] values or keys in the source.
155 +//Constraint//
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.
146 146  |MetadataConstrai nt|(((
147 147  Inherits from
148 -(% style="color:#2ecc71" %)//Constraint//
149 -)))|(% style="width:442px" %)Defines a (% style="color:#2ecc71" %)Constraint(%%) in terms of the content that can be found in metadata sources linked to the Constrainable [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] to which this (% style="color:#2ecc71" %)constraint(%%) is associated.
162 +//Constraint//
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.
150 150  |DataKeySet| |(% style="width:442px" %)A set of data keys.
151 -| |isIncluded|(% style="width:442px" %)Indicates whether the Data Key Set is included in the (% style="color:#2ecc71" %)constraint(%%) definition or excluded from the (% style="color:#2ecc71" %)constraint(%%) definition.
165 +| |isIncluded|(% style="width:442px" %)Indicates whether the Data Key Set is included in the constraint definition or excluded from the constraint definition.
152 152  | |+keys|(% style="width:442px" %)Association to the Data Keys in the set.
153 -| |+member|(% style="width:442px" %)Association to the selection of a value subset for [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] and [[Measures>>doc:xwiki:Glossary.Measure.WebHome]].
167 +| |+member|(% style="width:442px" %)Association to the selection of a value subset for Attributes and Measures.
154 154  |DataKey| |(% style="width:442px" %)The values of a key in a data set.
155 -| |isIncluded|(% style="width:442px" %)Indicates whether the Data Key is included in the (% style="color:#2ecc71" %)constraint(%%) definition or excluded from the (% style="color:#2ecc71" %)constraint(%%) definition.
169 +| |isIncluded|(% style="width:442px" %)Indicates whether the Data Key is included in the constraint definition or excluded from the constraint definition.
156 156  | |+keyValue|(% style="width:442px" %)(((
157 -Associates the [[Component>>doc:xwiki:Glossary.Component.WebHome]]
171 +Associates the Component
158 158  
159 159  Values that comprise the key.
160 160  )))
161 161  | |validFrom|(% style="width:442px" %)Date from which the Data Key is valid.
162 162  | |validTo|(% style="width:442px" %)Date from which the Data Key is superseded.
163 -|ComponentValue| |(% style="width:442px" %)The identification and value of a [[Component>>doc:xwiki:Glossary.Component.WebHome]] of the key (e.g., [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]])
164 -| |value|(% style="width:442px" %)The value of [[Component>>doc:xwiki:Glossary.Component.WebHome]]
165 -| |+valueFor|(% style="width:442px" %)Association to the [[Component>>doc:xwiki:Glossary.Component.WebHome]] (e.g., [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]]) in the Structure to which the Constrainable [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] is linked.
166 -|TimeDimensionValue| |(% style="width:442px" %)The value of the Time [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[component>>doc:xwiki:Glossary.Component.WebHome]].
167 -| |timeValue|(% style="width:442px" %)The value of the [[time period>>doc:xwiki:Glossary.Time period.WebHome]].
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.
168 168  | |operator|(% style="width:442px" %)(((
169 -Indicates whether the specified value represents and exact time or [[time period>>doc:xwiki:Glossary.Time period.WebHome]], or whether the value should be handled as a range.
183 +Indicates whether the specified value represents and exact time or time period, or whether the value should be handled as a range.
170 170  A value of greaterThan or greaterThanOrEqual indicates that the value is the beginning of a range (exclusive or inclusive, respectively).
171 171  A value of lessThan or lessThanOrEqual indicates that the value is the end or a range (exclusive or inclusive, respectively).
172 -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>>doc:xwiki:Glossary.Time period.WebHome]] after the beginning of the provided [[time period>>doc:xwiki:Glossary.Time period.WebHome]] for greaterThanOrEqual)
186 +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)
173 173  )))
174 -|CubeRegion| |(% style="width:442px" %)A set of [[Components>>doc:xwiki:Glossary.Component.WebHome]] 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>>doc:xwiki:Glossary.Artefact.WebHome]] is linked.
175 -| |isIncluded|(% style="width:442px" %)Indicates whether the Cube Region is included in the (% style="color:#2ecc71" %)constraint(%%) definition or excluded from the (% style="color:#2ecc71" %)constraint(%%) definition.
176 -| |+member|(% style="width:442px" %)Associates the set of [[Components>>doc:xwiki:Glossary.Component.WebHome]] that define the subset of values.
177 -|MetadataTargetRegion| |(% style="width:442px" %)A set of [[Components>>doc:xwiki:Glossary.Component.WebHome]] 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>>doc:xwiki:Glossary.Artefact.WebHome]] is linked.
178 -| |isIncluded|(% style="width:442px" %)Indicates whether the Metadata Target Region is included in the (% style="color:#2ecc71" %)constraint(%%) definition or excluded from the (% style="color:#2ecc71" %)constraint(%%) definition.
179 -| |+member|(% style="width:442px" %)Associates the set of [[Components>>doc:xwiki:Glossary.Component.WebHome]] that define the subset of values.
180 -|MemberSelection| |(% style="width:442px" %)A set of permissible values for one [[component>>doc:xwiki:Glossary.Component.WebHome]] of the axis.
181 -| |isIncluded|(% style="width:442px" %)Indicates whether the [[Member Selection>>doc:xwiki:Glossary.Member selection.WebHome]] is included in the (% style="color:#2ecc71" %)constraint(%%) definition or excluded from the (% style="color:#2ecc71" %)constraint(%%) definition.
182 -| |removePrefix|(% style="width:442px" %)Indicates whether the [[Codes>>doc:xwiki:Glossary.Code.WebHome]] should keep or not the prefix, as defined in the extension of Codelist.
183 -| |+valuesFor|(% style="width:442px" %)Association to the [[Component>>doc:xwiki:Glossary.Component.WebHome]] in the Structure to which the Constrainable [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] is linked, which defines the valid [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] 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.
184 184  |//SelectionValue//|(((
185 185  Abstract class. Sub classes are:
200 +
186 186  MemberValue
202 +
187 187  //TimeRangeValue//
204 +
188 188  LocalisedMemberValue
189 -)))|(% style="width:442px" %)A collection of values for the [[Member Selections>>doc:xwiki:Glossary.Member selection.WebHome]] that, combined with other [[Member Selections>>doc:xwiki:Glossary.Member selection.WebHome]], comprise the value content of the Cube Region.
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.
190 190  | |validFrom|(% style="width:442px" %)Date from which the Selection Value is valid.
191 191  | |validTo|(% style="width:442px" %)Date from which the Selection Value is superseded.
192 192  |MemberValue|(((
193 193  Inherits from
211 +
194 194  //SelectionValue//
195 -)))|(% style="width:442px" %)A single value of the set of values for the [[Member Selection>>doc:xwiki:Glossary.Member selection.WebHome]].
213 +)))|(% style="width:442px" %)A single value of the set of values for the Member Selection.
196 196  | |value|(% style="width:442px" %)A value of the member.
197 -| |cascadeValues|(% style="width:442px" %)Indicates that the child nodes of the member are included in the [[Member Selection>>doc:xwiki:Glossary.Member selection.WebHome]] (e.g., child [[codes>>doc:xwiki:Glossary.Code.WebHome]])
198 -|LocalisedMemberValue|(((
215 +| |cascadeValues|(% style="width:442px" %)Indicates that the child nodes of the member are included in the Member Selection (e.g., child codes)
216 +|LocalisedMemberV alue|(((
199 199  Inherits from
218 +
200 200  //SelectionValue//
201 -)))|(% style="width:442px" %)A single localised value of the set of values for a [[Member Selection>>doc:xwiki:Glossary.Member selection.WebHome]].
220 +)))|(% style="width:442px" %)A single localised value of the set of values for a Member Selection.
202 202  | |value|(% style="width:442px" %)A value of the member.
203 -| |locale|(% style="width:442px" %)The locale that the values must adhere to in the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]].
222 +| |locale|(% style="width:442px" %)The locale that the values must adhere to in the dataset.
204 204  |//TimeRangeValue//|(((
205 205  Inherits from
225 +
206 206  //SelectionValue//
227 +
207 207  Abstract Class Concrete Classes:
229 +
208 208  BeforePeriod
231 +
209 209  AfterPeriod
233 +
210 210  RangePeriod
211 211  )))|(% style="width:442px" %)A time value or values that specifies the date or dates for which the constrained selection is valid.
212 212  |BeforePeriod|(((
213 213  Inherits from
238 +
214 214  //TimeRangeValue//
215 215  )))|(% style="width:442px" %)The period before which the constrained selection is valid.
216 216  | |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
217 -| |period|(% style="width:442px" %)The [[time period>>doc:xwiki:Glossary.Time period.WebHome]] which acts as the latest possible reported period
242 +| |period|(% style="width:442px" %)The time period which acts as the latest possible reported period
218 218  |AfterPeriod|(((
219 219  Inherits from
245 +
220 220  //TimeRangeValue//
221 221  )))|(% style="width:442px" %)The period after which the constrained selection is valid.
222 222  | |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
223 -| |period|(% style="width:442px" %)The [[time period>>doc:xwiki:Glossary.Time period.WebHome]] which acts as the earliest possible reported period
249 +| |period|(% style="width:442px" %)The time period which acts as the earliest possible reported period
224 224  |RangePeriod| |(% style="width:442px" %)The start and end periods in a date range.
225 225  | |+start|(% style="width:442px" %)Association to the Start Period.
226 226  | |+end|(% style="width:442px" %)Association to the End Period.
227 227  |StartPeriod|(((
228 228  Inherits from
255 +
229 229  //TimeRangeValue//
230 230  )))|(% style="width:442px" %)The period from which the constrained selection is valid.
231 231  | |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
232 -| |period|(% style="width:442px" %)The [[time period>>doc:xwiki:Glossary.Time period.WebHome]] which acts as the start of the range
259 +| |period|(% style="width:442px" %)The time period which acts as the start of the range
233 233  |EndPeriod|(((
234 234  Inherits from
262 +
235 235  //TimeRangeValue//
236 236  )))|(% style="width:442px" %)The period to which the constrained selection is valid.
237 237  | |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
238 -| |period|(% style="width:442px" %)The [[time period>>doc:xwiki:Glossary.Time period.WebHome]] which acts as the end of the range
266 +| |period|(% style="width:442px" %)The time period which acts as the end of the range
239 239  |ReleaseCalendar| |(% style="width:442px" %)The schedule of publication or reporting of the data or metadata
240 -| |periodicity|(% style="width:442px" %)The [[time period>>doc:xwiki:Glossary.Time period.WebHome]] between the releases of the data or metadata
268 +| |periodicity|(% style="width:442px" %)The time period between the releases of the data or metadata
241 241  | |offset|(% style="width:442px" %)Interval between January 1^^st^^ and the first release of the data
242 242  | |tolerance|(% style="width:442px" %)Period after which the data or metadata may be deemed late.
271 +