SyntheticIdComponent

Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::SyntheticIdComponent

Definition

Persistent and unique identifier (PIDs) to provide standarized, long-lasting identification.

Examples

UUIDs, GUIDs, DOIs, URNs or any other unique id generation framework.

Explanatory notes

This PIDs either complement or replace identifier and dimension components. They complement them when there is a need for having a globally unique identifier as part of an instance key. They replace them when identier components are not available (e.g. after de-identification for confidentiality).

Diagram

Inheritance
  ᐊ── KeyValue::SyntheticIdComponent
Attributes

Name

Inherited from

Description

Data Type

Multiplicity

Default value

identifier

Components::DataStructureComponent

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

Identifier

0..1

semantic

Components::DataStructureComponent

Qualifies the purpose or use expressed as a paired external controlled vocabulary.

PairedControlledVocabularyEntry

0..*

specialization

Components::DataStructureComponent

The role played by the component for the data set for purposes of harmonization and integration, typically regarding geography, time, etc.

SpecializationRole

0..1

Associations

Direction

Association

Description

Multiplicity of SyntheticIdComponent

Package of Other Class

Other Class

Multiplicity of other class

Aggregation Kind

Inherited from

from

DataStructureComponent isDefinedBy RepresentedVariable

Data structure component is defined by zero to one represented variable.

0..*

Conceptual

RepresentedVariable

0..1

none

Components::DataStructureComponent

to

DataPoint correspondsTo DataStructureComponent

0..*

DataDescription

DataPoint

0..*

none

Components::DataStructureComponent

to

DataStructure has DataStructureComponent

0..*

DataDescription

DataStructure

0..1

none

Components::DataStructureComponent

to

KeyMember isBasedOn DataStructureComponent

0..*

DataDescription

KeyMember

0..*

none

Components::DataStructureComponent

to

AttributeComponent qualifies DataStructureComponent

0..*

Components

AttributeComponent

0..*

none

Components::DataStructureComponent

to

ComponentPosition indexes DataStructureComponent

0..1

Components

ComponentPosition

0..*

none

Components::DataStructureComponent

to

ForeignKeyComponent correspondsTo DataStructureComponent

1..1

Components

ForeignKeyComponent

0..1

none

Components::DataStructureComponent

to

PrimaryKeyComponent correspondsTo DataStructureComponent

1..1

Components

PrimaryKeyComponent

0..1

none

Components::DataStructureComponent

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 SyntheticIdComponent (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-KeyValue-SyntheticIdComponent"
 5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SyntheticIdComponent"
 6                 xmi:type="uml:Class">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-SyntheticIdComponent-ownedComment"
 8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SyntheticIdComponent-ownedComment"
 9                 xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-SyntheticIdComponent"/>
11      <body>Definition
12============
13Persistent and unique identifier (PIDs) to provide standarized, long-lasting identification. 
14
15Examples
16==========
17UUIDs, GUIDs, DOIs, URNs or any other unique id generation framework.
18
19Explanatory notes
20===================
21This PIDs either complement or replace identifier and dimension components. 
22They complement them when there is a need for having a globally unique identifier as part of an instance key. They replace them when identier components are not available (e.g. after de-identification for confidentiality).</body>
23   </ownedComment>
24   <name>SyntheticIdComponent</name>
25   <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-SyntheticIdComponent-generalization"
26                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#SyntheticIdComponent-generalization"
27                   xmi:type="uml:Generalization">
28      <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent"/>
29   </generalization>
30</packagedElement>

Fragment for the class SyntheticIdComponent (entire XML Schema)

 1<xs:element name="SyntheticIdComponent"
 2            type="SyntheticIdComponentXsdType"
 3            xml:id="SyntheticIdComponent">
 4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::SyntheticIdComponent -->
 5  <xs:annotation>
 6    <xs:documentation>Definition
 7          ============
 8          Persistent and unique identifier (PIDs) to provide standarized, long-lasting identification. 
 9          
10          Examples
11          ==========
12          UUIDs, GUIDs, DOIs, URNs or any other unique id generation framework.
13          
14          Explanatory notes
15          ===================
16          This PIDs either complement or replace identifier and dimension components. 
17          They complement them when there is a need for having a globally unique identifier as part of an instance key. They replace them when identier components are not available (e.g. after de-identification for confidentiality).</xs:documentation>
18  </xs:annotation>
19</xs:element>
20<xs:complexType name="SyntheticIdComponentXsdType"
21                xml:id="SyntheticIdComponentXsdType">
22  <xs:annotation>
23    <xs:documentation>Definition
24          ============
25          Persistent and unique identifier (PIDs) to provide standarized, long-lasting identification. 
26          
27          Examples
28          ==========
29          UUIDs, GUIDs, DOIs, URNs or any other unique id generation framework.
30          
31          Explanatory notes
32          ===================
33          This PIDs either complement or replace identifier and dimension components. 
34          They complement them when there is a need for having a globally unique identifier as part of an instance key. They replace them when identier components are not available (e.g. after de-identification for confidentiality).</xs:documentation>
35  </xs:annotation>
36  <xs:complexContent>
37    <xs:extension base="DataStructureComponentXsdType">
38      
39    </xs:extension>
40  </xs:complexContent>
41</xs:complexType>

Fragment for the class SyntheticIdComponent (main ontology)

1# class SyntheticIdComponent
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::SyntheticIdComponent
3cdi:SyntheticIdComponent
4  a rdfs:Class, owl:Class, ucmis:Class;
5  rdfs:label "SyntheticIdComponent";
6  rdfs:comment "Definition\n============\nPersistent and unique identifier (PIDs) to provide standarized, long-lasting identification. \n\nExamples\n==========\nUUIDs, GUIDs, DOIs, URNs or any other unique id generation framework.\n\nExplanatory notes\n===================\nThis PIDs either complement or replace identifier and dimension components. \nThey complement them when there is a need for having a globally unique identifier as part of an instance key. They replace them when identier components are not available (e.g. after de-identification for confidentiality)."@en;
7  rdfs:subClassOf cdi:DataStructureComponent;
8.

Fragment for the class SyntheticIdComponent (main JSON-LD)

 1{
 2  "@context": [
 3    "DataStructureComponent.jsonld",
 4    {
 5      "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
 6      "xsd": "http://www.w3.org/2001/XMLSchema#",
 7      "SyntheticIdComponent": "cdi:SyntheticIdComponent",
 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 2024-03-16 23:40:08.",
13  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::SyntheticIdComponent"
14}