StructuredDataSet#
Fully qualified class name of the UML model DDI-CDI 1.1beta: DDICDIModels::DDICDILibrary::Classes::FormatDescription::StructuredDataSet
Definition#
Information describing the physical aspects of a data set using a binary or highly structured text-based encoding.
Examples#
NetCDF, HDF5, Parquet or XML data files, each with the means of referencing collections of data points associated to an instance variable via a logical expression. For instance, XPath can be used to navigate an XML data structure and locate the relevant data points.
Diagram#
Diagram
Inheritance#
Inheritance
Attributes#
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
catalogDetails |
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 |
Default character set used in the physical data set. |
String |
0..1 |
||
encoding |
The character encoding of the represented data. From the W3C Recommendation “Metadata Vocabulary for Tabular Data” (https://www.w3.org/TR/tabular-metadata/) 5.9 Dialect: “encoding - An atomic property that sets the encoding flag to the single provided string value, which MUST be a defined in [encoding]. The default is ‘utf-8’.” From the same W3C recommendation 7.2 Encoding: “CSV files should be encoded using UTF-8, and should be in Unicode Normal Form C as defined in [UAX15]. If a CSV file is not encoded using UTF-8, the encoding should be specified through the charset parameter in the Content-Type header.” |
0..1 |
|||
fileSize |
File size expressed as a real number. |
Real |
0..1 |
||
fileSizeUofM |
Unit of measure of the fileSize as a simple string, e.g. KB, megabyte, GB, etc. |
String |
0..1 |
||
fingerprint |
Universal Numerical Fingerprint or similar format-independent, canonical hash value of the physical representation of data in the physical data set. |
0..1 |
|||
identifier |
Identifier for objects requiring short- or long-lasting referencing and management. |
0..1 |
|||
name |
Human understandable name (linguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage. |
0..1 |
|||
overview |
Short natural language account of the information obtained from the combination of properties and relationships associated with an object. |
0..1 |
|||
physicalFileURL |
URL for the physical data set. |
String |
0..1 |
||
purpose |
Intent or reason for the object/the description of the object. |
0..1 |
|||
recordCount |
Number of records in the physical data set. |
Integer |
0..1 |
||
standard |
An established standard to which the described resource conforms. |
0..* |
Associations#
Associations
Direction |
Association |
Description |
Multiplicity of StructuredDataSet |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
from |
PhysicalDataSet has InstanceVariable |
0..* |
0..* |
shared |
||||
from |
PhysicalDataSet isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
from |
PhysicalDataSet correspondsTo DataSet |
0..* |
0..1 |
none |
||||
from |
PhysicalDataSet has PhysicalMapping |
0..* |
- own package - |
0..* |
shared |
|||
from |
PhysicalDataSet has PhysicalMappingPosition |
1..1 |
- own package - |
0..* |
composite |
|||
from |
PhysicalDataSet has Segment |
0..* |
- own package - |
0..* |
shared |
|||
from |
PhysicalDataSet has SegmentPosition |
1..1 |
- own package - |
0..* |
composite |
|||
from |
PhysicalDataSet uses LogicalRecord |
0..* |
- own package - |
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 StructuredDataSet (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-FormatDescription-StructuredDataSet"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#StructuredDataSet"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-StructuredDataSet-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#StructuredDataSet-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-StructuredDataSet"/>
11 <body>Definition
12==========
13Information describing the physical aspects of a data set using a binary or highly structured text-based encoding.
14
15Examples
16========
17NetCDF, HDF5, Parquet or XML data files, each with the means of referencing collections of data points associated to an instance variable via a logical expression. For instance, XPath can be used to navigate an XML data structure and locate the relevant data points.
18</body>
19 </ownedComment>
20 <name>StructuredDataSet</name>
21 <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-StructuredDataSet-generalization"
22 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#StructuredDataSet-generalization"
23 xmi:type="uml:Generalization">
24 <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-PhysicalDataSet"/>
25 </generalization>
26</packagedElement>
Fragment for the class StructuredDataSet (entire XML Schema)
1<xs:element name="StructuredDataSet"
2 type="StructuredDataSetXsdType"
3 xml:id="StructuredDataSet">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::StructuredDataSet -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ==========
8 Information describing the physical aspects of a data set using a binary or highly structured text-based encoding.
9
10 Examples
11 ========
12 NetCDF, HDF5, Parquet or XML data files, each with the means of referencing collections of data points associated to an instance variable via a logical expression. For instance, XPath can be used to navigate an XML data structure and locate the relevant data points.</xs:documentation>
13 </xs:annotation>
14</xs:element>
15<xs:complexType name="StructuredDataSetXsdType"
16 xml:id="StructuredDataSetXsdType">
17 <xs:annotation>
18 <xs:documentation>Definition
19 ==========
20 Information describing the physical aspects of a data set using a binary or highly structured text-based encoding.
21
22 Examples
23 ========
24 NetCDF, HDF5, Parquet or XML data files, each with the means of referencing collections of data points associated to an instance variable via a logical expression. For instance, XPath can be used to navigate an XML data structure and locate the relevant data points.</xs:documentation>
25 </xs:annotation>
26 <xs:complexContent>
27 <xs:extension base="PhysicalDataSetXsdType">
28
29 </xs:extension>
30 </xs:complexContent>
31</xs:complexType>
Fragment for the class StructuredDataSet (entire JSON Schema)
1"cls-StructuredDataSet": {
2 "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/StructuredDataSet",
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": "StructuredDataSet"
14 },
15 "catalogDetails": {
16 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
17 "$ref": "#/defs/dt-CatalogDetails"
18 },
19 "characterSet": {
20 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
21 "$ref": "#/defs/xsd:string"
22 },
23 "encoding": {
24 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
25 "$ref": "#/defs/dt-ControlledVocabularyEntry"
26 },
27 "fileSize": {
28 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
29 "$ref": "#/defs/xsd:double"
30 },
31 "fileSizeUofM": {
32 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
33 "$ref": "#/defs/xsd:string"
34 },
35 "fingerprint": {
36 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
37 "$ref": "#/defs/dt-DataFingerprint"
38 },
39 "identifier": {
40 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
41 "$ref": "#/defs/dt-Identifier"
42 },
43 "name": {
44 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
45 "$ref": "#/defs/dt-ObjectName"
46 },
47 "overview": {
48 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
49 "$ref": "#/defs/dt-InternationalString"
50 },
51 "physicalFileURL": {
52 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
53 "$ref": "#/defs/xsd:string"
54 },
55 "purpose": {
56 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
57 "$ref": "#/defs/dt-InternationalString"
58 },
59 "recordCount": {
60 "$comment": "cardinality 0..1 – from cdi:PhysicalDataSet",
61 "$ref": "#/defs/xsd:integer"
62 },
63 "standard": {
64 "$comment": "cardinality 0..-1 – from cdi:PhysicalDataSet",
65 "if": { "type": "array" },
66 "then": { "items": { "$ref": "#/defs/dt-conformsTo" } },
67 "else": { "$ref": "#/defs/dt-conformsTo" }
68 },
69 "has_InstanceVariable": {
70 "description": "PhysicalDataSet_has_InstanceVariable",
71 "$comment": "cardinality 0..-1",
72 "anyOf": [
73 {
74 "$ref": "#/defs/target-InstanceVariable"
75 },
76 {
77 "type": "array",
78 "items": {
79 "$ref": "#/defs/target-InstanceVariable"
80 }
81 }
82 ]
83 },
84 "isDefinedBy_Concept": {
85 "description": "PhysicalDataSet_isDefinedBy_Concept",
86 "$comment": "cardinality 0..-1",
87 "anyOf": [
88 {
89 "$ref": "#/defs/target-Concept"
90 },
91 {
92 "type": "array",
93 "items": {
94 "$ref": "#/defs/target-Concept"
95 }
96 }
97 ]
98 },
99 "correspondsTo_DataSet": {
100 "description": "PhysicalDataSet_correspondsTo_DataSet",
101 "$comment": "cardinality 0..1",
102 "$ref": "#/defs/target-DataSet"
103 },
104 "has_PhysicalMapping": {
105 "description": "PhysicalDataSet_has_PhysicalMapping",
106 "$comment": "cardinality 0..-1",
107 "anyOf": [
108 {
109 "$ref": "#/defs/target-PhysicalMapping"
110 },
111 {
112 "type": "array",
113 "items": {
114 "$ref": "#/defs/target-PhysicalMapping"
115 }
116 }
117 ]
118 },
119 "has_PhysicalMappingPosition": {
120 "description": "PhysicalDataSet_has_PhysicalMappingPosition",
121 "$comment": "cardinality 0..-1",
122 "anyOf": [
123 {
124 "$ref": "#/defs/target-PhysicalMappingPosition"
125 },
126 {
127 "type": "array",
128 "items": {
129 "$ref": "#/defs/target-PhysicalMappingPosition"
130 }
131 }
132 ]
133 },
134 "has_Segment": {
135 "description": "PhysicalDataSet_has_Segment",
136 "$comment": "cardinality 0..-1",
137 "anyOf": [
138 {
139 "$ref": "#/defs/target-Segment"
140 },
141 {
142 "type": "array",
143 "items": {
144 "$ref": "#/defs/target-Segment"
145 }
146 }
147 ]
148 },
149 "has_SegmentPosition": {
150 "description": "PhysicalDataSet_has_SegmentPosition",
151 "$comment": "cardinality 0..-1",
152 "anyOf": [
153 {
154 "$ref": "#/defs/target-SegmentPosition"
155 },
156 {
157 "type": "array",
158 "items": {
159 "$ref": "#/defs/target-SegmentPosition"
160 }
161 }
162 ]
163 },
164 "uses_LogicalRecord": {
165 "description": "PhysicalDataSet_uses_LogicalRecord",
166 "$comment": "cardinality 0..1",
167 "$ref": "#/defs/target-LogicalRecord"
168 },
169
170 "sameAs": {
171 "$ref": "#/defs/owl:sameAs"
172 }
173 },
174 "required": ["@type"],
175 "additionalProperties": false
176},
177"target-StructuredDataSet": {
178 "description": "all subclasses of http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/StructuredDataSet",
179 "anyOf": [
180 { "$ref": "#/defs/cls-StructuredDataSet" },
181 { "type": "string", "format": "iri-reference" }
182 ]
183},
Fragment for the class StructuredDataSet (main ontology)
1# class StructuredDataSet
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::StructuredDataSet
3cdi:StructuredDataSet
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "StructuredDataSet";
6 rdfs:comment "Definition\n==========\nInformation describing the physical aspects of a data set using a binary or highly structured text-based encoding. \n\nExamples \n========\nNetCDF, HDF5, Parquet or XML data files, each with the means of referencing collections of data points associated to an instance variable via a logical expression. For instance, XPath can be used to navigate an XML data structure and locate the relevant data points."@en;
7 rdfs:subClassOf cdi:PhysicalDataSet;
8.
Fragment for the class StructuredDataSet (entire JSON-LD)
1{
2 "@context": [
3 "PhysicalDataSet.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 2026-04-15 14:38:41.",
13 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::FormatDescription::StructuredDataSet"
14}
Fragment for the class StructuredDataSet (entire SHACL - Shapes Constraint Language)
1# class StructuredDataSet
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::StructuredDataSet
3<#StructuredDataSet> a sh:NodeShape;
4 sh:targetClass cdi:StructuredDataSet;
5 sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/StructuredDataSet";
6 sh:closed true;
7 sh:ignoredProperties ( owl:sameAs );
8 sh:property [
9 sh:path rdf:type;
10 sh:in ( cdi:StructuredDataSet
11 ) ;
12 ];
13 # attributes
14 # associations from StructuredDataSet
15 # associations to StructuredDataSet
16
17 # ---- superclass: PhysicalDataSet
18 # attributes
19 sh:property <#PhysicalDataSet-catalogDetails>;
20 sh:property <#PhysicalDataSet-characterSet>;
21 sh:property <#PhysicalDataSet-encoding>;
22 sh:property <#PhysicalDataSet-fileSize>;
23 sh:property <#PhysicalDataSet-fileSizeUofM>;
24 sh:property <#PhysicalDataSet-fingerprint>;
25 sh:property <#PhysicalDataSet-identifier>;
26 sh:property <#PhysicalDataSet-name>;
27 sh:property <#PhysicalDataSet-overview>;
28 sh:property <#PhysicalDataSet-physicalFileURL>;
29 sh:property <#PhysicalDataSet-purpose>;
30 sh:property <#PhysicalDataSet-recordCount>;
31 sh:property <#PhysicalDataSet-standard>;
32 # associations from PhysicalDataSet
33 sh:property <#PhysicalDataSet_has_InstanceVariable>;
34 sh:property <#PhysicalDataSet_isDefinedBy_Concept>;
35 sh:property <#PhysicalDataSet_correspondsTo_DataSet>;
36 sh:property <#PhysicalDataSet_has_PhysicalMapping>;
37 sh:property <#PhysicalDataSet_has_PhysicalMappingPosition>;
38 sh:property <#PhysicalDataSet_has_Segment>;
39 sh:property <#PhysicalDataSet_has_SegmentPosition>;
40 sh:property <#PhysicalDataSet_uses_LogicalRecord>;
41 # associations to PhysicalDataSet
42
43
44
45
46
47.
Fragment for the class StructuredDataSet (entire ShEx - Shape Expressions)
1# class StructuredDataSet
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::StructuredDataSet
3cdi:StructuredDataSetShape CLOSED {
4 a [cdi:StructuredDataSet];
5 &cdi:PhysicalDataSetProperties;
6 }