ReferenceValue

Fully qualified class name: 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

Inheritance
  ᐊ── Long::ReferenceValue
Attributes

Name

Inherited from

Description

Data Type

Multiplicity

Default value

content

DataDescription::InstanceValue

The content of this value expressed as a string.

TypedString

0..1

identifier

DataDescription::InstanceValue

Identifier for objects requiring short- or long-lasting referencing and management.

Identifier

0..1

whiteSpace

DataDescription::InstanceValue

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”.

WhiteSpaceRule

0..1

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..*

DataDescription

Datum

0..*

none

DataDescription::InstanceValue

to

InstanceKey has InstanceValue

0..1

KeyValue

InstanceKey

0..*

none

DataDescription::InstanceValue

from

InstanceValue hasValueFrom ValueDomain

0..*

Representations

ValueDomain

1..1

none

DataDescription::InstanceValue

from

InstanceValue isStoredIn DataPoint

0..1

DataDescription

DataPoint

0..1

none

DataDescription::InstanceValue

from

InstanceValue represents ConceptualValue

1..*

DataDescription

ConceptualValue

0..1

none

DataDescription::InstanceValue

from

ReferenceValue correspondsTo VariableValueComponent

0..*

Components

VariableValueComponent

1..1

none

- own class -

to

InstanceKey refersTo ReferenceValue

1..1

KeyValue

InstanceKey

0..*

none

- own class -

to

Descriptor refersTo ReferenceValue

1..*

- own package -

Descriptor

1..1

none

- own class -

from

ReferenceValue hasValueFrom ReferenceValueDomain

0..*

- own package -

ReferenceValueDomain

1..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 ReferenceValue (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-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 (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";
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";
25  skos:altLabel "ReferenceValue_hasValueFrom_ReferenceValueDomain";
26  
27  rdfs:domain cdi:ReferenceValue;
28  rdfs:range cdi:ReferenceValueDomain;
29.

Fragment for the class ReferenceValue (main 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      "ReferenceValue": "cdi:ReferenceValue",
 8      
 9      "correspondsTo": {
10        "@id": "cdi:ReferenceValue_correspondsTo_VariableValueComponent",
11        "@type": "@id"      },
12      "hasValueFrom": {
13        "@id": "cdi:ReferenceValue_hasValueFrom_ReferenceValueDomain",
14        "@type": "@id"      },
15      "refersTo_OF_InstanceKey": {
16        "@reverse": "cdi:InstanceKey_refersTo_ReferenceValue",
17        "@type": "@id"
18      },
19      "refersTo_OF_Descriptor": {
20        "@reverse": "cdi:Descriptor_refersTo_ReferenceValue",
21        "@type": "@id"
22      },
23      " comment ": "tag:json-should-support-trailing-commas" 
24    }
25  ],
26  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-03-16 23:40:08.",
27  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceValue"
28}