PrimaryKeyComponent

Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::PrimaryKeyComponent

Definition

Role of a data structure component for content identification purposes

Explanatory notes

Equivalent to a primary key attribute (i.e. column) in the relational model. It can be used in conjunction with a foreign key component to link data structures and their related datasets.

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.

Identifier

0..1

Associations

Direction

Association

Description

Multiplicity of PrimaryKeyComponent

Package of Other Class

Other Class

Multiplicity of other class

Aggregation Kind

Inherited from

to

ForeignKeyComponent references PrimaryKeyComponent

1..1

- own package -

ForeignKeyComponent

0..1

none

- own class -

to

PrimaryKey isComposedOf PrimaryKeyComponent

1..*

- own package -

PrimaryKey

1..1

none

- own class -

from

PrimaryKeyComponent correspondsTo DataStructureComponent

0..1

- own package -

DataStructureComponent

1..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 PrimaryKeyComponent (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-PrimaryKeyComponent"
 5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PrimaryKeyComponent"
 6                 xmi:type="uml:Class">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-PrimaryKeyComponent-ownedComment"
 8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PrimaryKeyComponent-ownedComment"
 9                 xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-PrimaryKeyComponent"/>
11      <body>Definition
12============
13Role of a data structure component for content identification purposes
14
15Explanatory notes
16===================
17Equivalent to a primary key attribute (i.e. column) in the relational model.
18It can be used in conjunction with a foreign key component to link data structures and their related datasets.</body>
19   </ownedComment>
20   <name>PrimaryKeyComponent</name>
21   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-PrimaryKeyComponent-identifier"
22                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PrimaryKeyComponent-identifier"
23                   xmi:type="uml:Property">
24      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-PrimaryKeyComponent-identifier-ownedComment"
25                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PrimaryKeyComponent-identifier-ownedComment"
26                    xmi:type="uml:Comment">
27         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-PrimaryKeyComponent-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-PrimaryKeyComponent-identifier-lowerValue"
31                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PrimaryKeyComponent-identifier-lowerValue"
32                  xmi:type="uml:LiteralInteger"/>
33      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-PrimaryKeyComponent-identifier-upperValue"
34                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PrimaryKeyComponent-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-PrimaryKeyComponent-ownedAttribute"
43                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PrimaryKeyComponent-ownedAttribute"
44                   xmi:type="uml:Property">
45      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-PrimaryKeyComponent-ownedAttribute-lowerValue"
46                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PrimaryKeyComponent-ownedAttribute-lowerValue"
47                  xmi:type="uml:LiteralInteger">
48         <value>1</value>
49      </lowerValue>
50      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-PrimaryKeyComponent-ownedAttribute-upperValue"
51                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PrimaryKeyComponent-ownedAttribute-upperValue"
52                  xmi:type="uml:LiteralUnlimitedNatural">
53         <value>1</value>
54      </upperValue>
55      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-PrimaryKeyComponent_correspondsTo_DataStructureComponent"/>
56      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent"/>
57   </ownedAttribute>
58</packagedElement>

Fragment for the class PrimaryKeyComponent (entire XML Schema)

 1<xs:element name="PrimaryKeyComponent"
 2            type="PrimaryKeyComponentXsdType"
 3            xml:id="PrimaryKeyComponent">
 4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::PrimaryKeyComponent -->
 5  <xs:annotation>
 6    <xs:documentation>Definition
 7          ============
 8          Role of a data structure component for content identification purposes
 9          
10          Explanatory notes
11          ===================
12          Equivalent to a primary key attribute (i.e. column) in the relational model.
13          It can be used in conjunction with a foreign key component to link data structures and their related datasets.</xs:documentation>
14  </xs:annotation>
15</xs:element>
16<xs:complexType name="PrimaryKeyComponentXsdType"
17                xml:id="PrimaryKeyComponentXsdType">
18  <xs:annotation>
19    <xs:documentation>Definition
20          ============
21          Role of a data structure component for content identification purposes
22          
23          Explanatory notes
24          ===================
25          Equivalent to a primary key attribute (i.e. column) in the relational model.
26          It can be used in conjunction with a foreign key component to link data structures and their related datasets.</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="PrimaryKeyComponent-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="PrimaryKeyComponent_correspondsTo_DataStructureComponent"
39                minOccurs="1"
40                maxOccurs="1"
41                xml:id="PrimaryKeyComponent_correspondsTo_DataStructureComponent">
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="PrimaryKeyComponent_correspondsTo_DataStructureComponent-ddiReference"/>
54              <xs:element name="validType"
55                          minOccurs="0"
56                          maxOccurs="1"
57                          xml:id="PrimaryKeyComponent_correspondsTo_DataStructureComponent-validType">
58                <xs:simpleType>
59                  <xs:restriction base="xs:NMTOKEN">
60                    <xs:enumeration value="AttributeComponent"/>
61                    <xs:enumeration value="ContextualComponent"/>
62                    <xs:enumeration value="DataStructure"/>
63                    <xs:enumeration value="DataStructureComponent"/>
64                    <xs:enumeration value="DimensionComponent"/>
65                    <xs:enumeration value="DimensionalDataStructure"/>
66                    <xs:enumeration value="IdentifierComponent"/>
67                    <xs:enumeration value="KeyValueStructure"/>
68                    <xs:enumeration value="LongDataStructure"/>
69                    <xs:enumeration value="MeasureComponent"/>
70                    <xs:enumeration value="QualifiedMeasure"/>
71                    <xs:enumeration value="SyntheticIdComponent"/>
72                    <xs:enumeration value="VariableDescriptorComponent"/>
73                    <xs:enumeration value="VariableValueComponent"/>
74                    <xs:enumeration value="WideDataStructure"/>
75                  </xs:restriction>
76                </xs:simpleType>
77              </xs:element>
78            </xs:sequence>
79          </xs:restriction>
80        </xs:complexContent>
81      </xs:complexType>
82    </xs:element>
83  </xs:sequence>
84</xs:complexType>

Fragment for the class PrimaryKeyComponent (main ontology)

 1# class PrimaryKeyComponent
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::PrimaryKeyComponent
 3cdi:PrimaryKeyComponent
 4  a rdfs:Class, owl:Class, ucmis:Class;
 5  rdfs:label "PrimaryKeyComponent";
 6  rdfs:comment "Definition\n============\nRole of a data structure component for content identification purposes\n\nExplanatory notes\n===================\nEquivalent to a primary key attribute (i.e. column) in the relational model.\nIt can be used in conjunction with a foreign key component to link data structures and their related datasets."@en;
 7  
 8.
 9
10cdi:PrimaryKeyComponent-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:PrimaryKeyComponent;
15  rdfs:range cdi:Identifier;
16.
17
18
19cdi:PrimaryKeyComponent_correspondsTo_DataStructureComponent
20  a rdf:Property, owl:ObjectProperty, ucmis:Association;
21  # ASSOCIATION
22  rdfs:label "correspondsTo";
23  skos:altLabel "PrimaryKeyComponent_correspondsTo_DataStructureComponent";
24  
25  rdfs:domain cdi:PrimaryKeyComponent;
26  rdfs:range cdi:DataStructureComponent;
27.

Fragment for the class PrimaryKeyComponent (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      "PrimaryKeyComponent": "cdi:PrimaryKeyComponent",
 7      "identifier": {
 8        "@id": "cdi:PrimaryKeyComponent-identifier",
 9        "@type": "@id",
10        "@context": "Identifier.jsonld"
11      },
12      
13      "correspondsTo": {
14        "@id": "cdi:PrimaryKeyComponent_correspondsTo_DataStructureComponent",
15        "@type": "@id"      },
16      "references_OF_ForeignKeyComponent": {
17        "@reverse": "cdi:ForeignKeyComponent_references_PrimaryKeyComponent",
18        "@type": "@id"
19      },
20      "isComposedOf_OF_PrimaryKey": {
21        "@reverse": "cdi:PrimaryKey_isComposedOf_PrimaryKeyComponent",
22        "@type": "@id"
23      },
24      " comment ": "tag:json-should-support-trailing-commas" 
25    }
26  ],
27  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-03-16 23:40:07.",
28  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::PrimaryKeyComponent"
29}