InstanceVariable

Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::Conceptual::InstanceVariable

Definition

Use of a represented variable within a data set.

Examples

  1. Gender: Dan Gillman has gender <m, male>, Arofan Gregory has gender <m, male>, etc.

  2. Number of employees: Microsoft has 90,000 employees; IBM has 433,000 employees, etc.

  3. Endowment: Johns Hopkins has endowment of <3, $1,000,000 and above>, Yale has endowment of <3, $1,000,000 and above>, etc.

  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.

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

Inheritance
      ᐊ── Conceptual::InstanceVariable
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.

ControlledVocabularyEntry

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.

ControlledVocabularyEntry

0..1

source

- own class -

Reference capturing provenance information.

Reference

0..1

variableFunction

- own class -

Immutable characteristic of the variable such as geographic designator, weight, temporal designation, etc.

ControlledVocabularyEntry

0..*

describedUnitOfMeasure

Conceptual::RepresentedVariable

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.

ControlledVocabularyEntry

0..1

hasIntendedDataType

Conceptual::RepresentedVariable

The data type intended to be used by this variable. Supports the optional use of an external controlled vocabulary.

ControlledVocabularyEntry

0..1

simpleUnitOfMeasure

Conceptual::RepresentedVariable

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

Conceptual::ConceptualVariable

A short natural language account of the characteristics of the object.

InternationalString

0..1

unitOfMeasureKind

Conceptual::ConceptualVariable

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.

ControlledVocabularyEntry

0..1

catalogDetails

Conceptual::Concept

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.

CatalogDetails

0..1

definition

Conceptual::Concept

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.

InternationalString

0..1

displayLabel

Conceptual::Concept

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.

LabelForDisplay

0..*

externalDefinition

Conceptual::Concept

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.

Reference

0..1

identifier

Conceptual::Concept

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

Identifier

0..1

name

Conceptual::Concept

Human understandable name (linguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage.

ObjectName

0..*

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

Components

DataStructureComponent

0..*

none

Conceptual::RepresentedVariable

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

Representations

SentinelValueDomain

0..*

none

Conceptual::RepresentedVariable

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

Representations

SubstantiveValueDomain

0..1

none

Conceptual::RepresentedVariable

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 -

UnitType

0..1

none

Conceptual::ConceptualVariable

from

ConceptualVariable takesSentinelConceptsFrom SentinelConceptualDomain

Identifies the conceptual domain containing the set of sentinel concepts used to describe the conceptual variable.

0..*

- own package -

SentinelConceptualDomain

0..1

none

Conceptual::ConceptualVariable

from

ConceptualVariable takesSubstantiveConceptsFrom SubstantiveConceptualDomain

Identifies the substantive conceptual domain containing the set of substantive concepts used to describe the conceptual variable.

0..*

- own package -

SubstantiveConceptualDomain

0..1

none

Conceptual::ConceptualVariable

to

VariableCollection has ConceptualVariable

Variable collection has zero to many conceptual variables.

0..*

- own package -

VariableCollection

0..*

none

Conceptual::ConceptualVariable

to

VariablePosition indexes ConceptualVariable

Variable position indexes a conceptual variable.

1..1

- own package -

VariablePosition

0..*

none

Conceptual::ConceptualVariable

to

VariableRelationship hasSource ConceptualVariable

0..*

- own package -

VariableRelationship

0..*

none

Conceptual::ConceptualVariable

to

VariableRelationship hasTarget ConceptualVariable

Note that this can be realized as a collection to support tuples.

0..*

- own package -

VariableRelationship

0..*

none

Conceptual::ConceptualVariable

to

AgentListing isDefinedBy Concept

The conceptual basis for the collection of members.

0..*

Agents

AgentListing

0..*

none

Conceptual::Concept

to

ClassificationFamily isDefinedBy Concept

The conceptual basis for the collection of members.

0..*

Representations

ClassificationFamily

0..*

none

Conceptual::Concept

to

ClassificationIndex isDefinedBy Concept

The conceptual basis for the collection of members.

0..*

Representations

ClassificationIndex

0..*

none

Conceptual::Concept

to

ClassificationSeries isDefinedBy Concept

The conceptual basis for the collection of members.

0..*

Representations

ClassificationSeries

0..*

none

Conceptual::Concept

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 -

Concept

0..*

none

Conceptual::Concept

to

ConceptMap hasSource Concept

Concept map has one to many source concepts.

1..*

- own package -

ConceptMap

0..*

none

Conceptual::Concept

to

ConceptMap hasTarget Concept

Concept map has one to many target concepts.

1..*

- own package -

ConceptMap

0..*

none

Conceptual::Concept

to

ConceptRelationship hasSource Concept

Restricts source object to concept for the relationship.

1..1

- own package -

ConceptRelationship

0..*

none

Conceptual::Concept

to

ConceptRelationship hasTarget Concept

Restricts target object to concept for the relationship.

1..1

- own package -

ConceptRelationship

0..*

none

Conceptual::Concept

to

ConceptSystem has Concept

Concept system has zero to many concepts.

0..*

- own package -

ConceptSystem

0..*

none

Conceptual::Concept

to

ConceptSystem isDefinedBy Concept

Concept system is defined by zero to many concepts. The conceptual basis for the collection of members.

0..*

- own package -

ConceptSystem

0..*

none

Conceptual::Concept

to

DataStore isDefinedBy Concept

The conceptual basis for the collection of members.

0..*

FormatDescription

DataStore

0..*

none

Conceptual::Concept

to

EnumerationDomain isDefinedBy Concept

The conceptual basis for the collection of members.

0..*

Representations

EnumerationDomain

0..*

none

Conceptual::Concept

to

Level isDefinedBy Concept

A concept or concept sub-type which describes the level.

0..1

Representations

Level

0..*

none

Conceptual::Concept

to

LogicalRecord isDefinedBy Concept

The conceptual basis for the collection of members.

0..*

FormatDescription

LogicalRecord

0..*

none

Conceptual::Concept

to

PhysicalDataSet isDefinedBy Concept

The conceptual basis for the collection of members.

0..*

FormatDescription

PhysicalDataSet

0..*

none

Conceptual::Concept

to

PhysicalRecordSegment isDefinedBy Concept

The conceptual basis for the collection of members.

0..*

FormatDescription

PhysicalRecordSegment

0..*

none

Conceptual::Concept

to

PhysicalSegmentLayout isDefinedBy Concept

The conceptual basis for the collection of members.

0..*

FormatDescription

PhysicalSegmentLayout

0..*

none

Conceptual::Concept

to

VariableCollection isDefinedBy Concept

The conceptual basis for the collection of members.

0..*

- own package -

VariableCollection

0..*

none

Conceptual::Concept

to

CategoryStatistic appliesTo InstanceVariable

1..*

Representations

CategoryStatistic

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

DataDescription

DataPoint

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

DataDescription

Datum

0..*

none

- own class -

from

InstanceVariable has PhysicalSegmentLayout

0..*

FormatDescription

PhysicalSegmentLayout

0..*

none

- own class -

from

InstanceVariable has ValueMapping

0..*

FormatDescription

ValueMapping

0..1

shared

- own class -

to

InstanceVariableMap hasSource InstanceVariable

The source instance variable for the relationship.

1..*

FormatDescription

InstanceVariableMap

0..*

none

- own class -

to

InstanceVariableMap hasTarget InstanceVariable

Target instance variables if a directional relation is used.

0..*

FormatDescription

InstanceVariableMap

0..*

none

- own class -

to

LogicalRecord has InstanceVariable

0..*

FormatDescription

LogicalRecord

0..*

none

- own class -

to

PhysicalDataSet has InstanceVariable

0..*

FormatDescription

PhysicalDataSet

0..*

none

- own class -

Syntax representations / encodings

All syntax representations except the Canonical XMI are provided as reference points for specific implementations, or for use as defaults if sufficient in the form presented.

Fragment for the class InstanceVariable (entire model as XMI)

  1<packagedElement xmlns:StandardProfile="http://www.eclipse.org/uml2/5.0.0/UML/Profile/Standard"
  2                 xmlns:uml="http://www.eclipse.org/uml2/5.0.0/UML"
  3                 xmlns:xmi="http://www.omg.org/spec/XMI/20131001"
  4                 xmi:id="DDICDIModels-DDICDILibrary-Classes-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 &lt;m, male&gt;, Arofan Gregory has gender &lt;m, male&gt;, etc.
 182. Number of employees: Microsoft has 90,000 employees; IBM has 433,000 employees, etc.
 193. Endowment: Johns Hopkins has endowment of &lt;3, $1,000,000 and above&gt;, Yale has endowment of &lt;3, $1,000,000 and above&gt;, 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 &lt;m, male&gt;, Arofan Gregory has gender &lt;m, male&gt;, 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 &lt;3, $1,000,000 and above&gt;, Yale has endowment of &lt;3, $1,000,000 and above&gt;, 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 &lt;m, male&gt;, Arofan Gregory has gender &lt;m, male&gt;, 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 &lt;3, $1,000,000 and above&gt;, Yale has endowment of &lt;3, $1,000,000 and above&gt;, 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 (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";
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";
57  skos:altLabel "InstanceVariable_has_ValueMapping";
58  
59  rdfs:domain cdi:InstanceVariable;
60  rdfs:range cdi:ValueMapping;
61.

Fragment for the class InstanceVariable (main 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      "InstanceVariable": "cdi:InstanceVariable",
 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": {
30        "@id": "cdi:InstanceVariable_has_PhysicalSegmentLayout",
31        "@type": "@id"      },
32      "has": {
33        "@id": "cdi:InstanceVariable_has_ValueMapping",
34        "@type": "@id"      },
35      "appliesTo_OF_CategoryStatistic": {
36        "@reverse": "cdi:CategoryStatistic_appliesTo_InstanceVariable",
37        "@type": "@id"
38      },
39      "isDescribedBy_OF_DataPoint": {
40        "@reverse": "cdi:DataPoint_isDescribedBy_InstanceVariable",
41        "@type": "@id"
42      },
43      "isBoundedBy_OF_Datum": {
44        "@reverse": "cdi:Datum_isBoundedBy_InstanceVariable",
45        "@type": "@id"
46      },
47      "hasSource_OF_InstanceVariableMap": {
48        "@reverse": "cdi:InstanceVariableMap_hasSource_InstanceVariable",
49        "@type": "@id"
50      },
51      "hasTarget_OF_InstanceVariableMap": {
52        "@reverse": "cdi:InstanceVariableMap_hasTarget_InstanceVariable",
53        "@type": "@id"
54      },
55      "has_OF_LogicalRecord": {
56        "@reverse": "cdi:LogicalRecord_has_InstanceVariable",
57        "@type": "@id"
58      },
59      "has_OF_PhysicalDataSet": {
60        "@reverse": "cdi:PhysicalDataSet_has_InstanceVariable",
61        "@type": "@id"
62      },
63      " comment ": "tag:json-should-support-trailing-commas" 
64    }
65  ],
66  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-09-23 21:52:55.",
67  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::Conceptual::InstanceVariable"
68}