Skip to Content

Changes for page 12 Constraints

Last modified by Helena on 2025/09/10 11:19
From version 6.1
edited by Helena
on 2025/06/08 15:36
Change comment: There is no comment for this version
To version 9.1
edited by Helena
on 2025/09/10 11:19
Change comment: Migrated property [LightLLMprompt] from class [SKMS.Methodology.Code.MethodologyClass]

Summary

Details

Page properties
Tags
... ... @@ -1,0 +1,1 @@
1 +Artefact|Attribute|Code|Code list|Component|Constraint|Data provider|Data set|Data source|Data structure definition|Dataflow|Dimension|Maintainable artefact|Member selection|Metadata structure definition|Metadataflow|Provision agreement|Representation|Time period|isIncluded
Content
... ... @@ -4,13 +4,13 @@
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:sdmx: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:#e74c3c" %)//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:sdmx:Glossary.Artefact.WebHome]] to which the (% style="color:#e74c3c" %)//Constraint//(%%) is attached e.g., DataStructureDefinition, [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], ProvisionAgreement, MetadataStructureDefinition, [[Metadataflow>>doc:sdmx: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>>doc:sdmx: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:#e74c3c" %)//[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]//(%%) is also used to specify a subset of a [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] which may be used as a partial [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]], relevant in the context of the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] to which the (% style="color:#e74c3c" %)//[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]//(%%) is attached e.g., DataStructureDefinition, [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], ProvisionAgreement, MetadataStructureDefinition, [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], MetadataProvisionAgreement.
8 8  
9 9  Note that in this metamodel the term [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] refers to both data and metadata providers.
10 10  
11 11  The [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:sdmx: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.
12 12  
13 -These specifications are called (% style="color:#e74c3c" %)//Constraint//(%%) in this model.
13 +These specifications are called (% style="color:#e74c3c" %)//[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]//(%%) in this model.
14 14  
15 15  == 12.2 Inheritance ==
16 16  
... ... @@ -24,7 +24,7 @@
24 24  
25 25  ==== 12.2.2.1 Narrative ====
26 26  
27 -Any [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that inherits from the //ConstrainableArtefact// interface can have (% style="color:#e74c3c" %)constraints(%%) defined. The [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that can have (% style="color:#e74c3c" %)constraint(%%) metadata attached are:
27 +Any [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that inherits from the //ConstrainableArtefact// interface can have (% style="color:#e74c3c" %)[[constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) defined. The [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that can have (% style="color:#e74c3c" %)[[constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) metadata attached are:
28 28  
29 29  [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]
30 30  ProvisionAgreement
... ... @@ -35,7 +35,7 @@
35 35  MetadataProvisionAgreement
36 36  MetadataStructureDefinition
37 37  
38 -Note that, because the (% style="color:#e74c3c" %)//Constraint//(%%) can specify a subset of the [[component>>doc:sdmx: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:#e74c3c" %)//Constraint//(%%) itself may not be linked directly to a DataStructureDefinition or MetadataStructureDefinition, the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that it is constraining will be linked to a DataStructureDefinition or MetadataStructureDefinition. A DataProvider and MetadataProvider indirectly refernece DSDs and MSDs through their associated Data and Metadata [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] as such these (% style="color:#e74c3c" %)Constraints(%%) are restricted to Cube Regions and are applicable only to the DSDs / MSDs which contain the Componets being restricted.
38 +Note that, because the (% style="color:#e74c3c" %)//[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]//(%%) can specify a subset of the [[component>>doc:sdmx: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:#e74c3c" %)//[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]//(%%) itself may not be linked directly to a DataStructureDefinition or MetadataStructureDefinition, the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that it is constraining will be linked to a DataStructureDefinition or MetadataStructureDefinition. A DataProvider and MetadataProvider indirectly refernece DSDs and MSDs through their associated Data and Metadata [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] as such these (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) are restricted to Cube Regions and are applicable only to the DSDs / MSDs which contain the Componets being restricted.
39 39  
40 40  == 12.3 Constraints ==
41 41  
... ... @@ -49,18 +49,18 @@
49 49  
50 50  ==== 12.3.2.1 Narrative ====
51 51  
52 -The (% style="color:#e74c3c" %)constraint(%%) mechanism allows specific (% style="color:#e74c3c" %)constraints(%%) to be attached to a //ConstrainableArtefact//. These (% style="color:#e74c3c" %)constraints(%%) specify a subset of the total set of values or keys that may be present in any of the //ConstrainableArtefacts//.
52 +The (% style="color:#e74c3c" %)[[constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) mechanism allows specific (% style="color:#e74c3c" %)[[constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) to be attached to a //ConstrainableArtefact//. These (% style="color:#e74c3c" %)[[constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) specify a subset of the total set of values or keys that may be present in any of the //ConstrainableArtefacts//.
53 53  
54 54  For instance, a DataStructureDefinition specifies, for each [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], the list of allowable [[code>>doc:sdmx:Glossary.Code.WebHome]] values. However, a specific [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] that uses the
55 55  
56 -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:sdmx:Glossary.Dimension.WebHome]] values). In addition to this, a DataProvider that is capable of supplying data according to the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] has a ProvisionAgreement, and the DataProvider may also wish to supply (% style="color:#e74c3c" %)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:sdmx:Glossary.Data source.WebHome]] in terms of the KeySets or CubeRegions contained within it.
56 +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:sdmx:Glossary.Dimension.WebHome]] values). In addition to this, a DataProvider that is capable of supplying data according to the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] has a ProvisionAgreement, and the DataProvider may also wish to supply (% style="color:#e74c3c" %)[[constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) 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:sdmx:Glossary.Data source.WebHome]] in terms of the KeySets or CubeRegions contained within it.
57 57  
58 -A //ConstrainableArtefact// can have two types of (% style="color:#e74c3c" %)//Constraint//(%%)s:
58 +A //ConstrainableArtefact// can have two types of (% style="color:#e74c3c" %)//[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]//(%%)s:
59 59  
60 60  1. DataConstraint – is used as a mechanism to specify the set of keys (DataKeySet), or set of [[component>>doc:sdmx:Glossary.Component.WebHome]] values (CubeRegion) that can be reported against the target ConstrainableArtefact. Multiple such DataConstraints may be present for a //ConstrainableArtefact//.
61 61  1. MetadataConstraint – is used as a mechanism to specify a set of [[component>>doc:sdmx:Glossary.Component.WebHome]] values (MetadatTargetRegion) that can be reported against the target ConstrainableArtefact. Multiple such MetadataConstraints may be present for a //ConstrainableArtefact//.
62 62  
63 -Note also that another possible type of a (% style="color:#e74c3c" %)Constraint(%%) is available; that is a AvailableDataConstraint, this is used to report the data that exists in a [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. An AvailableDataConstraint is not a [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] as it is geneated dynamically based on the query. An AvailableDataConstraint contains only 1 Cube Region which is used to specify the valid values per [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] that is is attached to.
63 +Note also that another possible type of a (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) is available; that is a AvailableDataConstraint, this is used to report the data that exists in a [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. An AvailableDataConstraint is not a [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] as it is geneated dynamically based on the query. An AvailableDataConstraint contains only 1 Cube Region which is used to specify the valid values per [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] that is is attached to.
64 64  
65 65  === 12.3.3 Relationship Class Diagram – Detail ===
66 66  
... ... @@ -70,7 +70,7 @@
70 70  
71 71  ==== 12.3.3.1 Explanation of the Diagram ====
72 72  
73 -A (% style="color:#e74c3c" %)//Constraint//(%%) is a //MaintainableArtefact//.
73 +A (% style="color:#e74c3c" %)//[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]//(%%) is a //MaintainableArtefact//.
74 74  
75 75  A DataConstraint has a choice of two ways of specifying value subsets:
76 76  
... ... @@ -94,9 +94,9 @@
94 94  * "false" (default), or
95 95  * "excludeRoot", where all children are included, and the root [[Code>>doc:sdmx:Glossary.Code.WebHome]] is excluded (i.e. the referenced [[Code>>doc:sdmx:Glossary.Code.WebHome]]).
96 96  
97 -It is possible to define for the DataKeySet, DataKey, CubeRegion, MetadataTargetRegion and MemberSelection whether the set is included ([[isIncluded>>doc:sdmx:Glossary.isIncluded.WebHome]] = "true", default) or excluded ([[isIncluded>>doc:sdmx:Glossary.isIncluded.WebHome]] = "false") from the (% style="color:#e74c3c" %)Constraint(%%) definition. This [[attribute>>doc:sdmx: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:#e74c3c" %)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 +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:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) definition. This [[attribute>>doc:sdmx: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:#e74c3c" %)[[constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%). 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”.
98 98  
99 -In any MemberSelection that the corresponding //[[Component>>doc:sdmx: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:sdmx:Glossary.Code.WebHome]]. This is achieved via property removePrefix, which defaults to “false”.
99 +In any MemberSelection that the corresponding //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// was using [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] with extensions, it is possible to remove the prefix that has been used, in order to refer to the original [[Codes>>doc:sdmx:Glossary.Code.WebHome]]. This is achieved via property removePrefix, which defaults to “false”.
100 100  
101 101  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.
102 102  
... ... @@ -117,7 +117,7 @@
117 117  ProvisionAgreement
118 118  //QueryDatasource//
119 119  SimpleDatasource
120 -)))|(% style="width:572px" %)An [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that can have (% style="color:#e74c3c" %)Constraints(%%) specified.
120 +)))|(% style="width:572px" %)An [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that can have (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) specified.
121 121  |(% style="width:183px" %) |(% style="width:224px" %)content|(% style="width:572px" %)Associates the metadata that constrains the content to be found in a data or metadata source linked to the Constrainable [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]].
122 122  |(% style="width:183px" %)(% style="color:#e74c3c" %)//Constraint//|(% style="width:224px" %)(((
123 123  Inherits from
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,1 +1,0 @@
1 -13
SKMS.Methodology.Code.MethodologyClass[0]
Index
... ... @@ -1,0 +1,1 @@
1 +13