KeyDefinition#

Fully qualified class name of the UML model DDI-CDI 1.0: DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyDefinition

Definition#

Collection of concepts that uniquely defines a collection of data points in a dataset.

Diagram#

Diagram

Inheritance#

Inheritance
DataDescription::KeyDefinition

Attributes#

Attributes
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#

Associations
Associations#

Direction

Association

Description

Multiplicity of KeyDefinition

Package of Other Class

Other Class

Multiplicity of other class

Aggregation Kind

Inherited from

from

KeyDefinition correspondsTo Unit

0..*

Conceptual

Unit

0..1

none

own class

from

KeyDefinition correspondsTo Universe

0..*

Conceptual

Universe

0..1

none

own class

to

Key represents KeyDefinition

0..1

- own package -

Key

1..*

none

own class

from

KeyDefinition has KeyDefinitionMember

0..1

- own package -

KeyDefinitionMember

0..*

shared

own class

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 KeyDefinition (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-KeyDefinition"
 5                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition"
 6                  xmi:type="uml:Class">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-ownedComment"
 8                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-ownedComment"
 9                  xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition"/>
11      <body>Definition 
12============ 
13Collection of concepts that uniquely defines a collection of data points in a dataset.</body>
14   </ownedComment>
15   <name>KeyDefinition</name>
16   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-identifier"
17                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-identifier"
18                    xmi:type="uml:Property">
19      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-identifier-ownedComment"
20                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-identifier-ownedComment"
21                     xmi:type="uml:Comment">
22         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-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-KeyDefinition-identifier-lowerValue"
26                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-identifier-lowerValue"
27                   xmi:type="uml:LiteralInteger"/>
28      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-identifier-upperValue"
29                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-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-KeyDefinition-ownedAttribute_1"
38                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-ownedAttribute_1"
39                    xmi:type="uml:Property">
40      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-ownedAttribute_1-lowerValue"
41                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-ownedAttribute_1-lowerValue"
42                   xmi:type="uml:LiteralInteger"/>
43      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-ownedAttribute_1-upperValue"
44                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-ownedAttribute_1-upperValue"
45                   xmi:type="uml:LiteralUnlimitedNatural">
46         <value>1</value>
47      </upperValue>
48      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-KeyDefinition_correspondsTo_Universe"/>
49      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-Universe"/>
50   </ownedAttribute>
51   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-ownedAttribute_2"
52                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-ownedAttribute_2"
53                    xmi:type="uml:Property">
54      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-ownedAttribute_2-lowerValue"
55                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-ownedAttribute_2-lowerValue"
56                   xmi:type="uml:LiteralInteger"/>
57      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-ownedAttribute_2-upperValue"
58                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-ownedAttribute_2-upperValue"
59                   xmi:type="uml:LiteralUnlimitedNatural">
60         <value>1</value>
61      </upperValue>
62      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-KeyDefinition_correspondsTo_Unit"/>
63      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-Unit"/>
64   </ownedAttribute>
65   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-ownedAttribute_3"
66                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-ownedAttribute_3"
67                    xmi:type="uml:Property">
68      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-ownedAttribute_3-lowerValue"
69                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-ownedAttribute_3-lowerValue"
70                   xmi:type="uml:LiteralInteger"/>
71      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition-ownedAttribute_3-upperValue"
72                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyDefinition-ownedAttribute_3-upperValue"
73                   xmi:type="uml:LiteralUnlimitedNatural">
74         <value>*</value>
75      </upperValue>
76      <aggregation>shared</aggregation>
77      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinition_has_KeyDefinitionMember"/>
78      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyDefinitionMember"/>
79   </ownedAttribute>
80</packagedElement>

Fragment for the class KeyDefinition (entire XML Schema)

  1<xs:element name="KeyDefinition"
  2            type="KeyDefinitionXsdType"
  3            xml:id="KeyDefinition">
  4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyDefinition -->
  5  <xs:annotation>
  6    <xs:documentation>Definition 
  7          ============ 
  8          Collection of concepts that uniquely defines a collection of data points in a dataset.</xs:documentation>
  9  </xs:annotation>
 10</xs:element>
 11<xs:complexType name="KeyDefinitionXsdType"
 12                xml:id="KeyDefinitionXsdType">
 13  <xs:annotation>
 14    <xs:documentation>Definition 
 15          ============ 
 16          Collection of concepts that uniquely defines 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="KeyDefinition-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="KeyDefinition_correspondsTo_Universe"
 29                minOccurs="0"
 30                maxOccurs="1"
 31                xml:id="KeyDefinition_correspondsTo_Universe">
 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="KeyDefinition_correspondsTo_Universe-ddiReference"/>
 44              <xs:element name="validType"
 45                          minOccurs="0"
 46                          maxOccurs="unbounded"
 47                          xml:id="KeyDefinition_correspondsTo_Universe-validType">
 48                <xs:simpleType>
 49                  <xs:restriction base="xs:NMTOKEN">
 50                    <xs:enumeration value="Population"/>
 51                    <xs:enumeration value="Universe"/>
 52                  </xs:restriction>
 53                </xs:simpleType>
 54              </xs:element>
 55            </xs:sequence>
 56          </xs:restriction>
 57        </xs:complexContent>
 58      </xs:complexType>
 59    </xs:element>
 60    <xs:element name="KeyDefinition_correspondsTo_Unit"
 61                minOccurs="0"
 62                maxOccurs="1"
 63                xml:id="KeyDefinition_correspondsTo_Unit">
 64      <xs:annotation>
 65        <xs:documentation></xs:documentation>
 66      </xs:annotation>
 67      <xs:complexType>
 68        <xs:complexContent>
 69          <xs:restriction base="AssociationReferenceXsdType">
 70            <xs:sequence>
 71              <xs:element name="ddiReference"
 72                          type="InternationalRegistrationDataIdentifierXsdType"
 73                          minOccurs="0"
 74                          maxOccurs="1"
 75                          xml:id="KeyDefinition_correspondsTo_Unit-ddiReference"/>
 76              <xs:element name="validType"
 77                          minOccurs="0"
 78                          maxOccurs="unbounded"
 79                          xml:id="KeyDefinition_correspondsTo_Unit-validType">
 80                <xs:simpleType>
 81                  <xs:restriction base="xs:NMTOKEN">
 82                    <xs:enumeration value="Unit"/>
 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="KeyDefinition_has_KeyDefinitionMember"
 92                minOccurs="0"
 93                maxOccurs="unbounded"
 94                xml:id="KeyDefinition_has_KeyDefinitionMember">
 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="KeyDefinition_has_KeyDefinitionMember-ddiReference"/>
107              <xs:element name="validType"
108                          minOccurs="0"
109                          maxOccurs="1"
110                          xml:id="KeyDefinition_has_KeyDefinitionMember-validType">
111                <xs:simpleType>
112                  <xs:restriction base="xs:NMTOKEN">
113                    <xs:enumeration value="KeyDefinitionMember"/>
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:sequence>
123</xs:complexType>

Fragment for the class KeyDefinition (entire JSON Schema)

 1"cls-KeyDefinition": {
 2  "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/KeyDefinition",
 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": "KeyDefinition"
14    },
15    "identifier": {
16      "$comment": "cardinality 0..1 – from cdi:KeyDefinition",
17      "$ref": "#/defs/dt-Identifier"
18    },
19    "correspondsTo_Unit": {
20      "description": "KeyDefinition_correspondsTo_Unit",
21      "$comment": "cardinality 0..1",
22       "$ref": "#/defs/target-Unit"
23    },
24    "correspondsTo_Universe": {
25      "description": "KeyDefinition_correspondsTo_Universe",
26      "$comment": "cardinality 0..1",
27       "$ref": "#/defs/target-Universe"
28    },
29    "has_KeyDefinitionMember": {
30      "description": "KeyDefinition_has_KeyDefinitionMember",
31      "$comment": "cardinality 0..-1",
32      "anyOf": [
33        {
34          "$ref": "#/defs/target-KeyDefinitionMember"
35        },
36        {
37          "type": "array",
38          "items": {
39            "$ref": "#/defs/target-KeyDefinitionMember"
40          }
41        }
42      ]
43    },
44    "represents_OF_Key": {
45      "description": "Key_represents_KeyDefinition",
46      "$comment": "cardinality 1..-1",
47      "anyOf": [
48        {
49          "$ref": "#/defs/target-Key"
50        },
51        {
52          "type": "array",
53          "items": {
54            "$ref": "#/defs/target-Key"
55          }
56        }
57      ]
58    },
59    "sameAs": {
60      "$ref": "#/defs/owl:sameAs"
61    }
62  },
63  "required": ["@type"],
64  "additionalProperties": false
65},
66"target-KeyDefinition": {
67  "description": "all subclasses of http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/KeyDefinition",
68  "anyOf": [
69    { "$ref": "#/defs/cls-KeyDefinition" },
70    { "$ref": "#/defs/cls-DimensionalKeyDefinition" },
71    { "type": "string", "format": "iri-reference" }
72  ]
73},

Fragment for the class KeyDefinition (main ontology)

 1# class KeyDefinition
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyDefinition
 3cdi:KeyDefinition
 4  a rdfs:Class, owl:Class, ucmis:Class;
 5  rdfs:label "KeyDefinition";
 6  rdfs:comment "Definition \n============ \nCollection of concepts that uniquely defines a collection of data points in a dataset."@en;
 7  
 8.
 9
10cdi:KeyDefinition-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:KeyDefinition;
15  rdfs:range cdi:Identifier;
16.
17
18
19cdi:KeyDefinition_correspondsTo_Unit
20  a rdf:Property, owl:ObjectProperty, ucmis:Association;
21  # ASSOCIATION
22  rdfs:label "correspondsTo_Unit";
23  skos:altLabel "KeyDefinition_correspondsTo_Unit";
24  
25  rdfs:domain cdi:KeyDefinition;
26  rdfs:range cdi:Unit;
27.
28
29cdi:KeyDefinition_correspondsTo_Universe
30  a rdf:Property, owl:ObjectProperty, ucmis:Association;
31  # ASSOCIATION
32  rdfs:label "correspondsTo_Universe";
33  skos:altLabel "KeyDefinition_correspondsTo_Universe";
34  
35  rdfs:domain cdi:KeyDefinition;
36  rdfs:range cdi:Universe;
37.
38
39cdi:KeyDefinition_has_KeyDefinitionMember
40  a rdf:Property, owl:ObjectProperty, ucmis:Association;
41  # ASSOCIATION
42  rdfs:label "has_KeyDefinitionMember";
43  skos:altLabel "KeyDefinition_has_KeyDefinitionMember";
44  
45  rdfs:domain cdi:KeyDefinition;
46  rdfs:range cdi:KeyDefinitionMember;
47.

Fragment for the class KeyDefinition (entire 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
 7      "identifier": {
 8        "@id": "cdi:KeyDefinition-identifier",
 9        "@type": "@id",
10        "@context": "Identifier.jsonld"
11      },
12      
13      "correspondsTo_Unit": {
14        "@id": "cdi:KeyDefinition_correspondsTo_Unit",
15        "@type": "@id",
16        "@context": "Unit.jsonld"
17      },
18      "correspondsTo_Universe": {
19        "@id": "cdi:KeyDefinition_correspondsTo_Universe",
20        "@type": "@id",
21        "@context": "Universe.jsonld"
22      },
23      "has_KeyDefinitionMember": {
24        "@id": "cdi:KeyDefinition_has_KeyDefinitionMember",
25        "@type": "@id",
26        "@context": "KeyDefinitionMember.jsonld"
27      },
28      "represents_OF_Key": {
29        "@reverse": "cdi:Key_represents_KeyDefinition",
30        "@type": "@id",
31        "@context": "Key.jsonld"
32      },
33      " comment ": "tag:json-should-support-trailing-commas"
34    }
35  ],
36  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:52.",
37  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyDefinition"
38}

Fragment for the class KeyDefinition (entire SHACL - Shapes Constraint Language)

 1# class KeyDefinition
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyDefinition
 3<#KeyDefinition> a sh:NodeShape;
 4    sh:targetClass cdi:KeyDefinition;
 5	sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/KeyDefinition";
 6	sh:closed true;
 7	sh:ignoredProperties ( owl:sameAs );
 8    sh:property [
 9			sh:path rdf:type;
10			sh:in (   cdi:KeyDefinition
11			  cdi:DimensionalKeyDefinition
12			 ) ;
13    ];
14    # attributes
15    sh:property <#KeyDefinition-identifier>;
16    # associations from KeyDefinition
17    sh:property <#KeyDefinition_correspondsTo_Unit>;
18    sh:property <#KeyDefinition_correspondsTo_Universe>;
19    sh:property <#KeyDefinition_has_KeyDefinitionMember>;
20    # associations to KeyDefinition
21    sh:property <#rev_Key_represents_KeyDefinition>;
22
23
24
25.
26
27<#KeyDefinition-identifier> a sh:PropertyShape ;
28    sh:path cdi:KeyDefinition-identifier;
29    sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
30        cdi:Identifier
31      
32    ) ]];
33    sh:maxCount 1;
34.
35
36<#KeyDefinition_correspondsTo_Unit> a sh:PropertyShape ;
37    sh:path cdi:KeyDefinition_correspondsTo_Unit;
38	sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
39        cdi:Unit
40      
41    ) ]];
42    sh:maxCount 1;
43.
44<#rev_KeyDefinition_correspondsTo_Unit> a sh:PropertyShape ;
45    sh:path [ sh:inversePath cdi:KeyDefinition_correspondsTo_Unit ];
46.
47<#KeyDefinition_correspondsTo_Universe> a sh:PropertyShape ;
48    sh:path cdi:KeyDefinition_correspondsTo_Universe;
49	sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
50        cdi:Universe
51        cdi:Population
52      
53    ) ]];
54    sh:maxCount 1;
55.
56<#rev_KeyDefinition_correspondsTo_Universe> a sh:PropertyShape ;
57    sh:path [ sh:inversePath cdi:KeyDefinition_correspondsTo_Universe ];
58.
59<#KeyDefinition_has_KeyDefinitionMember> a sh:PropertyShape ;
60    sh:path cdi:KeyDefinition_has_KeyDefinitionMember;
61	sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
62        cdi:KeyDefinitionMember
63      
64    ) ]];
65.
66<#rev_KeyDefinition_has_KeyDefinitionMember> a sh:PropertyShape ;
67    sh:path [ sh:inversePath cdi:KeyDefinition_has_KeyDefinitionMember ];
68    sh:maxCount 1;
69.

Fragment for the class KeyDefinition (entire ShEx - Shape Expressions)

 1# class KeyDefinition
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyDefinition
 3cdi:KeyDefinitionShape CLOSED {
 4	a [cdi:KeyDefinition];
 5	$cdi:KeyDefinitionProperties (
 6	cdi:KeyDefinition-identifier	@cdi:IdentifierShape?;
 7	cdi:KeyDefinition_correspondsTo_Unit	@cdi:UnitShape ?;
 8	
 9	cdi:KeyDefinition_correspondsTo_Universe	@cdi:UniverseShape OR @cdi:PopulationShape?;
10	
11	^cdi:Key_represents_KeyDefinition @cdi:KeyShape OR @cdi:DimensionalKeyShape OR @cdi:InstanceKeyShape OR @cdi:LongKeyShape OR @cdi:WideKeyShape+;
12	cdi:KeyDefinition_has_KeyDefinitionMember	@cdi:KeyDefinitionMemberShape *;
13	
14		);
15}