ReferenceValue#
Fully qualified class name of the UML model DDI-CDI 1.0: DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceValue
Definition#
Recorded value in a variable value component. Value referenced by a descriptor.
Examples#
Consider two variables, i.e. income and age, with values appearing in the same column, e.g. 100000, 45, 85000, 34, etc. Codes “income” and “age” are descriptors whereas 100000, 45, 85000, 34 are reference values.
Diagram#
Diagram
Inheritance#
Inheritance
ᐊ── Long::ReferenceValue
Attributes#
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#
Associations
Direction |
Association |
Description |
Multiplicity of ReferenceValue |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
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 |
ReferenceValue correspondsTo VariableValueComponent |
0..* |
1..1 |
none |
own class |
|||
to |
InstanceKey refersTo ReferenceValue |
1..1 |
0..* |
none |
own class |
|||
to |
Descriptor refersTo ReferenceValue |
1..* |
- own package - |
1..1 |
none |
own class |
||
from |
ReferenceValue hasValueFrom ReferenceValueDomain |
0..* |
- own package - |
1..1 |
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 ReferenceValue (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-ReferenceValue"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceValue"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceValue-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue"/>
11 <body>Definition
12============
13Recorded value in a variable value component.
14Value referenced by a descriptor.
15
16Examples
17==========
18Consider two variables, i.e. income and age, with values appearing in the same column, e.g. 100000, 45, 85000, 34, etc.
19Codes "income" and "age" are descriptors whereas 100000, 45, 85000, 34 are reference values.</body>
20 </ownedComment>
21 <name>ReferenceValue</name>
22 <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue-generalization"
23 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceValue-generalization"
24 xmi:type="uml:Generalization">
25 <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-InstanceValue"/>
26 </generalization>
27 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue-ownedAttribute_1"
28 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceValue-ownedAttribute_1"
29 xmi:type="uml:Property">
30 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue-ownedAttribute_1-lowerValue"
31 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceValue-ownedAttribute_1-lowerValue"
32 xmi:type="uml:LiteralInteger">
33 <value>1</value>
34 </lowerValue>
35 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue-ownedAttribute_1-upperValue"
36 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceValue-ownedAttribute_1-upperValue"
37 xmi:type="uml:LiteralUnlimitedNatural">
38 <value>1</value>
39 </upperValue>
40 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-ReferenceValue_correspondsTo_VariableValueComponent"/>
41 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableValueComponent"/>
42 </ownedAttribute>
43 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue-ownedAttribute_2"
44 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceValue-ownedAttribute_2"
45 xmi:type="uml:Property">
46 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue-ownedAttribute_2-lowerValue"
47 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceValue-ownedAttribute_2-lowerValue"
48 xmi:type="uml:LiteralInteger">
49 <value>1</value>
50 </lowerValue>
51 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue-ownedAttribute_2-upperValue"
52 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceValue-ownedAttribute_2-upperValue"
53 xmi:type="uml:LiteralUnlimitedNatural">
54 <value>1</value>
55 </upperValue>
56 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue_hasValueFrom_ReferenceValueDomain"/>
57 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValueDomain"/>
58 </ownedAttribute>
59</packagedElement>
Fragment for the class ReferenceValue (entire XML Schema)
1<xs:element name="ReferenceValue"
2 type="ReferenceValueXsdType"
3 xml:id="ReferenceValue">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceValue -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ============
8 Recorded value in a variable value component.
9 Value referenced by a descriptor.
10
11 Examples
12 ==========
13 Consider two variables, i.e. income and age, with values appearing in the same column, e.g. 100000, 45, 85000, 34, etc.
14 Codes "income" and "age" are descriptors whereas 100000, 45, 85000, 34 are reference values.</xs:documentation>
15 </xs:annotation>
16</xs:element>
17<xs:complexType name="ReferenceValueXsdType"
18 xml:id="ReferenceValueXsdType">
19 <xs:annotation>
20 <xs:documentation>Definition
21 ============
22 Recorded value in a variable value component.
23 Value referenced by a descriptor.
24
25 Examples
26 ==========
27 Consider two variables, i.e. income and age, with values appearing in the same column, e.g. 100000, 45, 85000, 34, etc.
28 Codes "income" and "age" are descriptors whereas 100000, 45, 85000, 34 are reference values.</xs:documentation>
29 </xs:annotation>
30 <xs:complexContent>
31 <xs:extension base="InstanceValueXsdType">
32 <xs:sequence>
33 <xs:element name="ReferenceValue_correspondsTo_VariableValueComponent"
34 minOccurs="1"
35 maxOccurs="1"
36 xml:id="ReferenceValue_correspondsTo_VariableValueComponent">
37 <xs:annotation>
38 <xs:documentation></xs:documentation>
39 </xs:annotation>
40 <xs:complexType>
41 <xs:complexContent>
42 <xs:restriction base="AssociationReferenceXsdType">
43 <xs:sequence>
44 <xs:element name="ddiReference"
45 type="InternationalRegistrationDataIdentifierXsdType"
46 minOccurs="0"
47 maxOccurs="1"
48 xml:id="ReferenceValue_correspondsTo_VariableValueComponent-ddiReference"/>
49 <xs:element name="validType"
50 minOccurs="0"
51 maxOccurs="unbounded"
52 xml:id="ReferenceValue_correspondsTo_VariableValueComponent-validType">
53 <xs:simpleType>
54 <xs:restriction base="xs:NMTOKEN">
55 <xs:enumeration value="VariableValueComponent"/>
56 </xs:restriction>
57 </xs:simpleType>
58 </xs:element>
59 </xs:sequence>
60 </xs:restriction>
61 </xs:complexContent>
62 </xs:complexType>
63 </xs:element>
64 <xs:element name="ReferenceValue_hasValueFrom_ReferenceValueDomain"
65 minOccurs="1"
66 maxOccurs="1"
67 xml:id="ReferenceValue_hasValueFrom_ReferenceValueDomain">
68 <xs:annotation>
69 <xs:documentation></xs:documentation>
70 </xs:annotation>
71 <xs:complexType>
72 <xs:complexContent>
73 <xs:restriction base="AssociationReferenceXsdType">
74 <xs:sequence>
75 <xs:element name="ddiReference"
76 type="InternationalRegistrationDataIdentifierXsdType"
77 minOccurs="0"
78 maxOccurs="1"
79 xml:id="ReferenceValue_hasValueFrom_ReferenceValueDomain-ddiReference"/>
80 <xs:element name="validType"
81 minOccurs="0"
82 maxOccurs="unbounded"
83 xml:id="ReferenceValue_hasValueFrom_ReferenceValueDomain-validType">
84 <xs:simpleType>
85 <xs:restriction base="xs:NMTOKEN">
86 <xs:enumeration value="ReferenceValueDomain"/>
87 </xs:restriction>
88 </xs:simpleType>
89 </xs:element>
90 </xs:sequence>
91 </xs:restriction>
92 </xs:complexContent>
93 </xs:complexType>
94 </xs:element>
95 </xs:sequence>
96 </xs:extension>
97 </xs:complexContent>
98</xs:complexType>
Fragment for the class ReferenceValue (entire JSON Schema)
1"cls-ReferenceValue": {
2 "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/ReferenceValue",
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": "ReferenceValue"
14 },
15 "content": {
16 "$comment": "cardinality 0..1 – from cdi:InstanceValue",
17 "$ref": "#/defs/dt-TypedString"
18 },
19 "identifier": {
20 "$comment": "cardinality 0..1 – from cdi:InstanceValue",
21 "$ref": "#/defs/dt-Identifier"
22 },
23 "whiteSpace": {
24 "$comment": "cardinality 0..1 – from cdi:InstanceValue",
25 "$ref": "#/defs/enum-WhiteSpaceRule"
26 },
27 "correspondsTo_VariableValueComponent": {
28 "description": "ReferenceValue_correspondsTo_VariableValueComponent",
29 "$comment": "cardinality 1..1",
30 "$ref": "#/defs/target-VariableValueComponent"
31 },
32 "hasValueFrom_ReferenceValueDomain": {
33 "description": "ReferenceValue_hasValueFrom_ReferenceValueDomain",
34 "$comment": "cardinality 1..1",
35 "$ref": "#/defs/target-ReferenceValueDomain"
36 },
37 "hasValueFrom_ValueDomain": {
38 "description": "InstanceValue_hasValueFrom_ValueDomain",
39 "$comment": "cardinality 1..1",
40 "$ref": "#/defs/target-ValueDomain"
41 },
42 "isStoredIn": {
43 "description": "InstanceValue_isStoredIn_DataPoint",
44 "$comment": "cardinality 0..1",
45 "$ref": "#/defs/target-DataPoint"
46 },
47 "represents": {
48 "description": "InstanceValue_represents_ConceptualValue",
49 "$comment": "cardinality 0..1",
50 "$ref": "#/defs/target-ConceptualValue"
51 },
52 "refersTo_OF_InstanceKey": {
53 "description": "InstanceKey_refersTo_ReferenceValue",
54 "$comment": "cardinality 0..-1",
55 "anyOf": [
56 {
57 "$ref": "#/defs/target-InstanceKey"
58 },
59 {
60 "type": "array",
61 "items": {
62 "$ref": "#/defs/target-InstanceKey"
63 }
64 }
65 ]
66 },
67 "refersTo_OF_Descriptor": {
68 "description": "Descriptor_refersTo_ReferenceValue",
69 "$comment": "cardinality 1..1",
70 "$ref": "#/defs/target-Descriptor"
71 },
72 "uses_InstanceValue_OF_Datum": {
73 "description": "Datum_uses_InstanceValue",
74 "$comment": "cardinality 0..-1",
75 "anyOf": [
76 {
77 "$ref": "#/defs/target-Datum"
78 },
79 {
80 "type": "array",
81 "items": {
82 "$ref": "#/defs/target-Datum"
83 }
84 }
85 ]
86 },
87 "has_InstanceValue_OF_InstanceKey": {
88 "description": "InstanceKey_has_InstanceValue",
89 "$comment": "cardinality 0..-1",
90 "anyOf": [
91 {
92 "$ref": "#/defs/target-InstanceKey"
93 },
94 {
95 "type": "array",
96 "items": {
97 "$ref": "#/defs/target-InstanceKey"
98 }
99 }
100 ]
101 },
102 "sameAs": {
103 "$ref": "#/defs/owl:sameAs"
104 }
105 },
106 "required": ["correspondsTo_VariableValueComponent", "hasValueFrom_ReferenceValueDomain", "hasValueFrom_ValueDomain","@type"],
107 "additionalProperties": false
108},
109"target-ReferenceValue": {
110 "description": "all subclasses of http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/ReferenceValue",
111 "anyOf": [
112 { "$ref": "#/defs/cls-ReferenceValue" },
113 { "type": "string", "format": "iri-reference" }
114 ]
115},
Fragment for the class ReferenceValue (main ontology)
1# class ReferenceValue
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceValue
3cdi:ReferenceValue
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "ReferenceValue";
6 rdfs:comment "Definition\n============\nRecorded value in a variable value component. \nValue referenced by a descriptor.\n\nExamples\n==========\nConsider two variables, i.e. income and age, with values appearing in the same column, e.g. 100000, 45, 85000, 34, etc. \nCodes \"income\" and \"age\" are descriptors whereas 100000, 45, 85000, 34 are reference values."@en;
7 rdfs:subClassOf cdi:InstanceValue;
8.
9
10
11cdi:ReferenceValue_correspondsTo_VariableValueComponent
12 a rdf:Property, owl:ObjectProperty, ucmis:Association;
13 # ASSOCIATION
14 rdfs:label "correspondsTo_VariableValueComponent";
15 skos:altLabel "ReferenceValue_correspondsTo_VariableValueComponent";
16
17 rdfs:domain cdi:ReferenceValue;
18 rdfs:range cdi:VariableValueComponent;
19.
20
21cdi:ReferenceValue_hasValueFrom_ReferenceValueDomain
22 a rdf:Property, owl:ObjectProperty, ucmis:Association;
23 # ASSOCIATION
24 rdfs:label "hasValueFrom_ReferenceValueDomain";
25 skos:altLabel "ReferenceValue_hasValueFrom_ReferenceValueDomain";
26
27 rdfs:domain cdi:ReferenceValue;
28 rdfs:range cdi:ReferenceValueDomain;
29.
Fragment for the class ReferenceValue (entire JSON-LD)
1{
2 "@context": [
3 "InstanceValue.jsonld",
4 {
5 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
6 "xsd": "http://www.w3.org/2001/XMLSchema#",
7
8
9 "correspondsTo_VariableValueComponent": {
10 "@id": "cdi:ReferenceValue_correspondsTo_VariableValueComponent",
11 "@type": "@id",
12 "@context": "VariableValueComponent.jsonld"
13 },
14 "hasValueFrom_ReferenceValueDomain": {
15 "@id": "cdi:ReferenceValue_hasValueFrom_ReferenceValueDomain",
16 "@type": "@id",
17 "@context": "ReferenceValueDomain.jsonld"
18 },
19 "refersTo_OF_InstanceKey": {
20 "@reverse": "cdi:InstanceKey_refersTo_ReferenceValue",
21 "@type": "@id",
22 "@context": "InstanceKey.jsonld"
23 },
24 "refersTo_OF_Descriptor": {
25 "@reverse": "cdi:Descriptor_refersTo_ReferenceValue",
26 "@type": "@id",
27 "@context": "Descriptor.jsonld"
28 },
29 " comment ": "tag:json-should-support-trailing-commas"
30 }
31 ],
32 "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:51.",
33 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceValue"
34}
Fragment for the class ReferenceValue (entire SHACL - Shapes Constraint Language)
1# class ReferenceValue
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceValue
3<#ReferenceValue> a sh:NodeShape;
4 sh:targetClass cdi:ReferenceValue;
5 sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/ReferenceValue";
6 sh:closed true;
7 sh:ignoredProperties ( owl:sameAs );
8 sh:property [
9 sh:path rdf:type;
10 sh:in ( cdi:ReferenceValue
11 ) ;
12 ];
13 # attributes
14 # associations from ReferenceValue
15 sh:property <#ReferenceValue_correspondsTo_VariableValueComponent>;
16 sh:property <#ReferenceValue_hasValueFrom_ReferenceValueDomain>;
17 # associations to ReferenceValue
18 sh:property <#rev_InstanceKey_refersTo_ReferenceValue>;
19 sh:property <#rev_Descriptor_refersTo_ReferenceValue>;
20
21 # ---- superclass: InstanceValue
22 # attributes
23 sh:property <#InstanceValue-content>;
24 sh:property <#InstanceValue-identifier>;
25 sh:property <#InstanceValue-whiteSpace>;
26 # associations from InstanceValue
27 sh:property <#InstanceValue_hasValueFrom_ValueDomain>;
28 sh:property <#InstanceValue_isStoredIn_DataPoint>;
29 sh:property <#InstanceValue_represents_ConceptualValue>;
30 # associations to InstanceValue
31 sh:property <#rev_Datum_uses_InstanceValue>;
32 sh:property <#rev_InstanceKey_has_InstanceValue>;
33
34
35
36
37
38.
39
40
41<#ReferenceValue_correspondsTo_VariableValueComponent> a sh:PropertyShape ;
42 sh:path cdi:ReferenceValue_correspondsTo_VariableValueComponent;
43 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
44 cdi:VariableValueComponent
45
46 ) ]];
47 sh:minCount 1;
48 sh:maxCount 1;
49.
50<#rev_ReferenceValue_correspondsTo_VariableValueComponent> a sh:PropertyShape ;
51 sh:path [ sh:inversePath cdi:ReferenceValue_correspondsTo_VariableValueComponent ];
52.
53<#ReferenceValue_hasValueFrom_ReferenceValueDomain> a sh:PropertyShape ;
54 sh:path cdi:ReferenceValue_hasValueFrom_ReferenceValueDomain;
55 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
56 cdi:ReferenceValueDomain
57
58 ) ]];
59 sh:minCount 1;
60 sh:maxCount 1;
61.
62<#rev_ReferenceValue_hasValueFrom_ReferenceValueDomain> a sh:PropertyShape ;
63 sh:path [ sh:inversePath cdi:ReferenceValue_hasValueFrom_ReferenceValueDomain ];
64.
Fragment for the class ReferenceValue (entire ShEx - Shape Expressions)
1# class ReferenceValue
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceValue
3cdi:ReferenceValueShape CLOSED {
4 a [cdi:ReferenceValue];
5 cdi:ReferenceValue_correspondsTo_VariableValueComponent @cdi:VariableValueComponentShape ;
6
7 ^cdi:InstanceKey_refersTo_ReferenceValue @cdi:InstanceKeyShape *;
8 ^cdi:Descriptor_refersTo_ReferenceValue @cdi:DescriptorShape ;
9 cdi:ReferenceValue_hasValueFrom_ReferenceValueDomain @cdi:ReferenceValueDomainShape ;
10
11 &cdi:InstanceValueProperties;
12 }