Changes for page 12 Constraints

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

From 9.5 to 9.4 From 14.1 to 13.1

From version 13.1

edited by Artur
on 2025/05/22 14:56

Change comment: There is no comment for this version

To version 9.5

edited by Helena
on 2025/05/19 14:26

Change comment: Update document after refactoring.

Raw
Rendered

Summary

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

Details

Page properties

Author

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

Content

@@ -4,15 +4,15 @@
  == 12.1 Scope ==
--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: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:Glossary.Artefact.WebHome]] to which the (% style="color:#e74c3c" %)//Constraint//(%%) is attached e.g., DataStructureDefinition, [[Dataflow>>doc:Glossary.Dataflow.WebHome]], ProvisionAgreement, MetadataStructureDefinition, [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], MetadataProvisionAgreement.
++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.
--Note that in this metamodel the term [[data source>>doc:Glossary.Data source.WebHome]] refers to both data and metadata sources, and [[data provider>>doc:Glossary.Data provider.WebHome]] refers to both data and metadata providers.
++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.
--A [[data source>>doc:Glossary.Data source.WebHome]] may be a simple file of data or metadata (in [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]], JSON or other format), or a database or [[metadata repository>>doc:Glossary.Metadata repository.WebHome]]. A [[data source>>doc:Glossary.Data source.WebHome]] may contain data for many data or [[metadata flows>>doc:Glossary.Metadataflow.WebHome]] (called [[Dataflow>>doc:Glossary.Dataflow.WebHome]], and [[Metadataflow>>doc: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:Glossary.Data source.WebHome]] where this [[data source>>doc:Glossary.Data source.WebHome]] is registered (SimpleDataSource, //QueryDataSource//).
++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//).
--The [[Dataflow>>doc:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc: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.
++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.
--These specifications are called (% style="color:#e74c3c" %)//Constraint//(%%) in this model.
++These specifications are called (% style="color:#2ecc71" %)//Constraint//(%%) in this model.
  == 12.2 Inheritance ==
@@ -26,7 +26,7 @@
  ==== 12.2.2.1 Narrative ====
--Any [[artefact>>doc:Glossary.Artefact.WebHome]] that inherits from the //ConstrainableArtefact// interface can have (% style="color:#e74c3c" %)constraints(%%) defined. The [[artefacts>>doc:Glossary.Artefact.WebHome]] that can have (% style="color:#e74c3c" %)constraint(%%) metadata attached are:
++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:
  Dataflow
  ProvisionAgreement
@@ -36,10 +36,10 @@
  MetaDataProvider – this is restricted to release calendar
  MetadataProvisionAgreement
  MetadataSetMetadataStructureDefinition
--SimpleDataSource – this is a registered [[data source>>doc:Glossary.Data source.WebHome]] where the registration references the actual [[Data Set>>doc:Glossary.Data set.WebHome]] or Metadata Set
++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
  //QueryDataSource//
--Note that, because the (% style="color:#e74c3c" %)//Constraint//(%%) can specify a subset of the [[component>>doc: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: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:Glossary.Data structure definition.WebHome]] or [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] the type of information that can be contained in a (% style="color:#e74c3c" %)Constraint(%%) linked to a DataProvider/MetadataProvider is restricted to ReleaseCalendar.
++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.
  == 12.3 Constraints ==
@@ -53,18 +53,18 @@
  ==== 12.3.2.1 Narrative ====
--The (% style="color:#e74c3c" %)constraint(%%) mechanism allows specific (% style="color:#e74c3c" %)constraints(%%) to be attached to a //ConstrainableArtefact//. With the exception of ReleaseCalendar 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//.
++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//.
--For instance, a DataStructureDefinition specifies, for each [[Dimension>>doc:Glossary.Dimension.WebHome]], the list of allowable [[code>>doc:Glossary.Code.WebHome]] values. However, a specific [[Dataflow>>doc: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:Glossary.Dimension.WebHome]] values). In addition to this, a DataProvider that is capable of supplying data according to the [[Dataflow>>doc: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:Glossary.Data source.WebHome]] in terms of the KeySets or CubeRegions contained within it.
++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.
--A //ConstrainableArtefact// can have two types of (% style="color:#e74c3c" %)//Constraint//(%%)s:
++A //ConstrainableArtefact// can have two types of (% style="color:#2ecc71" %)//Constraint//(%%)s:
--1. DataConstraint – is used as a mechanism to specify, either the available set of keys (DataKeySet), or set of [[component>>doc: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:Glossary.Code list.WebHome]] for one [[Dimension>>doc:Glossary.Dimension.WebHome]], while another provides the validation for another [[Dimension>>doc:Glossary.Dimension.WebHome]] within the same DSD.
--1. MetadataConstraint – is used as a mechanism to specify a set of [[component>>doc: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:Glossary.Code list.WebHome]], whilst another MetadataConstraint can specify the actual content of a metadata source (role is actualContent).
++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.
++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).
--In addition to DataKeySet and/or CubeRegion/MetadataTargetRegion a (% style="color:#e74c3c" %)Constraint(%%) can have a ReleaseCalendar specifying when data or metadata are released for publication or reporting.
++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.
--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: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:Glossary.Statistical data and metadata exchange.WebHome]] REST API. Thus, its identification is autogenerated by the service responding to a data availability request.
++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.
  === 12.3.3 Relationship Class Diagram – Detail ===
@@ -74,28 +74,28 @@
  ==== 12.3.3.1 Explanation of the Diagram ====
--A (% style="color:#e74c3c" %)//Constraint//(%%) is a //MaintainableArtefact//.
++A (% style="color:#2ecc71" %)//Constraint//(%%) is a //MaintainableArtefact//.
  A DataConstraint has a choice of two ways of specifying value subsets:
--1. As a set of keys that can be present in the //[[DataSet>>doc:Glossary.Data set.WebHome]]// (DataKeySet). Each DataKey specifies a number of ComponentValues each of which reference a //[[Component>>doc:Glossary.Component.WebHome]]// (e.g., [[Dimension>>doc:Glossary.Dimension.WebHome]], DataAttribute). Each ComponentValue is a value that may be present for a //[[Component>>doc:Glossary.Component.WebHome]]// of a structure when contained in a //[[DataSet>>doc:Glossary.Data set.WebHome]]//. In addition, each DataKeySet may also include MemberSelections for AttributeComponents or [[Measures>>doc:Glossary.Measure.WebHome]].
--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:Glossary.Component.WebHome]]// of a structure when contained in a //[[DataSet>>doc:Glossary.Data set.WebHome]]//.
++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]].
++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]]//.
--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:Glossary.Component.WebHome]]//s but does not specify specific key combinations. In addition, in (1) the association between //[[Component>>doc:Glossary.Component.WebHome]]// and DataKeyValue is constrained to the [[components>>doc:Glossary.Component.WebHome]] that comprise the key, whereas in (2) it can contain other [[component>>doc:Glossary.Component.WebHome]] types (such as AttributeComponents or [[Measures>>doc:Glossary.Measure.WebHome]]). By adding MemberSelections to the DataKeySets of (1), AttributeComponents and [[Measures>>doc:Glossary.Measure.WebHome]] are constrained for the related DataKeys.
++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.
  A MetadataConstraint has only one way of specifying value subsets:
--~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:Glossary.Component.WebHome]]// of a structure when contained in a MetadataSet.
++~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.
--In both CubeRegion and MetadataTargetRegion, the value in ComponentValue.value and MemberValue.value must be consistent with the //[[Representation>>doc:Glossary.Representation.WebHome]]// declared for the //[[Component>>doc:Glossary.Component.WebHome]]// in the DataStructureDefinition ([[Dimension>>doc: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:Glossary.Code.WebHome]]) are included in the (% style="color:#e74c3c" %)Constraint(%%) by means of the cascadeValues [[attribute>>doc:Glossary.Attribute.WebHome]]. The latter may take the following values:
++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:
  * "true": all children are included,
  * "false" (default), or
--* " excludeRoot", where all children are included, and the root [[Code>>doc:Glossary.Code.WebHome]] is excluded (i.e. the referenced [[Code>>doc:Glossary.Code.WebHome]]).
++* " 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]]).
--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(%%) definition. This [[attribute>>doc: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”.
++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”.
--In any MemberSelection that the corresponding //[[Component>>doc: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:Glossary.Code.WebHome]]. This is achieved via property removePrefix, which defaults to “false”.
++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”.
  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.
@@ -115,92 +115,92 @@
  ProvisionAgreement
  //QueryDatasource//
  SimpleDatasource
--)))|(% style="width:442px" %)An [[artefact>>doc:Glossary.Artefact.WebHome]] that can have (% style="color:#e74c3c" %)Constraints(%%) specified.
--| |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:Glossary.Artefact.WebHome]].
--|(%%)(% style="color:#e74c3c" %)//Constraint//|(((
++)))|(% style="width:442px" %)An [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] that can have (% style="color:#2ecc71" %)Constraints(%%) specified.
++| |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]].
++|(%%)(% style="color:#2ecc71" %)//Constraint//|(((
  Inherits from
  //MaintainableArtefact//
  Abstract class Sub classes are:
  DataConstraint
  MetadataConstraint
--)))|(% 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:Glossary.Code list.WebHome]] and other valid content.
++)))|(% 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.
  | |+dataContentKeys|(% style="width:442px" %)(((
  Association to a subset of Data
--Key Sets (i.e., value combinations) that can be derived from the definition of the structure to which the Constrainable [[Artefact>>doc:Glossary.Artefact.WebHome]] is linked.
++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.
  )))
  | |+dataContentRegion|(% style="width:442px" %)(((
--Association to a subset of [[component>>doc:Glossary.Component.WebHome]] values that can be derived from the Data Structure
++Association to a subset of [[component>>doc:xwiki:Glossary.Component.WebHome]] values that can be derived from the Data Structure
--Definition to which the Constrainable [[Artefact>>doc:Glossary.Artefact.WebHome]] is linked.
++Definition to which the Constrainable [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] is linked.
  )))
--| |+metadataContentRegion|(% style="width:442px" %)Association to a subset of [[component>>doc:Glossary.Component.WebHome]] values that can be derived from the [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]] to which the Constrainable [[Artefact>>doc:Glossary.Artefact.WebHome]] is linked.
--| |role|(% style="width:442px" %)Association to the role that the (% style="color:#e74c3c" %)Constraint(%%) plays
++| |+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.
++| |role|(% style="width:442px" %)Association to the role that the (% style="color:#2ecc71" %)Constraint(%%) plays
  |DataConstraint|(((
  Inherits from
--(% style="color:#e74c3c" %)//Constraint//
--)))|(% style="width:442px" %)Defines a (% style="color:#e74c3c" %)Constraint(%%) in terms of the content that can be found in [[data sources>>doc:Glossary.Data source.WebHome]] linked to the Constrainable [[Artefact>>doc:Glossary.Artefact.WebHome]] to which this (% style="color:#e74c3c" %)constraint(%%) is associated.
--|ConstraintRoleType| |(% style="width:442px" %)Specifies the way the type of content of a (% style="color:#e74c3c" %)Constraint(%%) in terms of its purpose.
--| |allowableContent|(% style="width:442px" %)The (% style="color:#e74c3c" %)Constraint(%%) contains a specification of the valid subset of the [[Component>>doc:Glossary.Component.WebHome]] values or keys.
--| |actualContent|(% style="width:442px" %)The (% style="color:#e74c3c" %)Constraint(%%) contains a specification of the actual content of a data or metadata source in terms of the [[Component>>doc:Glossary.Component.WebHome]] values or keys in the source.
++(% style="color:#2ecc71" %)//Constraint//
++)))|(% 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.
++|ConstraintRoleType| |(% style="width:442px" %)Specifies the way the type of content of a (% style="color:#2ecc71" %)Constraint(%%) in terms of its purpose.
++| |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.
++| |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.
  |MetadataConstrai nt|(((
  Inherits from
--(% style="color:#e74c3c" %)//Constraint//
--)))|(% style="width:442px" %)Defines a (% style="color:#e74c3c" %)Constraint(%%) in terms of the content that can be found in metadata sources linked to the Constrainable [[Artefact>>doc:Glossary.Artefact.WebHome]] to which this (% style="color:#e74c3c" %)constraint(%%) is associated.
++(% style="color:#2ecc71" %)//Constraint//
++)))|(% 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.
  |DataKeySet| |(% style="width:442px" %)A set of data keys.
--| |isIncluded|(% style="width:442px" %)Indicates whether the Data Key Set is included in the (% style="color:#e74c3c" %)constraint(%%) definition or excluded from the (% style="color:#e74c3c" %)constraint(%%) definition.
++| |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.
  | |+keys|(% style="width:442px" %)Association to the Data Keys in the set.
--| |+member|(% style="width:442px" %)Association to the selection of a value subset for [[Attributes>>doc:Glossary.Attribute.WebHome]] and [[Measures>>doc:Glossary.Measure.WebHome]].
++| |+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]].
  |DataKey| |(% style="width:442px" %)The values of a key in a data set.
--| |isIncluded|(% style="width:442px" %)Indicates whether the Data Key is included in the (% style="color:#e74c3c" %)constraint(%%) definition or excluded from the (% style="color:#e74c3c" %)constraint(%%) definition.
++| |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.
  | |+keyValue|(% style="width:442px" %)(((
--Associates the [[Component>>doc:Glossary.Component.WebHome]]
++Associates the [[Component>>doc:xwiki:Glossary.Component.WebHome]]
  Values that comprise the key.
  )))
  | |validFrom|(% style="width:442px" %)Date from which the Data Key is valid.
  | |validTo|(% style="width:442px" %)Date from which the Data Key is superseded.
--|ComponentValue| |(% style="width:442px" %)The identification and value of a [[Component>>doc:Glossary.Component.WebHome]] of the key (e.g., [[Dimension>>doc:Glossary.Dimension.WebHome]])
--| |value|(% style="width:442px" %)The value of [[Component>>doc:Glossary.Component.WebHome]]
--| |+valueFor|(% style="width:442px" %)Association to the [[Component>>doc:Glossary.Component.WebHome]] (e.g., [[Dimension>>doc:Glossary.Dimension.WebHome]]) in the Structure to which the Constrainable [[Artefact>>doc:Glossary.Artefact.WebHome]] is linked.
--|TimeDimensionValue| |(% style="width:442px" %)The value of the Time [[Dimension>>doc:Glossary.Dimension.WebHome]] [[component>>doc:Glossary.Component.WebHome]].
--| |timeValue|(% style="width:442px" %)The value of the [[time period>>doc:Glossary.Time period.WebHome]].
++|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]])
++| |value|(% style="width:442px" %)The value of [[Component>>doc:xwiki:Glossary.Component.WebHome]]
++| |+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.
++|TimeDimensionValue| |(% style="width:442px" %)The value of the Time [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[component>>doc:xwiki:Glossary.Component.WebHome]].
++| |timeValue|(% style="width:442px" %)The value of the [[time period>>doc:xwiki:Glossary.Time period.WebHome]].
  | |operator|(% style="width:442px" %)(((
--Indicates whether the specified value represents and exact time or [[time period>>doc:Glossary.Time period.WebHome]], or whether the value should be handled as a range.
++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.
  A value of greaterThan or greaterThanOrEqual indicates that the value is the beginning of a range (exclusive or inclusive, respectively).
  A value of lessThan or lessThanOrEqual indicates that the value is the end or a range (exclusive or inclusive, respectively).
--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:Glossary.Time period.WebHome]] after the beginning of the provided [[time period>>doc:Glossary.Time period.WebHome]] for greaterThanOrEqual)
++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)
  )))
--|CubeRegion| |(% style="width:442px" %)A set of [[Components>>doc: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:Glossary.Artefact.WebHome]] is linked.
--| |isIncluded|(% style="width:442px" %)Indicates whether the Cube Region is included in the (% style="color:#e74c3c" %)constraint(%%) definition or excluded from the (% style="color:#e74c3c" %)constraint(%%) definition.
--| |+member|(% style="width:442px" %)Associates the set of [[Components>>doc:Glossary.Component.WebHome]] that define the subset of values.
--|MetadataTargetRegion| |(% style="width:442px" %)A set of [[Components>>doc: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:Glossary.Artefact.WebHome]] is linked.
--| |isIncluded|(% style="width:442px" %)Indicates whether the Metadata Target Region is included in the (% style="color:#e74c3c" %)constraint(%%) definition or excluded from the (% style="color:#e74c3c" %)constraint(%%) definition.
--| |+member|(% style="width:442px" %)Associates the set of [[Components>>doc:Glossary.Component.WebHome]] that define the subset of values.
--|MemberSelection| |(% style="width:442px" %)A set of permissible values for one [[component>>doc:Glossary.Component.WebHome]] of the axis.
--| |isIncluded|(% style="width:442px" %)Indicates whether the [[Member Selection>>doc:Glossary.Member selection.WebHome]] is included in the (% style="color:#e74c3c" %)constraint(%%) definition or excluded from the (% style="color:#e74c3c" %)constraint(%%) definition.
--| |removePrefix|(% style="width:442px" %)Indicates whether the [[Codes>>doc:Glossary.Code.WebHome]] should keep or not the prefix, as defined in the extension of Codelist.
--| |+valuesFor|(% style="width:442px" %)Association to the [[Component>>doc:Glossary.Component.WebHome]] in the Structure to which the Constrainable [[Artefact>>doc:Glossary.Artefact.WebHome]] is linked, which defines the valid [[Representation>>doc:Glossary.Representation.WebHome]] for the Member Values.
++|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.
++| |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.
++| |+member|(% style="width:442px" %)Associates the set of [[Components>>doc:xwiki:Glossary.Component.WebHome]] that define the subset of values.
++|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.
++| |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.
++| |+member|(% style="width:442px" %)Associates the set of [[Components>>doc:xwiki:Glossary.Component.WebHome]] that define the subset of values.
++|MemberSelection| |(% style="width:442px" %)A set of permissible values for one [[component>>doc:xwiki:Glossary.Component.WebHome]] of the axis.
++| |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.
++| |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.
++| |+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.
  |//SelectionValue//|(((
  Abstract class. Sub classes are:
  MemberValue
  //TimeRangeValue//
  LocalisedMemberValue
--)))|(% style="width:442px" %)A collection of values for the [[Member Selections>>doc:Glossary.Member selection.WebHome]] that, combined with other [[Member Selections>>doc:Glossary.Member selection.WebHome]], comprise the value content of the Cube Region.
++)))|(% 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.
  | |validFrom|(% style="width:442px" %)Date from which the Selection Value is valid.
  | |validTo|(% style="width:442px" %)Date from which the Selection Value is superseded.
  |MemberValue|(((
  Inherits from
  //SelectionValue//
--)))|(% style="width:442px" %)A single value of the set of values for the [[Member Selection>>doc:Glossary.Member selection.WebHome]].
++)))|(% style="width:442px" %)A single value of the set of values for the [[Member Selection>>doc:xwiki:Glossary.Member selection.WebHome]].
  | |value|(% style="width:442px" %)A value of the member.
--| |cascadeValues|(% style="width:442px" %)Indicates that the child nodes of the member are included in the [[Member Selection>>doc:Glossary.Member selection.WebHome]] (e.g., child [[codes>>doc:Glossary.Code.WebHome]])
++| |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]])
  |LocalisedMemberValue|(((
  Inherits from
  //SelectionValue//
--)))|(% style="width:442px" %)A single localised value of the set of values for a [[Member Selection>>doc:Glossary.Member selection.WebHome]].
++)))|(% style="width:442px" %)A single localised value of the set of values for a [[Member Selection>>doc:xwiki:Glossary.Member selection.WebHome]].
  | |value|(% style="width:442px" %)A value of the member.
--| |locale|(% style="width:442px" %)The locale that the values must adhere to in the [[dataset>>doc:Glossary.Data set.WebHome]].
++| |locale|(% style="width:442px" %)The locale that the values must adhere to in the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]].
  |//TimeRangeValue//|(((
  Inherits from
  //SelectionValue//
@@ -214,13 +214,13 @@
  //TimeRangeValue//
  )))|(% style="width:442px" %)The period before which the constrained selection is valid.
  | |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
--| |period|(% style="width:442px" %)The [[time period>>doc:Glossary.Time period.WebHome]] which acts as the latest possible reported period
++| |period|(% style="width:442px" %)The [[time period>>doc:xwiki:Glossary.Time period.WebHome]] which acts as the latest possible reported period
  |AfterPeriod|(((
  Inherits from
  //TimeRangeValue//
  )))|(% style="width:442px" %)The period after which the constrained selection is valid.
  | |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
--| |period|(% style="width:442px" %)The [[time period>>doc:Glossary.Time period.WebHome]] which acts as the earliest possible reported period
++| |period|(% style="width:442px" %)The [[time period>>doc:xwiki:Glossary.Time period.WebHome]] which acts as the earliest possible reported period
  |RangePeriod| |(% style="width:442px" %)The start and end periods in a date range.
  | |+start|(% style="width:442px" %)Association to the Start Period.
  | |+end|(% style="width:442px" %)Association to the End Period.
@@ -229,14 +229,14 @@
  //TimeRangeValue//
  )))|(% style="width:442px" %)The period from which the constrained selection is valid.
  | |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
--| |period|(% style="width:442px" %)The [[time period>>doc:Glossary.Time period.WebHome]] which acts as the start of the range
++| |period|(% style="width:442px" %)The [[time period>>doc:xwiki:Glossary.Time period.WebHome]] which acts as the start of the range
  |EndPeriod|(((
  Inherits from
  //TimeRangeValue//
  )))|(% style="width:442px" %)The period to which the constrained selection is valid.
  | |isInclusive|(% style="width:442px" %)Indication of whether the date is inclusive in the period.
--| |period|(% style="width:442px" %)The [[time period>>doc:Glossary.Time period.WebHome]] which acts as the end of the range
++| |period|(% style="width:442px" %)The [[time period>>doc:xwiki:Glossary.Time period.WebHome]] which acts as the end of the range
  |ReleaseCalendar| |(% style="width:442px" %)The schedule of publication or reporting of the data or metadata
--| |periodicity|(% style="width:442px" %)The [[time period>>doc:Glossary.Time period.WebHome]] between the releases of the data or metadata
++| |periodicity|(% style="width:442px" %)The [[time period>>doc:xwiki:Glossary.Time period.WebHome]] between the releases of the data or metadata
  | |offset|(% style="width:442px" %)Interval between January 1^^st^^ and the first release of the data
  | |tolerance|(% style="width:442px" %)Period after which the data or metadata may be deemed late.

SUZ.Methodology.Code.MethodologyClass[0]

index

...	...	@@ -1,1 +1,0 @@
1		-13