PairedControlledVocabularyEntry#

Fully qualified datatype name of the UML model DDI-CDI 1.0: DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::PairedControlledVocabularyEntry

Definition#

A tightly bound pair of items from an external controlled vocabulary. The extent property describes the extent to which the parent term applies for the specific case.

Examples#

When used to assign a role to an actor within a specific activity this term would express the degree of contribution. Contributor with term (role) “Editor” and extent “Lead”.

Alternatively the term might be a controlled vocabulary from a list of controlled vocabularies, e.g. the Generic Longitudinal Business Process Model (GLBPM) in a list that could include other business process model frameworks. In this context the extent becomes the name of a business process model task, e.g. “integrate data” from the GLBPM.

Diagram#

Diagram
⤢

Attributes#

Attributes
Attributes#

Name

Inherited from

Description

Data Type

Multiplicity

Default value

extent

- own datatype -

Describes the extent to which the parent term applies for the specific case using an external controlled vocabulary. When associated with a role from the CASRAI Contributor Roles Taxonomy an appropriate vocabulary should be specified as either “lead”, “equal”, or “supporting”.

ControlledVocabularyEntry

0..1

term

- own datatype -

The term attributed to the parent class, for example the role of a contributor.

ControlledVocabularyEntry

1..1

Usage#

Usage
Usage#

Type

Package

Classifier

Attribute

Class

Components

DataStructureComponent

semantic

DataType

StructuredDataTypes

AgentInRole

role

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 data type PairedControlledVocabularyEntry (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-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry"
 5                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PairedControlledVocabularyEntry"
 6                  xmi:type="uml:DataType">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry-ownedComment"
 8                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PairedControlledVocabularyEntry-ownedComment"
 9                  xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry"/>
11      <body>Definition
12==========
13A tightly bound pair of items from an external controlled vocabulary. The extent property describes the extent to which the parent term applies for the specific case.
14
15Examples
16========
17When used to assign a role to an actor within a specific activity this term would express the degree of contribution. Contributor with term (role) "Editor" and extent "Lead".
18
19Alternatively the term might be a controlled vocabulary from a list of controlled vocabularies, e.g. the Generic Longitudinal Business Process Model (GLBPM) in a list that could include other business process model frameworks. In this context the extent becomes the name of a business process model task, e.g. "integrate data" from the GLBPM.</body>
20   </ownedComment>
21   <name>PairedControlledVocabularyEntry</name>
22   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry-extent"
23                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PairedControlledVocabularyEntry-extent"
24                    xmi:type="uml:Property">
25      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry-extent-ownedComment"
26                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PairedControlledVocabularyEntry-extent-ownedComment"
27                     xmi:type="uml:Comment">
28         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry-extent"/>
29         <body>Describes the extent to which the parent term applies for the specific case using an external controlled vocabulary. When associated with a role from the CASRAI Contributor Roles Taxonomy an appropriate vocabulary should be specified as either "lead", "equal", or "supporting".</body>
30      </ownedComment>
31      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry-extent-lowerValue"
32                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PairedControlledVocabularyEntry-extent-lowerValue"
33                   xmi:type="uml:LiteralInteger"/>
34      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry-extent-upperValue"
35                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PairedControlledVocabularyEntry-extent-upperValue"
36                   xmi:type="uml:LiteralUnlimitedNatural">
37         <value>1</value>
38      </upperValue>
39      <name>extent</name>
40      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
41   </ownedAttribute>
42   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry-term"
43                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PairedControlledVocabularyEntry-term"
44                    xmi:type="uml:Property">
45      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry-term-ownedComment"
46                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PairedControlledVocabularyEntry-term-ownedComment"
47                     xmi:type="uml:Comment">
48         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry-term"/>
49         <body>The term attributed to the parent class, for example the role of a contributor.</body>
50      </ownedComment>
51      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry-term-lowerValue"
52                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PairedControlledVocabularyEntry-term-lowerValue"
53                   xmi:type="uml:LiteralInteger">
54         <value>1</value>
55      </lowerValue>
56      <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry-term-upperValue"
57                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#PairedControlledVocabularyEntry-term-upperValue"
58                   xmi:type="uml:LiteralUnlimitedNatural">
59         <value>1</value>
60      </upperValue>
61      <name>term</name>
62      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
63   </ownedAttribute>
64</packagedElement>

Fragment for the data type PairedControlledVocabularyEntry (entire XML Schema)

 1<xs:element name="PairedControlledVocabularyEntry"
 2            type="PairedControlledVocabularyEntryXsdType"
 3            xml:id="PairedControlledVocabularyEntry">
 4  <!-- based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::PairedControlledVocabularyEntry -->
 5  <xs:annotation>
 6    <xs:documentation>Definition
 7          ==========
 8          A tightly bound pair of items from an external controlled vocabulary. The extent property describes the extent to which the parent term applies for the specific case.
 9          
10          Examples
11          ========
12          When used to assign a role to an actor within a specific activity this term would express the degree of contribution. Contributor with term (role) "Editor" and extent "Lead".
13          
14          Alternatively the term might be a controlled vocabulary from a list of controlled vocabularies, e.g. the Generic Longitudinal Business Process Model (GLBPM) in a list that could include other business process model frameworks. In this context the extent becomes the name of a business process model task, e.g. "integrate data" from the GLBPM.</xs:documentation>
15  </xs:annotation>
16</xs:element>
17<xs:complexType name="PairedControlledVocabularyEntryXsdType"
18                xml:id="PairedControlledVocabularyEntryXsdType">
19  <xs:annotation>
20    <xs:documentation>Definition
21          ==========
22          A tightly bound pair of items from an external controlled vocabulary. The extent property describes the extent to which the parent term applies for the specific case.
23          
24          Examples
25          ========
26          When used to assign a role to an actor within a specific activity this term would express the degree of contribution. Contributor with term (role) "Editor" and extent "Lead".
27          
28          Alternatively the term might be a controlled vocabulary from a list of controlled vocabularies, e.g. the Generic Longitudinal Business Process Model (GLBPM) in a list that could include other business process model frameworks. In this context the extent becomes the name of a business process model task, e.g. "integrate data" from the GLBPM.</xs:documentation>
29  </xs:annotation>
30  <xs:sequence>
31    <xs:element name="extent"
32                type="ControlledVocabularyEntryXsdType"
33                minOccurs="0"
34                maxOccurs="1"
35                xml:id="PairedControlledVocabularyEntry-extent">
36      <xs:annotation>
37        <xs:documentation>Describes the extent to which the parent term applies for the specific case using an external controlled vocabulary. When associated with a role from the CASRAI Contributor Roles Taxonomy an appropriate vocabulary should be specified as either "lead", "equal", or "supporting".</xs:documentation>
38      </xs:annotation>
39    </xs:element>
40    <xs:element name="term"
41                type="ControlledVocabularyEntryXsdType"
42                minOccurs="1"
43                maxOccurs="1"
44                xml:id="PairedControlledVocabularyEntry-term">
45      <xs:annotation>
46        <xs:documentation>The term attributed to the parent class, for example the role of a contributor.</xs:documentation>
47      </xs:annotation>
48    </xs:element>
49  </xs:sequence>
50</xs:complexType>

Fragment for the data type PairedControlledVocabularyEntry (entire JSON Schema)

 1"dt-PairedControlledVocabularyEntry": {
 2  "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/PairedControlledVocabularyEntry",
 3  "type": ["object"],
 4  "properties": {
 5    "extent": {
 6      "$comment": "cardinality 0..1 – from cdi:PairedControlledVocabularyEntry",
 7      "$ref": "#/defs/dt-ControlledVocabularyEntry"
 8    },
 9    "term": {
10      "$comment": "cardinality 1..1 – from cdi:PairedControlledVocabularyEntry",
11      "$ref": "#/defs/dt-ControlledVocabularyEntry"
12    },
13    "@type": {
14      "const": "PairedControlledVocabularyEntry"
15    }
16  },
17  "required": ["term","@type"],
18  "additionalProperties": false
19},

Fragment for the data type PairedControlledVocabularyEntry (main ontology)

 1# datatype PairedControlledVocabularyEntry
 2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::PairedControlledVocabularyEntry
 3cdi:PairedControlledVocabularyEntry
 4  a rdfs:Class, owl:Class, ucmis:StructuredDataType;
 5  rdfs:label "PairedControlledVocabularyEntry";
 6  rdfs:comment "Definition\n==========\nA tightly bound pair of items from an external controlled vocabulary. The extent property describes the extent to which the parent term applies for the specific case.\n\nExamples\n========\nWhen used to assign a role to an actor within a specific activity this term would express the degree of contribution. Contributor with term (role) \"Editor\" and extent \"Lead\".\n\nAlternatively the term might be a controlled vocabulary from a list of controlled vocabularies, e.g. the Generic Longitudinal Business Process Model (GLBPM) in a list that could include other business process model frameworks. In this context the extent becomes the name of a business process model task, e.g. \"integrate data\" from the GLBPM."@en;
 7  
 8  owl:hasKey (cdi:PairedControlledVocabularyEntry-extent cdi:PairedControlledVocabularyEntry-term);
 9.
10
11cdi:PairedControlledVocabularyEntry-extent
12  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
13  rdfs:label "extent";
14  rdfs:comment "Describes the extent to which the parent term applies for the specific case using an external controlled vocabulary. When associated with a role from the CASRAI Contributor Roles Taxonomy an appropriate vocabulary should be specified as either \"lead\", \"equal\", or \"supporting\"."@en;
15  rdfs:domain cdi:PairedControlledVocabularyEntry;
16  rdfs:range cdi:ControlledVocabularyEntry;
17.
18
19cdi:PairedControlledVocabularyEntry-term
20  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
21  rdfs:label "term";
22  rdfs:comment "The term attributed to the parent class, for example the role of a contributor."@en;
23  rdfs:domain cdi:PairedControlledVocabularyEntry;
24  rdfs:range cdi:ControlledVocabularyEntry;
25.

Fragment for the data type PairedControlledVocabularyEntry (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      "extent": {
 8        "@id": "cdi:PairedControlledVocabularyEntry-extent",
 9        "@type": "@id",
10        "@context": "ControlledVocabularyEntry.jsonld"
11      },
12      "term": {
13        "@id": "cdi:PairedControlledVocabularyEntry-term",
14        "@type": "@id",
15        "@context": "ControlledVocabularyEntry.jsonld"
16      },
17      
18      " comment ": "tag:json-should-support-trailing-commas" 
19    }
20  ],
21  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:56.",
22  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::PairedControlledVocabularyEntry"
23}

Fragment for the data type PairedControlledVocabularyEntry (entire SHACL - Shapes Constraint Language)

 1# datatype PairedControlledVocabularyEntry
 2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::PairedControlledVocabularyEntry
 3<#PairedControlledVocabularyEntry> a sh:NodeShape;
 4    sh:targetClass cdi:PairedControlledVocabularyEntry;
 5	sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/PairedControlledVocabularyEntry";
 6	sh:closed true;
 7	sh:ignoredProperties ( owl:sameAs );
 8    sh:property [
 9			sh:path rdf:type;
10			sh:in (   cdi:PairedControlledVocabularyEntry
11			 ) ;
12    ];
13    # attributes
14    sh:property <#PairedControlledVocabularyEntry-extent>;
15    sh:property <#PairedControlledVocabularyEntry-term>;
16
17
18
19.
20
21<#PairedControlledVocabularyEntry-extent> a sh:PropertyShape ;
22    sh:path cdi:PairedControlledVocabularyEntry-extent;
23    sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
24        cdi:ControlledVocabularyEntry
25      
26    ) ]];
27    sh:maxCount 1;
28.
29<#PairedControlledVocabularyEntry-term> a sh:PropertyShape ;
30    sh:path cdi:PairedControlledVocabularyEntry-term;
31    sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
32        cdi:ControlledVocabularyEntry
33      
34    ) ]];
35    sh:minCount 1;
36    sh:maxCount 1;
37.

Fragment for the data type PairedControlledVocabularyEntry (entire ShEx - Shape Expressions)

1# datatype PairedControlledVocabularyEntry
2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::PairedControlledVocabularyEntry
3cdi:PairedControlledVocabularyEntryShape CLOSED {
4	a [cdi:PairedControlledVocabularyEntry];
5	cdi:PairedControlledVocabularyEntry-extent	@cdi:ControlledVocabularyEntryShape?;
6	cdi:PairedControlledVocabularyEntry-term	@cdi:ControlledVocabularyEntryShape;
7	}