KeyValueStructure#
Fully qualified class name of the UML model DDI-CDI 1.0: DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::KeyValueStructure
Definition#
Structure of a key-value datastore (organized collection of key-value data). It is described by identifier, contextual, synthetic id, dimension, variable descriptor and variable value components.
Examples#
The structure described by [Income distribution, Unit id, Period, Income] where Income distribution is the contextual component, Unit id identifies a statistical unit, period is a effective period and Income is the variable of interest.
Diagram#
Diagram
Inheritance#
Inheritance
ᐊ── KeyValue::KeyValueStructure
Attributes#
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#
Associations
Direction |
Association |
Description |
Multiplicity of KeyValueStructure |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
to |
DataSet isStructuredBy DataStructure |
0..* |
0..* |
none |
||||
from |
DataStructure has ComponentPosition |
1..1 |
0..* |
composite |
||||
from |
DataStructure has DataStructureComponent |
0..1 |
0..* |
composite |
||||
from |
DataStructure has ForeignKey |
1..1 |
0..* |
composite |
||||
from |
DataStructure has PrimaryKey |
1..1 |
0..1 |
composite |
||||
to |
PhysicalDataSetStructure correspondsTo DataStructure |
0..1 |
0..* |
none |
||||
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 |
Encodings#
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 KeyValueStructure (entire model as XMI)
1<packagedElement xmlns:StandardProfile="http://www.omg.org/spec/UML/20131001/StandardProfile"
2 xmlns:uml="http://www.omg.org/spec/UML/20131001"
3 xmlns:xmi="http://www.omg.org/spec/XMI/20131001"
4 xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-KeyValueStructure"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyValueStructure"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-KeyValueStructure-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyValueStructure-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-KeyValueStructure"/>
11 <body>Definition
12============
13Structure of a key-value datastore (organized collection of key-value data). It is described by identifier, contextual, synthetic id, dimension, variable descriptor and variable value components.
14
15Examples
16==========
17The structure described by [Income distribution, Unit id, Period, Income] where Income distribution is the contextual component, Unit id identifies a statistical unit, period is a effective period and Income is the variable of interest.</body>
18 </ownedComment>
19 <name>KeyValueStructure</name>
20 <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-KeyValueStructure-generalization"
21 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyValueStructure-generalization"
22 xmi:type="uml:Generalization">
23 <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-DataStructure"/>
24 </generalization>
25</packagedElement>
Fragment for the class KeyValueStructure (entire XML Schema)
1<xs:element name="KeyValueStructure"
2 type="KeyValueStructureXsdType"
3 xml:id="KeyValueStructure">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::KeyValueStructure -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ============
8 Structure of a key-value datastore (organized collection of key-value data). It is described by identifier, contextual, synthetic id, dimension, variable descriptor and variable value components.
9
10 Examples
11 ==========
12 The structure described by [Income distribution, Unit id, Period, Income] where Income distribution is the contextual component, Unit id identifies a statistical unit, period is a effective period and Income is the variable of interest.</xs:documentation>
13 </xs:annotation>
14</xs:element>
15<xs:complexType name="KeyValueStructureXsdType"
16 xml:id="KeyValueStructureXsdType">
17 <xs:annotation>
18 <xs:documentation>Definition
19 ============
20 Structure of a key-value datastore (organized collection of key-value data). It is described by identifier, contextual, synthetic id, dimension, variable descriptor and variable value components.
21
22 Examples
23 ==========
24 The structure described by [Income distribution, Unit id, Period, Income] where Income distribution is the contextual component, Unit id identifies a statistical unit, period is a effective period and Income is the variable of interest.</xs:documentation>
25 </xs:annotation>
26 <xs:complexContent>
27 <xs:extension base="DataStructureXsdType">
28
29 </xs:extension>
30 </xs:complexContent>
31</xs:complexType>
Fragment for the class KeyValueStructure (entire JSON Schema)
1"cls-KeyValueStructure": {
2 "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/KeyValueStructure",
3 "type": "object",
4 "properties": {
5 "@context": {
6 "$ref": "#/defs/at-context"
7 },
8 "@id": {
9 "type": "string",
10 "format": "iri-reference"
11 },
12 "@type": {
13 "const": "KeyValueStructure"
14 },
15 "identifier": {
16 "$comment": "cardinality 0..1 – from cdi:DataStructureComponent",
17 "$ref": "#/defs/dt-Identifier"
18 },
19 "semantic": {
20 "$comment": "cardinality 0..-1 – from cdi:DataStructureComponent",
21 "if": { "type": "array" },
22 "then": { "items": { "$ref": "#/defs/dt-PairedControlledVocabularyEntry" } },
23 "else": { "$ref": "#/defs/dt-PairedControlledVocabularyEntry" }
24 },
25 "specialization": {
26 "$comment": "cardinality 0..1 – from cdi:DataStructureComponent",
27 "$ref": "#/defs/dt-SpecializationRole"
28 },
29 "has_ComponentPosition": {
30 "description": "DataStructure_has_ComponentPosition",
31 "$comment": "cardinality 0..-1",
32 "anyOf": [
33 {
34 "$ref": "#/defs/target-ComponentPosition"
35 },
36 {
37 "type": "array",
38 "items": {
39 "$ref": "#/defs/target-ComponentPosition"
40 }
41 }
42 ]
43 },
44 "has_DataStructureComponent": {
45 "description": "DataStructure_has_DataStructureComponent",
46 "$comment": "cardinality 0..-1",
47 "anyOf": [
48 {
49 "$ref": "#/defs/target-DataStructureComponent"
50 },
51 {
52 "type": "array",
53 "items": {
54 "$ref": "#/defs/target-DataStructureComponent"
55 }
56 }
57 ]
58 },
59 "has_ForeignKey": {
60 "description": "DataStructure_has_ForeignKey",
61 "$comment": "cardinality 0..-1",
62 "anyOf": [
63 {
64 "$ref": "#/defs/target-ForeignKey"
65 },
66 {
67 "type": "array",
68 "items": {
69 "$ref": "#/defs/target-ForeignKey"
70 }
71 }
72 ]
73 },
74 "has_PrimaryKey": {
75 "description": "DataStructure_has_PrimaryKey",
76 "$comment": "cardinality 0..1",
77 "$ref": "#/defs/target-PrimaryKey"
78 },
79 "isDefinedBy_RepresentedVariable": {
80 "description": "DataStructureComponent_isDefinedBy_RepresentedVariable",
81 "$comment": "cardinality 0..1",
82 "$ref": "#/defs/target-RepresentedVariable"
83 },
84 "isStructuredBy_OF_DataSet": {
85 "description": "DataSet_isStructuredBy_DataStructure",
86 "$comment": "cardinality 0..-1",
87 "anyOf": [
88 {
89 "$ref": "#/defs/target-DataSet"
90 },
91 {
92 "type": "array",
93 "items": {
94 "$ref": "#/defs/target-DataSet"
95 }
96 }
97 ]
98 },
99 "correspondsTo_DataStructure_OF_PhysicalDataSetStructure": {
100 "description": "PhysicalDataSetStructure_correspondsTo_DataStructure",
101 "$comment": "cardinality 0..-1",
102 "anyOf": [
103 {
104 "$ref": "#/defs/target-PhysicalDataSetStructure"
105 },
106 {
107 "type": "array",
108 "items": {
109 "$ref": "#/defs/target-PhysicalDataSetStructure"
110 }
111 }
112 ]
113 },
114 "correspondsTo_DataStructureComponent_OF_DataPoint": {
115 "description": "DataPoint_correspondsTo_DataStructureComponent",
116 "$comment": "cardinality 0..-1",
117 "anyOf": [
118 {
119 "$ref": "#/defs/target-DataPoint"
120 },
121 {
122 "type": "array",
123 "items": {
124 "$ref": "#/defs/target-DataPoint"
125 }
126 }
127 ]
128 },
129 "has_DataStructureComponent_OF_DataStructure": {
130 "description": "DataStructure_has_DataStructureComponent",
131 "$comment": "cardinality 0..1",
132 "$ref": "#/defs/target-DataStructure"
133 },
134 "isBasedOn_OF_KeyMember": {
135 "description": "KeyMember_isBasedOn_DataStructureComponent",
136 "$comment": "cardinality 0..-1",
137 "anyOf": [
138 {
139 "$ref": "#/defs/target-KeyMember"
140 },
141 {
142 "type": "array",
143 "items": {
144 "$ref": "#/defs/target-KeyMember"
145 }
146 }
147 ]
148 },
149 "qualifies_OF_AttributeComponent": {
150 "description": "AttributeComponent_qualifies_DataStructureComponent",
151 "$comment": "cardinality 0..-1",
152 "anyOf": [
153 {
154 "$ref": "#/defs/target-AttributeComponent"
155 },
156 {
157 "type": "array",
158 "items": {
159 "$ref": "#/defs/target-AttributeComponent"
160 }
161 }
162 ]
163 },
164 "indexes_OF_ComponentPosition": {
165 "description": "ComponentPosition_indexes_DataStructureComponent",
166 "$comment": "cardinality 0..-1",
167 "anyOf": [
168 {
169 "$ref": "#/defs/target-ComponentPosition"
170 },
171 {
172 "type": "array",
173 "items": {
174 "$ref": "#/defs/target-ComponentPosition"
175 }
176 }
177 ]
178 },
179 "correspondsTo_DataStructureComponent_OF_ForeignKeyComponent": {
180 "description": "ForeignKeyComponent_correspondsTo_DataStructureComponent",
181 "$comment": "cardinality 0..1",
182 "$ref": "#/defs/target-ForeignKeyComponent"
183 },
184 "correspondsTo_DataStructureComponent_OF_PrimaryKeyComponent": {
185 "description": "PrimaryKeyComponent_correspondsTo_DataStructureComponent",
186 "$comment": "cardinality 0..1",
187 "$ref": "#/defs/target-PrimaryKeyComponent"
188 },
189 "sameAs": {
190 "$ref": "#/defs/owl:sameAs"
191 }
192 },
193 "required": ["@type"],
194 "additionalProperties": false
195},
196"target-KeyValueStructure": {
197 "description": "all subclasses of http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/KeyValueStructure",
198 "anyOf": [
199 { "$ref": "#/defs/cls-KeyValueStructure" },
200 { "type": "string", "format": "iri-reference" }
201 ]
202},
Fragment for the class KeyValueStructure (main ontology)
1# class KeyValueStructure
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::KeyValueStructure
3cdi:KeyValueStructure
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "KeyValueStructure";
6 rdfs:comment "Definition\n============\nStructure of a key-value datastore (organized collection of key-value data). It is described by identifier, contextual, synthetic id, dimension, variable descriptor and variable value components.\n\nExamples\n==========\nThe structure described by [Income distribution, Unit id, Period, Income] where Income distribution is the contextual component, Unit id identifies a statistical unit, period is a effective period and Income is the variable of interest."@en;
7 rdfs:subClassOf cdi:DataStructure;
8.
Fragment for the class KeyValueStructure (entire JSON-LD)
1{
2 "@context": [
3 "DataStructure.jsonld",
4 {
5 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
6 "xsd": "http://www.w3.org/2001/XMLSchema#",
7
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 2025-08-29 14:34:50.",
13 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::KeyValueStructure"
14}
Fragment for the class KeyValueStructure (entire SHACL - Shapes Constraint Language)
1# class KeyValueStructure
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::KeyValueStructure
3<#KeyValueStructure> a sh:NodeShape;
4 sh:targetClass cdi:KeyValueStructure;
5 sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/KeyValueStructure";
6 sh:closed true;
7 sh:ignoredProperties ( owl:sameAs );
8 sh:property [
9 sh:path rdf:type;
10 sh:in ( cdi:KeyValueStructure
11 ) ;
12 ];
13 # attributes
14 # associations from KeyValueStructure
15 # associations to KeyValueStructure
16
17 # ---- superclass: DataStructure
18 # attributes
19 # associations from DataStructure
20 sh:property <#DataStructure_has_ComponentPosition>;
21 sh:property <#DataStructure_has_DataStructureComponent>;
22 sh:property <#DataStructure_has_ForeignKey>;
23 sh:property <#DataStructure_has_PrimaryKey>;
24 # associations to DataStructure
25 sh:property <#rev_DataSet_isStructuredBy_DataStructure>;
26 sh:property <#rev_PhysicalDataSetStructure_correspondsTo_DataStructure>;
27
28 # ---- superclass: DataStructureComponent
29 # attributes
30 sh:property <#DataStructureComponent-identifier>;
31 sh:property <#DataStructureComponent-semantic>;
32 sh:property <#DataStructureComponent-specialization>;
33 # associations from DataStructureComponent
34 sh:property <#DataStructureComponent_isDefinedBy_RepresentedVariable>;
35 # associations to DataStructureComponent
36 sh:property <#rev_DataPoint_correspondsTo_DataStructureComponent>;
37 sh:property <#rev_DataStructure_has_DataStructureComponent>;
38 sh:property <#rev_KeyMember_isBasedOn_DataStructureComponent>;
39 sh:property <#rev_AttributeComponent_qualifies_DataStructureComponent>;
40 sh:property <#rev_ComponentPosition_indexes_DataStructureComponent>;
41 sh:property <#rev_ForeignKeyComponent_correspondsTo_DataStructureComponent>;
42 sh:property <#rev_PrimaryKeyComponent_correspondsTo_DataStructureComponent>;
43
44
45
46
47
48
49
50.
Fragment for the class KeyValueStructure (entire ShEx - Shape Expressions)
1# class KeyValueStructure
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::KeyValueStructure
3cdi:KeyValueStructureShape CLOSED {
4 a [cdi:KeyValueStructure];
5 &cdi:DataStructureProperties;
6 }