Descriptor¶
Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::Descriptor
Definition¶
Use of a code for variable identification in the context of a data structure and a variable descriptor component.
Examples¶
Consider two variables, i.e. income and age, with values appearing in the same column. Codes “income” and “age” are descriptors. They appear multiple time in a variable descriptor component, one for each value in the variable value component. Each descriptor references one of those values. This way it’s possible to identify which values correspond to income and which ones to age.
Diagram
Inheritance
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
content |
The content of this value expressed as a string. |
0..1 |
|||
identifier |
Identifier for objects requiring short- or long-lasting referencing and management. |
0..1 |
|||
whiteSpace |
The usual setting “collapse” states that leading and trailing white space will be removed and multiple adjacent white spaces will be treated as a single white space. When setting to “replace” all occurrences of #x9 (tab), #xA (line feed) and #xD (carriage return) are replaced with #x20 (space) but leading and trailing spaces will be retained. If the existence of any of these white spaces is critical to the understanding of the content, change the value of this attribute to “preserve”. |
0..1 |
Associations
Direction |
Association |
Description |
Multiplicity of Descriptor |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
to |
Key has KeyMember |
0..* |
0..1 |
none |
||||
from |
KeyMember isBasedOn DataStructureComponent |
0..* |
0..* |
none |
||||
to |
Datum uses InstanceValue |
1..* |
0..* |
none |
||||
to |
InstanceKey has InstanceValue |
0..1 |
0..* |
none |
||||
from |
InstanceValue hasValueFrom ValueDomain |
0..* |
1..1 |
none |
||||
from |
InstanceValue isStoredIn DataPoint |
0..1 |
0..1 |
none |
||||
from |
InstanceValue represents ConceptualValue |
1..* |
0..1 |
none |
||||
from |
Descriptor hasValueFrom DescriptorValueDomain |
0..* |
- own package - |
1..1 |
none |
- own class - |
||
from |
Descriptor identifies ReferenceVariable |
0..* |
- own package - |
1..1 |
none |
- own class - |
||
from |
Descriptor refersTo ReferenceValue |
1..1 |
- own package - |
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 Descriptor (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-Long-Descriptor"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor"/>
11 <body>Definition
12==========
13Use of a code for variable identification in the context of a data structure and a variable descriptor component.
14
15Examples
16========
17Consider two variables, i.e. income and age, with values appearing in the same column. Codes "income" and "age" are descriptors. They appear multiple time in a variable descriptor component, one for each value in the variable value component. Each descriptor references one of those values. This way it's possible to identify which values correspond to income and which ones to age.</body>
18 </ownedComment>
19 <name>Descriptor</name>
20 <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor-generalization"
21 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor-generalization"
22 xmi:type="uml:Generalization">
23 <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyMember"/>
24 </generalization>
25 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor-ownedAttribute_1"
26 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor-ownedAttribute_1"
27 xmi:type="uml:Property">
28 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor-ownedAttribute_1-lowerValue"
29 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor-ownedAttribute_1-lowerValue"
30 xmi:type="uml:LiteralInteger">
31 <value>1</value>
32 </lowerValue>
33 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor-ownedAttribute_1-upperValue"
34 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor-ownedAttribute_1-upperValue"
35 xmi:type="uml:LiteralUnlimitedNatural">
36 <value>*</value>
37 </upperValue>
38 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor_refersTo_ReferenceValue"/>
39 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue"/>
40 </ownedAttribute>
41 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor-ownedAttribute_2"
42 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor-ownedAttribute_2"
43 xmi:type="uml:Property">
44 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor-ownedAttribute_2-lowerValue"
45 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor-ownedAttribute_2-lowerValue"
46 xmi:type="uml:LiteralInteger">
47 <value>1</value>
48 </lowerValue>
49 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor-ownedAttribute_2-upperValue"
50 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor-ownedAttribute_2-upperValue"
51 xmi:type="uml:LiteralUnlimitedNatural">
52 <value>1</value>
53 </upperValue>
54 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor_identifies_ReferenceVariable"/>
55 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceVariable"/>
56 </ownedAttribute>
57 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor-ownedAttribute_3"
58 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor-ownedAttribute_3"
59 xmi:type="uml:Property">
60 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor-ownedAttribute_3-lowerValue"
61 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor-ownedAttribute_3-lowerValue"
62 xmi:type="uml:LiteralInteger">
63 <value>1</value>
64 </lowerValue>
65 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor-ownedAttribute_3-upperValue"
66 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Descriptor-ownedAttribute_3-upperValue"
67 xmi:type="uml:LiteralUnlimitedNatural">
68 <value>1</value>
69 </upperValue>
70 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-Descriptor_hasValueFrom_DescriptorValueDomain"/>
71 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorValueDomain"/>
72 </ownedAttribute>
73</packagedElement>
Fragment for the class Descriptor (entire XML Schema)
1<xs:element name="Descriptor"
2 type="DescriptorXsdType"
3 xml:id="Descriptor">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::Descriptor -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ==========
8 Use of a code for variable identification in the context of a data structure and a variable descriptor component.
9
10 Examples
11 ========
12 Consider two variables, i.e. income and age, with values appearing in the same column. Codes "income" and "age" are descriptors. They appear multiple time in a variable descriptor component, one for each value in the variable value component. Each descriptor references one of those values. This way it's possible to identify which values correspond to income and which ones to age.</xs:documentation>
13 </xs:annotation>
14</xs:element>
15<xs:complexType name="DescriptorXsdType"
16 xml:id="DescriptorXsdType">
17 <xs:annotation>
18 <xs:documentation>Definition
19 ==========
20 Use of a code for variable identification in the context of a data structure and a variable descriptor component.
21
22 Examples
23 ========
24 Consider two variables, i.e. income and age, with values appearing in the same column. Codes "income" and "age" are descriptors. They appear multiple time in a variable descriptor component, one for each value in the variable value component. Each descriptor references one of those values. This way it's possible to identify which values correspond to income and which ones to age.</xs:documentation>
25 </xs:annotation>
26 <xs:complexContent>
27 <xs:extension base="KeyMemberXsdType">
28 <xs:sequence>
29 <xs:element name="Descriptor_refersTo_ReferenceValue"
30 minOccurs="1"
31 maxOccurs="unbounded"
32 xml:id="Descriptor_refersTo_ReferenceValue">
33 <xs:annotation>
34 <xs:documentation></xs:documentation>
35 </xs:annotation>
36 <xs:complexType>
37 <xs:complexContent>
38 <xs:restriction base="AssociationReferenceXsdType">
39 <xs:sequence>
40 <xs:element name="ddiReference"
41 type="InternationalRegistrationDataIdentifierXsdType"
42 minOccurs="0"
43 maxOccurs="1"
44 xml:id="Descriptor_refersTo_ReferenceValue-ddiReference"/>
45 <xs:element name="validType"
46 minOccurs="1"
47 maxOccurs="1"
48 xml:id="Descriptor_refersTo_ReferenceValue-validType">
49 <xs:simpleType>
50 <xs:restriction base="xs:NMTOKEN">
51 <xs:enumeration value="ReferenceValue"/>
52 </xs:restriction>
53 </xs:simpleType>
54 </xs:element>
55 </xs:sequence>
56 </xs:restriction>
57 </xs:complexContent>
58 </xs:complexType>
59 </xs:element>
60 <xs:element name="Descriptor_identifies_ReferenceVariable"
61 minOccurs="1"
62 maxOccurs="1"
63 xml:id="Descriptor_identifies_ReferenceVariable">
64 <xs:annotation>
65 <xs:documentation></xs:documentation>
66 </xs:annotation>
67 <xs:complexType>
68 <xs:complexContent>
69 <xs:restriction base="AssociationReferenceXsdType">
70 <xs:sequence>
71 <xs:element name="ddiReference"
72 type="InternationalRegistrationDataIdentifierXsdType"
73 minOccurs="0"
74 maxOccurs="1"
75 xml:id="Descriptor_identifies_ReferenceVariable-ddiReference"/>
76 <xs:element name="validType"
77 minOccurs="0"
78 maxOccurs="unbounded"
79 xml:id="Descriptor_identifies_ReferenceVariable-validType">
80 <xs:simpleType>
81 <xs:restriction base="xs:NMTOKEN">
82 <xs:enumeration value="ReferenceVariable"/>
83 </xs:restriction>
84 </xs:simpleType>
85 </xs:element>
86 </xs:sequence>
87 </xs:restriction>
88 </xs:complexContent>
89 </xs:complexType>
90 </xs:element>
91 <xs:element name="Descriptor_hasValueFrom_DescriptorValueDomain"
92 minOccurs="1"
93 maxOccurs="1"
94 xml:id="Descriptor_hasValueFrom_DescriptorValueDomain">
95 <xs:annotation>
96 <xs:documentation></xs:documentation>
97 </xs:annotation>
98 <xs:complexType>
99 <xs:complexContent>
100 <xs:restriction base="AssociationReferenceXsdType">
101 <xs:sequence>
102 <xs:element name="ddiReference"
103 type="InternationalRegistrationDataIdentifierXsdType"
104 minOccurs="0"
105 maxOccurs="1"
106 xml:id="Descriptor_hasValueFrom_DescriptorValueDomain-ddiReference"/>
107 <xs:element name="validType"
108 minOccurs="0"
109 maxOccurs="unbounded"
110 xml:id="Descriptor_hasValueFrom_DescriptorValueDomain-validType">
111 <xs:simpleType>
112 <xs:restriction base="xs:NMTOKEN">
113 <xs:enumeration value="DescriptorValueDomain"/>
114 </xs:restriction>
115 </xs:simpleType>
116 </xs:element>
117 </xs:sequence>
118 </xs:restriction>
119 </xs:complexContent>
120 </xs:complexType>
121 </xs:element>
122 </xs:sequence>
123 </xs:extension>
124 </xs:complexContent>
125</xs:complexType>
Fragment for the class Descriptor (main ontology)
1# class Descriptor
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::Descriptor
3cdi:Descriptor
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "Descriptor";
6 rdfs:comment "Definition\n==========\nUse of a code for variable identification in the context of a data structure and a variable descriptor component.\n\nExamples\n========\nConsider two variables, i.e. income and age, with values appearing in the same column. Codes \"income\" and \"age\" are descriptors. They appear multiple time in a variable descriptor component, one for each value in the variable value component. Each descriptor references one of those values. This way it's possible to identify which values correspond to income and which ones to age."@en;
7 rdfs:subClassOf cdi:KeyMember;
8.
9
10
11cdi:Descriptor_hasValueFrom_DescriptorValueDomain
12 a rdf:Property, owl:ObjectProperty, ucmis:Association;
13 # ASSOCIATION
14 rdfs:label "hasValueFrom";
15 skos:altLabel "Descriptor_hasValueFrom_DescriptorValueDomain";
16
17 rdfs:domain cdi:Descriptor;
18 rdfs:range cdi:DescriptorValueDomain;
19.
20
21cdi:Descriptor_identifies_ReferenceVariable
22 a rdf:Property, owl:ObjectProperty, ucmis:Association;
23 # ASSOCIATION
24 rdfs:label "identifies";
25 skos:altLabel "Descriptor_identifies_ReferenceVariable";
26
27 rdfs:domain cdi:Descriptor;
28 rdfs:range cdi:ReferenceVariable;
29.
30
31cdi:Descriptor_refersTo_ReferenceValue
32 a rdf:Property, owl:ObjectProperty, ucmis:Association;
33 # ASSOCIATION
34 rdfs:label "refersTo";
35 skos:altLabel "Descriptor_refersTo_ReferenceValue";
36
37 rdfs:domain cdi:Descriptor;
38 rdfs:range cdi:ReferenceValue;
39.
Fragment for the class Descriptor (main JSON-LD)
1{
2 "@context": [
3 "KeyMember.jsonld",
4 {
5 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
6 "xsd": "http://www.w3.org/2001/XMLSchema#",
7 "Descriptor": "cdi:Descriptor",
8
9 "hasValueFrom": {
10 "@id": "cdi:Descriptor_hasValueFrom_DescriptorValueDomain",
11 "@type": "@id" },
12 "identifies": {
13 "@id": "cdi:Descriptor_identifies_ReferenceVariable",
14 "@type": "@id" },
15 "refersTo": {
16 "@id": "cdi:Descriptor_refersTo_ReferenceValue",
17 "@type": "@id" },
18 " comment ": "tag:json-should-support-trailing-commas"
19 }
20 ],
21 "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-09-23 21:52:58.",
22 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::Descriptor"
23}
