ContextualComponent¶
Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::ContextualComponent
Definition¶
Encapsulates contextual information of the key-value datastore to provide a scope to the instance key. The instance key is unique within the scope.
Examples¶
A partition, cluster name and any other key-value datastore organization information.
Explanatory notes¶
A key-value datastore can be organized into multiple contextual components. Other data structure components that are part of the instance key, e.g. identifier and dimension components, guarantee uniqueness only within the scope of a contextual component. Synthetic id components do guarantee global uniqueness, but they might complex to setup and maintain in many organizations. Contextual components provide a simple mechanism to achieve uniqueness within a single key-value datastore. When a key-value datastore is organized in contextual components, a contextual component prefix is added to the instance key to make it unique across the entire key-value datastore.
Diagram
Inheritance
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
identifier |
Identifier for objects requiring short- or long-lasting referencing and management. |
0..1 |
|||
semantic |
Qualifies the purpose or use expressed as a paired external controlled vocabulary. |
0..* |
|||
specialization |
The role played by the component for the data set for purposes of harmonization and integration, typically regarding geography, time, etc. |
0..1 |
Associations
Direction |
Association |
Description |
Multiplicity of ContextualComponent |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
from |
DataStructureComponent isDefinedBy RepresentedVariable |
Data structure component is defined by zero to one represented variable. |
0..* |
0..1 |
none |
|||
to |
DataPoint correspondsTo DataStructureComponent |
0..* |
0..* |
none |
||||
to |
DataStructure has DataStructureComponent |
0..* |
0..1 |
none |
||||
to |
KeyMember isBasedOn DataStructureComponent |
0..* |
0..* |
none |
||||
to |
AttributeComponent qualifies DataStructureComponent |
0..* |
0..* |
none |
||||
to |
ComponentPosition indexes DataStructureComponent |
0..1 |
0..* |
none |
||||
to |
ForeignKeyComponent correspondsTo DataStructureComponent |
1..1 |
0..1 |
none |
||||
to |
PrimaryKeyComponent correspondsTo DataStructureComponent |
1..1 |
0..1 |
none |
Syntax representations / encodings
All syntax representations except the Canonical XMI are provided as reference points for specific implementations, or for use as defaults if sufficient in the form presented.
Fragment for the class ContextualComponent (entire model as XMI)
1<packagedElement xmlns:StandardProfile="http://www.eclipse.org/uml2/5.0.0/UML/Profile/Standard"
2 xmlns:uml="http://www.eclipse.org/uml2/5.0.0/UML"
3 xmlns:xmi="http://www.omg.org/spec/XMI/20131001"
4 xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-ContextualComponent"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ContextualComponent"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-ContextualComponent-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ContextualComponent-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-ContextualComponent"/>
11 <body>Definition
12============
13Encapsulates contextual information of the key-value datastore to provide a scope to the instance key. The instance key is unique within the scope.
14
15Examples
16==========
17A partition, cluster name and any other key-value datastore organization information.
18
19Explanatory notes
20===================
21A key-value datastore can be organized into multiple contextual components.
22Other data structure components that are part of the instance key, e.g. identifier and dimension components, guarantee uniqueness only within the scope of a contextual component.
23Synthetic id components do guarantee global uniqueness, but they might complex to setup and maintain in many organizations.
24Contextual components provide a simple mechanism to achieve uniqueness within a single key-value datastore.
25When a key-value datastore is organized in contextual components, a contextual component prefix is added to the instance key to make it unique across the entire key-value datastore.</body>
26 </ownedComment>
27 <name>ContextualComponent</name>
28 <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-ContextualComponent-generalization"
29 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ContextualComponent-generalization"
30 xmi:type="uml:Generalization">
31 <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent"/>
32 </generalization>
33</packagedElement>
Fragment for the class ContextualComponent (entire XML Schema)
1<xs:element name="ContextualComponent"
2 type="ContextualComponentXsdType"
3 xml:id="ContextualComponent">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::ContextualComponent -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ============
8 Encapsulates contextual information of the key-value datastore to provide a scope to the instance key. The instance key is unique within the scope.
9
10 Examples
11 ==========
12 A partition, cluster name and any other key-value datastore organization information.
13
14 Explanatory notes
15 ===================
16 A key-value datastore can be organized into multiple contextual components.
17 Other data structure components that are part of the instance key, e.g. identifier and dimension components, guarantee uniqueness only within the scope of a contextual component.
18 Synthetic id components do guarantee global uniqueness, but they might complex to setup and maintain in many organizations.
19 Contextual components provide a simple mechanism to achieve uniqueness within a single key-value datastore.
20 When a key-value datastore is organized in contextual components, a contextual component prefix is added to the instance key to make it unique across the entire key-value datastore.</xs:documentation>
21 </xs:annotation>
22</xs:element>
23<xs:complexType name="ContextualComponentXsdType"
24 xml:id="ContextualComponentXsdType">
25 <xs:annotation>
26 <xs:documentation>Definition
27 ============
28 Encapsulates contextual information of the key-value datastore to provide a scope to the instance key. The instance key is unique within the scope.
29
30 Examples
31 ==========
32 A partition, cluster name and any other key-value datastore organization information.
33
34 Explanatory notes
35 ===================
36 A key-value datastore can be organized into multiple contextual components.
37 Other data structure components that are part of the instance key, e.g. identifier and dimension components, guarantee uniqueness only within the scope of a contextual component.
38 Synthetic id components do guarantee global uniqueness, but they might complex to setup and maintain in many organizations.
39 Contextual components provide a simple mechanism to achieve uniqueness within a single key-value datastore.
40 When a key-value datastore is organized in contextual components, a contextual component prefix is added to the instance key to make it unique across the entire key-value datastore.</xs:documentation>
41 </xs:annotation>
42 <xs:complexContent>
43 <xs:extension base="DataStructureComponentXsdType">
44
45 </xs:extension>
46 </xs:complexContent>
47</xs:complexType>
Fragment for the class ContextualComponent (main ontology)
1# class ContextualComponent
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::ContextualComponent
3cdi:ContextualComponent
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "ContextualComponent";
6 rdfs:comment "Definition\n============\nEncapsulates contextual information of the key-value datastore to provide a scope to the instance key. The instance key is unique within the scope.\n\nExamples\n==========\nA partition, cluster name and any other key-value datastore organization information. \n\nExplanatory notes\n===================\nA key-value datastore can be organized into multiple contextual components. \nOther data structure components that are part of the instance key, e.g. identifier and dimension components, guarantee uniqueness only within the scope of a contextual component. \nSynthetic id components do guarantee global uniqueness, but they might complex to setup and maintain in many organizations. \nContextual components provide a simple mechanism to achieve uniqueness within a single key-value datastore. \nWhen a key-value datastore is organized in contextual components, a contextual component prefix is added to the instance key to make it unique across the entire key-value datastore."@en;
7 rdfs:subClassOf cdi:DataStructureComponent;
8.
Fragment for the class ContextualComponent (main JSON-LD)
1{
2 "@context": [
3 "DataStructureComponent.jsonld",
4 {
5 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
6 "xsd": "http://www.w3.org/2001/XMLSchema#",
7 "ContextualComponent": "cdi:ContextualComponent",
8
9 " comment ": "tag:json-should-support-trailing-commas"
10 }
11 ],
12 "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-09-23 21:52:57.",
13 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::ContextualComponent"
14}
