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