DescriptorValueDomain#
Fully qualified class name of the UML model DDI-CDI 1.0: DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::DescriptorValueDomain
Definition#
Set of permissible values for a variable playing the role of 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 that appear in the descriptor value domain corresponding to the descriptor variable.
Diagram#
Diagram
Inheritance#
Inheritance
Attributes#
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
catalogDetails |
Bundles the information useful for a data catalog entry. Examples would be creator, contributor, title, copyright, embargo, and license information A set of information useful for attribution, data discovery, and access. This is information that is tied to the identity of the object. If this information changes the version of the associated object changes. |
0..1 |
|||
displayLabel |
A human-readable display label for the object. Supports the use of multiple languages. Repeat for labels with different content, for example, labels with differing length limitations. |
0..* |
|||
identifier |
Identifier for objects requiring short- or long-lasting referencing and management. |
0..1 |
|||
recommendedDataType |
The data types that are recommended for use with this domain. |
0..* |
Associations#
Associations
Direction |
Association |
Description |
Multiplicity of DescriptorValueDomain |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
to |
RepresentedVariable takesSubstantiveValuesFrom SubstantiveValueDomain |
The substantive representation (substantive value domain) of the variable. This is equivalent to the relationship “Measures” in the Generic Statistical Information Model (GSIM) although GSIM makes no distinction between substantive and sentinel values. |
0..1 |
0..* |
none |
|||
from |
SubstantiveValueDomain takesConceptsFrom SubstantiveConceptualDomain |
Corresponding conceptual definition given by an substantive conceptual domain. |
0..* |
0..1 |
none |
|||
to |
MainKeyMember hasValueFrom SubstantiveValueDomain |
0..1 |
0..* |
none |
||||
from |
SubstantiveValueDomain isDescribedBy ValueAndConceptDescription |
A formal description of the set of valid values - for described value domains. |
0..* |
0..1 |
none |
|||
from |
SubstantiveValueDomain takesValuesFrom EnumerationDomain |
Any subtype of an enumeration domain enumerating the set of valid values. |
0..* |
0..1 |
none |
|||
to |
InstanceValue hasValueFrom ValueDomain |
1..1 |
0..* |
none |
||||
to |
DimensionComponent isStructuredBy ValueDomain |
0..1 |
0..* |
none |
||||
to |
Descriptor hasValueFrom DescriptorValueDomain |
1..1 |
- own package - |
0..* |
none |
own class |
||
to |
DescriptorVariable takesSubstantiveValuesFrom DescriptorValueDomain |
0..1 |
- own package - |
0..* |
none |
own class |
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 class DescriptorValueDomain (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-Classes-DataDescription-Long-DescriptorValueDomain"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DescriptorValueDomain"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorValueDomain-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DescriptorValueDomain-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorValueDomain"/>
11 <body>Definition
12============
13Set of permissible values for a variable playing the role of a variable descriptor component.
14
15Examples
16==========
17Consider two variables, i.e. income and age, with values appearing in the same column.
18Codes "income" and "age" are descriptors that appear in the descriptor value domain corresponding to the descriptor variable.</body>
19 </ownedComment>
20 <name>DescriptorValueDomain</name>
21 <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorValueDomain-generalization"
22 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DescriptorValueDomain-generalization"
23 xmi:type="uml:Generalization">
24 <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-SubstantiveValueDomain"/>
25 </generalization>
26</packagedElement>
Fragment for the class DescriptorValueDomain (entire XML Schema)
1<xs:element name="DescriptorValueDomain"
2 type="DescriptorValueDomainXsdType"
3 xml:id="DescriptorValueDomain">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::DescriptorValueDomain -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ============
8 Set of permissible values for a variable playing the role of a variable descriptor component.
9
10 Examples
11 ==========
12 Consider two variables, i.e. income and age, with values appearing in the same column.
13 Codes "income" and "age" are descriptors that appear in the descriptor value domain corresponding to the descriptor variable.</xs:documentation>
14 </xs:annotation>
15</xs:element>
16<xs:complexType name="DescriptorValueDomainXsdType"
17 xml:id="DescriptorValueDomainXsdType">
18 <xs:annotation>
19 <xs:documentation>Definition
20 ============
21 Set of permissible values for a variable playing the role of a variable descriptor component.
22
23 Examples
24 ==========
25 Consider two variables, i.e. income and age, with values appearing in the same column.
26 Codes "income" and "age" are descriptors that appear in the descriptor value domain corresponding to the descriptor variable.</xs:documentation>
27 </xs:annotation>
28 <xs:complexContent>
29 <xs:extension base="SubstantiveValueDomainXsdType">
30
31 </xs:extension>
32 </xs:complexContent>
33</xs:complexType>
Fragment for the class DescriptorValueDomain (entire JSON Schema)
1"cls-DescriptorValueDomain": {
2 "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/DescriptorValueDomain",
3 "type": "object",
4 "properties": {
5 "@context": {
6 "$ref": "#/defs/at-context"
7 },
8 "@id": {
9 "type": "string",
10 "format": "iri-reference"
11 },
12 "@type": {
13 "const": "DescriptorValueDomain"
14 },
15 "catalogDetails": {
16 "$comment": "cardinality 0..1 – from cdi:ValueDomain",
17 "$ref": "#/defs/dt-CatalogDetails"
18 },
19 "displayLabel": {
20 "$comment": "cardinality 0..-1 – from cdi:ValueDomain",
21 "if": { "type": "array" },
22 "then": { "items": { "$ref": "#/defs/dt-LabelForDisplay" } },
23 "else": { "$ref": "#/defs/dt-LabelForDisplay" }
24 },
25 "identifier": {
26 "$comment": "cardinality 0..1 – from cdi:ValueDomain",
27 "$ref": "#/defs/dt-Identifier"
28 },
29 "recommendedDataType": {
30 "$comment": "cardinality 0..-1 – from cdi:ValueDomain",
31 "if": { "type": "array" },
32 "then": { "items": { "$ref": "#/defs/dt-ControlledVocabularyEntry" } },
33 "else": { "$ref": "#/defs/dt-ControlledVocabularyEntry" }
34 },
35 "takesConceptsFrom": {
36 "description": "SubstantiveValueDomain_takesConceptsFrom_SubstantiveConceptualDomain",
37 "$comment": "cardinality 0..1",
38 "$ref": "#/defs/target-SubstantiveConceptualDomain"
39 },
40 "isDescribedBy": {
41 "description": "SubstantiveValueDomain_isDescribedBy_ValueAndConceptDescription",
42 "$comment": "cardinality 0..1",
43 "$ref": "#/defs/target-ValueAndConceptDescription"
44 },
45 "takesValuesFrom": {
46 "description": "SubstantiveValueDomain_takesValuesFrom_EnumerationDomain",
47 "$comment": "cardinality 0..1",
48 "$ref": "#/defs/target-EnumerationDomain"
49 },
50 "hasValueFrom_DescriptorValueDomain_OF_Descriptor": {
51 "description": "Descriptor_hasValueFrom_DescriptorValueDomain",
52 "$comment": "cardinality 0..-1",
53 "anyOf": [
54 {
55 "$ref": "#/defs/target-Descriptor"
56 },
57 {
58 "type": "array",
59 "items": {
60 "$ref": "#/defs/target-Descriptor"
61 }
62 }
63 ]
64 },
65 "takesSubstantiveValuesFrom_DescriptorValueDomain_OF_DescriptorVariable": {
66 "description": "DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain",
67 "$comment": "cardinality 0..-1",
68 "anyOf": [
69 {
70 "$ref": "#/defs/target-DescriptorVariable"
71 },
72 {
73 "type": "array",
74 "items": {
75 "$ref": "#/defs/target-DescriptorVariable"
76 }
77 }
78 ]
79 },
80 "takesSubstantiveValuesFrom_SubstantiveValueDomain_OF_RepresentedVariable": {
81 "description": "RepresentedVariable_takesSubstantiveValuesFrom_SubstantiveValueDomain",
82 "$comment": "cardinality 0..-1",
83 "anyOf": [
84 {
85 "$ref": "#/defs/target-RepresentedVariable"
86 },
87 {
88 "type": "array",
89 "items": {
90 "$ref": "#/defs/target-RepresentedVariable"
91 }
92 }
93 ]
94 },
95 "hasValueFrom_SubstantiveValueDomain_OF_MainKeyMember": {
96 "description": "MainKeyMember_hasValueFrom_SubstantiveValueDomain",
97 "$comment": "cardinality 0..-1",
98 "anyOf": [
99 {
100 "$ref": "#/defs/target-MainKeyMember"
101 },
102 {
103 "type": "array",
104 "items": {
105 "$ref": "#/defs/target-MainKeyMember"
106 }
107 }
108 ]
109 },
110 "hasValueFrom_ValueDomain_OF_InstanceValue": {
111 "description": "InstanceValue_hasValueFrom_ValueDomain",
112 "$comment": "cardinality 0..-1",
113 "anyOf": [
114 {
115 "$ref": "#/defs/target-InstanceValue"
116 },
117 {
118 "type": "array",
119 "items": {
120 "$ref": "#/defs/target-InstanceValue"
121 }
122 }
123 ]
124 },
125 "isStructuredBy_OF_DimensionComponent": {
126 "description": "DimensionComponent_isStructuredBy_ValueDomain",
127 "$comment": "cardinality 0..-1",
128 "anyOf": [
129 {
130 "$ref": "#/defs/target-DimensionComponent"
131 },
132 {
133 "type": "array",
134 "items": {
135 "$ref": "#/defs/target-DimensionComponent"
136 }
137 }
138 ]
139 },
140 "sameAs": {
141 "$ref": "#/defs/owl:sameAs"
142 }
143 },
144 "required": ["@type"],
145 "additionalProperties": false
146},
147"target-DescriptorValueDomain": {
148 "description": "all subclasses of http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/DescriptorValueDomain",
149 "anyOf": [
150 { "$ref": "#/defs/cls-DescriptorValueDomain" },
151 { "type": "string", "format": "iri-reference" }
152 ]
153},
Fragment for the class DescriptorValueDomain (main ontology)
1# class DescriptorValueDomain
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::DescriptorValueDomain
3cdi:DescriptorValueDomain
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "DescriptorValueDomain";
6 rdfs:comment "Definition\n============\nSet of permissible values for a variable playing the role of a variable descriptor component.\n\nExamples\n==========\nConsider two variables, i.e. income and age, with values appearing in the same column. \nCodes \"income\" and \"age\" are descriptors that appear in the descriptor value domain corresponding to the descriptor variable."@en;
7 rdfs:subClassOf cdi:SubstantiveValueDomain;
8.
Fragment for the class DescriptorValueDomain (entire JSON-LD)
1{
2 "@context": [
3 "SubstantiveValueDomain.jsonld",
4 {
5 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
6 "xsd": "http://www.w3.org/2001/XMLSchema#",
7
8
9 "hasValueFrom_DescriptorValueDomain_OF_Descriptor": {
10 "@reverse": "cdi:Descriptor_hasValueFrom_DescriptorValueDomain",
11 "@type": "@id",
12 "@context": "Descriptor.jsonld"
13 },
14 "takesSubstantiveValuesFrom_DescriptorValueDomain_OF_DescriptorVariable": {
15 "@reverse": "cdi:DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain",
16 "@type": "@id",
17 "@context": "DescriptorVariable.jsonld"
18 },
19 " comment ": "tag:json-should-support-trailing-commas"
20 }
21 ],
22 "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:51.",
23 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::DescriptorValueDomain"
24}
Fragment for the class DescriptorValueDomain (entire SHACL - Shapes Constraint Language)
1# class DescriptorValueDomain
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::DescriptorValueDomain
3<#DescriptorValueDomain> a sh:NodeShape;
4 sh:targetClass cdi:DescriptorValueDomain;
5 sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/DescriptorValueDomain";
6 sh:closed true;
7 sh:ignoredProperties ( owl:sameAs );
8 sh:property [
9 sh:path rdf:type;
10 sh:in ( cdi:DescriptorValueDomain
11 ) ;
12 ];
13 # attributes
14 # associations from DescriptorValueDomain
15 # associations to DescriptorValueDomain
16 sh:property <#rev_Descriptor_hasValueFrom_DescriptorValueDomain>;
17 sh:property <#rev_DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain>;
18
19 # ---- superclass: SubstantiveValueDomain
20 # attributes
21 # associations from SubstantiveValueDomain
22 sh:property <#SubstantiveValueDomain_takesConceptsFrom_SubstantiveConceptualDomain>;
23 sh:property <#SubstantiveValueDomain_isDescribedBy_ValueAndConceptDescription>;
24 sh:property <#SubstantiveValueDomain_takesValuesFrom_EnumerationDomain>;
25 # associations to SubstantiveValueDomain
26 sh:property <#rev_RepresentedVariable_takesSubstantiveValuesFrom_SubstantiveValueDomain>;
27 sh:property <#rev_MainKeyMember_hasValueFrom_SubstantiveValueDomain>;
28
29 # ---- superclass: ValueDomain
30 # attributes
31 sh:property <#ValueDomain-catalogDetails>;
32 sh:property <#ValueDomain-displayLabel>;
33 sh:property <#ValueDomain-identifier>;
34 sh:property <#ValueDomain-recommendedDataType>;
35 # associations from ValueDomain
36 # associations to ValueDomain
37 sh:property <#rev_InstanceValue_hasValueFrom_ValueDomain>;
38 sh:property <#rev_DimensionComponent_isStructuredBy_ValueDomain>;
39
40
41
42
43
44
45
46.
Fragment for the class DescriptorValueDomain (entire ShEx - Shape Expressions)
1# class DescriptorValueDomain
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::DescriptorValueDomain
3cdi:DescriptorValueDomainShape CLOSED {
4 a [cdi:DescriptorValueDomain];
5 ^cdi:Descriptor_hasValueFrom_DescriptorValueDomain @cdi:DescriptorShape *;
6 ^cdi:DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain @cdi:DescriptorVariableShape *;
7 &cdi:SubstantiveValueDomainProperties;
8 }