DataStore¶
Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::FormatDescription::DataStore
Definition¶
Collection of logical records.
Examples¶
The data lineage of an individual business process or an entire data pipeline are both examples of a logical record relation structures. In a data lineage we can observe how logical records are connected within a business process or across business processes.
Explanatory notes¶
Keep in mind that a logical records are definitions, not a “datasets”. Logical records organized in a structured collection is called a logical record relation structure. Instances of logical records instantiated as organizations of data points hosting data are described in format description. A data store is reusable across studies. Each study has at most one data store.
Diagram
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
aboutMissing |
- own class - |
General information about missing data, e.g., that missing data have been standardized across the collection, missing data are present because of merging, etc.- corresponds to DDI2.5 dataMsng. |
0..1 |
||
allowsDuplicates |
- own class - |
If value is False, the members are unique within the collection - if True, there may be duplicates. (Note that a mathematical “bag” permits duplicates and is unordered - a “set” does not have duplicates and may be ordered.) |
Boolean |
1..1 |
|
catalogDetails |
- own class - |
Bundles the information useful for a data catalog entry. Examples would be creator, contributor, title, copyright, embargo, and license information. A set of information useful for attribution, data discovery, and access. This is information that is tied to the identity of the object. If this information changes the version of the associated object changes. |
0..1 |
||
characterSet |
- own class - |
Default character set used in the Data Store. |
String |
0..1 |
|
dataStoreType |
- own class - |
The type of datastore. Could be delimited file, fixed record length file, relational database, etc. Points to an external definition which can be part of a controlled vocabulary maintained by the DDI Alliance. |
0..1 |
||
identifier |
- own class - |
Identifier for objects requiring short- or long-lasting referencing and management. |
0..1 |
||
name |
- own class - |
Human understandable name (liguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage. |
0..* |
||
purpose |
- own class - |
Intent or reason for the object/the description of the object. |
0..1 |
||
recordCount |
- own class - |
The number of records in the Data Store. |
Integer |
0..1 |
Associations
Direction |
Association |
Description |
Multiplicity of DataStore |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
from |
DataStore isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
- own class - |
||
from |
DataStore has LogicalRecord |
0..* |
- own package - |
0..* |
shared |
- own class - |
||
from |
DataStore has LogicalRecordPosition |
1..1 |
- own package - |
0..* |
composite |
- own class - |
||
from |
DataStore has RecordRelation |
The record relation that defines the relationship and linking requirements between logical records in the data store. |
0..* |
- own package - |
0..1 |
shared |
- own class - |
|
to |
LogicalRecordRelationStructure structures DataStore |
0..* |
- own package - |
0..* |
none |
- own class - |
||
to |
PhysicalDataSet formats DataStore |
Data store physically represented by the structure description. |
0..* |
- own package - |
0..* |
none |
- own class - |
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 DataStore (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-FormatDescription-DataStore"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore"/>
11 <body>Definition
12============
13Collection of logical records.
14
15Examples
16==========
17The data lineage of an individual business process or an entire data pipeline are both examples of a logical record relation structures. In a data lineage we can observe how logical records are connected within a business process or across business processes.
18
19Explanatory notes
20===================
21Keep in mind that a logical records are definitions, not a "datasets". Logical records organized in a structured collection is called a logical record relation structure. Instances of logical records instantiated as organizations of data points hosting data are described in format description. A data store is reusable across studies. Each study has at most one data store.</body>
22 </ownedComment>
23 <name>DataStore</name>
24 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-aboutMissing"
25 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-aboutMissing"
26 xmi:type="uml:Property">
27 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-aboutMissing-ownedComment"
28 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-aboutMissing-ownedComment"
29 xmi:type="uml:Comment">
30 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-aboutMissing"/>
31 <body>General information about missing data, e.g., that missing data have been standardized across the collection, missing data are present because of merging, etc.- corresponds to DDI2.5 dataMsng.</body>
32 </ownedComment>
33 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-aboutMissing-lowerValue"
34 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-aboutMissing-lowerValue"
35 xmi:type="uml:LiteralInteger"/>
36 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-aboutMissing-upperValue"
37 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-aboutMissing-upperValue"
38 xmi:type="uml:LiteralUnlimitedNatural">
39 <value>1</value>
40 </upperValue>
41 <name>aboutMissing</name>
42 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalString"/>
43 </ownedAttribute>
44 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-allowsDuplicates"
45 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-allowsDuplicates"
46 xmi:type="uml:Property">
47 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-allowsDuplicates-ownedComment"
48 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-allowsDuplicates-ownedComment"
49 xmi:type="uml:Comment">
50 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-allowsDuplicates"/>
51 <body>If value is False, the members are unique within the collection - if True, there may be duplicates. (Note that a mathematical “bag” permits duplicates and is unordered - a “set” does not have duplicates and may be ordered.)</body>
52 </ownedComment>
53 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-allowsDuplicates-lowerValue"
54 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-allowsDuplicates-lowerValue"
55 xmi:type="uml:LiteralInteger">
56 <value>1</value>
57 </lowerValue>
58 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-allowsDuplicates-upperValue"
59 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-allowsDuplicates-upperValue"
60 xmi:type="uml:LiteralUnlimitedNatural">
61 <value>1</value>
62 </upperValue>
63 <name>allowsDuplicates</name>
64 <type href="http://www.eclipse.org/uml2/5.0.0/UML/PrimitiveTypes.xmi#Boolean"
65 xmi:type="uml:PrimitiveType"/>
66 </ownedAttribute>
67 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-catalogDetails"
68 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-catalogDetails"
69 xmi:type="uml:Property">
70 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-catalogDetails-ownedComment"
71 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-catalogDetails-ownedComment"
72 xmi:type="uml:Comment">
73 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-catalogDetails"/>
74 <body>Bundles the information useful for a data catalog entry. Examples would be creator, contributor, title, copyright, embargo, and license information. A set of information useful for attribution, data discovery, and access. This is information that is tied to the identity of the object. If this information changes the version of the associated object changes.</body>
75 </ownedComment>
76 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-catalogDetails-lowerValue"
77 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-catalogDetails-lowerValue"
78 xmi:type="uml:LiteralInteger"/>
79 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-catalogDetails-upperValue"
80 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-catalogDetails-upperValue"
81 xmi:type="uml:LiteralUnlimitedNatural">
82 <value>1</value>
83 </upperValue>
84 <name>catalogDetails</name>
85 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CatalogDetails"/>
86 </ownedAttribute>
87 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-characterSet"
88 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-characterSet"
89 xmi:type="uml:Property">
90 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-characterSet-ownedComment"
91 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-characterSet-ownedComment"
92 xmi:type="uml:Comment">
93 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-characterSet"/>
94 <body>Default character set used in the Data Store.</body>
95 </ownedComment>
96 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-characterSet-lowerValue"
97 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-characterSet-lowerValue"
98 xmi:type="uml:LiteralInteger"/>
99 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-characterSet-upperValue"
100 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-characterSet-upperValue"
101 xmi:type="uml:LiteralUnlimitedNatural">
102 <value>1</value>
103 </upperValue>
104 <name>characterSet</name>
105 <type href="http://www.eclipse.org/uml2/5.0.0/UML/PrimitiveTypes.xmi#String"
106 xmi:type="uml:PrimitiveType"/>
107 </ownedAttribute>
108 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-dataStoreType"
109 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-dataStoreType"
110 xmi:type="uml:Property">
111 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-dataStoreType-ownedComment"
112 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-dataStoreType-ownedComment"
113 xmi:type="uml:Comment">
114 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-dataStoreType"/>
115 <body>The type of datastore. Could be delimited file, fixed record length file, relational database, etc. Points to an external definition which can be part of a controlled vocabulary maintained by the DDI Alliance.</body>
116 </ownedComment>
117 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-dataStoreType-lowerValue"
118 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-dataStoreType-lowerValue"
119 xmi:type="uml:LiteralInteger"/>
120 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-dataStoreType-upperValue"
121 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-dataStoreType-upperValue"
122 xmi:type="uml:LiteralUnlimitedNatural">
123 <value>1</value>
124 </upperValue>
125 <name>dataStoreType</name>
126 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
127 </ownedAttribute>
128 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-identifier"
129 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-identifier"
130 xmi:type="uml:Property">
131 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-identifier-ownedComment"
132 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-identifier-ownedComment"
133 xmi:type="uml:Comment">
134 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-identifier"/>
135 <body>Identifier for objects requiring short- or long-lasting referencing and management.</body>
136 </ownedComment>
137 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-identifier-lowerValue"
138 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-identifier-lowerValue"
139 xmi:type="uml:LiteralInteger"/>
140 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-identifier-upperValue"
141 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-identifier-upperValue"
142 xmi:type="uml:LiteralUnlimitedNatural">
143 <value>1</value>
144 </upperValue>
145 <name>identifier</name>
146 <isID>true</isID>
147 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Identifier"/>
148 </ownedAttribute>
149 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-name"
150 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-name"
151 xmi:type="uml:Property">
152 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-name-ownedComment"
153 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-name-ownedComment"
154 xmi:type="uml:Comment">
155 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-name"/>
156 <body>Human understandable name (liguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage.</body>
157 </ownedComment>
158 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-name-lowerValue"
159 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-name-lowerValue"
160 xmi:type="uml:LiteralInteger"/>
161 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-name-upperValue"
162 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-name-upperValue"
163 xmi:type="uml:LiteralUnlimitedNatural">
164 <value>*</value>
165 </upperValue>
166 <name>name</name>
167 <isOrdered>true</isOrdered>
168 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ObjectName"/>
169 </ownedAttribute>
170 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_1"
171 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_1"
172 xmi:type="uml:Property">
173 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_1-lowerValue"
174 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_1-lowerValue"
175 xmi:type="uml:LiteralInteger"/>
176 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_1-upperValue"
177 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_1-upperValue"
178 xmi:type="uml:LiteralUnlimitedNatural">
179 <value>*</value>
180 </upperValue>
181 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-DataStore_isDefinedBy_Concept"/>
182 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-Concept"/>
183 </ownedAttribute>
184 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_2"
185 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_2"
186 xmi:type="uml:Property">
187 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_2-lowerValue"
188 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_2-lowerValue"
189 xmi:type="uml:LiteralInteger"/>
190 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_2-upperValue"
191 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_2-upperValue"
192 xmi:type="uml:LiteralUnlimitedNatural">
193 <value>*</value>
194 </upperValue>
195 <aggregation>composite</aggregation>
196 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore_has_LogicalRecordPosition"/>
197 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-LogicalRecordPosition"/>
198 </ownedAttribute>
199 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_3"
200 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_3"
201 xmi:type="uml:Property">
202 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_3-lowerValue"
203 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_3-lowerValue"
204 xmi:type="uml:LiteralInteger"/>
205 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_3-upperValue"
206 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_3-upperValue"
207 xmi:type="uml:LiteralUnlimitedNatural">
208 <value>*</value>
209 </upperValue>
210 <aggregation>shared</aggregation>
211 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore_has_LogicalRecord"/>
212 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-LogicalRecord"/>
213 </ownedAttribute>
214 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_4"
215 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_4"
216 xmi:type="uml:Property">
217 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_4-lowerValue"
218 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_4-lowerValue"
219 xmi:type="uml:LiteralInteger"/>
220 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-ownedAttribute_4-upperValue"
221 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-ownedAttribute_4-upperValue"
222 xmi:type="uml:LiteralUnlimitedNatural">
223 <value>1</value>
224 </upperValue>
225 <aggregation>shared</aggregation>
226 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore_has_RecordRelation"/>
227 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-RecordRelation"/>
228 </ownedAttribute>
229 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-purpose"
230 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-purpose"
231 xmi:type="uml:Property">
232 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-purpose-ownedComment"
233 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-purpose-ownedComment"
234 xmi:type="uml:Comment">
235 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-purpose"/>
236 <body>Intent or reason for the object/the description of the object.</body>
237 </ownedComment>
238 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-purpose-lowerValue"
239 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-purpose-lowerValue"
240 xmi:type="uml:LiteralInteger"/>
241 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-purpose-upperValue"
242 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-purpose-upperValue"
243 xmi:type="uml:LiteralUnlimitedNatural">
244 <value>1</value>
245 </upperValue>
246 <name>purpose</name>
247 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalString"/>
248 </ownedAttribute>
249 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-recordCount"
250 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-recordCount"
251 xmi:type="uml:Property">
252 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-recordCount-ownedComment"
253 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-recordCount-ownedComment"
254 xmi:type="uml:Comment">
255 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-recordCount"/>
256 <body>The number of records in the Data Store.</body>
257 </ownedComment>
258 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-recordCount-lowerValue"
259 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-recordCount-lowerValue"
260 xmi:type="uml:LiteralInteger"/>
261 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-DataStore-recordCount-upperValue"
262 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStore-recordCount-upperValue"
263 xmi:type="uml:LiteralUnlimitedNatural">
264 <value>1</value>
265 </upperValue>
266 <name>recordCount</name>
267 <type href="http://www.eclipse.org/uml2/5.0.0/UML/PrimitiveTypes.xmi#Integer"
268 xmi:type="uml:PrimitiveType"/>
269 </ownedAttribute>
270</packagedElement>
Fragment for the class DataStore (entire XML Schema)
1<xs:element name="DataStore"
2 type="DataStoreXsdType"
3 xml:id="DataStore">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::DataStore -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ============
8 Collection of logical records.
9
10 Examples
11 ==========
12 The data lineage of an individual business process or an entire data pipeline are both examples of a logical record relation structures. In a data lineage we can observe how logical records are connected within a business process or across business processes.
13
14 Explanatory notes
15 ===================
16 Keep in mind that a logical records are definitions, not a "datasets". Logical records organized in a structured collection is called a logical record relation structure. Instances of logical records instantiated as organizations of data points hosting data are described in format description. A data store is reusable across studies. Each study has at most one data store.</xs:documentation>
17 </xs:annotation>
18</xs:element>
19<xs:complexType name="DataStoreXsdType"
20 xml:id="DataStoreXsdType">
21 <xs:annotation>
22 <xs:documentation>Definition
23 ============
24 Collection of logical records.
25
26 Examples
27 ==========
28 The data lineage of an individual business process or an entire data pipeline are both examples of a logical record relation structures. In a data lineage we can observe how logical records are connected within a business process or across business processes.
29
30 Explanatory notes
31 ===================
32 Keep in mind that a logical records are definitions, not a "datasets". Logical records organized in a structured collection is called a logical record relation structure. Instances of logical records instantiated as organizations of data points hosting data are described in format description. A data store is reusable across studies. Each study has at most one data store.</xs:documentation>
33 </xs:annotation>
34 <xs:sequence>
35 <xs:element name="aboutMissing"
36 type="InternationalStringXsdType"
37 minOccurs="0"
38 maxOccurs="1"
39 xml:id="DataStore-aboutMissing">
40 <xs:annotation>
41 <xs:documentation>General information about missing data, e.g., that missing data have been standardized across the collection, missing data are present because of merging, etc.- corresponds to DDI2.5 dataMsng.</xs:documentation>
42 </xs:annotation>
43 </xs:element>
44 <xs:element name="allowsDuplicates"
45 type="xs:boolean"
46 minOccurs="1"
47 maxOccurs="1"
48 xml:id="DataStore-allowsDuplicates">
49 <xs:annotation>
50 <xs:documentation>If value is False, the members are unique within the collection - if True, there may be duplicates. (Note that a mathematical “bag” permits duplicates and is unordered - a “set” does not have duplicates and may be ordered.)</xs:documentation>
51 </xs:annotation>
52 </xs:element>
53 <xs:element name="catalogDetails"
54 type="CatalogDetailsXsdType"
55 minOccurs="0"
56 maxOccurs="1"
57 xml:id="DataStore-catalogDetails">
58 <xs:annotation>
59 <xs:documentation>Bundles the information useful for a data catalog entry. Examples would be creator, contributor, title, copyright, embargo, and license information. A set of information useful for attribution, data discovery, and access. This is information that is tied to the identity of the object. If this information changes the version of the associated object changes.</xs:documentation>
60 </xs:annotation>
61 </xs:element>
62 <xs:element name="characterSet"
63 type="xs:string"
64 minOccurs="0"
65 maxOccurs="1"
66 xml:id="DataStore-characterSet">
67 <xs:annotation>
68 <xs:documentation>Default character set used in the Data Store.</xs:documentation>
69 </xs:annotation>
70 </xs:element>
71 <xs:element name="dataStoreType"
72 type="ControlledVocabularyEntryXsdType"
73 minOccurs="0"
74 maxOccurs="1"
75 xml:id="DataStore-dataStoreType">
76 <xs:annotation>
77 <xs:documentation>The type of datastore. Could be delimited file, fixed record length file, relational database, etc. Points to an external definition which can be part of a controlled vocabulary maintained by the DDI Alliance.</xs:documentation>
78 </xs:annotation>
79 </xs:element>
80 <xs:element name="identifier"
81 type="IdentifierXsdType"
82 minOccurs="0"
83 maxOccurs="1"
84 xml:id="DataStore-identifier">
85 <xs:annotation>
86 <xs:documentation>Identifier for objects requiring short- or long-lasting referencing and management.</xs:documentation>
87 </xs:annotation>
88 </xs:element>
89 <xs:element name="name"
90 type="ObjectNameXsdType"
91 minOccurs="0"
92 maxOccurs="unbounded"
93 xml:id="DataStore-name">
94 <xs:annotation>
95 <xs:documentation>Human understandable name (liguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage.</xs:documentation>
96 </xs:annotation>
97 </xs:element>
98 <xs:element name="purpose"
99 type="InternationalStringXsdType"
100 minOccurs="0"
101 maxOccurs="1"
102 xml:id="DataStore-purpose">
103 <xs:annotation>
104 <xs:documentation>Intent or reason for the object/the description of the object.</xs:documentation>
105 </xs:annotation>
106 </xs:element>
107 <xs:element name="recordCount"
108 type="xs:integer"
109 minOccurs="0"
110 maxOccurs="1"
111 xml:id="DataStore-recordCount">
112 <xs:annotation>
113 <xs:documentation>The number of records in the Data Store.</xs:documentation>
114 </xs:annotation>
115 </xs:element>
116 <xs:element name="DataStore_isDefinedBy_Concept"
117 minOccurs="0"
118 maxOccurs="unbounded"
119 xml:id="DataStore_isDefinedBy_Concept">
120 <xs:annotation>
121 <xs:documentation>The conceptual basis for the collection of members.</xs:documentation>
122 </xs:annotation>
123 <xs:complexType>
124 <xs:complexContent>
125 <xs:restriction base="AssociationReferenceXsdType">
126 <xs:sequence>
127 <xs:element name="ddiReference"
128 type="InternationalRegistrationDataIdentifierXsdType"
129 minOccurs="0"
130 maxOccurs="1"
131 xml:id="DataStore_isDefinedBy_Concept-ddiReference"/>
132 <xs:element name="validType"
133 minOccurs="0"
134 maxOccurs="unbounded"
135 xml:id="DataStore_isDefinedBy_Concept-validType">
136 <xs:simpleType>
137 <xs:restriction base="xs:NMTOKEN">
138 <xs:enumeration value="Category"/>
139 <xs:enumeration value="Concept"/>
140 <xs:enumeration value="ConceptualValue"/>
141 <xs:enumeration value="ConceptualVariable"/>
142 <xs:enumeration value="DescriptorVariable"/>
143 <xs:enumeration value="DimensionalKeyDefinitionMember"/>
144 <xs:enumeration value="InstanceVariable"/>
145 <xs:enumeration value="KeyDefinitionMember"/>
146 <xs:enumeration value="Population"/>
147 <xs:enumeration value="ReferenceVariable"/>
148 <xs:enumeration value="RepresentedVariable"/>
149 <xs:enumeration value="UnitType"/>
150 <xs:enumeration value="Universe"/>
151 </xs:restriction>
152 </xs:simpleType>
153 </xs:element>
154 </xs:sequence>
155 </xs:restriction>
156 </xs:complexContent>
157 </xs:complexType>
158 </xs:element>
159 <xs:element name="DataStore_has_LogicalRecordPosition"
160 minOccurs="0"
161 maxOccurs="unbounded"
162 xml:id="DataStore_has_LogicalRecordPosition">
163 <xs:annotation>
164 <xs:documentation></xs:documentation>
165 </xs:annotation>
166 <xs:complexType>
167 <xs:complexContent>
168 <xs:restriction base="AssociationReferenceXsdType">
169 <xs:sequence>
170 <xs:element name="ddiReference"
171 type="InternationalRegistrationDataIdentifierXsdType"
172 minOccurs="0"
173 maxOccurs="1"
174 xml:id="DataStore_has_LogicalRecordPosition-ddiReference"/>
175 <xs:element name="validType"
176 minOccurs="1"
177 maxOccurs="1"
178 xml:id="DataStore_has_LogicalRecordPosition-validType">
179 <xs:simpleType>
180 <xs:restriction base="xs:NMTOKEN">
181 <xs:enumeration value="LogicalRecordPosition"/>
182 </xs:restriction>
183 </xs:simpleType>
184 </xs:element>
185 </xs:sequence>
186 </xs:restriction>
187 </xs:complexContent>
188 </xs:complexType>
189 </xs:element>
190 <xs:element name="DataStore_has_LogicalRecord"
191 minOccurs="0"
192 maxOccurs="unbounded"
193 xml:id="DataStore_has_LogicalRecord">
194 <xs:annotation>
195 <xs:documentation></xs:documentation>
196 </xs:annotation>
197 <xs:complexType>
198 <xs:complexContent>
199 <xs:restriction base="AssociationReferenceXsdType">
200 <xs:sequence>
201 <xs:element name="ddiReference"
202 type="InternationalRegistrationDataIdentifierXsdType"
203 minOccurs="0"
204 maxOccurs="1"
205 xml:id="DataStore_has_LogicalRecord-ddiReference"/>
206 <xs:element name="validType"
207 minOccurs="0"
208 maxOccurs="unbounded"
209 xml:id="DataStore_has_LogicalRecord-validType">
210 <xs:simpleType>
211 <xs:restriction base="xs:NMTOKEN">
212 <xs:enumeration value="LogicalRecord"/>
213 </xs:restriction>
214 </xs:simpleType>
215 </xs:element>
216 </xs:sequence>
217 </xs:restriction>
218 </xs:complexContent>
219 </xs:complexType>
220 </xs:element>
221 <xs:element name="DataStore_has_RecordRelation"
222 minOccurs="0"
223 maxOccurs="1"
224 xml:id="DataStore_has_RecordRelation">
225 <xs:annotation>
226 <xs:documentation>The record relation that defines the relationship and linking requirements between logical records in the data store.</xs:documentation>
227 </xs:annotation>
228 <xs:complexType>
229 <xs:complexContent>
230 <xs:restriction base="AssociationReferenceXsdType">
231 <xs:sequence>
232 <xs:element name="ddiReference"
233 type="InternationalRegistrationDataIdentifierXsdType"
234 minOccurs="0"
235 maxOccurs="1"
236 xml:id="DataStore_has_RecordRelation-ddiReference"/>
237 <xs:element name="validType"
238 minOccurs="0"
239 maxOccurs="unbounded"
240 xml:id="DataStore_has_RecordRelation-validType">
241 <xs:simpleType>
242 <xs:restriction base="xs:NMTOKEN">
243 <xs:enumeration value="RecordRelation"/>
244 </xs:restriction>
245 </xs:simpleType>
246 </xs:element>
247 </xs:sequence>
248 </xs:restriction>
249 </xs:complexContent>
250 </xs:complexType>
251 </xs:element>
252 </xs:sequence>
253</xs:complexType>
Fragment for the class DataStore (main ontology)
1# class DataStore
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::DataStore
3cdi:DataStore
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "DataStore";
6 rdfs:comment "Definition \n============ \nCollection of logical records. \n\nExamples \n========== \nThe data lineage of an individual business process or an entire data pipeline are both examples of a logical record relation structures. In a data lineage we can observe how logical records are connected within a business process or across business processes. \n\nExplanatory notes \n=================== \nKeep in mind that a logical records are definitions, not a \"datasets\". Logical records organized in a structured collection is called a logical record relation structure. Instances of logical records instantiated as organizations of data points hosting data are described in format description. A data store is reusable across studies. Each study has at most one data store."@en;
7
8.
9
10cdi:DataStore-aboutMissing
11 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
12 rdfs:label "aboutMissing";
13 rdfs:comment "General information about missing data, e.g., that missing data have been standardized across the collection, missing data are present because of merging, etc.- corresponds to DDI2.5 dataMsng."@en;
14 rdfs:domain cdi:DataStore;
15 rdfs:range cdi:InternationalString;
16.
17
18cdi:DataStore-allowsDuplicates
19 a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
20 rdfs:label "allowsDuplicates";
21 rdfs:comment "If value is False, the members are unique within the collection - if True, there may be duplicates. (Note that a mathematical “bag” permits duplicates and is unordered - a “set” does not have duplicates and may be ordered.)"@en;
22 rdfs:domain cdi:DataStore;
23 rdfs:range xsd:boolean;
24.
25
26cdi:DataStore-catalogDetails
27 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
28 rdfs:label "catalogDetails";
29 rdfs:comment "Bundles the information useful for a data catalog entry. Examples would be creator, contributor, title, copyright, embargo, and license information. A set of information useful for attribution, data discovery, and access. This is information that is tied to the identity of the object. If this information changes the version of the associated object changes."@en;
30 rdfs:domain cdi:DataStore;
31 rdfs:range cdi:CatalogDetails;
32.
33
34cdi:DataStore-characterSet
35 a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
36 rdfs:label "characterSet";
37 rdfs:comment "Default character set used in the Data Store."@en;
38 rdfs:domain cdi:DataStore;
39 rdfs:range xsd:string;
40.
41
42cdi:DataStore-dataStoreType
43 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
44 rdfs:label "dataStoreType";
45 rdfs:comment "The type of datastore. Could be delimited file, fixed record length file, relational database, etc. Points to an external definition which can be part of a controlled vocabulary maintained by the DDI Alliance."@en;
46 rdfs:domain cdi:DataStore;
47 rdfs:range cdi:ControlledVocabularyEntry;
48.
49
50cdi:DataStore-identifier
51 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
52 rdfs:label "identifier";
53 rdfs:comment "Identifier for objects requiring short- or long-lasting referencing and management."@en;
54 rdfs:domain cdi:DataStore;
55 rdfs:range cdi:Identifier;
56.
57
58cdi:DataStore-name
59 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
60 rdfs:label "name";
61 rdfs:comment "Human understandable name (liguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage."@en;
62 rdfs:domain cdi:DataStore;
63 rdfs:range cdi:ObjectName;
64.
65
66cdi:DataStore-purpose
67 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
68 rdfs:label "purpose";
69 rdfs:comment "Intent or reason for the object/the description of the object."@en;
70 rdfs:domain cdi:DataStore;
71 rdfs:range cdi:InternationalString;
72.
73
74cdi:DataStore-recordCount
75 a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
76 rdfs:label "recordCount";
77 rdfs:comment "The number of records in the Data Store."@en;
78 rdfs:domain cdi:DataStore;
79 rdfs:range xsd:integer;
80.
81
82
83cdi:DataStore_isDefinedBy_Concept
84 a rdf:Property, owl:ObjectProperty, ucmis:Association;
85 # ASSOCIATION
86 rdfs:label "isDefinedBy";
87 skos:altLabel "DataStore_isDefinedBy_Concept";
88 rdfs:comment "The conceptual basis for the collection of members."@en;
89 rdfs:domain cdi:DataStore;
90 rdfs:range cdi:Concept;
91.
92
93cdi:DataStore_has_LogicalRecord
94 a rdf:Property, owl:ObjectProperty, ucmis:Association;
95 # ASSOCIATION
96 rdfs:label "has";
97 skos:altLabel "DataStore_has_LogicalRecord";
98
99 rdfs:domain cdi:DataStore;
100 rdfs:range cdi:LogicalRecord;
101.
102
103cdi:DataStore_has_LogicalRecordPosition
104 a rdf:Property, owl:ObjectProperty, ucmis:Association;
105 # ASSOCIATION
106 rdfs:label "has";
107 skos:altLabel "DataStore_has_LogicalRecordPosition";
108
109 rdfs:domain cdi:DataStore;
110 rdfs:range cdi:LogicalRecordPosition;
111.
112
113cdi:DataStore_has_RecordRelation
114 a rdf:Property, owl:ObjectProperty, ucmis:Association;
115 # ASSOCIATION
116 rdfs:label "has";
117 skos:altLabel "DataStore_has_RecordRelation";
118 rdfs:comment "The record relation that defines the relationship and linking requirements between logical records in the data store."@en;
119 rdfs:domain cdi:DataStore;
120 rdfs:range cdi:RecordRelation;
121.
Fragment for the class DataStore (main JSON-LD)
1{
2 "@context": [
3 {
4 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
5 "xsd": "http://www.w3.org/2001/XMLSchema#",
6 "DataStore": "cdi:DataStore",
7 "aboutMissing": {
8 "@id": "cdi:DataStore-aboutMissing",
9 "@type": "@id",
10 "@context": "InternationalString.jsonld"
11 },
12 "allowsDuplicates": {
13 "@id": "cdi:DataStore-allowsDuplicates",
14 "@type": "xsd:boolean"
15 },
16 "catalogDetails": {
17 "@id": "cdi:DataStore-catalogDetails",
18 "@type": "@id",
19 "@context": "CatalogDetails.jsonld"
20 },
21 "characterSet": {
22 "@id": "cdi:DataStore-characterSet",
23 "@type": "xsd:string"
24 },
25 "dataStoreType": {
26 "@id": "cdi:DataStore-dataStoreType",
27 "@type": "@id",
28 "@context": "ControlledVocabularyEntry.jsonld"
29 },
30 "identifier": {
31 "@id": "cdi:DataStore-identifier",
32 "@type": "@id",
33 "@context": "Identifier.jsonld"
34 },
35 "name": {
36 "@id": "cdi:DataStore-name",
37 "@type": "@id",
38 "@context": "ObjectName.jsonld"
39 },
40 "purpose": {
41 "@id": "cdi:DataStore-purpose",
42 "@type": "@id",
43 "@context": "InternationalString.jsonld"
44 },
45 "recordCount": {
46 "@id": "cdi:DataStore-recordCount",
47 "@type": "xsd:integer"
48 },
49
50 "isDefinedBy": {
51 "@id": "cdi:DataStore_isDefinedBy_Concept",
52 "@type": "@id" },
53 "has": {
54 "@id": "cdi:DataStore_has_LogicalRecord",
55 "@type": "@id" },
56 "has": {
57 "@id": "cdi:DataStore_has_LogicalRecordPosition",
58 "@type": "@id" },
59 "has": {
60 "@id": "cdi:DataStore_has_RecordRelation",
61 "@type": "@id" },
62 "structures_OF_LogicalRecordRelationStructure": {
63 "@reverse": "cdi:LogicalRecordRelationStructure_structures_DataStore",
64 "@type": "@id"
65 },
66 "formats_OF_PhysicalDataSet": {
67 "@reverse": "cdi:PhysicalDataSet_formats_DataStore",
68 "@type": "@id"
69 },
70 " comment ": "tag:json-should-support-trailing-commas"
71 }
72 ],
73 "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-03-16 23:40:09.",
74 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::FormatDescription::DataStore"
75}
