InstanceVariable#
Fully qualified class name of the UML model DDI-CDI 1.0: DDICDIModels::DDICDILibrary::Classes::Conceptual::InstanceVariable
Definition#
Use of a represented variable within a data set.
Examples#
Gender: Dan Gillman has gender <m, male>, Arofan Gregory has gender <m, male>, etc.
Number of employees: Microsoft has 90,000 employees; IBM has 433,000 employees, etc.
Endowment: Johns Hopkins has endowment of <3, $1,000,000 and above>, Yale has endowment of <3, $1,000,000 and above>, etc.
A tornado near Winterset, Iowa, had a peak wind speed of 170 mph. Two instance variables of a person’s height reference the same represented variable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same substantive value domain, use a sentinel value domain drawn from the same set of sentinel value domains, have the same sentinel (missing value) concepts, and draw their population from the same universe. In other words, the two instance variables should be comparable.
Explanatory notes#
The instance variable class inherits all of the properties and relationships of the represented variable class and, in turn, the conceptual variable class. This means that an instance variable can be completely populated without the need to create an associated represented variable or conceptual variable. If, however, a user wishes to indicate that a particular instance variable is patterned after a particular represented variable or a particular conceptual variable that may be indicated by including a relationship to the represented variable and/or conceptual variable. Including these references is an important method of indicating that multiple instance variables have the same representation, measure the same concept, and are drawn from the same universe. If two instance variables of a person’s height reference the same represented variable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same substantive value domain, use a sentinel value domain drawn from the same set of sentinel value domains, have the same sentinel (missing value) concepts, and draw their population from the same universe. In other words, the two instance variables should be comparable. The instance variable describes actual instances of data that have been collected.
Diagram#
Diagram
Inheritance#
Inheritance
ᐊ── Conceptual::InstanceVariable
Attributes#
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
physicalDataType |
- own class - |
The data type of this variable. Supports the optional use of an external controlled vocabulary. |
0..1 |
||
platformType |
- own class - |
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 |
||
source |
- own class - |
Reference capturing provenance information. |
0..1 |
||
variableFunction |
- own class - |
Immutable characteristic of the variable such as geographic designator, weight, temporal designation, etc. |
0..* |
||
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 InstanceVariable |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
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..* |
- own package - |
0..1 |
none |
||
from |
ConceptualVariable takesSentinelConceptsFrom SentinelConceptualDomain |
Identifies the conceptual domain containing the set of sentinel concepts used to describe the conceptual variable. |
0..* |
- own package - |
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..* |
- own package - |
0..1 |
none |
||
to |
VariableCollection has ConceptualVariable |
Variable collection has zero to many conceptual variables. |
0..* |
- own package - |
0..* |
none |
||
to |
VariablePosition indexes ConceptualVariable |
Variable position indexes a conceptual variable. |
1..1 |
- own package - |
0..* |
none |
||
to |
VariableRelationship hasSource ConceptualVariable |
0..* |
- own package - |
0..* |
none |
|||
to |
VariableRelationship hasTarget ConceptualVariable |
Note that this can be realized as a collection to support tuples. |
0..* |
- own package - |
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 |
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..* |
- own package - |
0..* |
none |
||
to |
ConceptMap hasSource Concept |
Concept map has one to many source concepts. |
1..* |
- own package - |
0..* |
none |
||
to |
ConceptMap hasTarget Concept |
Concept map has one to many target concepts. |
1..* |
- own package - |
0..* |
none |
||
to |
ConceptRelationship hasSource Concept |
Restricts source object to concept for the relationship. |
1..1 |
- own package - |
0..* |
none |
||
to |
ConceptRelationship hasTarget Concept |
Restricts target object to concept for the relationship. |
1..1 |
- own package - |
0..* |
none |
||
to |
ConceptSystem has Concept |
Concept system has zero to many concepts. |
0..* |
- own package - |
0..* |
none |
||
to |
ConceptSystem isDefinedBy Concept |
Concept system is defined by zero to many concepts. The conceptual basis for the collection of members. |
0..* |
- own package - |
0..* |
none |
||
to |
DataStore isDefinedBy Concept |
The conceptual basis for the collection of members. |
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 |
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 |
PhysicalRecordSegment isDefinedBy Concept |
The conceptual basis for the collection of members. |
0..* |
0..* |
none |
|||
to |
PhysicalSegmentLayout 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..* |
- own package - |
0..* |
none |
||
to |
CategoryStatistic appliesTo InstanceVariable |
1..* |
0..* |
none |
own class |
|||
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 |
own class |
||
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 |
own class |
||
from |
InstanceVariable has PhysicalSegmentLayout |
0..* |
0..* |
none |
own class |
|||
from |
InstanceVariable has ValueMapping |
0..* |
0..1 |
shared |
own class |
|||
to |
InstanceVariableMap hasSource InstanceVariable |
The source instance variable for the relationship. |
1..* |
0..* |
none |
own class |
||
to |
InstanceVariableMap hasTarget InstanceVariable |
Target instance variables if a directional relation is used. |
0..* |
0..* |
none |
own class |
||
to |
LogicalRecord has InstanceVariable |
0..* |
0..* |
none |
own class |
|||
to |
PhysicalDataSet has InstanceVariable |
0..* |
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 InstanceVariable (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-Conceptual-InstanceVariable"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable"/>
11 <body>Definition
12==========
13Use of a represented variable within a data set.
14
15Examples
16========
171. Gender: Dan Gillman has gender <m, male>, Arofan Gregory has gender <m, male>, etc.
182. Number of employees: Microsoft has 90,000 employees; IBM has 433,000 employees, etc.
193. Endowment: Johns Hopkins has endowment of <3, $1,000,000 and above>, Yale has endowment of <3, $1,000,000 and above>, etc.
204. A tornado near Winterset, Iowa, had a peak wind speed of 170 mph. Two instance variables of a person's height reference the same represented variable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same substantive value domain, use a sentinel value domain drawn from the same set of sentinel value domains, have the same sentinel (missing value) concepts, and draw their population from the same universe. In other words, the two instance variables should be comparable.
21
22Explanatory notes
23=================
24The instance variable class inherits all of the properties and relationships of the represented variable class and, in turn, the conceptual variable class. This means that an instance variable can be completely populated without the need to create an associated represented variable or conceptual variable. If, however, a user wishes to indicate that a particular instance variable is patterned after a particular represented variable or a particular conceptual variable that may be indicated by including a relationship to the represented variable and/or conceptual variable. Including these references is an important method of indicating that multiple instance variables have the same representation, measure the same concept, and are drawn from the same universe. If two instance variables of a person's height reference the same represented variable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same substantive value domain, use a sentinel value domain drawn from the same set of sentinel value domains, have the same sentinel (missing value) concepts, and draw their population from the same universe. In other words, the two instance variables should be comparable. The instance variable describes actual instances of data that have been collected.</body>
25 </ownedComment>
26 <name>InstanceVariable</name>
27 <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-generalization"
28 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-generalization"
29 xmi:type="uml:Generalization">
30 <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-RepresentedVariable"/>
31 </generalization>
32 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-ownedAttribute_1"
33 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-ownedAttribute_1"
34 xmi:type="uml:Property">
35 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-ownedAttribute_1-lowerValue"
36 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-ownedAttribute_1-lowerValue"
37 xmi:type="uml:LiteralInteger"/>
38 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-ownedAttribute_1-upperValue"
39 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-ownedAttribute_1-upperValue"
40 xmi:type="uml:LiteralUnlimitedNatural">
41 <value>*</value>
42 </upperValue>
43 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable_has_PhysicalSegmentLayout"/>
44 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-PhysicalSegmentLayout"/>
45 </ownedAttribute>
46 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-ownedAttribute_2"
47 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-ownedAttribute_2"
48 xmi:type="uml:Property">
49 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-ownedAttribute_2-lowerValue"
50 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-ownedAttribute_2-lowerValue"
51 xmi:type="uml:LiteralInteger"/>
52 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-ownedAttribute_2-upperValue"
53 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-ownedAttribute_2-upperValue"
54 xmi:type="uml:LiteralUnlimitedNatural">
55 <value>1</value>
56 </upperValue>
57 <aggregation>shared</aggregation>
58 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable_has_ValueMapping"/>
59 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-ValueMapping"/>
60 </ownedAttribute>
61 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-physicalDataType"
62 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-physicalDataType"
63 xmi:type="uml:Property">
64 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-physicalDataType-ownedComment"
65 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-physicalDataType-ownedComment"
66 xmi:type="uml:Comment">
67 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-physicalDataType"/>
68 <body>The data type of this variable. Supports the optional use of an external controlled vocabulary.</body>
69 </ownedComment>
70 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-physicalDataType-lowerValue"
71 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-physicalDataType-lowerValue"
72 xmi:type="uml:LiteralInteger"/>
73 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-physicalDataType-upperValue"
74 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-physicalDataType-upperValue"
75 xmi:type="uml:LiteralUnlimitedNatural">
76 <value>1</value>
77 </upperValue>
78 <name>physicalDataType</name>
79 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
80 </ownedAttribute>
81 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-platformType"
82 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-platformType"
83 xmi:type="uml:Property">
84 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-platformType-ownedComment"
85 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-platformType-ownedComment"
86 xmi:type="uml:Comment">
87 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-platformType"/>
88 <body>Describes the application or technical system context in which the variable has been realized. Typically a statistical processing package or other processing environment.</body>
89 </ownedComment>
90 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-platformType-lowerValue"
91 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-platformType-lowerValue"
92 xmi:type="uml:LiteralInteger"/>
93 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-platformType-upperValue"
94 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-platformType-upperValue"
95 xmi:type="uml:LiteralUnlimitedNatural">
96 <value>1</value>
97 </upperValue>
98 <name>platformType</name>
99 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
100 </ownedAttribute>
101 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-source"
102 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-source"
103 xmi:type="uml:Property">
104 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-source-ownedComment"
105 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-source-ownedComment"
106 xmi:type="uml:Comment">
107 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-source"/>
108 <body>Reference capturing provenance information.</body>
109 </ownedComment>
110 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-source-lowerValue"
111 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-source-lowerValue"
112 xmi:type="uml:LiteralInteger"/>
113 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-source-upperValue"
114 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-source-upperValue"
115 xmi:type="uml:LiteralUnlimitedNatural">
116 <value>1</value>
117 </upperValue>
118 <name>source</name>
119 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Reference"/>
120 </ownedAttribute>
121 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-variableFunction"
122 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-variableFunction"
123 xmi:type="uml:Property">
124 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-variableFunction-ownedComment"
125 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-variableFunction-ownedComment"
126 xmi:type="uml:Comment">
127 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-variableFunction"/>
128 <body>Immutable characteristic of the variable such as geographic designator, weight, temporal designation, etc.</body>
129 </ownedComment>
130 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-variableFunction-lowerValue"
131 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-variableFunction-lowerValue"
132 xmi:type="uml:LiteralInteger"/>
133 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable-variableFunction-upperValue"
134 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariable-variableFunction-upperValue"
135 xmi:type="uml:LiteralUnlimitedNatural">
136 <value>*</value>
137 </upperValue>
138 <name>variableFunction</name>
139 <isOrdered>true</isOrdered>
140 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
141 </ownedAttribute>
142</packagedElement>
Fragment for the class InstanceVariable (entire XML Schema)
1<xs:element name="InstanceVariable"
2 type="InstanceVariableXsdType"
3 xml:id="InstanceVariable">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::Conceptual::InstanceVariable -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ==========
8 Use of a represented variable within a data set.
9
10 Examples
11 ========
12 1. Gender: Dan Gillman has gender <m, male>, Arofan Gregory has gender <m, male>, etc.
13 2. Number of employees: Microsoft has 90,000 employees; IBM has 433,000 employees, etc.
14 3. Endowment: Johns Hopkins has endowment of <3, $1,000,000 and above>, Yale has endowment of <3, $1,000,000 and above>, etc.
15 4. A tornado near Winterset, Iowa, had a peak wind speed of 170 mph. Two instance variables of a person's height reference the same represented variable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same substantive value domain, use a sentinel value domain drawn from the same set of sentinel value domains, have the same sentinel (missing value) concepts, and draw their population from the same universe. In other words, the two instance variables should be comparable.
16
17 Explanatory notes
18 =================
19 The instance variable class inherits all of the properties and relationships of the represented variable class and, in turn, the conceptual variable class. This means that an instance variable can be completely populated without the need to create an associated represented variable or conceptual variable. If, however, a user wishes to indicate that a particular instance variable is patterned after a particular represented variable or a particular conceptual variable that may be indicated by including a relationship to the represented variable and/or conceptual variable. Including these references is an important method of indicating that multiple instance variables have the same representation, measure the same concept, and are drawn from the same universe. If two instance variables of a person's height reference the same represented variable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same substantive value domain, use a sentinel value domain drawn from the same set of sentinel value domains, have the same sentinel (missing value) concepts, and draw their population from the same universe. In other words, the two instance variables should be comparable. The instance variable describes actual instances of data that have been collected.</xs:documentation>
20 </xs:annotation>
21</xs:element>
22<xs:complexType name="InstanceVariableXsdType"
23 xml:id="InstanceVariableXsdType">
24 <xs:annotation>
25 <xs:documentation>Definition
26 ==========
27 Use of a represented variable within a data set.
28
29 Examples
30 ========
31 1. Gender: Dan Gillman has gender <m, male>, Arofan Gregory has gender <m, male>, etc.
32 2. Number of employees: Microsoft has 90,000 employees; IBM has 433,000 employees, etc.
33 3. Endowment: Johns Hopkins has endowment of <3, $1,000,000 and above>, Yale has endowment of <3, $1,000,000 and above>, etc.
34 4. A tornado near Winterset, Iowa, had a peak wind speed of 170 mph. Two instance variables of a person's height reference the same represented variable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same substantive value domain, use a sentinel value domain drawn from the same set of sentinel value domains, have the same sentinel (missing value) concepts, and draw their population from the same universe. In other words, the two instance variables should be comparable.
35
36 Explanatory notes
37 =================
38 The instance variable class inherits all of the properties and relationships of the represented variable class and, in turn, the conceptual variable class. This means that an instance variable can be completely populated without the need to create an associated represented variable or conceptual variable. If, however, a user wishes to indicate that a particular instance variable is patterned after a particular represented variable or a particular conceptual variable that may be indicated by including a relationship to the represented variable and/or conceptual variable. Including these references is an important method of indicating that multiple instance variables have the same representation, measure the same concept, and are drawn from the same universe. If two instance variables of a person's height reference the same represented variable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same substantive value domain, use a sentinel value domain drawn from the same set of sentinel value domains, have the same sentinel (missing value) concepts, and draw their population from the same universe. In other words, the two instance variables should be comparable. The instance variable describes actual instances of data that have been collected.</xs:documentation>
39 </xs:annotation>
40 <xs:complexContent>
41 <xs:extension base="RepresentedVariableXsdType">
42 <xs:sequence>
43 <xs:element name="physicalDataType"
44 type="ControlledVocabularyEntryXsdType"
45 minOccurs="0"
46 maxOccurs="1"
47 xml:id="InstanceVariable-physicalDataType">
48 <xs:annotation>
49 <xs:documentation>The data type of this variable. Supports the optional use of an external controlled vocabulary.</xs:documentation>
50 </xs:annotation>
51 </xs:element>
52 <xs:element name="platformType"
53 type="ControlledVocabularyEntryXsdType"
54 minOccurs="0"
55 maxOccurs="1"
56 xml:id="InstanceVariable-platformType">
57 <xs:annotation>
58 <xs:documentation>Describes the application or technical system context in which the variable has been realized. Typically a statistical processing package or other processing environment.</xs:documentation>
59 </xs:annotation>
60 </xs:element>
61 <xs:element name="source"
62 type="ReferenceXsdType"
63 minOccurs="0"
64 maxOccurs="1"
65 xml:id="InstanceVariable-source">
66 <xs:annotation>
67 <xs:documentation>Reference capturing provenance information.</xs:documentation>
68 </xs:annotation>
69 </xs:element>
70 <xs:element name="variableFunction"
71 type="ControlledVocabularyEntryXsdType"
72 minOccurs="0"
73 maxOccurs="unbounded"
74 xml:id="InstanceVariable-variableFunction">
75 <xs:annotation>
76 <xs:documentation>Immutable characteristic of the variable such as geographic designator, weight, temporal designation, etc.</xs:documentation>
77 </xs:annotation>
78 </xs:element>
79 <xs:element name="InstanceVariable_has_PhysicalSegmentLayout"
80 minOccurs="0"
81 maxOccurs="unbounded"
82 xml:id="InstanceVariable_has_PhysicalSegmentLayout">
83 <xs:annotation>
84 <xs:documentation></xs:documentation>
85 </xs:annotation>
86 <xs:complexType>
87 <xs:complexContent>
88 <xs:restriction base="AssociationReferenceXsdType">
89 <xs:sequence>
90 <xs:element name="ddiReference"
91 type="InternationalRegistrationDataIdentifierXsdType"
92 minOccurs="0"
93 maxOccurs="1"
94 xml:id="InstanceVariable_has_PhysicalSegmentLayout-ddiReference"/>
95 <xs:element name="validType"
96 minOccurs="0"
97 maxOccurs="unbounded"
98 xml:id="InstanceVariable_has_PhysicalSegmentLayout-validType">
99 <xs:simpleType>
100 <xs:restriction base="xs:NMTOKEN">
101 <xs:enumeration value="PhysicalSegmentLayout"/>
102 <xs:enumeration value="UnitSegmentLayout"/>
103 </xs:restriction>
104 </xs:simpleType>
105 </xs:element>
106 </xs:sequence>
107 </xs:restriction>
108 </xs:complexContent>
109 </xs:complexType>
110 </xs:element>
111 <xs:element name="InstanceVariable_has_ValueMapping"
112 minOccurs="0"
113 maxOccurs="1"
114 xml:id="InstanceVariable_has_ValueMapping">
115 <xs:annotation>
116 <xs:documentation></xs:documentation>
117 </xs:annotation>
118 <xs:complexType>
119 <xs:complexContent>
120 <xs:restriction base="AssociationReferenceXsdType">
121 <xs:sequence>
122 <xs:element name="ddiReference"
123 type="InternationalRegistrationDataIdentifierXsdType"
124 minOccurs="0"
125 maxOccurs="1"
126 xml:id="InstanceVariable_has_ValueMapping-ddiReference"/>
127 <xs:element name="validType"
128 minOccurs="0"
129 maxOccurs="unbounded"
130 xml:id="InstanceVariable_has_ValueMapping-validType">
131 <xs:simpleType>
132 <xs:restriction base="xs:NMTOKEN">
133 <xs:enumeration value="ValueMapping"/>
134 </xs:restriction>
135 </xs:simpleType>
136 </xs:element>
137 </xs:sequence>
138 </xs:restriction>
139 </xs:complexContent>
140 </xs:complexType>
141 </xs:element>
142 </xs:sequence>
143 </xs:extension>
144 </xs:complexContent>
145</xs:complexType>
Fragment for the class InstanceVariable (entire JSON Schema)
1"cls-InstanceVariable": {
2 "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/InstanceVariable",
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": "InstanceVariable"
14 },
15 "physicalDataType": {
16 "$comment": "cardinality 0..1 – from cdi:InstanceVariable",
17 "$ref": "#/defs/dt-ControlledVocabularyEntry"
18 },
19 "platformType": {
20 "$comment": "cardinality 0..1 – from cdi:InstanceVariable",
21 "$ref": "#/defs/dt-ControlledVocabularyEntry"
22 },
23 "source": {
24 "$comment": "cardinality 0..1 – from cdi:InstanceVariable",
25 "$ref": "#/defs/dt-Reference"
26 },
27 "variableFunction": {
28 "$comment": "cardinality 0..-1 – from cdi:InstanceVariable",
29 "if": { "type": "array" },
30 "then": { "items": { "$ref": "#/defs/dt-ControlledVocabularyEntry" } },
31 "else": { "$ref": "#/defs/dt-ControlledVocabularyEntry" }
32 },
33 "describedUnitOfMeasure": {
34 "$comment": "cardinality 0..1 – from cdi:RepresentedVariable",
35 "$ref": "#/defs/dt-ControlledVocabularyEntry"
36 },
37 "hasIntendedDataType": {
38 "$comment": "cardinality 0..1 – from cdi:RepresentedVariable",
39 "$ref": "#/defs/dt-ControlledVocabularyEntry"
40 },
41 "simpleUnitOfMeasure": {
42 "$comment": "cardinality 0..1 – from cdi:RepresentedVariable",
43 "$ref": "#/defs/xsd:string"
44 },
45 "descriptiveText": {
46 "$comment": "cardinality 0..1 – from cdi:ConceptualVariable",
47 "$ref": "#/defs/dt-InternationalString"
48 },
49 "unitOfMeasureKind": {
50 "$comment": "cardinality 0..1 – from cdi:ConceptualVariable",
51 "$ref": "#/defs/dt-ControlledVocabularyEntry"
52 },
53 "catalogDetails": {
54 "$comment": "cardinality 0..1 – from cdi:Concept",
55 "$ref": "#/defs/dt-CatalogDetails"
56 },
57 "definition": {
58 "$comment": "cardinality 0..1 – from cdi:Concept",
59 "$ref": "#/defs/dt-InternationalString"
60 },
61 "displayLabel": {
62 "$comment": "cardinality 0..-1 – from cdi:Concept",
63 "if": { "type": "array" },
64 "then": { "items": { "$ref": "#/defs/dt-LabelForDisplay" } },
65 "else": { "$ref": "#/defs/dt-LabelForDisplay" }
66 },
67 "externalDefinition": {
68 "$comment": "cardinality 0..1 – from cdi:Concept",
69 "$ref": "#/defs/dt-Reference"
70 },
71 "identifier": {
72 "$comment": "cardinality 0..1 – from cdi:Concept",
73 "$ref": "#/defs/dt-Identifier"
74 },
75 "name": {
76 "$comment": "cardinality 0..-1 – from cdi:Concept",
77 "if": { "type": "array" },
78 "then": { "items": { "$ref": "#/defs/dt-ObjectName" } },
79 "else": { "$ref": "#/defs/dt-ObjectName" }
80 },
81 "has_PhysicalSegmentLayout": {
82 "description": "InstanceVariable_has_PhysicalSegmentLayout",
83 "$comment": "cardinality 0..-1",
84 "anyOf": [
85 {
86 "$ref": "#/defs/target-PhysicalSegmentLayout"
87 },
88 {
89 "type": "array",
90 "items": {
91 "$ref": "#/defs/target-PhysicalSegmentLayout"
92 }
93 }
94 ]
95 },
96 "has_ValueMapping": {
97 "description": "InstanceVariable_has_ValueMapping",
98 "$comment": "cardinality 0..1",
99 "$ref": "#/defs/target-ValueMapping"
100 },
101 "takesSentinelValuesFrom": {
102 "description": "RepresentedVariable_takesSentinelValuesFrom_SentinelValueDomain",
103 "$comment": "cardinality 0..-1",
104 "anyOf": [
105 {
106 "$ref": "#/defs/target-SentinelValueDomain"
107 },
108 {
109 "type": "array",
110 "items": {
111 "$ref": "#/defs/target-SentinelValueDomain"
112 }
113 }
114 ]
115 },
116 "takesSubstantiveValuesFrom_SubstantiveValueDomain": {
117 "description": "RepresentedVariable_takesSubstantiveValuesFrom_SubstantiveValueDomain",
118 "$comment": "cardinality 0..1",
119 "$ref": "#/defs/target-SubstantiveValueDomain"
120 },
121 "measures": {
122 "description": "ConceptualVariable_measures_UnitType",
123 "$comment": "cardinality 0..1",
124 "$ref": "#/defs/target-UnitType"
125 },
126 "takesSentinelConceptsFrom": {
127 "description": "ConceptualVariable_takesSentinelConceptsFrom_SentinelConceptualDomain",
128 "$comment": "cardinality 0..1",
129 "$ref": "#/defs/target-SentinelConceptualDomain"
130 },
131 "takesSubstantiveConceptsFrom": {
132 "description": "ConceptualVariable_takesSubstantiveConceptsFrom_SubstantiveConceptualDomain",
133 "$comment": "cardinality 0..1",
134 "$ref": "#/defs/target-SubstantiveConceptualDomain"
135 },
136 "uses_Concept": {
137 "description": "Concept_uses_Concept",
138 "$comment": "cardinality 0..-1",
139 "anyOf": [
140 {
141 "$ref": "#/defs/target-Concept"
142 },
143 {
144 "type": "array",
145 "items": {
146 "$ref": "#/defs/target-Concept"
147 }
148 }
149 ]
150 },
151 "appliesTo_OF_CategoryStatistic": {
152 "description": "CategoryStatistic_appliesTo_InstanceVariable",
153 "$comment": "cardinality 0..-1",
154 "anyOf": [
155 {
156 "$ref": "#/defs/target-CategoryStatistic"
157 },
158 {
159 "type": "array",
160 "items": {
161 "$ref": "#/defs/target-CategoryStatistic"
162 }
163 }
164 ]
165 },
166 "isDescribedBy_OF_DataPoint": {
167 "description": "DataPoint_isDescribedBy_InstanceVariable",
168 "$comment": "cardinality 0..-1",
169 "anyOf": [
170 {
171 "$ref": "#/defs/target-DataPoint"
172 },
173 {
174 "type": "array",
175 "items": {
176 "$ref": "#/defs/target-DataPoint"
177 }
178 }
179 ]
180 },
181 "isBoundedBy_OF_Datum": {
182 "description": "Datum_isBoundedBy_InstanceVariable",
183 "$comment": "cardinality 0..-1",
184 "anyOf": [
185 {
186 "$ref": "#/defs/target-Datum"
187 },
188 {
189 "type": "array",
190 "items": {
191 "$ref": "#/defs/target-Datum"
192 }
193 }
194 ]
195 },
196 "hasSource_OF_InstanceVariableMap": {
197 "description": "InstanceVariableMap_hasSource_InstanceVariable",
198 "$comment": "cardinality 0..-1",
199 "anyOf": [
200 {
201 "$ref": "#/defs/target-InstanceVariableMap"
202 },
203 {
204 "type": "array",
205 "items": {
206 "$ref": "#/defs/target-InstanceVariableMap"
207 }
208 }
209 ]
210 },
211 "hasTarget_OF_InstanceVariableMap": {
212 "description": "InstanceVariableMap_hasTarget_InstanceVariable",
213 "$comment": "cardinality 0..-1",
214 "anyOf": [
215 {
216 "$ref": "#/defs/target-InstanceVariableMap"
217 },
218 {
219 "type": "array",
220 "items": {
221 "$ref": "#/defs/target-InstanceVariableMap"
222 }
223 }
224 ]
225 },
226 "has_InstanceVariable_OF_LogicalRecord": {
227 "description": "LogicalRecord_has_InstanceVariable",
228 "$comment": "cardinality 0..-1",
229 "anyOf": [
230 {
231 "$ref": "#/defs/target-LogicalRecord"
232 },
233 {
234 "type": "array",
235 "items": {
236 "$ref": "#/defs/target-LogicalRecord"
237 }
238 }
239 ]
240 },
241 "has_InstanceVariable_OF_PhysicalDataSet": {
242 "description": "PhysicalDataSet_has_InstanceVariable",
243 "$comment": "cardinality 0..-1",
244 "anyOf": [
245 {
246 "$ref": "#/defs/target-PhysicalDataSet"
247 },
248 {
249 "type": "array",
250 "items": {
251 "$ref": "#/defs/target-PhysicalDataSet"
252 }
253 }
254 ]
255 },
256 "isDefinedBy_RepresentedVariable_OF_DataStructureComponent": {
257 "description": "DataStructureComponent_isDefinedBy_RepresentedVariable",
258 "$comment": "cardinality 0..-1",
259 "anyOf": [
260 {
261 "$ref": "#/defs/target-DataStructureComponent"
262 },
263 {
264 "type": "array",
265 "items": {
266 "$ref": "#/defs/target-DataStructureComponent"
267 }
268 }
269 ]
270 },
271 "has_ConceptualVariable_OF_VariableCollection": {
272 "description": "VariableCollection_has_ConceptualVariable",
273 "$comment": "cardinality 0..-1",
274 "anyOf": [
275 {
276 "$ref": "#/defs/target-VariableCollection"
277 },
278 {
279 "type": "array",
280 "items": {
281 "$ref": "#/defs/target-VariableCollection"
282 }
283 }
284 ]
285 },
286 "indexes_OF_VariablePosition": {
287 "description": "VariablePosition_indexes_ConceptualVariable",
288 "$comment": "cardinality 0..-1",
289 "anyOf": [
290 {
291 "$ref": "#/defs/target-VariablePosition"
292 },
293 {
294 "type": "array",
295 "items": {
296 "$ref": "#/defs/target-VariablePosition"
297 }
298 }
299 ]
300 },
301 "hasSource_OF_VariableRelationship": {
302 "description": "VariableRelationship_hasSource_ConceptualVariable",
303 "$comment": "cardinality 0..-1",
304 "anyOf": [
305 {
306 "$ref": "#/defs/target-VariableRelationship"
307 },
308 {
309 "type": "array",
310 "items": {
311 "$ref": "#/defs/target-VariableRelationship"
312 }
313 }
314 ]
315 },
316 "hasTarget_OF_VariableRelationship": {
317 "description": "VariableRelationship_hasTarget_ConceptualVariable",
318 "$comment": "cardinality 0..-1",
319 "anyOf": [
320 {
321 "$ref": "#/defs/target-VariableRelationship"
322 },
323 {
324 "type": "array",
325 "items": {
326 "$ref": "#/defs/target-VariableRelationship"
327 }
328 }
329 ]
330 },
331 "isDefinedBy_Concept_OF_AgentListing": {
332 "description": "AgentListing_isDefinedBy_Concept",
333 "$comment": "cardinality 0..-1",
334 "anyOf": [
335 {
336 "$ref": "#/defs/target-AgentListing"
337 },
338 {
339 "type": "array",
340 "items": {
341 "$ref": "#/defs/target-AgentListing"
342 }
343 }
344 ]
345 },
346 "isDefinedBy_Concept_OF_ClassificationFamily": {
347 "description": "ClassificationFamily_isDefinedBy_Concept",
348 "$comment": "cardinality 0..-1",
349 "anyOf": [
350 {
351 "$ref": "#/defs/target-ClassificationFamily"
352 },
353 {
354 "type": "array",
355 "items": {
356 "$ref": "#/defs/target-ClassificationFamily"
357 }
358 }
359 ]
360 },
361 "isDefinedBy_Concept_OF_ClassificationIndex": {
362 "description": "ClassificationIndex_isDefinedBy_Concept",
363 "$comment": "cardinality 0..-1",
364 "anyOf": [
365 {
366 "$ref": "#/defs/target-ClassificationIndex"
367 },
368 {
369 "type": "array",
370 "items": {
371 "$ref": "#/defs/target-ClassificationIndex"
372 }
373 }
374 ]
375 },
376 "isDefinedBy_Concept_OF_ClassificationSeries": {
377 "description": "ClassificationSeries_isDefinedBy_Concept",
378 "$comment": "cardinality 0..-1",
379 "anyOf": [
380 {
381 "$ref": "#/defs/target-ClassificationSeries"
382 },
383 {
384 "type": "array",
385 "items": {
386 "$ref": "#/defs/target-ClassificationSeries"
387 }
388 }
389 ]
390 },
391 "uses_Concept_OF_Concept": {
392 "description": "Concept_uses_Concept",
393 "$comment": "cardinality 0..-1",
394 "anyOf": [
395 {
396 "$ref": "#/defs/target-Concept"
397 },
398 {
399 "type": "array",
400 "items": {
401 "$ref": "#/defs/target-Concept"
402 }
403 }
404 ]
405 },
406 "hasSource_OF_ConceptMap": {
407 "description": "ConceptMap_hasSource_Concept",
408 "$comment": "cardinality 0..-1",
409 "anyOf": [
410 {
411 "$ref": "#/defs/target-ConceptMap"
412 },
413 {
414 "type": "array",
415 "items": {
416 "$ref": "#/defs/target-ConceptMap"
417 }
418 }
419 ]
420 },
421 "hasTarget_OF_ConceptMap": {
422 "description": "ConceptMap_hasTarget_Concept",
423 "$comment": "cardinality 0..-1",
424 "anyOf": [
425 {
426 "$ref": "#/defs/target-ConceptMap"
427 },
428 {
429 "type": "array",
430 "items": {
431 "$ref": "#/defs/target-ConceptMap"
432 }
433 }
434 ]
435 },
436 "hasSource_OF_ConceptRelationship": {
437 "description": "ConceptRelationship_hasSource_Concept",
438 "$comment": "cardinality 0..-1",
439 "anyOf": [
440 {
441 "$ref": "#/defs/target-ConceptRelationship"
442 },
443 {
444 "type": "array",
445 "items": {
446 "$ref": "#/defs/target-ConceptRelationship"
447 }
448 }
449 ]
450 },
451 "hasTarget_OF_ConceptRelationship": {
452 "description": "ConceptRelationship_hasTarget_Concept",
453 "$comment": "cardinality 0..-1",
454 "anyOf": [
455 {
456 "$ref": "#/defs/target-ConceptRelationship"
457 },
458 {
459 "type": "array",
460 "items": {
461 "$ref": "#/defs/target-ConceptRelationship"
462 }
463 }
464 ]
465 },
466 "has_Concept_OF_ConceptSystem": {
467 "description": "ConceptSystem_has_Concept",
468 "$comment": "cardinality 0..-1",
469 "anyOf": [
470 {
471 "$ref": "#/defs/target-ConceptSystem"
472 },
473 {
474 "type": "array",
475 "items": {
476 "$ref": "#/defs/target-ConceptSystem"
477 }
478 }
479 ]
480 },
481 "isDefinedBy_Concept_OF_ConceptSystem": {
482 "description": "ConceptSystem_isDefinedBy_Concept",
483 "$comment": "cardinality 0..-1",
484 "anyOf": [
485 {
486 "$ref": "#/defs/target-ConceptSystem"
487 },
488 {
489 "type": "array",
490 "items": {
491 "$ref": "#/defs/target-ConceptSystem"
492 }
493 }
494 ]
495 },
496 "isDefinedBy_Concept_OF_DataStore": {
497 "description": "DataStore_isDefinedBy_Concept",
498 "$comment": "cardinality 0..-1",
499 "anyOf": [
500 {
501 "$ref": "#/defs/target-DataStore"
502 },
503 {
504 "type": "array",
505 "items": {
506 "$ref": "#/defs/target-DataStore"
507 }
508 }
509 ]
510 },
511 "isDefinedBy_Concept_OF_EnumerationDomain": {
512 "description": "EnumerationDomain_isDefinedBy_Concept",
513 "$comment": "cardinality 0..-1",
514 "anyOf": [
515 {
516 "$ref": "#/defs/target-EnumerationDomain"
517 },
518 {
519 "type": "array",
520 "items": {
521 "$ref": "#/defs/target-EnumerationDomain"
522 }
523 }
524 ]
525 },
526 "isDefinedBy_Concept_OF_Level": {
527 "description": "Level_isDefinedBy_Concept",
528 "$comment": "cardinality 0..-1",
529 "anyOf": [
530 {
531 "$ref": "#/defs/target-Level"
532 },
533 {
534 "type": "array",
535 "items": {
536 "$ref": "#/defs/target-Level"
537 }
538 }
539 ]
540 },
541 "isDefinedBy_Concept_OF_LogicalRecord": {
542 "description": "LogicalRecord_isDefinedBy_Concept",
543 "$comment": "cardinality 0..-1",
544 "anyOf": [
545 {
546 "$ref": "#/defs/target-LogicalRecord"
547 },
548 {
549 "type": "array",
550 "items": {
551 "$ref": "#/defs/target-LogicalRecord"
552 }
553 }
554 ]
555 },
556 "isDefinedBy_Concept_OF_PhysicalDataSet": {
557 "description": "PhysicalDataSet_isDefinedBy_Concept",
558 "$comment": "cardinality 0..-1",
559 "anyOf": [
560 {
561 "$ref": "#/defs/target-PhysicalDataSet"
562 },
563 {
564 "type": "array",
565 "items": {
566 "$ref": "#/defs/target-PhysicalDataSet"
567 }
568 }
569 ]
570 },
571 "isDefinedBy_Concept_OF_PhysicalRecordSegment": {
572 "description": "PhysicalRecordSegment_isDefinedBy_Concept",
573 "$comment": "cardinality 0..-1",
574 "anyOf": [
575 {
576 "$ref": "#/defs/target-PhysicalRecordSegment"
577 },
578 {
579 "type": "array",
580 "items": {
581 "$ref": "#/defs/target-PhysicalRecordSegment"
582 }
583 }
584 ]
585 },
586 "isDefinedBy_Concept_OF_PhysicalSegmentLayout": {
587 "description": "PhysicalSegmentLayout_isDefinedBy_Concept",
588 "$comment": "cardinality 0..-1",
589 "anyOf": [
590 {
591 "$ref": "#/defs/target-PhysicalSegmentLayout"
592 },
593 {
594 "type": "array",
595 "items": {
596 "$ref": "#/defs/target-PhysicalSegmentLayout"
597 }
598 }
599 ]
600 },
601 "isDefinedBy_Concept_OF_VariableCollection": {
602 "description": "VariableCollection_isDefinedBy_Concept",
603 "$comment": "cardinality 0..-1",
604 "anyOf": [
605 {
606 "$ref": "#/defs/target-VariableCollection"
607 },
608 {
609 "type": "array",
610 "items": {
611 "$ref": "#/defs/target-VariableCollection"
612 }
613 }
614 ]
615 },
616 "sameAs": {
617 "$ref": "#/defs/owl:sameAs"
618 }
619 },
620 "required": ["@type"],
621 "additionalProperties": false
622},
623"target-InstanceVariable": {
624 "description": "all subclasses of http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/InstanceVariable",
625 "anyOf": [
626 { "$ref": "#/defs/cls-InstanceVariable" },
627 { "$ref": "#/defs/cls-DescriptorVariable" },
628 { "$ref": "#/defs/cls-ReferenceVariable" },
629 { "type": "string", "format": "iri-reference" }
630 ]
631},
Fragment for the class InstanceVariable (main ontology)
1# class InstanceVariable
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::Conceptual::InstanceVariable
3cdi:InstanceVariable
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "InstanceVariable";
6 rdfs:comment "Definition\n==========\nUse of a represented variable within a data set. \n\nExamples\n======== \n1. Gender: Dan Gillman has gender <m, male>, Arofan Gregory has gender <m, male>, etc.\n2. Number of employees: Microsoft has 90,000 employees; IBM has 433,000 employees, etc.\n3. Endowment: Johns Hopkins has endowment of <3, $1,000,000 and above>, Yale has endowment of <3, $1,000,000 and above>, etc.\n4. A tornado near Winterset, Iowa, had a peak wind speed of 170 mph. Two instance variables of a person's height reference the same represented variable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same substantive value domain, use a sentinel value domain drawn from the same set of sentinel value domains, have the same sentinel (missing value) concepts, and draw their population from the same universe. In other words, the two instance variables should be comparable.\n\nExplanatory notes\n================= \nThe instance variable class inherits all of the properties and relationships of the represented variable class and, in turn, the conceptual variable class. This means that an instance variable can be completely populated without the need to create an associated represented variable or conceptual variable. If, however, a user wishes to indicate that a particular instance variable is patterned after a particular represented variable or a particular conceptual variable that may be indicated by including a relationship to the represented variable and/or conceptual variable. Including these references is an important method of indicating that multiple instance variables have the same representation, measure the same concept, and are drawn from the same universe. If two instance variables of a person's height reference the same represented variable. This indicates that they are intended to: be measured with the same unit of measurement, have the same intended data type, have the same substantive value domain, use a sentinel value domain drawn from the same set of sentinel value domains, have the same sentinel (missing value) concepts, and draw their population from the same universe. In other words, the two instance variables should be comparable. The instance variable describes actual instances of data that have been collected."@en;
7 rdfs:subClassOf cdi:RepresentedVariable;
8.
9
10cdi:InstanceVariable-physicalDataType
11 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
12 rdfs:label "physicalDataType";
13 rdfs:comment "The data type of this variable. Supports the optional use of an external controlled vocabulary."@en;
14 rdfs:domain cdi:InstanceVariable;
15 rdfs:range cdi:ControlledVocabularyEntry;
16.
17
18cdi:InstanceVariable-platformType
19 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
20 rdfs:label "platformType";
21 rdfs:comment "Describes the application or technical system context in which the variable has been realized. Typically a statistical processing package or other processing environment."@en;
22 rdfs:domain cdi:InstanceVariable;
23 rdfs:range cdi:ControlledVocabularyEntry;
24.
25
26cdi:InstanceVariable-source
27 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
28 rdfs:label "source";
29 rdfs:comment "Reference capturing provenance information."@en;
30 rdfs:domain cdi:InstanceVariable;
31 rdfs:range cdi:Reference;
32.
33
34cdi:InstanceVariable-variableFunction
35 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
36 rdfs:label "variableFunction";
37 rdfs:comment "Immutable characteristic of the variable such as geographic designator, weight, temporal designation, etc."@en;
38 rdfs:domain cdi:InstanceVariable;
39 rdfs:range cdi:ControlledVocabularyEntry;
40.
41
42
43cdi:InstanceVariable_has_PhysicalSegmentLayout
44 a rdf:Property, owl:ObjectProperty, ucmis:Association;
45 # ASSOCIATION
46 rdfs:label "has_PhysicalSegmentLayout";
47 skos:altLabel "InstanceVariable_has_PhysicalSegmentLayout";
48
49 rdfs:domain cdi:InstanceVariable;
50 rdfs:range cdi:PhysicalSegmentLayout;
51.
52
53cdi:InstanceVariable_has_ValueMapping
54 a rdf:Property, owl:ObjectProperty, ucmis:Association;
55 # ASSOCIATION
56 rdfs:label "has_ValueMapping";
57 skos:altLabel "InstanceVariable_has_ValueMapping";
58
59 rdfs:domain cdi:InstanceVariable;
60 rdfs:range cdi:ValueMapping;
61.
Fragment for the class InstanceVariable (entire JSON-LD)
1{
2 "@context": [
3 "RepresentedVariable.jsonld",
4 {
5 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
6 "xsd": "http://www.w3.org/2001/XMLSchema#",
7
8 "physicalDataType": {
9 "@id": "cdi:InstanceVariable-physicalDataType",
10 "@type": "@id",
11 "@context": "ControlledVocabularyEntry.jsonld"
12 },
13 "platformType": {
14 "@id": "cdi:InstanceVariable-platformType",
15 "@type": "@id",
16 "@context": "ControlledVocabularyEntry.jsonld"
17 },
18 "source": {
19 "@id": "cdi:InstanceVariable-source",
20 "@type": "@id",
21 "@context": "Reference.jsonld"
22 },
23 "variableFunction": {
24 "@id": "cdi:InstanceVariable-variableFunction",
25 "@type": "@id",
26 "@context": "ControlledVocabularyEntry.jsonld"
27 },
28
29 "has_PhysicalSegmentLayout": {
30 "@id": "cdi:InstanceVariable_has_PhysicalSegmentLayout",
31 "@type": "@id",
32 "@context": "PhysicalSegmentLayout.jsonld"
33 },
34 "has_ValueMapping": {
35 "@id": "cdi:InstanceVariable_has_ValueMapping",
36 "@type": "@id",
37 "@context": "ValueMapping.jsonld"
38 },
39 "appliesTo_OF_CategoryStatistic": {
40 "@reverse": "cdi:CategoryStatistic_appliesTo_InstanceVariable",
41 "@type": "@id",
42 "@context": "CategoryStatistic.jsonld"
43 },
44 "isDescribedBy_OF_DataPoint": {
45 "@reverse": "cdi:DataPoint_isDescribedBy_InstanceVariable",
46 "@type": "@id",
47 "@context": "DataPoint.jsonld"
48 },
49 "isBoundedBy_OF_Datum": {
50 "@reverse": "cdi:Datum_isBoundedBy_InstanceVariable",
51 "@type": "@id",
52 "@context": "Datum.jsonld"
53 },
54 "hasSource_OF_InstanceVariableMap": {
55 "@reverse": "cdi:InstanceVariableMap_hasSource_InstanceVariable",
56 "@type": "@id",
57 "@context": "InstanceVariableMap.jsonld"
58 },
59 "hasTarget_OF_InstanceVariableMap": {
60 "@reverse": "cdi:InstanceVariableMap_hasTarget_InstanceVariable",
61 "@type": "@id",
62 "@context": "InstanceVariableMap.jsonld"
63 },
64 "has_InstanceVariable_OF_LogicalRecord": {
65 "@reverse": "cdi:LogicalRecord_has_InstanceVariable",
66 "@type": "@id",
67 "@context": "LogicalRecord.jsonld"
68 },
69 "has_InstanceVariable_OF_PhysicalDataSet": {
70 "@reverse": "cdi:PhysicalDataSet_has_InstanceVariable",
71 "@type": "@id",
72 "@context": "PhysicalDataSet.jsonld"
73 },
74 " comment ": "tag:json-should-support-trailing-commas"
75 }
76 ],
77 "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:49.",
78 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::Conceptual::InstanceVariable"
79}
Fragment for the class InstanceVariable (entire SHACL - Shapes Constraint Language)
1# class InstanceVariable
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::Conceptual::InstanceVariable
3<#InstanceVariable> a sh:NodeShape;
4 sh:targetClass cdi:InstanceVariable;
5 sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/InstanceVariable";
6 sh:closed true;
7 sh:ignoredProperties ( owl:sameAs );
8 sh:property [
9 sh:path rdf:type;
10 sh:in ( cdi:InstanceVariable
11 cdi:DescriptorVariable
12 cdi:ReferenceVariable
13 ) ;
14 ];
15 # attributes
16 sh:property <#InstanceVariable-physicalDataType>;
17 sh:property <#InstanceVariable-platformType>;
18 sh:property <#InstanceVariable-source>;
19 sh:property <#InstanceVariable-variableFunction>;
20 # associations from InstanceVariable
21 sh:property <#InstanceVariable_has_PhysicalSegmentLayout>;
22 sh:property <#InstanceVariable_has_ValueMapping>;
23 # associations to InstanceVariable
24 sh:property <#rev_CategoryStatistic_appliesTo_InstanceVariable>;
25 sh:property <#rev_DataPoint_isDescribedBy_InstanceVariable>;
26 sh:property <#rev_Datum_isBoundedBy_InstanceVariable>;
27 sh:property <#rev_InstanceVariableMap_hasSource_InstanceVariable>;
28 sh:property <#rev_InstanceVariableMap_hasTarget_InstanceVariable>;
29 sh:property <#rev_LogicalRecord_has_InstanceVariable>;
30 sh:property <#rev_PhysicalDataSet_has_InstanceVariable>;
31
32 # ---- superclass: RepresentedVariable
33 # attributes
34 sh:property <#RepresentedVariable-describedUnitOfMeasure>;
35 sh:property <#RepresentedVariable-hasIntendedDataType>;
36 sh:property <#RepresentedVariable-simpleUnitOfMeasure>;
37 # associations from RepresentedVariable
38 sh:property <#RepresentedVariable_takesSentinelValuesFrom_SentinelValueDomain>;
39 sh:property <#RepresentedVariable_takesSubstantiveValuesFrom_SubstantiveValueDomain>;
40 # associations to RepresentedVariable
41 sh:property <#rev_DataStructureComponent_isDefinedBy_RepresentedVariable>;
42
43 # ---- superclass: ConceptualVariable
44 # attributes
45 sh:property <#ConceptualVariable-descriptiveText>;
46 sh:property <#ConceptualVariable-unitOfMeasureKind>;
47 # associations from ConceptualVariable
48 sh:property <#ConceptualVariable_measures_UnitType>;
49 sh:property <#ConceptualVariable_takesSentinelConceptsFrom_SentinelConceptualDomain>;
50 sh:property <#ConceptualVariable_takesSubstantiveConceptsFrom_SubstantiveConceptualDomain>;
51 # associations to ConceptualVariable
52 sh:property <#rev_VariableCollection_has_ConceptualVariable>;
53 sh:property <#rev_VariablePosition_indexes_ConceptualVariable>;
54 sh:property <#rev_VariableRelationship_hasSource_ConceptualVariable>;
55 sh:property <#rev_VariableRelationship_hasTarget_ConceptualVariable>;
56
57 # ---- superclass: Concept
58 # attributes
59 sh:property <#Concept-catalogDetails>;
60 sh:property <#Concept-definition>;
61 sh:property <#Concept-displayLabel>;
62 sh:property <#Concept-externalDefinition>;
63 sh:property <#Concept-identifier>;
64 sh:property <#Concept-name>;
65 # associations from Concept
66 sh:property <#Concept_uses_Concept>;
67 # associations to Concept
68 sh:property <#rev_AgentListing_isDefinedBy_Concept>;
69 sh:property <#rev_ClassificationFamily_isDefinedBy_Concept>;
70 sh:property <#rev_ClassificationIndex_isDefinedBy_Concept>;
71 sh:property <#rev_ClassificationSeries_isDefinedBy_Concept>;
72 sh:property <#rev_Concept_uses_Concept>;
73 sh:property <#rev_ConceptMap_hasSource_Concept>;
74 sh:property <#rev_ConceptMap_hasTarget_Concept>;
75 sh:property <#rev_ConceptRelationship_hasSource_Concept>;
76 sh:property <#rev_ConceptRelationship_hasTarget_Concept>;
77 sh:property <#rev_ConceptSystem_has_Concept>;
78 sh:property <#rev_ConceptSystem_isDefinedBy_Concept>;
79 sh:property <#rev_DataStore_isDefinedBy_Concept>;
80 sh:property <#rev_EnumerationDomain_isDefinedBy_Concept>;
81 sh:property <#rev_Level_isDefinedBy_Concept>;
82 sh:property <#rev_LogicalRecord_isDefinedBy_Concept>;
83 sh:property <#rev_PhysicalDataSet_isDefinedBy_Concept>;
84 sh:property <#rev_PhysicalRecordSegment_isDefinedBy_Concept>;
85 sh:property <#rev_PhysicalSegmentLayout_isDefinedBy_Concept>;
86 sh:property <#rev_VariableCollection_isDefinedBy_Concept>;
87
88
89
90
91
92
93
94
95
96.
97
98<#InstanceVariable-physicalDataType> a sh:PropertyShape ;
99 sh:path cdi:InstanceVariable-physicalDataType;
100 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
101 cdi:ControlledVocabularyEntry
102
103 ) ]];
104 sh:maxCount 1;
105.
106<#InstanceVariable-platformType> a sh:PropertyShape ;
107 sh:path cdi:InstanceVariable-platformType;
108 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
109 cdi:ControlledVocabularyEntry
110
111 ) ]];
112 sh:maxCount 1;
113.
114<#InstanceVariable-source> a sh:PropertyShape ;
115 sh:path cdi:InstanceVariable-source;
116 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
117 cdi:Reference
118
119 ) ]];
120 sh:maxCount 1;
121.
122<#InstanceVariable-variableFunction> a sh:PropertyShape ;
123 sh:path cdi:InstanceVariable-variableFunction;
124 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
125 cdi:ControlledVocabularyEntry
126
127 ) ]];
128.
129
130<#InstanceVariable_has_PhysicalSegmentLayout> a sh:PropertyShape ;
131 sh:path cdi:InstanceVariable_has_PhysicalSegmentLayout;
132 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
133 cdi:PhysicalSegmentLayout
134 cdi:UnitSegmentLayout
135
136 ) ]];
137.
138<#rev_InstanceVariable_has_PhysicalSegmentLayout> a sh:PropertyShape ;
139 sh:path [ sh:inversePath cdi:InstanceVariable_has_PhysicalSegmentLayout ];
140.
141<#InstanceVariable_has_ValueMapping> a sh:PropertyShape ;
142 sh:path cdi:InstanceVariable_has_ValueMapping;
143 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
144 cdi:ValueMapping
145
146 ) ]];
147 sh:maxCount 1;
148.
149<#rev_InstanceVariable_has_ValueMapping> a sh:PropertyShape ;
150 sh:path [ sh:inversePath cdi:InstanceVariable_has_ValueMapping ];
151.
Fragment for the class InstanceVariable (entire ShEx - Shape Expressions)
1# class InstanceVariable
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::Conceptual::InstanceVariable
3cdi:InstanceVariableShape CLOSED {
4 a [cdi:InstanceVariable];
5 $cdi:InstanceVariableProperties (
6 cdi:InstanceVariable-physicalDataType @cdi:ControlledVocabularyEntryShape?;
7 cdi:InstanceVariable-platformType @cdi:ControlledVocabularyEntryShape?;
8 cdi:InstanceVariable-source @cdi:ReferenceShape?;
9 cdi:InstanceVariable-variableFunction @cdi:ControlledVocabularyEntryShape*;
10 ^cdi:CategoryStatistic_appliesTo_InstanceVariable @cdi:CategoryStatisticShape *;
11 ^cdi:DataPoint_isDescribedBy_InstanceVariable @cdi:DataPointShape *;
12 ^cdi:Datum_isBoundedBy_InstanceVariable @cdi:DatumShape OR @cdi:RevisableDatumShape*;
13 cdi:InstanceVariable_has_PhysicalSegmentLayout @cdi:PhysicalSegmentLayoutShape OR @cdi:UnitSegmentLayoutShape*;
14
15 cdi:InstanceVariable_has_ValueMapping @cdi:ValueMappingShape ?;
16
17 ^cdi:InstanceVariableMap_hasSource_InstanceVariable @cdi:InstanceVariableMapShape *;
18 ^cdi:InstanceVariableMap_hasTarget_InstanceVariable @cdi:InstanceVariableMapShape *;
19 ^cdi:LogicalRecord_has_InstanceVariable @cdi:LogicalRecordShape *;
20 ^cdi:PhysicalDataSet_has_InstanceVariable @cdi:PhysicalDataSetShape *;
21 &cdi:RepresentedVariableProperties;
22 );
23}