CorrespondenceDefinition

Fully qualified datatype name: DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::CorrespondenceDefinition

Definition

Describes the commonalities and differences between two members using a textual description of both commonalities and differences plus an optional coding of the type of commonality.

Diagram

Attributes

Name

Inherited from

Description

Data Type

Multiplicity

Default value

commonality

- own datatype -

A description of the common features of the two items. Supports multiple language versions of the same content as well as optional formatting of the content.

InternationalString

0..1

commonalityCode

- own datatype -

Commonality expressed as a term or code. Supports the use of an external controlled vocabulary. If repeated, clarify each external controlled vocabulary used.

ControlledVocabularyEntry

0..*

difference

- own datatype -

A description of the differences between the two items. Supports multiple language versions of the same content as well as optional formatting of the content.

InternationalString

0..1

matching

- own datatype -

Allows specification of exact match, close match, or disjoint. These relationships can be further defined by describing commonalities or differences or providing additional controlled vocabulary descriptions of relationships.

MatchingCriterion

0..1

Usage

Type

Package

Classifier

Attribute

Class

Conceptual

ConceptMap

correspondence

Class

FormatDescription

InstanceVariableMap

correspondence

Class

CollectionsPattern

Map

correspondence

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 data type CorrespondenceDefinition (entire XMI model)

 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-DataTypes-StructuredDataTypes-CorrespondenceDefinition"
 5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition"
 6                 xmi:type="uml:DataType">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-ownedComment"
 8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-ownedComment"
 9                 xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition"/>
11      <body>Definition
12============
13Describes the commonalities and differences between two members using a textual description of both commonalities and differences plus an optional coding of the type of commonality.</body>
14   </ownedComment>
15   <name>CorrespondenceDefinition</name>
16   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-commonality"
17                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-commonality"
18                   xmi:type="uml:Property">
19      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-commonality-ownedComment"
20                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-commonality-ownedComment"
21                    xmi:type="uml:Comment">
22         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-commonality"/>
23         <body>A description of the common features of the two items. Supports multiple language versions of the same content as well as optional formatting of the content.</body>
24      </ownedComment>
25      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-commonality-lowerValue"
26                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-commonality-lowerValue"
27                  xmi:type="uml:LiteralInteger"/>
28      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-commonality-upperValue"
29                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-commonality-upperValue"
30                  xmi:type="uml:LiteralUnlimitedNatural">
31         <value>1</value>
32      </upperValue>
33      <name>commonality</name>
34      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalString"/>
35   </ownedAttribute>
36   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-commonalityCode"
37                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-commonalityCode"
38                   xmi:type="uml:Property">
39      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-commonalityCode-ownedComment"
40                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-commonalityCode-ownedComment"
41                    xmi:type="uml:Comment">
42         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-commonalityCode"/>
43         <body>Commonality expressed as a term or code. Supports the use of an external controlled vocabulary. If repeated, clarify each external controlled vocabulary used.</body>
44      </ownedComment>
45      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-commonalityCode-lowerValue"
46                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-commonalityCode-lowerValue"
47                  xmi:type="uml:LiteralInteger"/>
48      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-commonalityCode-upperValue"
49                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-commonalityCode-upperValue"
50                  xmi:type="uml:LiteralUnlimitedNatural">
51         <value>*</value>
52      </upperValue>
53      <name>commonalityCode</name>
54      <isOrdered>true</isOrdered>
55      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
56   </ownedAttribute>
57   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-difference"
58                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-difference"
59                   xmi:type="uml:Property">
60      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-difference-ownedComment"
61                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-difference-ownedComment"
62                    xmi:type="uml:Comment">
63         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-difference"/>
64         <body>A description of the differences between the two items. Supports multiple language versions of the same content as well as optional formatting of the content.</body>
65      </ownedComment>
66      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-difference-lowerValue"
67                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-difference-lowerValue"
68                  xmi:type="uml:LiteralInteger"/>
69      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-difference-upperValue"
70                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-difference-upperValue"
71                  xmi:type="uml:LiteralUnlimitedNatural">
72         <value>1</value>
73      </upperValue>
74      <name>difference</name>
75      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalString"/>
76   </ownedAttribute>
77   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-matching"
78                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-matching"
79                   xmi:type="uml:Property">
80      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-matching-ownedComment"
81                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-matching-ownedComment"
82                    xmi:type="uml:Comment">
83         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-matching"/>
84         <body>Allows specification of exact match, close match, or disjoint. These relationships can be further defined by describing commonalities or differences or providing additional controlled vocabulary descriptions of relationships.</body>
85      </ownedComment>
86      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-matching-lowerValue"
87                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-matching-lowerValue"
88                  xmi:type="uml:LiteralInteger"/>
89      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition-matching-upperValue"
90                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CorrespondenceDefinition-matching-upperValue"
91                  xmi:type="uml:LiteralUnlimitedNatural">
92         <value>1</value>
93      </upperValue>
94      <name>matching</name>
95      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-Enumerations-MatchingCriterion"/>
96   </ownedAttribute>
97</packagedElement>

Fragment for the data type CorrespondenceDefinition (entire XML Schema)

 1<xs:element name="CorrespondenceDefinition"
 2            type="CorrespondenceDefinitionXsdType"
 3            xml:id="CorrespondenceDefinition">
 4  <!-- based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::CorrespondenceDefinition -->
 5  <xs:annotation>
 6    <xs:documentation>Definition
 7          ============
 8          Describes the commonalities and differences between two members using a textual description of both commonalities and differences plus an optional coding of the type of commonality.</xs:documentation>
 9  </xs:annotation>
10</xs:element>
11<xs:complexType name="CorrespondenceDefinitionXsdType"
12                xml:id="CorrespondenceDefinitionXsdType">
13  <xs:annotation>
14    <xs:documentation>Definition
15          ============
16          Describes the commonalities and differences between two members using a textual description of both commonalities and differences plus an optional coding of the type of commonality.</xs:documentation>
17  </xs:annotation>
18  <xs:sequence>
19    <xs:element name="commonality"
20                type="InternationalStringXsdType"
21                minOccurs="0"
22                maxOccurs="1"
23                xml:id="CorrespondenceDefinition-commonality">
24      <xs:annotation>
25        <xs:documentation>A description of the common features of the two items. Supports multiple language versions of the same content as well as optional formatting of the content.</xs:documentation>
26      </xs:annotation>
27    </xs:element>
28    <xs:element name="commonalityCode"
29                type="ControlledVocabularyEntryXsdType"
30                minOccurs="0"
31                maxOccurs="unbounded"
32                xml:id="CorrespondenceDefinition-commonalityCode">
33      <xs:annotation>
34        <xs:documentation>Commonality expressed as a term or code. Supports the use of an external controlled vocabulary. If repeated, clarify each external controlled vocabulary used.</xs:documentation>
35      </xs:annotation>
36    </xs:element>
37    <xs:element name="difference"
38                type="InternationalStringXsdType"
39                minOccurs="0"
40                maxOccurs="1"
41                xml:id="CorrespondenceDefinition-difference">
42      <xs:annotation>
43        <xs:documentation>A description of the differences between the two items. Supports multiple language versions of the same content as well as optional formatting of the content.</xs:documentation>
44      </xs:annotation>
45    </xs:element>
46    <xs:element name="matching"
47                type="MatchingCriterionXsdType"
48                minOccurs="0"
49                maxOccurs="1"
50                xml:id="CorrespondenceDefinition-matching">
51      <xs:annotation>
52        <xs:documentation>Allows specification of exact match, close match, or disjoint. These relationships can be further defined by describing commonalities or differences or providing additional controlled vocabulary descriptions of relationships.</xs:documentation>
53      </xs:annotation>
54    </xs:element>
55  </xs:sequence>
56</xs:complexType>

Fragment for the data type CorrespondenceDefinition (main ontology, entire ontology as zip)

 1# datatype CorrespondenceDefinition
 2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::CorrespondenceDefinition
 3cdi:CorrespondenceDefinition
 4  a rdfs:Class, owl:Class, ucmis:StructuredDataType;
 5  rdfs:label "CorrespondenceDefinition";
 6  rdfs:comment "Definition\n============\nDescribes the commonalities and differences between two members using a textual description of both commonalities and differences plus an optional coding of the type of commonality."@en;
 7  
 8  owl:hasKey (cdi:CorrespondenceDefinition-commonality cdi:CorrespondenceDefinition-commonalityCode cdi:CorrespondenceDefinition-difference cdi:CorrespondenceDefinition-matching);
 9.
10
11cdi:CorrespondenceDefinition-commonality
12  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
13  rdfs:label "commonality";
14  rdfs:comment "A description of the common features of the two items. Supports multiple language versions of the same content as well as optional formatting of the content."@en;
15  rdfs:domain cdi:CorrespondenceDefinition;
16  rdfs:range cdi:InternationalString;
17.
18
19cdi:CorrespondenceDefinition-commonalityCode
20  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
21  rdfs:label "commonalityCode";
22  rdfs:comment "Commonality expressed as a term or code. Supports the use of an external controlled vocabulary. If repeated, clarify each external controlled vocabulary used."@en;
23  rdfs:domain cdi:CorrespondenceDefinition;
24  rdfs:range cdi:ControlledVocabularyEntry;
25.
26
27cdi:CorrespondenceDefinition-difference
28  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
29  rdfs:label "difference";
30  rdfs:comment "A description of the differences between the two items. Supports multiple language versions of the same content as well as optional formatting of the content."@en;
31  rdfs:domain cdi:CorrespondenceDefinition;
32  rdfs:range cdi:InternationalString;
33.
34
35cdi:CorrespondenceDefinition-matching
36  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
37  rdfs:label "matching";
38  rdfs:comment "Allows specification of exact match, close match, or disjoint. These relationships can be further defined by describing commonalities or differences or providing additional controlled vocabulary descriptions of relationships."@en;
39  rdfs:domain cdi:CorrespondenceDefinition;
40  rdfs:range cdi:MatchingCriterion;
41.

Fragment for the data type CorrespondenceDefinition (main JSON-LD entire JSON-LD as zip)

 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      "commonality": {
 8        "@id": "cdi:CorrespondenceDefinition-commonality",
 9        "@type": "@id",
10        "@context": "InternationalString.jsonld"
11      },
12      "commonalityCode": {
13        "@id": "cdi:CorrespondenceDefinition-commonalityCode",
14        "@type": "@id",
15        "@context": "ControlledVocabularyEntry.jsonld"
16      },
17      "difference": {
18        "@id": "cdi:CorrespondenceDefinition-difference",
19        "@type": "@id",
20        "@context": "InternationalString.jsonld"
21      },
22      "matching": {
23        "@id": "cdi:CorrespondenceDefinition-matching",
24        "@type": "@vocab",
25        "@context": {
26          "CloseMatch": "cdi:CloseMatch"
27      ,    "Disjoint": "cdi:Disjoint"
28      ,    "ExactMatch": "cdi:ExactMatch"
29        }
30      },
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 2025-01-25 16:58:34.",
36  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::CorrespondenceDefinition"
37}