Wiki source code of 12 Constraints
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
5.1 | 1 | {{box title="**Contents**"}} |
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| |
1.1 | 4 | |
| |
5.1 | 5 | == 12.1 Scope == |
| 6 | |||
| |
18.1 | 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 2\.1.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>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] which may be used as a partial [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]], relevant in the context of the [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] to which the (% style="color:#e74c3c" %)//Constraint//(%%) is attached e.g., DataStructureDefinition, [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]], ProvisionAgreement, MetadataStructureDefinition, [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]], MetadataProvisionAgreement. |
| |
1.1 | 8 | |
| |
18.1 | 9 | Note that in this metamodel the term [[data provider>>doc:sdmx:Glossary 2\.1.Data provider.WebHome]] refers to both data and metadata providers. |
| |
1.1 | 10 | |
| |
18.1 | 11 | The [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] and [[Metadataflow>>doc:sdmx:Glossary 2\.1.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. |
| |
1.1 | 12 | |
| |
18.1 | 13 | These specifications are called (% style="color:#e74c3c" %)//Constraint//(%%) in this model. |
| |
1.1 | 14 | |
| |
5.1 | 15 | == 12.2 Inheritance == |
| |
1.1 | 16 | |
| |
5.1 | 17 | === 12.2.1 Class Diagram of Constrainable Artefacts - Inheritance === |
| |
1.1 | 18 | |
| |
11.2 | 19 | [[image:image67.png]] |
| 20 | |||
| |
1.1 | 21 | **Figure 41: Inheritance class diagram of constrainable and provisioning artefacts** |
| 22 | |||
| |
5.1 | 23 | === 12.2.2 Explanation of the Diagram === |
| |
1.1 | 24 | |
| |
5.1 | 25 | ==== 12.2.2.1 Narrative ==== |
| |
1.1 | 26 | |
| |
18.1 | 27 | Any [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] that inherits from the //ConstrainableArtefact// interface can have (% style="color:#e74c3c" %)constraints(%%) defined. The [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] that can have (% style="color:#e74c3c" %)constraint(%%) metadata attached are: |
| |
1.1 | 28 | |
| |
18.1 | 29 | [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] |
| |
1.1 | 30 | ProvisionAgreement |
| 31 | DataProvider | ||
| 32 | DataStructureDefinition | ||
| |
18.1 | 33 | [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]] |
| |
1.1 | 34 | MetaDataProvider |
| 35 | MetadataProvisionAgreement | ||
| 36 | MetadataStructureDefinition | ||
| 37 | |||
| |
18.1 | 38 | Note that, because the (% style="color:#e74c3c" %)//Constraint//(%%) can specify a subset of the [[component>>doc:sdmx:Glossary 2\.1.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 2\.1.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 2\.1.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. |
| |
1.1 | 39 | |
| |
5.1 | 40 | == 12.3 Constraints == |
| |
1.1 | 41 | |
| |
5.1 | 42 | === 12.3.1 Relationship Class Diagram – high level view === |
| |
1.1 | 43 | |
| |
12.1 | 44 | [[image:image68.png]] |
| 45 | |||
| |
1.1 | 46 | **Figure 42: Relationship class diagram showing constraint metadata** |
| 47 | |||
| |
5.1 | 48 | === 12.3.2 Explanation of the Diagram === |
| |
1.1 | 49 | |
| |
5.1 | 50 | ==== 12.3.2.1 Narrative ==== |
| |
1.1 | 51 | |
| |
18.1 | 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//. |
| |
1.1 | 53 | |
| |
18.1 | 54 | For instance, a DataStructureDefinition specifies, for each [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]], the list of allowable [[code>>doc:sdmx:Glossary 2\.1.Code.WebHome]] values. However, a specific [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] that uses the |
| |
1.1 | 55 | |
| |
18.1 | 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 2\.1.Dimension.WebHome]] values). In addition to this, a DataProvider that is capable of supplying data according to the [[Dataflow>>doc:sdmx:Glossary 2\.1.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 2\.1.Data source.WebHome]] in terms of the KeySets or CubeRegions contained within it. |
| |
1.1 | 57 | |
| |
18.1 | 58 | A //ConstrainableArtefact// can have two types of (% style="color:#e74c3c" %)//Constraint//(%%)s: |
| |
1.1 | 59 | |
| |
18.1 | 60 | 1. DataConstraint – is used as a mechanism to specify the set of keys (DataKeySet), or set of [[component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] values (CubeRegion) that can be reported against the target ConstrainableArtefact. Multiple such DataConstraints may be present for a //ConstrainableArtefact//. |
| 61 | 1. MetadataConstraint – is used as a mechanism to specify a set of [[component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] values (MetadatTargetRegion) that can be reported against the target ConstrainableArtefact. Multiple such MetadataConstraints may be present for a //ConstrainableArtefact//. | ||
| |
1.1 | 62 | |
| |
18.1 | 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 2\.1.Data source.WebHome]]. An AvailableDataConstraint is not a [[Maintainable Artefact>>doc:sdmx:Glossary 2\.1.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 2\.1.Dimension.WebHome]] of the [[DSD>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]] that is is attached to. |
| |
1.1 | 64 | |
| |
5.1 | 65 | === 12.3.3 Relationship Class Diagram – Detail === |
| |
1.1 | 66 | |
| 67 | [[image:1749246701065-474.jpeg]]** ** | ||
| 68 | |||
| 69 | **Figure 43: Constraints – Key Set, Cube Region and Metadata Target Region** | ||
| 70 | |||
| |
5.1 | 71 | ==== 12.3.3.1 Explanation of the Diagram ==== |
| |
1.1 | 72 | |
| |
18.1 | 73 | A (% style="color:#e74c3c" %)//Constraint//(%%) is a //MaintainableArtefact//. |
| |
1.1 | 74 | |
| 75 | A DataConstraint has a choice of two ways of specifying value subsets: | ||
| 76 | |||
| |
18.1 | 77 | 1. As a set of keys that can be present in the //[[DataSet>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]// (DataKeySet). Each DataKey specifies a number of ComponentValues each of which reference a //[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]// (e.g., [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]], DataAttribute). Each ComponentValue is a value that may be present for a //[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]// of a structure when contained in a //[[DataSet>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]//. In addition, each DataKeySet may also include MemberSelections for AttributeComponents or [[Measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]]. |
| 78 | 1. As a CubeRegion whose MemberSelections SelectionValues define a subset of allowed/disallowed values for a [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] when contained in a //[[DataSet>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]/MetadataSet//. A DataConstraint is restricted to a maximum of 2 CubeRegions, one to define included (allowable) content, and the other to define disallowed content (isIncluded=false). | ||
| |
1.1 | 79 | |
| 80 | The difference between (1) and (2) above is that : | ||
| 81 | |||
| |
18.1 | 82 | 1. Defines a combination of [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] values, which are assessed in combination to reference one or more [[Series>>doc:sdmx:Glossary 2\.1.Series.WebHome]] in a [[Dataset>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]. This combination of values can be used to explicitly include or exclude the [[Series>>doc:sdmx:Glossary 2\.1.Series.WebHome]] from being reported (via the isIncluded property). In addition, once a set of [[Series>>doc:sdmx:Glossary 2\.1.Series.WebHome]] are targeted by a DataKey restrictions can be applied to [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] and Measure values by defining subsets of values that are either allowed or disallowed. The DataKeySet targets its rules to specific [[Series>>doc:sdmx:Glossary 2\.1.Series.WebHome]]. |
| 83 | 1. Defines a subset of values that are allowed for a [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]. Each CubeRegion MemberSelection defines a single [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] to define a set of allowed or disallowed values, the MemberSelections are processed indepently of each other. The Cube Region supplies global rules, not [[series>>doc:sdmx:Glossary 2\.1.Series.WebHome]] specific rules. | ||
| |
1.1 | 84 | |
| 85 | A MetadataConstraint has only one way of specifying value subsets: | ||
| 86 | |||
| |
18.1 | 87 | ~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:sdmx:Glossary 2\.1.Component.WebHome]]// of a structure when contained in a MetadataSet. |
| |
1.1 | 88 | |
| |
18.1 | 89 | In both CubeRegion and MetadataTargetRegion, the value in ComponentValue.value and MemberValue.value must be consistent with the //[[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]]// declared for the //[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]// in the DataStructureDefinition ([[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] or DataAttribute) or MetadataStructureDefinition (MetadataAttribute). Note that in all cases the |
| |
1.1 | 90 | |
| |
18.1 | 91 | "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:sdmx:Glossary 2\.1.Code.WebHome]]) are included in the (% style="color:#e74c3c" %)Constraint(%%) by means of the cascadeValues [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]. The latter may take the following values: |
| |
1.1 | 92 | |
| 93 | * "true": all children are included, | ||
| 94 | * "false" (default), or | ||
| |
18.1 | 95 | * "excludeRoot", where all children are included, and the root [[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]] is excluded (i.e. the referenced [[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]]). |
| |
1.1 | 96 | |
| |
18.1 | 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(%%) definition. This [[attribute>>doc:sdmx:Glossary 2\.1.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”. |
| |
1.1 | 98 | |
| |
18.1 | 99 | In any MemberSelection that the corresponding //[[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]// was using [[Codelist>>doc:sdmx:Glossary 2\.1.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 2\.1.Code.WebHome]]. This is achieved via property removePrefix, which defaults to “false”. |
| |
1.1 | 100 | |
| 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 | |||
| |
18.1 | 103 | ==== 12.3.3.2 D ==== |
| |
1.1 | 104 | |
| |
18.1 | 105 | ==== efinitions ==== |
| 106 | |||
| |
5.1 | 107 | (% style="width:974.835px" %) |
| 108 | |(% style="width:183px" %)**Class**|(% style="width:224px" %)**Feature**|(% style="width:572px" %)**Description** | ||
| 109 | |(% style="width:183px" %)//ConstrainableArtefact//|(% style="width:224px" %)((( | ||
| |
1.1 | 110 | Abstract Class |
| 111 | Sub classes are: | ||
| |
18.1 | 112 | [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] |
| |
1.1 | 113 | DataProvider |
| 114 | DataStructureDefinition | ||
| |
18.1 | 115 | [[Metadataflow>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]] |
| |
5.1 | 116 | MetadataProvisionAgreement |
| |
1.1 | 117 | MetadataSet |
| |
10.2 | 118 | MetadataStructureDefinition |
| |
1.1 | 119 | ProvisionAgreement |
| 120 | //QueryDatasource// | ||
| 121 | SimpleDatasource | ||
| |
18.1 | 122 | )))|(% style="width:572px" %)An [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] that can have (% style="color:#e74c3c" %)Constraints(%%) specified. |
| 123 | |(% 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 2\.1.Artefact.WebHome]]. | ||
| |
6.1 | 124 | |(% style="width:183px" %)(% style="color:#e74c3c" %)//Constraint//|(% style="width:224px" %)((( |
| |
1.1 | 125 | Inherits from |
| 126 | //MaintainableArtefact// | ||
| 127 | Abstract class | ||
| 128 | Sub classes are: | ||
| 129 | DataConstraint | ||
| 130 | MetadataConstraint | ||
| |
18.1 | 131 | )))|(% style="width:572px" %)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:sdmx:Glossary 2\.1.Code list.WebHome]] and other valid content. |
| 132 | |(% style="width:183px" %) |(% style="width:224px" %)+dataContentKeys|(% style="width:572px" %)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:sdmx:Glossary 2\.1.Artefact.WebHome]] is linked. | ||
| 133 | |(% style="width:183px" %) |(% style="width:224px" %)+dataContentRegion|(% style="width:572px" %)Association to a subset of [[component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] values that can be derived from the [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]] to which the Constrainable [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] is linked. | ||
| 134 | |(% style="width:183px" %) |(% style="width:224px" %)+metadataContentRegion|(% style="width:572px" %)Association to a subset of [[component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] values that can be derived from the [[Metadata Structure Definition>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]] to which the Constrainable [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] is linked. | ||
| |
6.1 | 135 | |(% style="width:183px" %) |(% style="width:224px" %)role|(% style="width:572px" %)Association to the role that the (% style="color:#e74c3c" %)Constraint(%%) plays |
| |
5.1 | 136 | |(% style="width:183px" %)DataConstraint|(% style="width:224px" %)((( |
| |
1.1 | 137 | Inherits from |
| |
6.1 | 138 | (% style="color:#e74c3c" %)//Constraint// |
| |
18.1 | 139 | )))|(% style="width:572px" %)Defines a (% style="color:#e74c3c" %)Constraint(%%) in terms of the content that can be found in [[data sources>>doc:sdmx:Glossary 2\.1.Data source.WebHome]] linked to the Constrainable [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] to which this (% style="color:#e74c3c" %)constraint(%%) is associated. |
| |
6.1 | 140 | |(% style="width:183px" %)ConstraintRoleType|(% style="width:224px" %) |(% style="width:572px" %)Specifies the way the type of content of a (% style="color:#e74c3c" %)Constraint(%%) in terms of its purpose. |
| |
18.1 | 141 | |(% style="width:183px" %) |(% style="width:224px" %)allowableContent|(% style="width:572px" %)The (% style="color:#e74c3c" %)Constraint(%%) contains a specification of the valid subset of the [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] values or keys. |
| 142 | |(% style="width:183px" %) |(% style="width:224px" %)actualContent|(% style="width:572px" %)The (% style="color:#e74c3c" %)Constraint(%%) contains a specification of the actual content of a data or metadata source in terms of the [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] values or keys in the source. | ||
| |
5.1 | 143 | |(% style="width:183px" %)MetadataConstraint|(% style="width:224px" %)((( |
| |
1.1 | 144 | Inherits from |
| |
6.1 | 145 | (% style="color:#e74c3c" %)//Constraint// |
| |
18.1 | 146 | )))|(% style="width:572px" %)Defines a (% style="color:#e74c3c" %)Constraint(%%) in terms of the content that can be found in metadata sources linked to the Constrainable [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] to which this (% style="color:#e74c3c" %)constraint(%%) is associated. |
| |
5.1 | 147 | |(% style="width:183px" %)DataKeySet|(% style="width:224px" %) |(% style="width:572px" %)A set of data keys. |
| |
18.1 | 148 | |(% style="width:183px" %) |(% style="width:224px" %)[[isIncluded>>doc:sdmx:Glossary 2\.1.isIncluded.WebHome]]|(% style="width:572px" %)Indicates whether the Data Key Set is included in the (% style="color:#e74c3c" %)constraint(%%) definition or excluded from the (% style="color:#e74c3c" %)constraint(%%) definition. |
| |
5.1 | 149 | |(% style="width:183px" %) |(% style="width:224px" %)+keys|(% style="width:572px" %)Association to the Data Keys in the set. |
| |
18.1 | 150 | |(% style="width:183px" %) |(% style="width:224px" %)+member|(% style="width:572px" %)Association to the selection of a value subset for [[Attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] and [[Measures>>doc:sdmx:Glossary 2\.1.Measure.WebHome]]. |
| 151 | |(% style="width:183px" %)DataKey|(% style="width:224px" %) |(% style="width:572px" %)The values of a key in a [[data set>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]. | ||
| 152 | |(% style="width:183px" %) |(% style="width:224px" %)[[isIncluded>>doc:sdmx:Glossary 2\.1.isIncluded.WebHome]]|(% style="width:572px" %)Indicates whether the Data Key is included in the (% style="color:#e74c3c" %)constraint(%%) definition or excluded from the (% style="color:#e74c3c" %)constraint(%%) definition. | ||
| 153 | |(% style="width:183px" %) |(% style="width:224px" %)+keyValue|(% style="width:572px" %)Associates the [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] Values that comprise the key. | ||
| |
5.1 | 154 | |(% style="width:183px" %) |(% style="width:224px" %)validFrom|(% style="width:572px" %)Date from which the Data Key is valid. |
| 155 | |(% style="width:183px" %) |(% style="width:224px" %)validTo|(% style="width:572px" %)Date from which the Data Key is superseded. | ||
| |
18.1 | 156 | |(% style="width:183px" %)ComponentValue|(% style="width:224px" %) |(% style="width:572px" %)The identification and value of a [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] of the key (e.g., [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]]) |
| 157 | |(% style="width:183px" %) |(% style="width:224px" %)value|(% style="width:572px" %)The value of [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] | ||
| 158 | |(% style="width:183px" %) |(% style="width:224px" %)+valueFor|(% style="width:572px" %)Association to the [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] (e.g., [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]]) in the Structure to which the Constrainable [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] is linked. | ||
| 159 | |(% style="width:183px" %)TimeDimensionValue|(% style="width:224px" %) |(% style="width:572px" %)The value of the Time [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] [[component>>doc:sdmx:Glossary 2\.1.Component.WebHome]]. | ||
| 160 | |(% style="width:183px" %) |(% style="width:224px" %)timeValue|(% style="width:572px" %)The value of the [[time period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]]. | ||
| |
5.1 | 161 | |(% style="width:183px" %) |(% style="width:224px" %)operator|(% style="width:572px" %)((( |
| |
18.1 | 162 | Indicates whether the specified value represents and exact time or [[time period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]], or whether the value should be handled as a range. |
| |
1.1 | 163 | A value of greaterThan or greaterThanOrEqual indicates that the value is the beginning of a range (exclusive or inclusive, respectively). |
| |
5.1 | 164 | A value of lessThan or lessThanOrEqual indicates that the value is the end or a range (exclusive or inclusive, respectively). |
| |
18.1 | 165 | 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:sdmx:Glossary 2\.1.Time period.WebHome]] after the beginning of the provided [[time period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]] for greaterThanOrEqual) |
| |
1.1 | 166 | ))) |
| 167 | |||
| |
5.1 | 168 | (% style="width:978.835px" %) |
| 169 | |(% style="width:172px" %)**Class**|(% style="width:231px" %)**Feature**|(% style="width:572px" %)**Description** | ||
| |
18.1 | 170 | |(% style="width:172px" %)CubeRegion|(% style="width:231px" %) |(% style="width:572px" %)A set of [[Components>>doc:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.Artefact.WebHome]] is linked. |
| 171 | |(% style="width:172px" %) |(% style="width:231px" %)[[isIncluded>>doc:sdmx:Glossary 2\.1.isIncluded.WebHome]]|(% style="width:572px" %)Indicates whether the Cube Region is included in the (% style="color:#e74c3c" %)constraint(%%) definition or excluded from the (% style="color:#e74c3c" %)constraint(%%) definition. | ||
| 172 | |(% style="width:172px" %) |(% style="width:231px" %)+member|(% style="width:572px" %)Associates the set of [[Components>>doc:sdmx:Glossary 2\.1.Component.WebHome]] that define the subset of values. | ||
| 173 | |(% style="width:172px" %)MetadataTargetRegion|(% style="width:231px" %) |(% style="width:572px" %)A set of [[Components>>doc:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.Artefact.WebHome]] is linked. | ||
| 174 | |(% style="width:172px" %) |(% style="width:231px" %)[[isIncluded>>doc:sdmx:Glossary 2\.1.isIncluded.WebHome]]|(% style="width:572px" %)Indicates whether the Metadata Target Region is included in the (% style="color:#e74c3c" %)constraint(%%) definition or excluded from the (% style="color:#e74c3c" %)constraint(%%) definition. | ||
| 175 | |(% style="width:172px" %) |(% style="width:231px" %)+member|(% style="width:572px" %)Associates the set of [[Components>>doc:sdmx:Glossary 2\.1.Component.WebHome]] that define the subset of values. | ||
| 176 | |(% style="width:172px" %)MemberSelection|(% style="width:231px" %) |(% style="width:572px" %)A set of permissible values for one [[component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] of the axis. | ||
| 177 | |(% style="width:172px" %) |(% style="width:231px" %)[[isIncluded>>doc:sdmx:Glossary 2\.1.isIncluded.WebHome]]|(% style="width:572px" %)Indicates whether the [[Member Selection>>doc:sdmx:Glossary 2\.1.Member selection.WebHome]] is included in the (% style="color:#e74c3c" %)constraint(%%) definition or excluded from the (% style="color:#e74c3c" %)constraint(%%) definition. | ||
| 178 | |(% style="width:172px" %) |(% style="width:231px" %)removePrefix|(% style="width:572px" %)Indicates whether the [[Codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] should keep or not the prefix, as defined in the extension of [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]]. | ||
| 179 | |(% style="width:172px" %) |(% style="width:231px" %)+valuesFor|(% style="width:572px" %)Association to the [[Component>>doc:sdmx:Glossary 2\.1.Component.WebHome]] in the Structure to which the Constrainable [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] is linked, which defines the valid [[Representation>>doc:sdmx:Glossary 2\.1.Representation.WebHome]] for the [[Member Values>>doc:sdmx:Glossary 2\.1.Member value.WebHome]]. | ||
| |
5.1 | 180 | |(% style="width:172px" %)//SelectionValue//|(% style="width:231px" %)((( |
| |
1.1 | 181 | Abstract class. Sub classes are: |
| 182 | MemberValue | ||
| 183 | //TimeRangeValue// | ||
| 184 | LocalisedMemberValue | ||
| |
18.1 | 185 | )))|(% style="width:572px" %)A collection of values for the [[Member Selections>>doc:sdmx:Glossary 2\.1.Member selection.WebHome]] that, combined with other [[Member Selections>>doc:sdmx:Glossary 2\.1.Member selection.WebHome]], comprise the value content of the Cube Region. |
| |
5.1 | 186 | |(% style="width:172px" %) |(% style="width:231px" %)validFrom|(% style="width:572px" %)Date from which the Selection Value is valid. |
| 187 | |(% style="width:172px" %) |(% style="width:231px" %)validTo|(% style="width:572px" %)Date from which the Selection Value is superseded. | ||
| 188 | |(% style="width:172px" %)MemberValue|(% style="width:231px" %)((( | ||
| |
1.1 | 189 | Inherits from |
| 190 | //SelectionValue// | ||
| |
18.1 | 191 | )))|(% style="width:572px" %)A single value of the set of values for the [[Member Selection>>doc:sdmx:Glossary 2\.1.Member selection.WebHome]]. |
| |
5.1 | 192 | |(% style="width:172px" %) |(% style="width:231px" %)value|(% style="width:572px" %)A value of the member. |
| |
18.1 | 193 | |(% style="width:172px" %) |(% style="width:231px" %)cascadeValues|(% style="width:572px" %)Indicates that the child nodes of the member are included in the [[Member Selection>>doc:sdmx:Glossary 2\.1.Member selection.WebHome]] (e.g., child [[codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]]) |
| |
5.1 | 194 | |(% style="width:172px" %)LocalisedMemberValue|(% style="width:231px" %)((( |
| |
1.1 | 195 | Inherits from |
| 196 | //SelectionValue// | ||
| |
18.1 | 197 | )))|(% style="width:572px" %)A single localised value of the set of values for a [[Member Selection>>doc:sdmx:Glossary 2\.1.Member selection.WebHome]]. |
| |
5.1 | 198 | |(% style="width:172px" %) |(% style="width:231px" %)value|(% style="width:572px" %)A value of the member. |
| |
18.1 | 199 | |(% style="width:172px" %) |(% style="width:231px" %)locale|(% style="width:572px" %)The locale that the values must adhere to in the [[dataset>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]. |
| |
5.1 | 200 | |(% style="width:172px" %)//TimeRangeValue//|(% style="width:231px" %)((( |
| |
1.1 | 201 | Inherits from |
| 202 | //SelectionValue// | ||
| 203 | Abstract Class | ||
| 204 | Concrete Classes: | ||
| 205 | BeforePeriod | ||
| 206 | AfterPeriod | ||
| 207 | RangePeriod | ||
| |
5.1 | 208 | )))|(% style="width:572px" %)A time value or values that specifies the date or dates for which the constrained selection is valid. |
| 209 | |(% style="width:172px" %)BeforePeriod|(% style="width:231px" %)((( | ||
| |
1.1 | 210 | Inherits from |
| 211 | //TimeRangeValue// | ||
| |
5.1 | 212 | )))|(% style="width:572px" %)The period before which the constrained selection is valid. |
| 213 | |(% style="width:172px" %) |(% style="width:231px" %)isInclusive|(% style="width:572px" %)Indication of whether the date is inclusive in the period. | ||
| |
18.1 | 214 | |(% style="width:172px" %) |(% style="width:231px" %)period|(% style="width:572px" %)The [[time period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]] which acts as the latest possible reported period |
| |
5.1 | 215 | |(% style="width:172px" %)AfterPeriod|(% style="width:231px" %)((( |
| |
1.1 | 216 | Inherits from |
| 217 | //TimeRangeValue// | ||
| |
5.1 | 218 | )))|(% style="width:572px" %)The period after which the constrained selection is valid. |
| 219 | |(% style="width:172px" %) |(% style="width:231px" %)isInclusive|(% style="width:572px" %)Indication of whether the date is inclusive in the period. | ||
| |
18.1 | 220 | |(% style="width:172px" %) |(% style="width:231px" %)period|(% style="width:572px" %)The [[time period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]] which acts as the earliest possible reported period |
| |
5.1 | 221 | |(% style="width:172px" %)RangePeriod|(% style="width:231px" %) |(% style="width:572px" %)The start and end periods in a date range. |
| 222 | |(% style="width:172px" %) |(% style="width:231px" %)+start|(% style="width:572px" %)Association to the Start Period. | ||
| 223 | |(% style="width:172px" %) |(% style="width:231px" %)+end|(% style="width:572px" %)Association to the End Period. | ||
| 224 | |(% style="width:172px" %)StartPeriod|(% style="width:231px" %)((( | ||
| |
1.1 | 225 | Inherits from |
| 226 | //TimeRangeValue// | ||
| |
5.1 | 227 | )))|(% style="width:572px" %)The period from which the constrained selection is valid. |
| 228 | |(% style="width:172px" %) |(% style="width:231px" %)isInclusive|(% style="width:572px" %)Indication of whether the date is inclusive in the period. | ||
| |
18.1 | 229 | |(% style="width:172px" %) |(% style="width:231px" %)period|(% style="width:572px" %)The [[time period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]] which acts as the start of the range |
| |
5.1 | 230 | |(% style="width:172px" %)EndPeriod|(% style="width:231px" %)((( |
| |
1.1 | 231 | Inherits from |
| 232 | //TimeRangeValue// | ||
| |
5.1 | 233 | )))|(% style="width:572px" %)The period to which the constrained selection is valid. |
| 234 | |(% style="width:172px" %) |(% style="width:231px" %)isInclusive|(% style="width:572px" %)Indication of whether the date is inclusive in the period. | ||
| |
18.1 | 235 | |(% style="width:172px" %) |(% style="width:231px" %)period|(% style="width:572px" %)The [[time period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]] which acts as the end of the range |