Key

Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::DataDescription::Key

Definition

Collection of data instances that uniquely identify a collection of data points in a dataset.

Diagram

Inheritance
DataDescription::Key
ᐊ── Long::LongKey
ᐊ── Wide::WideKey
Attributes

Name

Inherited from

Description

Data Type

Multiplicity

Default value

identifier

- own class -

Identifier for objects requiring short- or long-lasting referencing and management.

Identifier

0..1

Associations

Direction

Association

Description

Multiplicity of Key

Package of Other Class

Other Class

Multiplicity of other class

Aggregation Kind

Inherited from

from

Key correspondsTo Unit

0..*

Conceptual

Unit

0..1

none

- own class -

from

Key correspondsTo Universe

0..*

Conceptual

Universe

0..1

none

- own class -

to

DataSet has Key

0..*

- own package -

DataSet

1..1

none

- own class -

from

Key has KeyMember

0..1

- own package -

KeyMember

0..*

shared

- own class -

from

Key identifies DataPoint

0..1

- own package -

DataPoint

1..*

none

- own class -

from

Key represents KeyDefinition

1..*

- own package -

KeyDefinition

0..1

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 Key (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-Key"
  5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key"
  6                 xmi:type="uml:Class">
  7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedComment"
  8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedComment"
  9                 xmi:type="uml:Comment">
 10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key"/>
 11      <body>Definition 
 12============ 
 13Collection of data instances that uniquely identify a collection of data points in a dataset.</body>
 14   </ownedComment>
 15   <name>Key</name>
 16   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-identifier"
 17                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-identifier"
 18                   xmi:type="uml:Property">
 19      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-identifier-ownedComment"
 20                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-identifier-ownedComment"
 21                    xmi:type="uml:Comment">
 22         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-identifier"/>
 23         <body>Identifier for objects requiring short- or long-lasting referencing and management.</body>
 24      </ownedComment>
 25      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-identifier-lowerValue"
 26                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-identifier-lowerValue"
 27                  xmi:type="uml:LiteralInteger"/>
 28      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-identifier-upperValue"
 29                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-identifier-upperValue"
 30                  xmi:type="uml:LiteralUnlimitedNatural">
 31         <value>1</value>
 32      </upperValue>
 33      <name>identifier</name>
 34      <isID>true</isID>
 35      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Identifier"/>
 36   </ownedAttribute>
 37   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_1"
 38                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_1"
 39                   xmi:type="uml:Property">
 40      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_1-lowerValue"
 41                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_1-lowerValue"
 42                  xmi:type="uml:LiteralInteger"/>
 43      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_1-upperValue"
 44                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_1-upperValue"
 45                  xmi:type="uml:LiteralUnlimitedNatural">
 46         <value>1</value>
 47      </upperValue>
 48      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-Key_correspondsTo_Unit"/>
 49      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-Unit"/>
 50   </ownedAttribute>
 51   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_2"
 52                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_2"
 53                   xmi:type="uml:Property">
 54      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_2-lowerValue"
 55                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_2-lowerValue"
 56                  xmi:type="uml:LiteralInteger"/>
 57      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_2-upperValue"
 58                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_2-upperValue"
 59                  xmi:type="uml:LiteralUnlimitedNatural">
 60         <value>1</value>
 61      </upperValue>
 62      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key_represents_KeyDefinition"/>
 63      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition"/>
 64   </ownedAttribute>
 65   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_3"
 66                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_3"
 67                   xmi:type="uml:Property">
 68      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_3-lowerValue"
 69                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_3-lowerValue"
 70                  xmi:type="uml:LiteralInteger">
 71         <value>1</value>
 72      </lowerValue>
 73      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_3-upperValue"
 74                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_3-upperValue"
 75                  xmi:type="uml:LiteralUnlimitedNatural">
 76         <value>*</value>
 77      </upperValue>
 78      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key_identifies_DataPoint"/>
 79      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-DataPoint"/>
 80   </ownedAttribute>
 81   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_4"
 82                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_4"
 83                   xmi:type="uml:Property">
 84      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_4-lowerValue"
 85                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_4-lowerValue"
 86                  xmi:type="uml:LiteralInteger"/>
 87      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_4-upperValue"
 88                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_4-upperValue"
 89                  xmi:type="uml:LiteralUnlimitedNatural">
 90         <value>1</value>
 91      </upperValue>
 92      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-Key_correspondsTo_Universe"/>
 93      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-Universe"/>
 94   </ownedAttribute>
 95   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_5"
 96                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_5"
 97                   xmi:type="uml:Property">
 98      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_5-lowerValue"
 99                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_5-lowerValue"
100                  xmi:type="uml:LiteralInteger"/>
101      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key-ownedAttribute_5-upperValue"
102                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Key-ownedAttribute_5-upperValue"
103                  xmi:type="uml:LiteralUnlimitedNatural">
104         <value>*</value>
105      </upperValue>
106      <aggregation>shared</aggregation>
107      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key_has_KeyMember"/>
108      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyMember"/>
109   </ownedAttribute>
110</packagedElement>

Fragment for the class Key (entire XML Schema)

  1<xs:element name="Key"
  2            type="KeyXsdType"
  3            xml:id="Key">
  4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Key -->
  5  <xs:annotation>
  6    <xs:documentation>Definition 
  7          ============ 
  8          Collection of data instances that uniquely identify a collection of data points in a dataset.</xs:documentation>
  9  </xs:annotation>
 10</xs:element>
 11<xs:complexType name="KeyXsdType"
 12                xml:id="KeyXsdType">
 13  <xs:annotation>
 14    <xs:documentation>Definition 
 15          ============ 
 16          Collection of data instances that uniquely identify a collection of data points in a dataset.</xs:documentation>
 17  </xs:annotation>
 18  <xs:sequence>
 19    <xs:element name="identifier"
 20                type="IdentifierXsdType"
 21                minOccurs="0"
 22                maxOccurs="1"
 23                xml:id="Key-identifier">
 24      <xs:annotation>
 25        <xs:documentation>Identifier for objects requiring short- or long-lasting referencing and management.</xs:documentation>
 26      </xs:annotation>
 27    </xs:element>
 28    <xs:element name="Key_correspondsTo_Unit"
 29                minOccurs="0"
 30                maxOccurs="1"
 31                xml:id="Key_correspondsTo_Unit">
 32      <xs:annotation>
 33        <xs:documentation></xs:documentation>
 34      </xs:annotation>
 35      <xs:complexType>
 36        <xs:complexContent>
 37          <xs:restriction base="AssociationReferenceXsdType">
 38            <xs:sequence>
 39              <xs:element name="ddiReference"
 40                          type="InternationalRegistrationDataIdentifierXsdType"
 41                          minOccurs="0"
 42                          maxOccurs="1"
 43                          xml:id="Key_correspondsTo_Unit-ddiReference"/>
 44              <xs:element name="validType"
 45                          minOccurs="0"
 46                          maxOccurs="unbounded"
 47                          xml:id="Key_correspondsTo_Unit-validType">
 48                <xs:simpleType>
 49                  <xs:restriction base="xs:NMTOKEN">
 50                    <xs:enumeration value="Unit"/>
 51                  </xs:restriction>
 52                </xs:simpleType>
 53              </xs:element>
 54            </xs:sequence>
 55          </xs:restriction>
 56        </xs:complexContent>
 57      </xs:complexType>
 58    </xs:element>
 59    <xs:element name="Key_represents_KeyDefinition"
 60                minOccurs="0"
 61                maxOccurs="1"
 62                xml:id="Key_represents_KeyDefinition">
 63      <xs:annotation>
 64        <xs:documentation></xs:documentation>
 65      </xs:annotation>
 66      <xs:complexType>
 67        <xs:complexContent>
 68          <xs:restriction base="AssociationReferenceXsdType">
 69            <xs:sequence>
 70              <xs:element name="ddiReference"
 71                          type="InternationalRegistrationDataIdentifierXsdType"
 72                          minOccurs="0"
 73                          maxOccurs="1"
 74                          xml:id="Key_represents_KeyDefinition-ddiReference"/>
 75              <xs:element name="validType"
 76                          minOccurs="1"
 77                          maxOccurs="unbounded"
 78                          xml:id="Key_represents_KeyDefinition-validType">
 79                <xs:simpleType>
 80                  <xs:restriction base="xs:NMTOKEN">
 81                    <xs:enumeration value="DimensionalKeyDefinition"/>
 82                    <xs:enumeration value="KeyDefinition"/>
 83                  </xs:restriction>
 84                </xs:simpleType>
 85              </xs:element>
 86            </xs:sequence>
 87          </xs:restriction>
 88        </xs:complexContent>
 89      </xs:complexType>
 90    </xs:element>
 91    <xs:element name="Key_identifies_DataPoint"
 92                minOccurs="1"
 93                maxOccurs="unbounded"
 94                xml:id="Key_identifies_DataPoint">
 95      <xs:annotation>
 96        <xs:documentation></xs:documentation>
 97      </xs:annotation>
 98      <xs:complexType>
 99        <xs:complexContent>
100          <xs:restriction base="AssociationReferenceXsdType">
101            <xs:sequence>
102              <xs:element name="ddiReference"
103                          type="InternationalRegistrationDataIdentifierXsdType"
104                          minOccurs="0"
105                          maxOccurs="1"
106                          xml:id="Key_identifies_DataPoint-ddiReference"/>
107              <xs:element name="validType"
108                          minOccurs="0"
109                          maxOccurs="1"
110                          xml:id="Key_identifies_DataPoint-validType">
111                <xs:simpleType>
112                  <xs:restriction base="xs:NMTOKEN">
113                    <xs:enumeration value="DataPoint"/>
114                  </xs:restriction>
115                </xs:simpleType>
116              </xs:element>
117            </xs:sequence>
118          </xs:restriction>
119        </xs:complexContent>
120      </xs:complexType>
121    </xs:element>
122    <xs:element name="Key_correspondsTo_Universe"
123                minOccurs="0"
124                maxOccurs="1"
125                xml:id="Key_correspondsTo_Universe">
126      <xs:annotation>
127        <xs:documentation></xs:documentation>
128      </xs:annotation>
129      <xs:complexType>
130        <xs:complexContent>
131          <xs:restriction base="AssociationReferenceXsdType">
132            <xs:sequence>
133              <xs:element name="ddiReference"
134                          type="InternationalRegistrationDataIdentifierXsdType"
135                          minOccurs="0"
136                          maxOccurs="1"
137                          xml:id="Key_correspondsTo_Universe-ddiReference"/>
138              <xs:element name="validType"
139                          minOccurs="0"
140                          maxOccurs="unbounded"
141                          xml:id="Key_correspondsTo_Universe-validType">
142                <xs:simpleType>
143                  <xs:restriction base="xs:NMTOKEN">
144                    <xs:enumeration value="Population"/>
145                    <xs:enumeration value="Universe"/>
146                  </xs:restriction>
147                </xs:simpleType>
148              </xs:element>
149            </xs:sequence>
150          </xs:restriction>
151        </xs:complexContent>
152      </xs:complexType>
153    </xs:element>
154    <xs:element name="Key_has_KeyMember"
155                minOccurs="0"
156                maxOccurs="unbounded"
157                xml:id="Key_has_KeyMember">
158      <xs:annotation>
159        <xs:documentation></xs:documentation>
160      </xs:annotation>
161      <xs:complexType>
162        <xs:complexContent>
163          <xs:restriction base="AssociationReferenceXsdType">
164            <xs:sequence>
165              <xs:element name="ddiReference"
166                          type="InternationalRegistrationDataIdentifierXsdType"
167                          minOccurs="0"
168                          maxOccurs="1"
169                          xml:id="Key_has_KeyMember-ddiReference"/>
170              <xs:element name="validType"
171                          minOccurs="0"
172                          maxOccurs="1"
173                          xml:id="Key_has_KeyMember-validType">
174                <xs:simpleType>
175                  <xs:restriction base="xs:NMTOKEN">
176                    <xs:enumeration value="Descriptor"/>
177                    <xs:enumeration value="DimensionalKeyMember"/>
178                    <xs:enumeration value="KeyMember"/>
179                    <xs:enumeration value="LongMainKeyMember"/>
180                    <xs:enumeration value="MainKeyMember"/>
181                    <xs:enumeration value="WideKeyMember"/>
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:sequence>
191</xs:complexType>

Fragment for the class Key (main ontology)

 1# class Key
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Key
 3cdi:Key
 4  a rdfs:Class, owl:Class, ucmis:Class;
 5  rdfs:label "Key";
 6  rdfs:comment "Definition \n============ \nCollection of data instances that uniquely identify a collection of data points in a dataset."@en;
 7  
 8.
 9
10cdi:Key-identifier
11  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
12  rdfs:label "identifier";
13  rdfs:comment "Identifier for objects requiring short- or long-lasting referencing and management."@en;
14  rdfs:domain cdi:Key;
15  rdfs:range cdi:Identifier;
16.
17
18
19cdi:Key_correspondsTo_Unit
20  a rdf:Property, owl:ObjectProperty, ucmis:Association;
21  # ASSOCIATION
22  rdfs:label "correspondsTo";
23  skos:altLabel "Key_correspondsTo_Unit";
24  
25  rdfs:domain cdi:Key;
26  rdfs:range cdi:Unit;
27.
28
29cdi:Key_correspondsTo_Universe
30  a rdf:Property, owl:ObjectProperty, ucmis:Association;
31  # ASSOCIATION
32  rdfs:label "correspondsTo";
33  skos:altLabel "Key_correspondsTo_Universe";
34  
35  rdfs:domain cdi:Key;
36  rdfs:range cdi:Universe;
37.
38
39cdi:Key_has_KeyMember
40  a rdf:Property, owl:ObjectProperty, ucmis:Association;
41  # ASSOCIATION
42  rdfs:label "has";
43  skos:altLabel "Key_has_KeyMember";
44  
45  rdfs:domain cdi:Key;
46  rdfs:range cdi:KeyMember;
47.
48
49cdi:Key_identifies_DataPoint
50  a rdf:Property, owl:ObjectProperty, ucmis:Association;
51  # ASSOCIATION
52  rdfs:label "identifies";
53  skos:altLabel "Key_identifies_DataPoint";
54  
55  rdfs:domain cdi:Key;
56  rdfs:range cdi:DataPoint;
57.
58
59cdi:Key_represents_KeyDefinition
60  a rdf:Property, owl:ObjectProperty, ucmis:Association;
61  # ASSOCIATION
62  rdfs:label "represents";
63  skos:altLabel "Key_represents_KeyDefinition";
64  
65  rdfs:domain cdi:Key;
66  rdfs:range cdi:KeyDefinition;
67.

Fragment for the class Key (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      "Key": "cdi:Key",
 7      "identifier": {
 8        "@id": "cdi:Key-identifier",
 9        "@type": "@id",
10        "@context": "Identifier.jsonld"
11      },
12      
13      "correspondsTo": {
14        "@id": "cdi:Key_correspondsTo_Unit",
15        "@type": "@id"      },
16      "correspondsTo": {
17        "@id": "cdi:Key_correspondsTo_Universe",
18        "@type": "@id"      },
19      "has": {
20        "@id": "cdi:Key_has_KeyMember",
21        "@type": "@id"      },
22      "identifies": {
23        "@id": "cdi:Key_identifies_DataPoint",
24        "@type": "@id"      },
25      "represents": {
26        "@id": "cdi:Key_represents_KeyDefinition",
27        "@type": "@id"      },
28      "has_OF_DataSet": {
29        "@reverse": "cdi:DataSet_has_Key",
30        "@type": "@id"
31      },
32      " comment ": "tag:json-should-support-trailing-commas" 
33    }
34  ],
35  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-03-16 23:40:09.",
36  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Key"
37}