ReferenceVariable#
Fully qualified class name of the UML model DDI-CDI 1.1beta: DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceVariable
Definition#
Variable that records values of multiple variables in the context of a data structure. Variable playing the role of a variable value component.
Examples#
Consider two variables, i.e. income and age, with values appearing in the same column, e.g. 100000, 45, 85000, 34, etc. Values 100000, 45, 85000, 34 are reference values in the reference value domain corresponding to the reference variable.
Diagram#
Diagram
Inheritance#
Inheritance
Attributes#
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
function |
Immutable characteristic of the variable such as geographic designator, weight, temporal designation, etc. |
0..* |
|||
physicalDataType |
The base datatype of the physical representation. An integer instance variable might, for example, be stored as a floating point number. From the W3C Recommendation “Metadata Vocabulary for Tabular Data” (https://www.w3.org/TR/tabular-metadata/) Inherited 5.7: “datatype: An atomic property that contains either a single string that is the main datatype of the values of the cell or a datatype description object. If the value of this property is a string, it MUST be the name of one of the built-in datatypes defined in section 5.11.1 Built-in Datatypes and this value is normalized to an object whose base property is the original string value. If it is an object then it describes a more specialized datatype. If a cell contains a sequence (i.e. the separator property is specified and not null) then this property specifies the datatype of each value within that sequence. See 5.11 Datatypes and Parsing Cells in [tabular-data-model] for more details. The normalized value of this property becomes the datatype annotation for the described column.” |
0..1 |
|||
platformType |
Describes the application or technical system context in which the variable has been realized. Typically a statistical processing package or other processing environment. |
0..1 |
|||
role |
Role of the variable when no reusable data structure is available or necessary. The role can be any of the types of data structure components supported, e.g. identifier, measure, dimension, attribute, etc. (that means the data structure is not reused across physical data sets) |
0..* |
|||
source |
Reference capturing provenance information of the instance variable. |
0..1 |
|||
describedUnitOfMeasure |
The unit in which the data values are measured (kg, pound, euro), expressed as a value from a controlled system of entries (i.e., QDT). Supports the provision of an identifier for the entry in the authoritative source (a URI, etc.), and the specific vocabulary. |
0..1 |
|||
hasIntendedDataType |
The data type intended to be used by this variable. Supports the optional use of an external controlled vocabulary. |
0..1 |
|||
simpleUnitOfMeasure |
The unit in which the data values are measured (kg, pound, euro), expressed as a simple string, in cases where no additional information is available (in the legacy system) or needed (as in the case of broad agreement within the community of use [i.e., ISO country codes, currencies, etc. in SDMX]) |
String |
0..1 |
||
descriptiveText |
A short natural language account of the characteristics of the object. |
0..1 |
|||
unitOfMeasureKind |
Kind of unit of measure, so that it may be prone to translation to equivalent UOMs. Example values include “acceleration,” “temperature,” “salinity”, etc. This description exists at the conceptual level, indicating a limitation on the type of representations which may be used for the variable as it is made more concrete. |
0..1 |
|||
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 |
|||
definition |
Natural language statement conveying the meaning of a concept, differentiating it from other concepts. Supports the use of multiple languages and structured text. ‘externalDefinition’ can’t be used if ‘definition’ is used. |
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..* |
|||
externalDefinition |
A reference to an external definition of a concept (that is, a concept which is described outside the content of the DDI-CDI metadata description). An example is a SKOS concept. The definition property is assumed to duplicate the external one referenced if externalDefinition is used. Other corresponding properties are assumed to be included unchanged if used. |
0..1 |
|||
identifier |
Identifier for objects requiring short- or long-lasting referencing and management. |
0..1 |
|||
name |
Human understandable name (linguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage. |
0..* |
Associations#
Associations
Direction |
Association |
Description |
Multiplicity of ReferenceVariable |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
to |
DataPoint isDescribedBy InstanceVariable |
The instance variable delimits the values which can populate a data point. Data point is described by one instance variable. |
1..1 |
0..* |
none |
|||
to |
DataSet has InstanceVariable |
0..* |
1..* |
none |
||||
to |
Datum isBoundedBy InstanceVariable |
A datum is bounded by an instance variable. The datum is drawn from a set of values, either substantive or sentinel described by the value domain of the instance variable. |
1..* |
0..* |
none |
|||
to |
InstanceVariableMap hasSource InstanceVariable |
The source instance variable for the relationship. |
1..* |
0..* |
none |
|||
to |
InstanceVariableMap hasTarget InstanceVariable |
Target instance variables if a directional relation is used. |
0..* |
0..* |
none |
|||
from |
InstanceVariable isDescribedBy StatisticsCollection |
0..1 |
0..1 |
none |
||||
to |
LogicalRecord has InstanceVariable |
0..* |
0..* |
none |
||||
to |
PhysicalDataSet has InstanceVariable |
0..* |
0..* |
none |
||||
to |
PhysicalMapping formats InstanceVariable |
0..1 |
0..* |
none |
||||
to |
StatisticsCollection hasWeight InstanceVariable |
0..1 |
0..* |
none |
||||
to |
Statistics hasWeight InstanceVariable |
0..1 |
0..* |
none |
||||
to |
DataStructureComponent isDefinedBy RepresentedVariable |
Data structure component is defined by zero to one represented variable. |
0..1 |
0..* |
none |
|||
from |
RepresentedVariable takesSentinelValuesFrom SentinelValueDomain |
A represented variable may have more than one sets of sentinel value domains, one for each type of software platform on which related instance variables might be instantiated. All of the sentinel value domains must have sentinel conceptual domains that correspond exactly. This allows codes for missing values to be explicitly matched across platforms. |
0..* |
0..* |
none |
|||
from |
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..* |
0..1 |
none |
|||
from |
ConceptualVariable measures UnitType |
The measures association is intended to describe specific relationships between the ConceptualVariable and UnitType classes, and similar relationships between their sub-classes. This is documented in section VII.D.5 of the “DDI-Cross Domain Integration: Detailed Model” document. |
0..* |
0..1 |
none |
|||
from |
ConceptualVariable takesSentinelConceptsFrom SentinelConceptualDomain |
Identifies the conceptual domain containing the set of sentinel concepts used to describe the conceptual variable. |
0..* |
0..1 |
none |
|||
from |
ConceptualVariable takesSubstantiveConceptsFrom SubstantiveConceptualDomain |
Identifies the substantive conceptual domain containing the set of substantive concepts used to describe the conceptual variable. |
0..* |
0..1 |
none |
|||
to |
VariableCollection has ConceptualVariable |
Variable collection has zero to many conceptual variables. |
0..* |
0..* |
none |
|||
to |
VariablePosition indexes ConceptualVariable |
Variable position indexes a conceptual variable. |
1..1 |
0..* |
none |
|||
to |
VariableRelationship hasSource ConceptualVariable |
0..* |
0..* |
none |
||||
to |
VariableRelationship hasTarget ConceptualVariable |
Note that this can be realized as a collection to support tuples. |
0..* |
0..* |
none |
|||
to |
AgentListing isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
ClassificationFamily isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
ClassificationIndex isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
ClassificationSeries isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
ConceptMap hasSource Concept |
Concept map has one to many source concepts. |
1..* |
0..* |
none |
|||
to |
ConceptMap hasTarget Concept |
Concept map has one to many target concepts. |
1..* |
0..* |
none |
|||
to |
ConceptRelationship hasSource Concept |
Restricts source object to concept for the relationship. |
1..1 |
0..* |
none |
|||
to |
ConceptRelationship hasTarget Concept |
Restricts target object to concept for the relationship. |
1..1 |
0..* |
none |
|||
to |
ConceptSystem has Concept |
Concept system has zero to many concepts. |
0..* |
0..* |
none |
|||
to |
ConceptSystem isDefinedBy Concept |
Concept system is defined by zero to many concepts. The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
Concept uses Concept |
The uses association is intended to describe specific relationships between Concepts and several of its sub-classes. This is documented in section VII.D.5 of the “DDI-Cross Domain Integration: Detailed Model” document. |
0..* |
0..* |
none |
|||
to |
EnumerationDomain isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
Level isDefinedBy Concept |
A concept or concept sub-type which describes the level. |
0..1 |
0..* |
none |
|||
to |
LogicalRecordRepository isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
LogicalRecord isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
PhysicalDataSet isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
Segment isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
TabularTextDataSet isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
VariableCollection isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
Descriptor identifies ReferenceVariable |
1..1 |
- own package - |
0..* |
none |
own class |
||
from |
ReferenceVariable takesValuesFrom ReferenceValueDomain |
Points to a value domain that contains values that may be drawn from the domains of multiple simple variables. |
0..* |
- own package - |
0..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 ReferenceVariable (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-ReferenceVariable"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceVariable"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceVariable-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceVariable-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceVariable"/>
11 <body>Definition
12============
13Variable that records values of multiple variables in the context of a data structure.
14Variable playing the role of a variable value component.
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.
19Values 100000, 45, 85000, 34 are reference values in the reference value domain corresponding to the reference variable.
20
21</body>
22 </ownedComment>
23 <name>ReferenceVariable</name>
24 <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceVariable-generalization"
25 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceVariable-generalization"
26 xmi:type="uml:Generalization">
27 <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable"/>
28 </generalization>
29 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceVariable-ownedAttribute"
30 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceVariable-ownedAttribute"
31 xmi:type="uml:Property">
32 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceVariable-ownedAttribute-lowerValue"
33 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceVariable-ownedAttribute-lowerValue"
34 xmi:type="uml:LiteralInteger"/>
35 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceVariable-ownedAttribute-upperValue"
36 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ReferenceVariable-ownedAttribute-upperValue"
37 xmi:type="uml:LiteralUnlimitedNatural">
38 <value>1</value>
39 </upperValue>
40 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceVariable_takesValuesFrom_ReferenceValueDomain"/>
41 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValueDomain"/>
42 </ownedAttribute>
43</packagedElement>
Fragment for the class ReferenceVariable (entire XML Schema)
1<xs:element name="ReferenceVariable"
2 type="ReferenceVariableXsdType"
3 xml:id="ReferenceVariable">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceVariable -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ============
8 Variable that records values of multiple variables in the context of a data structure.
9 Variable playing the role of a variable value component.
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 Values 100000, 45, 85000, 34 are reference values in the reference value domain corresponding to the reference variable.</xs:documentation>
15 </xs:annotation>
16</xs:element>
17<xs:complexType name="ReferenceVariableXsdType"
18 xml:id="ReferenceVariableXsdType">
19 <xs:annotation>
20 <xs:documentation>Definition
21 ============
22 Variable that records values of multiple variables in the context of a data structure.
23 Variable playing the role of a variable value component.
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 Values 100000, 45, 85000, 34 are reference values in the reference value domain corresponding to the reference variable.</xs:documentation>
29 </xs:annotation>
30 <xs:complexContent>
31 <xs:extension base="InstanceVariableXsdType">
32 <xs:sequence>
33 <xs:element name="ReferenceVariable_takesValuesFrom_ReferenceValueDomain"
34 minOccurs="0"
35 maxOccurs="1"
36 xml:id="ReferenceVariable_takesValuesFrom_ReferenceValueDomain">
37 <xs:annotation>
38 <xs:documentation>Points to a value domain that contains values that may be drawn from the domains of multiple simple variables.</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="ReferenceVariable_takesValuesFrom_ReferenceValueDomain-ddiReference"/>
49 <xs:element name="validType"
50 minOccurs="0"
51 maxOccurs="unbounded"
52 xml:id="ReferenceVariable_takesValuesFrom_ReferenceValueDomain-validType">
53 <xs:simpleType>
54 <xs:restriction base="xs:NMTOKEN">
55 <xs:enumeration value="ReferenceValueDomain"/>
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:sequence>
65 </xs:extension>
66 </xs:complexContent>
67</xs:complexType>
Fragment for the class ReferenceVariable (entire JSON Schema)
1"cls-ReferenceVariable": {
2 "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/ReferenceVariable",
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": "ReferenceVariable"
14 },
15 "function": {
16 "$comment": "cardinality 0..-1 – from cdi:InstanceVariable",
17 "if": { "type": "array" },
18 "then": { "items": { "$ref": "#/defs/dt-ControlledVocabularyEntry" } },
19 "else": { "$ref": "#/defs/dt-ControlledVocabularyEntry" }
20 },
21 "physicalDataType": {
22 "$comment": "cardinality 0..1 – from cdi:InstanceVariable",
23 "$ref": "#/defs/dt-ControlledVocabularyEntry"
24 },
25 "platformType": {
26 "$comment": "cardinality 0..1 – from cdi:InstanceVariable",
27 "$ref": "#/defs/dt-ControlledVocabularyEntry"
28 },
29 "role": {
30 "$comment": "cardinality 0..-1 – from cdi:InstanceVariable",
31 "if": { "type": "array" },
32 "then": { "items": { "$ref": "#/defs/dt-ControlledVocabularyEntry" } },
33 "else": { "$ref": "#/defs/dt-ControlledVocabularyEntry" }
34 },
35 "source": {
36 "$comment": "cardinality 0..1 – from cdi:InstanceVariable",
37 "$ref": "#/defs/dt-Reference"
38 },
39 "describedUnitOfMeasure": {
40 "$comment": "cardinality 0..1 – from cdi:RepresentedVariable",
41 "$ref": "#/defs/dt-ControlledVocabularyEntry"
42 },
43 "hasIntendedDataType": {
44 "$comment": "cardinality 0..1 – from cdi:RepresentedVariable",
45 "$ref": "#/defs/dt-ControlledVocabularyEntry"
46 },
47 "simpleUnitOfMeasure": {
48 "$comment": "cardinality 0..1 – from cdi:RepresentedVariable",
49 "$ref": "#/defs/xsd:string"
50 },
51 "descriptiveText": {
52 "$comment": "cardinality 0..1 – from cdi:ConceptualVariable",
53 "$ref": "#/defs/dt-InternationalString"
54 },
55 "unitOfMeasureKind": {
56 "$comment": "cardinality 0..1 – from cdi:ConceptualVariable",
57 "$ref": "#/defs/dt-ControlledVocabularyEntry"
58 },
59 "catalogDetails": {
60 "$comment": "cardinality 0..1 – from cdi:Concept",
61 "$ref": "#/defs/dt-CatalogDetails"
62 },
63 "definition": {
64 "$comment": "cardinality 0..1 – from cdi:Concept",
65 "$ref": "#/defs/dt-InternationalString"
66 },
67 "displayLabel": {
68 "$comment": "cardinality 0..-1 – from cdi:Concept",
69 "if": { "type": "array" },
70 "then": { "items": { "$ref": "#/defs/dt-LabelForDisplay" } },
71 "else": { "$ref": "#/defs/dt-LabelForDisplay" }
72 },
73 "externalDefinition": {
74 "$comment": "cardinality 0..1 – from cdi:Concept",
75 "$ref": "#/defs/dt-Reference"
76 },
77 "identifier": {
78 "$comment": "cardinality 0..1 – from cdi:Concept",
79 "$ref": "#/defs/dt-Identifier"
80 },
81 "name": {
82 "$comment": "cardinality 0..-1 – from cdi:Concept",
83 "if": { "type": "array" },
84 "then": { "items": { "$ref": "#/defs/dt-ObjectName" } },
85 "else": { "$ref": "#/defs/dt-ObjectName" }
86 },
87 "takesValuesFrom": {
88 "description": "ReferenceVariable_takesValuesFrom_ReferenceValueDomain",
89 "$comment": "cardinality 0..1",
90 "$ref": "#/defs/target-ReferenceValueDomain"
91 },
92 "isDescribedBy": {
93 "description": "InstanceVariable_isDescribedBy_StatisticsCollection",
94 "$comment": "cardinality 0..1",
95 "$ref": "#/defs/target-StatisticsCollection"
96 },
97 "takesSentinelValuesFrom": {
98 "description": "RepresentedVariable_takesSentinelValuesFrom_SentinelValueDomain",
99 "$comment": "cardinality 0..-1",
100 "anyOf": [
101 {
102 "$ref": "#/defs/target-SentinelValueDomain"
103 },
104 {
105 "type": "array",
106 "items": {
107 "$ref": "#/defs/target-SentinelValueDomain"
108 }
109 }
110 ]
111 },
112 "takesSubstantiveValuesFrom_SubstantiveValueDomain": {
113 "description": "RepresentedVariable_takesSubstantiveValuesFrom_SubstantiveValueDomain",
114 "$comment": "cardinality 0..1",
115 "$ref": "#/defs/target-SubstantiveValueDomain"
116 },
117 "measures": {
118 "description": "ConceptualVariable_measures_UnitType",
119 "$comment": "cardinality 0..1",
120 "$ref": "#/defs/target-UnitType"
121 },
122 "takesSentinelConceptsFrom": {
123 "description": "ConceptualVariable_takesSentinelConceptsFrom_SentinelConceptualDomain",
124 "$comment": "cardinality 0..1",
125 "$ref": "#/defs/target-SentinelConceptualDomain"
126 },
127 "takesSubstantiveConceptsFrom": {
128 "description": "ConceptualVariable_takesSubstantiveConceptsFrom_SubstantiveConceptualDomain",
129 "$comment": "cardinality 0..1",
130 "$ref": "#/defs/target-SubstantiveConceptualDomain"
131 },
132 "uses_Concept": {
133 "description": "Concept_uses_Concept",
134 "$comment": "cardinality 0..-1",
135 "anyOf": [
136 {
137 "$ref": "#/defs/target-Concept"
138 },
139 {
140 "type": "array",
141 "items": {
142 "$ref": "#/defs/target-Concept"
143 }
144 }
145 ]
146 },
147 "identifies_OF_Descriptor": {
148 "description": "Descriptor_identifies_ReferenceVariable",
149 "$comment": "cardinality 0..-1",
150 "anyOf": [
151 {
152 "$ref": "#/defs/target-Descriptor"
153 },
154 {
155 "type": "array",
156 "items": {
157 "$ref": "#/defs/target-Descriptor"
158 }
159 }
160 ]
161 },
162 "isDescribedBy_OF_DataPoint": {
163 "description": "DataPoint_isDescribedBy_InstanceVariable",
164 "$comment": "cardinality 0..-1",
165 "anyOf": [
166 {
167 "$ref": "#/defs/target-DataPoint"
168 },
169 {
170 "type": "array",
171 "items": {
172 "$ref": "#/defs/target-DataPoint"
173 }
174 }
175 ]
176 },
177 "has_InstanceVariable_OF_DataSet": {
178 "description": "DataSet_has_InstanceVariable",
179 "$comment": "cardinality 1..-1",
180 "anyOf": [
181 {
182 "$ref": "#/defs/target-DataSet"
183 },
184 {
185 "type": "array",
186 "items": {
187 "$ref": "#/defs/target-DataSet"
188 }
189 }
190 ]
191 },
192 "isBoundedBy_OF_Datum": {
193 "description": "Datum_isBoundedBy_InstanceVariable",
194 "$comment": "cardinality 0..-1",
195 "anyOf": [
196 {
197 "$ref": "#/defs/target-Datum"
198 },
199 {
200 "type": "array",
201 "items": {
202 "$ref": "#/defs/target-Datum"
203 }
204 }
205 ]
206 },
207 "hasSource_OF_InstanceVariableMap": {
208 "description": "InstanceVariableMap_hasSource_InstanceVariable",
209 "$comment": "cardinality 0..-1",
210 "anyOf": [
211 {
212 "$ref": "#/defs/target-InstanceVariableMap"
213 },
214 {
215 "type": "array",
216 "items": {
217 "$ref": "#/defs/target-InstanceVariableMap"
218 }
219 }
220 ]
221 },
222 "hasTarget_OF_InstanceVariableMap": {
223 "description": "InstanceVariableMap_hasTarget_InstanceVariable",
224 "$comment": "cardinality 0..-1",
225 "anyOf": [
226 {
227 "$ref": "#/defs/target-InstanceVariableMap"
228 },
229 {
230 "type": "array",
231 "items": {
232 "$ref": "#/defs/target-InstanceVariableMap"
233 }
234 }
235 ]
236 },
237 "has_InstanceVariable_OF_LogicalRecord": {
238 "description": "LogicalRecord_has_InstanceVariable",
239 "$comment": "cardinality 0..-1",
240 "anyOf": [
241 {
242 "$ref": "#/defs/target-LogicalRecord"
243 },
244 {
245 "type": "array",
246 "items": {
247 "$ref": "#/defs/target-LogicalRecord"
248 }
249 }
250 ]
251 },
252 "has_InstanceVariable_OF_PhysicalDataSet": {
253 "description": "PhysicalDataSet_has_InstanceVariable",
254 "$comment": "cardinality 0..-1",
255 "anyOf": [
256 {
257 "$ref": "#/defs/target-PhysicalDataSet"
258 },
259 {
260 "type": "array",
261 "items": {
262 "$ref": "#/defs/target-PhysicalDataSet"
263 }
264 }
265 ]
266 },
267 "formats_OF_PhysicalMapping": {
268 "description": "PhysicalMapping_formats_InstanceVariable",
269 "$comment": "cardinality 0..-1",
270 "anyOf": [
271 {
272 "$ref": "#/defs/target-PhysicalMapping"
273 },
274 {
275 "type": "array",
276 "items": {
277 "$ref": "#/defs/target-PhysicalMapping"
278 }
279 }
280 ]
281 },
282 "hasWeight_OF_StatisticsCollection": {
283 "description": "StatisticsCollection_hasWeight_InstanceVariable",
284 "$comment": "cardinality 0..-1",
285 "anyOf": [
286 {
287 "$ref": "#/defs/target-StatisticsCollection"
288 },
289 {
290 "type": "array",
291 "items": {
292 "$ref": "#/defs/target-StatisticsCollection"
293 }
294 }
295 ]
296 },
297 "hasWeight_OF_Statistics": {
298 "description": "Statistics_hasWeight_InstanceVariable",
299 "$comment": "cardinality 0..-1",
300 "anyOf": [
301 {
302 "$ref": "#/defs/target-Statistics"
303 },
304 {
305 "type": "array",
306 "items": {
307 "$ref": "#/defs/target-Statistics"
308 }
309 }
310 ]
311 },
312 "isDefinedBy_RepresentedVariable_OF_DataStructureComponent": {
313 "description": "DataStructureComponent_isDefinedBy_RepresentedVariable",
314 "$comment": "cardinality 0..-1",
315 "anyOf": [
316 {
317 "$ref": "#/defs/target-DataStructureComponent"
318 },
319 {
320 "type": "array",
321 "items": {
322 "$ref": "#/defs/target-DataStructureComponent"
323 }
324 }
325 ]
326 },
327 "has_ConceptualVariable_OF_VariableCollection": {
328 "description": "VariableCollection_has_ConceptualVariable",
329 "$comment": "cardinality 0..-1",
330 "anyOf": [
331 {
332 "$ref": "#/defs/target-VariableCollection"
333 },
334 {
335 "type": "array",
336 "items": {
337 "$ref": "#/defs/target-VariableCollection"
338 }
339 }
340 ]
341 },
342 "indexes_OF_VariablePosition": {
343 "description": "VariablePosition_indexes_ConceptualVariable",
344 "$comment": "cardinality 0..-1",
345 "anyOf": [
346 {
347 "$ref": "#/defs/target-VariablePosition"
348 },
349 {
350 "type": "array",
351 "items": {
352 "$ref": "#/defs/target-VariablePosition"
353 }
354 }
355 ]
356 },
357 "hasSource_OF_VariableRelationship": {
358 "description": "VariableRelationship_hasSource_ConceptualVariable",
359 "$comment": "cardinality 0..-1",
360 "anyOf": [
361 {
362 "$ref": "#/defs/target-VariableRelationship"
363 },
364 {
365 "type": "array",
366 "items": {
367 "$ref": "#/defs/target-VariableRelationship"
368 }
369 }
370 ]
371 },
372 "hasTarget_OF_VariableRelationship": {
373 "description": "VariableRelationship_hasTarget_ConceptualVariable",
374 "$comment": "cardinality 0..-1",
375 "anyOf": [
376 {
377 "$ref": "#/defs/target-VariableRelationship"
378 },
379 {
380 "type": "array",
381 "items": {
382 "$ref": "#/defs/target-VariableRelationship"
383 }
384 }
385 ]
386 },
387 "isDefinedBy_Concept_OF_AgentListing": {
388 "description": "AgentListing_isDefinedBy_Concept",
389 "$comment": "cardinality 0..-1",
390 "anyOf": [
391 {
392 "$ref": "#/defs/target-AgentListing"
393 },
394 {
395 "type": "array",
396 "items": {
397 "$ref": "#/defs/target-AgentListing"
398 }
399 }
400 ]
401 },
402 "isDefinedBy_Concept_OF_ClassificationFamily": {
403 "description": "ClassificationFamily_isDefinedBy_Concept",
404 "$comment": "cardinality 0..-1",
405 "anyOf": [
406 {
407 "$ref": "#/defs/target-ClassificationFamily"
408 },
409 {
410 "type": "array",
411 "items": {
412 "$ref": "#/defs/target-ClassificationFamily"
413 }
414 }
415 ]
416 },
417 "isDefinedBy_Concept_OF_ClassificationIndex": {
418 "description": "ClassificationIndex_isDefinedBy_Concept",
419 "$comment": "cardinality 0..-1",
420 "anyOf": [
421 {
422 "$ref": "#/defs/target-ClassificationIndex"
423 },
424 {
425 "type": "array",
426 "items": {
427 "$ref": "#/defs/target-ClassificationIndex"
428 }
429 }
430 ]
431 },
432 "isDefinedBy_Concept_OF_ClassificationSeries": {
433 "description": "ClassificationSeries_isDefinedBy_Concept",
434 "$comment": "cardinality 0..-1",
435 "anyOf": [
436 {
437 "$ref": "#/defs/target-ClassificationSeries"
438 },
439 {
440 "type": "array",
441 "items": {
442 "$ref": "#/defs/target-ClassificationSeries"
443 }
444 }
445 ]
446 },
447 "hasSource_OF_ConceptMap": {
448 "description": "ConceptMap_hasSource_Concept",
449 "$comment": "cardinality 0..-1",
450 "anyOf": [
451 {
452 "$ref": "#/defs/target-ConceptMap"
453 },
454 {
455 "type": "array",
456 "items": {
457 "$ref": "#/defs/target-ConceptMap"
458 }
459 }
460 ]
461 },
462 "hasTarget_OF_ConceptMap": {
463 "description": "ConceptMap_hasTarget_Concept",
464 "$comment": "cardinality 0..-1",
465 "anyOf": [
466 {
467 "$ref": "#/defs/target-ConceptMap"
468 },
469 {
470 "type": "array",
471 "items": {
472 "$ref": "#/defs/target-ConceptMap"
473 }
474 }
475 ]
476 },
477 "hasSource_OF_ConceptRelationship": {
478 "description": "ConceptRelationship_hasSource_Concept",
479 "$comment": "cardinality 0..-1",
480 "anyOf": [
481 {
482 "$ref": "#/defs/target-ConceptRelationship"
483 },
484 {
485 "type": "array",
486 "items": {
487 "$ref": "#/defs/target-ConceptRelationship"
488 }
489 }
490 ]
491 },
492 "hasTarget_OF_ConceptRelationship": {
493 "description": "ConceptRelationship_hasTarget_Concept",
494 "$comment": "cardinality 0..-1",
495 "anyOf": [
496 {
497 "$ref": "#/defs/target-ConceptRelationship"
498 },
499 {
500 "type": "array",
501 "items": {
502 "$ref": "#/defs/target-ConceptRelationship"
503 }
504 }
505 ]
506 },
507 "has_Concept_OF_ConceptSystem": {
508 "description": "ConceptSystem_has_Concept",
509 "$comment": "cardinality 0..-1",
510 "anyOf": [
511 {
512 "$ref": "#/defs/target-ConceptSystem"
513 },
514 {
515 "type": "array",
516 "items": {
517 "$ref": "#/defs/target-ConceptSystem"
518 }
519 }
520 ]
521 },
522 "isDefinedBy_Concept_OF_ConceptSystem": {
523 "description": "ConceptSystem_isDefinedBy_Concept",
524 "$comment": "cardinality 0..-1",
525 "anyOf": [
526 {
527 "$ref": "#/defs/target-ConceptSystem"
528 },
529 {
530 "type": "array",
531 "items": {
532 "$ref": "#/defs/target-ConceptSystem"
533 }
534 }
535 ]
536 },
537 "uses_Concept_OF_Concept": {
538 "description": "Concept_uses_Concept",
539 "$comment": "cardinality 0..-1",
540 "anyOf": [
541 {
542 "$ref": "#/defs/target-Concept"
543 },
544 {
545 "type": "array",
546 "items": {
547 "$ref": "#/defs/target-Concept"
548 }
549 }
550 ]
551 },
552 "isDefinedBy_Concept_OF_EnumerationDomain": {
553 "description": "EnumerationDomain_isDefinedBy_Concept",
554 "$comment": "cardinality 0..-1",
555 "anyOf": [
556 {
557 "$ref": "#/defs/target-EnumerationDomain"
558 },
559 {
560 "type": "array",
561 "items": {
562 "$ref": "#/defs/target-EnumerationDomain"
563 }
564 }
565 ]
566 },
567 "isDefinedBy_Concept_OF_Level": {
568 "description": "Level_isDefinedBy_Concept",
569 "$comment": "cardinality 0..-1",
570 "anyOf": [
571 {
572 "$ref": "#/defs/target-Level"
573 },
574 {
575 "type": "array",
576 "items": {
577 "$ref": "#/defs/target-Level"
578 }
579 }
580 ]
581 },
582 "isDefinedBy_Concept_OF_LogicalRecordRepository": {
583 "description": "LogicalRecordRepository_isDefinedBy_Concept",
584 "$comment": "cardinality 0..-1",
585 "anyOf": [
586 {
587 "$ref": "#/defs/target-LogicalRecordRepository"
588 },
589 {
590 "type": "array",
591 "items": {
592 "$ref": "#/defs/target-LogicalRecordRepository"
593 }
594 }
595 ]
596 },
597 "isDefinedBy_Concept_OF_LogicalRecord": {
598 "description": "LogicalRecord_isDefinedBy_Concept",
599 "$comment": "cardinality 0..-1",
600 "anyOf": [
601 {
602 "$ref": "#/defs/target-LogicalRecord"
603 },
604 {
605 "type": "array",
606 "items": {
607 "$ref": "#/defs/target-LogicalRecord"
608 }
609 }
610 ]
611 },
612 "isDefinedBy_Concept_OF_PhysicalDataSet": {
613 "description": "PhysicalDataSet_isDefinedBy_Concept",
614 "$comment": "cardinality 0..-1",
615 "anyOf": [
616 {
617 "$ref": "#/defs/target-PhysicalDataSet"
618 },
619 {
620 "type": "array",
621 "items": {
622 "$ref": "#/defs/target-PhysicalDataSet"
623 }
624 }
625 ]
626 },
627 "isDefinedBy_Concept_OF_Segment": {
628 "description": "Segment_isDefinedBy_Concept",
629 "$comment": "cardinality 0..-1",
630 "anyOf": [
631 {
632 "$ref": "#/defs/target-Segment"
633 },
634 {
635 "type": "array",
636 "items": {
637 "$ref": "#/defs/target-Segment"
638 }
639 }
640 ]
641 },
642 "isDefinedBy_Concept_OF_TabularTextDataSet": {
643 "description": "TabularTextDataSet_isDefinedBy_Concept",
644 "$comment": "cardinality 0..-1",
645 "anyOf": [
646 {
647 "$ref": "#/defs/target-TabularTextDataSet"
648 },
649 {
650 "type": "array",
651 "items": {
652 "$ref": "#/defs/target-TabularTextDataSet"
653 }
654 }
655 ]
656 },
657 "isDefinedBy_Concept_OF_VariableCollection": {
658 "description": "VariableCollection_isDefinedBy_Concept",
659 "$comment": "cardinality 0..-1",
660 "anyOf": [
661 {
662 "$ref": "#/defs/target-VariableCollection"
663 },
664 {
665 "type": "array",
666 "items": {
667 "$ref": "#/defs/target-VariableCollection"
668 }
669 }
670 ]
671 },
672 "sameAs": {
673 "$ref": "#/defs/owl:sameAs"
674 }
675 },
676 "required": ["@type"],
677 "additionalProperties": false
678},
679"target-ReferenceVariable": {
680 "description": "all subclasses of http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/ReferenceVariable",
681 "anyOf": [
682 { "$ref": "#/defs/cls-ReferenceVariable" },
683 { "type": "string", "format": "iri-reference" }
684 ]
685},
Fragment for the class ReferenceVariable (main ontology)
1# class ReferenceVariable
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceVariable
3cdi:ReferenceVariable
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "ReferenceVariable";
6 rdfs:comment "Definition\n============\nVariable that records values of multiple variables in the context of a data structure.\nVariable playing the role of a variable value component.\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. \nValues 100000, 45, 85000, 34 are reference values in the reference value domain corresponding to the reference variable."@en;
7 rdfs:subClassOf cdi:InstanceVariable;
8.
9
10
11cdi:ReferenceVariable_takesValuesFrom_ReferenceValueDomain
12 a rdf:Property, owl:ObjectProperty, ucmis:Association;
13 # ASSOCIATION
14 rdfs:label "takesValuesFrom";
15 skos:altLabel "ReferenceVariable_takesValuesFrom_ReferenceValueDomain";
16 rdfs:comment "Points to a value domain that contains values that may be drawn from the domains of multiple simple variables."@en;
17 rdfs:domain cdi:ReferenceVariable;
18 rdfs:range cdi:ReferenceValueDomain;
19.
Fragment for the class ReferenceVariable (entire JSON-LD)
1{
2 "@context": [
3 "InstanceVariable.jsonld",
4 {
5 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
6 "xsd": "http://www.w3.org/2001/XMLSchema#",
7
8
9 "takesValuesFrom": {
10 "@id": "cdi:ReferenceVariable_takesValuesFrom_ReferenceValueDomain",
11 "@type": "@id",
12 "@context": "ReferenceValueDomain.jsonld"
13 },
14 "identifies_OF_Descriptor": {
15 "@reverse": "cdi:Descriptor_identifies_ReferenceVariable",
16 "@type": "@id",
17 "@context": "Descriptor.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 2026-04-15 14:38:40.",
23 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceVariable"
24}
Fragment for the class ReferenceVariable (entire SHACL - Shapes Constraint Language)
1# class ReferenceVariable
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceVariable
3<#ReferenceVariable> a sh:NodeShape;
4 sh:targetClass cdi:ReferenceVariable;
5 sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/ReferenceVariable";
6 sh:closed true;
7 sh:ignoredProperties ( owl:sameAs );
8 sh:property [
9 sh:path rdf:type;
10 sh:in ( cdi:ReferenceVariable
11 ) ;
12 ];
13 # attributes
14 # associations from ReferenceVariable
15 sh:property <#ReferenceVariable_takesValuesFrom_ReferenceValueDomain>;
16 # associations to ReferenceVariable
17 sh:property <#rev_Descriptor_identifies_ReferenceVariable>;
18
19 # ---- superclass: InstanceVariable
20 # attributes
21 sh:property <#InstanceVariable-function>;
22 sh:property <#InstanceVariable-physicalDataType>;
23 sh:property <#InstanceVariable-platformType>;
24 sh:property <#InstanceVariable-role>;
25 sh:property <#InstanceVariable-source>;
26 # associations from InstanceVariable
27 sh:property <#InstanceVariable_isDescribedBy_StatisticsCollection>;
28 # associations to InstanceVariable
29 sh:property <#rev_DataPoint_isDescribedBy_InstanceVariable>;
30 sh:property <#rev_DataSet_has_InstanceVariable>;
31 sh:property <#rev_Datum_isBoundedBy_InstanceVariable>;
32 sh:property <#rev_InstanceVariableMap_hasSource_InstanceVariable>;
33 sh:property <#rev_InstanceVariableMap_hasTarget_InstanceVariable>;
34 sh:property <#rev_LogicalRecord_has_InstanceVariable>;
35 sh:property <#rev_PhysicalDataSet_has_InstanceVariable>;
36 sh:property <#rev_PhysicalMapping_formats_InstanceVariable>;
37 sh:property <#rev_StatisticsCollection_hasWeight_InstanceVariable>;
38 sh:property <#rev_Statistics_hasWeight_InstanceVariable>;
39
40 # ---- superclass: RepresentedVariable
41 # attributes
42 sh:property <#RepresentedVariable-describedUnitOfMeasure>;
43 sh:property <#RepresentedVariable-hasIntendedDataType>;
44 sh:property <#RepresentedVariable-simpleUnitOfMeasure>;
45 # associations from RepresentedVariable
46 sh:property <#RepresentedVariable_takesSentinelValuesFrom_SentinelValueDomain>;
47 sh:property <#RepresentedVariable_takesSubstantiveValuesFrom_SubstantiveValueDomain>;
48 # associations to RepresentedVariable
49 sh:property <#rev_DataStructureComponent_isDefinedBy_RepresentedVariable>;
50
51 # ---- superclass: ConceptualVariable
52 # attributes
53 sh:property <#ConceptualVariable-descriptiveText>;
54 sh:property <#ConceptualVariable-unitOfMeasureKind>;
55 # associations from ConceptualVariable
56 sh:property <#ConceptualVariable_measures_UnitType>;
57 sh:property <#ConceptualVariable_takesSentinelConceptsFrom_SentinelConceptualDomain>;
58 sh:property <#ConceptualVariable_takesSubstantiveConceptsFrom_SubstantiveConceptualDomain>;
59 # associations to ConceptualVariable
60 sh:property <#rev_VariableCollection_has_ConceptualVariable>;
61 sh:property <#rev_VariablePosition_indexes_ConceptualVariable>;
62 sh:property <#rev_VariableRelationship_hasSource_ConceptualVariable>;
63 sh:property <#rev_VariableRelationship_hasTarget_ConceptualVariable>;
64
65 # ---- superclass: Concept
66 # attributes
67 sh:property <#Concept-catalogDetails>;
68 sh:property <#Concept-definition>;
69 sh:property <#Concept-displayLabel>;
70 sh:property <#Concept-externalDefinition>;
71 sh:property <#Concept-identifier>;
72 sh:property <#Concept-name>;
73 # associations from Concept
74 sh:property <#Concept_uses_Concept>;
75 # associations to Concept
76 sh:property <#rev_AgentListing_isDefinedBy_Concept>;
77 sh:property <#rev_ClassificationFamily_isDefinedBy_Concept>;
78 sh:property <#rev_ClassificationIndex_isDefinedBy_Concept>;
79 sh:property <#rev_ClassificationSeries_isDefinedBy_Concept>;
80 sh:property <#rev_ConceptMap_hasSource_Concept>;
81 sh:property <#rev_ConceptMap_hasTarget_Concept>;
82 sh:property <#rev_ConceptRelationship_hasSource_Concept>;
83 sh:property <#rev_ConceptRelationship_hasTarget_Concept>;
84 sh:property <#rev_ConceptSystem_has_Concept>;
85 sh:property <#rev_ConceptSystem_isDefinedBy_Concept>;
86 sh:property <#rev_Concept_uses_Concept>;
87 sh:property <#rev_EnumerationDomain_isDefinedBy_Concept>;
88 sh:property <#rev_Level_isDefinedBy_Concept>;
89 sh:property <#rev_LogicalRecordRepository_isDefinedBy_Concept>;
90 sh:property <#rev_LogicalRecord_isDefinedBy_Concept>;
91 sh:property <#rev_PhysicalDataSet_isDefinedBy_Concept>;
92 sh:property <#rev_Segment_isDefinedBy_Concept>;
93 sh:property <#rev_TabularTextDataSet_isDefinedBy_Concept>;
94 sh:property <#rev_VariableCollection_isDefinedBy_Concept>;
95
96
97
98
99
100
101
102
103
104
105
106.
107
108
109<#ReferenceVariable_takesValuesFrom_ReferenceValueDomain> a sh:PropertyShape ;
110 sh:path cdi:ReferenceVariable_takesValuesFrom_ReferenceValueDomain;
111 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
112 cdi:ReferenceValueDomain
113
114 ) ]];
115 sh:maxCount 1;
116.
117<#rev_ReferenceVariable_takesValuesFrom_ReferenceValueDomain> a sh:PropertyShape ;
118 sh:path [ sh:inversePath cdi:ReferenceVariable_takesValuesFrom_ReferenceValueDomain ];
119.
Fragment for the class ReferenceVariable (entire ShEx - Shape Expressions)
1# class ReferenceVariable
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::ReferenceVariable
3cdi:ReferenceVariableShape CLOSED {
4 a [cdi:ReferenceVariable];
5 ^cdi:Descriptor_identifies_ReferenceVariable @cdi:DescriptorShape *;
6 cdi:ReferenceVariable_takesValuesFrom_ReferenceValueDomain @cdi:ReferenceValueDomainShape ?;
7
8 &cdi:InstanceVariableProperties;
9 }