ForeignKey¶
Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::ForeignKey
Definition¶
Role of a set of data structure components for content referencing purposes
Explanatory notes¶
Equivalent to foreign key in the relational model. It can be used in conjunction with primary key to link data structures and their related data sets.
Diagram
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
identifier |
- own class - |
Identifier for objects requiring short- or long-lasting referencing and management. |
0..1 |
Associations
Direction |
Association |
Description |
Multiplicity of ForeignKey |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
to |
DataStructure has ForeignKey |
0..* |
1..1 |
none |
- own class - |
|||
from |
ForeignKey isComposedOf ForeignKeyComponent |
1..1 |
- own package - |
1..* |
composite |
- 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 ForeignKey (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-Components-ForeignKey"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ForeignKey"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKey-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ForeignKey-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKey"/>
11 <body>Definition
12============
13Role of a set of data structure components for content referencing purposes
14
15Explanatory notes
16===================
17Equivalent to foreign key in the relational model.
18It can be used in conjunction with primary key to link data structures and their related data sets.</body>
19 </ownedComment>
20 <name>ForeignKey</name>
21 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKey-identifier"
22 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ForeignKey-identifier"
23 xmi:type="uml:Property">
24 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKey-identifier-ownedComment"
25 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ForeignKey-identifier-ownedComment"
26 xmi:type="uml:Comment">
27 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKey-identifier"/>
28 <body>Identifier for objects requiring short- or long-lasting referencing and management.</body>
29 </ownedComment>
30 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKey-identifier-lowerValue"
31 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ForeignKey-identifier-lowerValue"
32 xmi:type="uml:LiteralInteger"/>
33 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKey-identifier-upperValue"
34 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ForeignKey-identifier-upperValue"
35 xmi:type="uml:LiteralUnlimitedNatural">
36 <value>1</value>
37 </upperValue>
38 <name>identifier</name>
39 <isID>true</isID>
40 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Identifier"/>
41 </ownedAttribute>
42 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKey-ownedAttribute"
43 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ForeignKey-ownedAttribute"
44 xmi:type="uml:Property">
45 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKey-ownedAttribute-lowerValue"
46 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ForeignKey-ownedAttribute-lowerValue"
47 xmi:type="uml:LiteralInteger">
48 <value>1</value>
49 </lowerValue>
50 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKey-ownedAttribute-upperValue"
51 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ForeignKey-ownedAttribute-upperValue"
52 xmi:type="uml:LiteralUnlimitedNatural">
53 <value>*</value>
54 </upperValue>
55 <aggregation>composite</aggregation>
56 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKey_isComposedOf_ForeignKeyComponent"/>
57 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ForeignKeyComponent"/>
58 </ownedAttribute>
59</packagedElement>
Fragment for the class ForeignKey (entire XML Schema)
1<xs:element name="ForeignKey"
2 type="ForeignKeyXsdType"
3 xml:id="ForeignKey">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::ForeignKey -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ============
8 Role of a set of data structure components for content referencing purposes
9
10 Explanatory notes
11 ===================
12 Equivalent to foreign key in the relational model.
13 It can be used in conjunction with primary key to link data structures and their related data sets.</xs:documentation>
14 </xs:annotation>
15</xs:element>
16<xs:complexType name="ForeignKeyXsdType"
17 xml:id="ForeignKeyXsdType">
18 <xs:annotation>
19 <xs:documentation>Definition
20 ============
21 Role of a set of data structure components for content referencing purposes
22
23 Explanatory notes
24 ===================
25 Equivalent to foreign key in the relational model.
26 It can be used in conjunction with primary key to link data structures and their related data sets.</xs:documentation>
27 </xs:annotation>
28 <xs:sequence>
29 <xs:element name="identifier"
30 type="IdentifierXsdType"
31 minOccurs="0"
32 maxOccurs="1"
33 xml:id="ForeignKey-identifier">
34 <xs:annotation>
35 <xs:documentation>Identifier for objects requiring short- or long-lasting referencing and management.</xs:documentation>
36 </xs:annotation>
37 </xs:element>
38 <xs:element name="ForeignKey_isComposedOf_ForeignKeyComponent"
39 minOccurs="1"
40 maxOccurs="unbounded"
41 xml:id="ForeignKey_isComposedOf_ForeignKeyComponent">
42 <xs:annotation>
43 <xs:documentation></xs:documentation>
44 </xs:annotation>
45 <xs:complexType>
46 <xs:complexContent>
47 <xs:restriction base="AssociationReferenceXsdType">
48 <xs:sequence>
49 <xs:element name="ddiReference"
50 type="InternationalRegistrationDataIdentifierXsdType"
51 minOccurs="0"
52 maxOccurs="1"
53 xml:id="ForeignKey_isComposedOf_ForeignKeyComponent-ddiReference"/>
54 <xs:element name="validType"
55 minOccurs="1"
56 maxOccurs="1"
57 xml:id="ForeignKey_isComposedOf_ForeignKeyComponent-validType">
58 <xs:simpleType>
59 <xs:restriction base="xs:NMTOKEN">
60 <xs:enumeration value="ForeignKeyComponent"/>
61 </xs:restriction>
62 </xs:simpleType>
63 </xs:element>
64 </xs:sequence>
65 </xs:restriction>
66 </xs:complexContent>
67 </xs:complexType>
68 </xs:element>
69 </xs:sequence>
70</xs:complexType>
Fragment for the class ForeignKey (main ontology)
1# class ForeignKey
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::ForeignKey
3cdi:ForeignKey
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "ForeignKey";
6 rdfs:comment "Definition\n============\nRole of a set of data structure components for content referencing purposes\n\nExplanatory notes\n===================\nEquivalent to foreign key in the relational model.\nIt can be used in conjunction with primary key to link data structures and their related data sets."@en;
7
8.
9
10cdi:ForeignKey-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:ForeignKey;
15 rdfs:range cdi:Identifier;
16.
17
18
19cdi:ForeignKey_isComposedOf_ForeignKeyComponent
20 a rdf:Property, owl:ObjectProperty, ucmis:Association;
21 # ASSOCIATION
22 rdfs:label "isComposedOf";
23 skos:altLabel "ForeignKey_isComposedOf_ForeignKeyComponent";
24
25 rdfs:domain cdi:ForeignKey;
26 rdfs:range cdi:ForeignKeyComponent;
27.
Fragment for the class ForeignKey (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 "ForeignKey": "cdi:ForeignKey",
7 "identifier": {
8 "@id": "cdi:ForeignKey-identifier",
9 "@type": "@id",
10 "@context": "Identifier.jsonld"
11 },
12
13 "isComposedOf": {
14 "@id": "cdi:ForeignKey_isComposedOf_ForeignKeyComponent",
15 "@type": "@id" },
16 "has_OF_DataStructure": {
17 "@reverse": "cdi:DataStructure_has_ForeignKey",
18 "@type": "@id"
19 },
20 " comment ": "tag:json-should-support-trailing-commas"
21 }
22 ],
23 "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-03-16 23:40:06.",
24 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::ForeignKey"
25}
