Changes for page 12 Constraints

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

From 5.1 to 4.1 From 7.2 to 7.1

From version 7.1

edited by Helena
on 2025/05/15 11:07

Change comment: There is no comment for this version

To version 5.1

edited by Helena
on 2025/05/15 09:59

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 0 added, 1 removed)
- SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_7f83d17f.gif

Details

Page properties

Content

@@ -1,6 +1,4 @@
--{{box title="**Contents**"}}
--{{toc/}}
--{{/box}}
++= 12 Constraints =
  == 12.1 Scope ==
@@ -75,8 +75,10 @@
  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.
--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.
++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.
++
  === 12.3.3 Relationship Class Diagram – Detail ===
  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_d166f6ab.jpg||height="708" width="619"]]
@@ -92,7 +92,7 @@
 . 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.
 . 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//.
--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.
++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.
  A MetadataConstraint has only one way of specifying value subsets:
@@ -102,7 +102,7 @@
  * "true": all children are included,
  * "false" (default), or
--* " excludeRoot", where all children are included, and the root Code is excluded (i.e. the referenced Code).
++* "[[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_7f83d17f.gif||alt="Shape31" height="55" width="97"]] excludeRoot", where all children are included, and the root Code is excluded (i.e. the referenced Code).
  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”.
@@ -112,8 +112,7 @@
  ==== 12.3.3.2 Definitions ====
--(% style="width:908.294px" %)
--|**Class**|**Feature**|(% style="width:442px" %)**Description**
++|**Class**|**Feature**|**Description**
  |//ConstrainableArt efact//|(((
  Abstract Class Sub classes are:
@@ -125,11 +125,13 @@
  Metadataflow
--MetadataProvisionAgreement
++MetadataProvisionAgreem
++ent
++
  MetadataSet
--MetadataStructureDefinition
++MetadataStructureDefini tion
  ProvisionAgreement
@@ -136,8 +136,8 @@
  //QueryDatasource//
  SimpleDatasource
--)))|(% style="width:442px" %)An artefact that can have 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.
++)))|An artefact that can have Constraints specified.
++||content|Associates the metadata that constrains the content to be found in a data or metadata source linked to the Constrainable Artefact.
  |//Constraint//|(((
  Inherits from
@@ -148,64 +148,69 @@
  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 and other valid content.
--| |+dataContentKeys|(% 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.
++||+dataContentKeys|(((
  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 is linked.
  )))
--| |+dataContentRegion|(% style="width:442px" %)(((
++||+dataContentRegion|(((
  Association to a subset of component values that can be derived from the Data Structure
  Definition to which the Constrainable Artefact is linked.
  )))
--| |+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.
--| |role|(% style="width:442px" %)Association to the role that the Constraint plays
++||+metadataContentRegion|Association to a subset of component values that can be derived from the Metadata Structure Definition to which the Constrainable Artefact is linked.
++||role|Association to the role that the Constraint plays
  |DataConstraint|(((
  Inherits from
++
  //Constraint//
--)))|(% 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.
--|ConstraintRoleTy pe| |(% style="width:442px" %)Specifies the way the type of content of a Constraint in terms of its purpose.
--| |allowableContent|(% style="width:442px" %)The Constraint contains a specification of the valid subset of the Component values or keys.
--| |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.
++)))|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.
++|ConstraintRoleTy pe||Specifies the way the type of content of a Constraint in terms of its purpose.
++||allowableContent|The Constraint contains a specification of the valid subset of the Component values or keys.
++||actualContent|The Constraint contains a specification of the actual content of a data or metadata source in terms of the Component values or keys in the source.
  |MetadataConstrai nt|(((
  Inherits from
++
  //Constraint//
--)))|(% 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.
--|DataKeySet| |(% style="width:442px" %)A set of data keys.
--| |isIncluded|(% style="width:442px" %)Indicates whether the Data Key Set is included in the constraint definition or excluded from the 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 and Measures.
--|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 constraint definition or excluded from the constraint definition.
--| |+keyValue|(% 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.
++|DataKeySet||A set of data keys.
++||isIncluded|Indicates whether the Data Key Set is included in the constraint definition or excluded from the constraint definition.
++||+keys|Association to the Data Keys in the set.
++||+member|Association to the selection of a value subset for Attributes and Measures.
++|DataKey||The values of a key in a data set.
++||isIncluded|Indicates whether the Data Key is included in the constraint definition or excluded from the constraint definition.
++||+keyValue|(((
  Associates the Component
  Values that comprise the key.
  )))
--| |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 of the key (e.g., Dimension)
--| |value|(% style="width:442px" %)The value of Component
--| |+valueFor|(% style="width:442px" %)Association to the Component (e.g., Dimension) in the Structure to which the Constrainable Artefact is linked.
--|TimeDimensionVal ue| |(% style="width:442px" %)The value of the Time Dimension component.
--| |timeValue|(% style="width:442px" %)The value of the time period.
--| |operator|(% style="width:442px" %)(((
++||validFrom|Date from which the Data Key is valid.
++||validTo|Date from which the Data Key is superseded.
++|ComponentValue||The identification and value of a Component of the key (e.g., Dimension)
++||value|The value of Component
++||+valueFor|Association to the Component (e.g., Dimension) in the Structure to which the Constrainable Artefact is linked.
++|TimeDimensionVal ue||The value of the Time Dimension component.
++||timeValue|The value of the time period.
++||operator|(((
  Indicates whether the specified value represents and exact time or time period, or whether the value should be handled as a range.
++
  A value of greaterThan or greaterThanOrEqual indicates that the value is the beginning of a range (exclusive or inclusive, respectively).
++
  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 after the beginning of the provided time period for greaterThanOrEqual)
  )))
--|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.
--| |isIncluded|(% style="width:442px" %)Indicates whether the Cube Region is included in the constraint definition or excluded from the constraint definition.
--| |+member|(% style="width:442px" %)Associates the set of Components that define the subset of values.
--|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.
--| |isIncluded|(% style="width:442px" %)Indicates whether the Metadata Target Region is included in the constraint definition or excluded from the constraint definition.
--| |+member|(% style="width:442px" %)Associates the set of Components that define the subset of values.
--|MemberSelection| |(% style="width:442px" %)A set of permissible values for one component of the axis.
--| |isIncluded|(% style="width:442px" %)Indicates whether the Member Selection is included in the constraint definition or excluded from the constraint definition.
--| |removePrefix|(% style="width:442px" %)Indicates whether the Codes should keep or not the prefix, as defined in the extension of Codelist.
--| |+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.
++|CubeRegion||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.
++||isIncluded|Indicates whether the Cube Region is included in the constraint definition or excluded from the constraint definition.
++||+member|Associates the set of Components that define the subset of values.
++|MetadataTargetRe gion||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.
++||isIncluded|Indicates whether the Metadata Target Region is included in the constraint definition or excluded from the constraint definition.
++||+member|Associates the set of Components that define the subset of values.
++|MemberSelection||A set of permissible values for one component of the axis.
++||isIncluded|Indicates whether the Member Selection is included in the constraint definition or excluded from the constraint definition.
++||removePrefix|Indicates whether the Codes should keep or not the prefix, as defined in the extension of Codelist.
++||+valuesFor|Association to the Component in the Structure to which the Constrainable Artefact is linked, which defines the valid Representation for the Member Values.
  |//SelectionValue//|(((
  Abstract class. Sub classes are:
@@ -214,23 +214,23 @@
  //TimeRangeValue//
  LocalisedMemberValue
--)))|(% 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.
--| |validFrom|(% style="width:442px" %)Date from which the Selection Value is valid.
--| |validTo|(% style="width:442px" %)Date from which the Selection Value is superseded.
++)))|A collection of values for the Member Selections that, combined with other Member Selections, comprise the value content of the Cube Region.
++||validFrom|Date from which the Selection Value is valid.
++||validTo|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.
--| |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 (e.g., child codes)
++)))|A single value of the set of values for the Member Selection.
++||value|A value of the member.
++||cascadeValues|Indicates that the child nodes of the member are included in the Member Selection (e.g., child codes)
  |LocalisedMemberV alue|(((
  Inherits from
  //SelectionValue//
--)))|(% style="width:442px" %)A single localised value of the set of values for a Member Selection.
--| |value|(% style="width:442px" %)A value of the member.
--| |locale|(% style="width:442px" %)The locale that the values must adhere to in the dataset.
++)))|A single localised value of the set of values for a Member Selection.
++||value|A value of the member.
++||locale|The locale that the values must adhere to in the dataset.
  |//TimeRangeValue//|(((
  Inherits from
@@ -243,40 +243,43 @@
  AfterPeriod
  RangePeriod
--)))|(% style="width:442px" %)A time value or values that specifies the date or dates for which the constrained selection is valid.
++)))|A time value or values that specifies the date or dates for which the constrained selection is valid.
  |BeforePeriod|(((
  Inherits from
  //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 which acts as the latest possible reported period
++)))|The period before which the constrained selection is valid.
++||isInclusive|Indication of whether the date is inclusive in the period.
++||period|The time period 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 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.
++)))|The period after which the constrained selection is valid.
++||isInclusive|Indication of whether the date is inclusive in the period.
++||period|The time period which acts as the earliest possible reported period
++|RangePeriod||The start and end periods in a date range.
++||+start|Association to the Start Period.
++||+end|Association to the End Period.
  |StartPeriod|(((
  Inherits from
  //TimeRangeValue//
--)))|(% 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 which acts as the start of the range
++)))|The period from which the constrained selection is valid.
++||isInclusive|Indication of whether the date is inclusive in the period.
++||period|The time period 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 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 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.
--
++)))|The period to which the constrained selection is valid.
++||isInclusive|Indication of whether the date is inclusive in the period.
++||period|The time period which acts as the end of the range
++|ReleaseCalendar||The schedule of publication or reporting of the data or metadata
++||periodicity|The time period between the releases of the data or metadata
++||offset|Interval between January 1^^st^^ and the first release of the data
++||tolerance|Period after which the data or metadata may be deemed late.
++
++
++
++

SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_7f83d17f.gif

Author

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

Size

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

Content