DescriptorVariable

Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::DescriptorVariable

Definition

Variable that provides codes for variable identification in the context of a data structure. Variable playing the role of a variable descriptor component.

Examples

Consider two variables, i.e. income and age, with values apearing in the same column. Codes “income” and “age” are descriptors that appear in the descriptor value domain corresponding to the descriptor variable.

Diagram

Inheritance
      ᐊ── Long::DescriptorVariable
Attributes

Name

Inherited from

Description

Data Type

Multiplicity

Default value

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 DescriptorVariable

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

Conceptual

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

Conceptual

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

Conceptual

SubstantiveConceptualDomain

0..1

none

Conceptual::ConceptualVariable

to

VariableCollection has ConceptualVariable

Variable collection has zero to many conceptual variables.

0..*

Conceptual

VariableCollection

0..*

none

Conceptual::ConceptualVariable

to

VariablePosition indexes ConceptualVariable

Variable position indexes a conceptual variable.

1..1

Conceptual

VariablePosition

0..*

none

Conceptual::ConceptualVariable

to

VariableRelationship hasSource ConceptualVariable

0..*

Conceptual

VariableRelationship

0..*

none

Conceptual::ConceptualVariable

to

VariableRelationship hasTarget ConceptualVariable

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

0..*

Conceptual

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

Conceptual

Concept

0..*

none

Conceptual::Concept

to

ConceptMap hasSource Concept

Concept map has one to many source concepts.

1..*

Conceptual

ConceptMap

0..*

none

Conceptual::Concept

to

ConceptMap hasTarget Concept

Concept map has one to many target concepts.

1..*

Conceptual

ConceptMap

0..*

none

Conceptual::Concept

to

ConceptRelationship hasSource Concept

Restricts source object to concept for the relationship.

1..1

Conceptual

ConceptRelationship

0..*

none

Conceptual::Concept

to

ConceptRelationship hasTarget Concept

Restricts target object to concept for the relationship.

1..1

Conceptual

ConceptRelationship

0..*

none

Conceptual::Concept

to

ConceptSystem has Concept

Concept system has zero to many concepts.

0..*

Conceptual

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

Conceptual

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

Conceptual

VariableCollection

0..*

none

Conceptual::Concept

to

VariableDescriptorComponent isDefinedBy DescriptorVariable

0..1

Components

VariableDescriptorComponent

0..*

none

- own class -

from

DescriptorVariable takesSubstantiveValuesFrom DescriptorValueDomain

0..*

- own package -

DescriptorValueDomain

0..1

none

- own class -

Syntax representations / encodings

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

Fragment for the class DescriptorVariable (entire model as XMI)

 1<packagedElement xmlns:StandardProfile="http://www.eclipse.org/uml2/5.0.0/UML/Profile/Standard"
 2                 xmlns:uml="http://www.eclipse.org/uml2/5.0.0/UML"
 3                 xmlns:xmi="http://www.omg.org/spec/XMI/20131001"
 4                 xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorVariable"
 5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DescriptorVariable"
 6                 xmi:type="uml:Class">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorVariable-ownedComment"
 8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DescriptorVariable-ownedComment"
 9                 xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorVariable"/>
11      <body>Definition
12============
13Variable that provides codes for variable identification in the context of a data structure.
14Variable playing the role of a variable descriptor component.
15
16Examples
17==========
18Consider two variables, i.e. income and age, with values apearing in the same column. 
19Codes "income" and "age" are descriptors that appear in the descriptor value domain corresponding to the descriptor variable.</body>
20   </ownedComment>
21   <name>DescriptorVariable</name>
22   <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorVariable-generalization"
23                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DescriptorVariable-generalization"
24                   xmi:type="uml:Generalization">
25      <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-RepresentedVariable"/>
26   </generalization>
27   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorVariable-ownedAttribute"
28                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DescriptorVariable-ownedAttribute"
29                   xmi:type="uml:Property">
30      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorVariable-ownedAttribute-lowerValue"
31                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DescriptorVariable-ownedAttribute-lowerValue"
32                  xmi:type="uml:LiteralInteger"/>
33      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorVariable-ownedAttribute-upperValue"
34                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DescriptorVariable-ownedAttribute-upperValue"
35                  xmi:type="uml:LiteralUnlimitedNatural">
36         <value>1</value>
37      </upperValue>
38      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain"/>
39      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorValueDomain"/>
40   </ownedAttribute>
41</packagedElement>

Fragment for the class DescriptorVariable (entire XML Schema)

 1<xs:element name="DescriptorVariable"
 2            type="DescriptorVariableXsdType"
 3            xml:id="DescriptorVariable">
 4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::DescriptorVariable -->
 5  <xs:annotation>
 6    <xs:documentation>Definition
 7          ============
 8          Variable that provides codes for variable identification in the context of a data structure.
 9          Variable playing the role of a variable descriptor component.
10          
11          Examples
12          ==========
13          Consider two variables, i.e. income and age, with values apearing in the same column. 
14          Codes "income" and "age" are descriptors that appear in the descriptor value domain corresponding to the descriptor variable.</xs:documentation>
15  </xs:annotation>
16</xs:element>
17<xs:complexType name="DescriptorVariableXsdType"
18                xml:id="DescriptorVariableXsdType">
19  <xs:annotation>
20    <xs:documentation>Definition
21          ============
22          Variable that provides codes for variable identification in the context of a data structure.
23          Variable playing the role of a variable descriptor component.
24          
25          Examples
26          ==========
27          Consider two variables, i.e. income and age, with values apearing in the same column. 
28          Codes "income" and "age" are descriptors that appear in the descriptor value domain corresponding to the descriptor variable.</xs:documentation>
29  </xs:annotation>
30  <xs:complexContent>
31    <xs:extension base="RepresentedVariableXsdType">
32      <xs:sequence>
33        <xs:element name="DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain"
34                    minOccurs="0"
35                    maxOccurs="1"
36                    xml:id="DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain">
37          <xs:annotation>
38            <xs:documentation></xs:documentation>
39          </xs:annotation>
40          <xs:complexType>
41            <xs:complexContent>
42              <xs:restriction base="AssociationReferenceXsdType">
43                <xs:sequence>
44                  <xs:element name="ddiReference"
45                              type="InternationalRegistrationDataIdentifierXsdType"
46                              minOccurs="0"
47                              maxOccurs="1"
48                              xml:id="DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain-ddiReference"/>
49                  <xs:element name="validType"
50                              minOccurs="0"
51                              maxOccurs="unbounded"
52                              xml:id="DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain-validType">
53                    <xs:simpleType>
54                      <xs:restriction base="xs:NMTOKEN">
55                        <xs:enumeration value="DescriptorValueDomain"/>
56                      </xs:restriction>
57                    </xs:simpleType>
58                  </xs:element>
59                </xs:sequence>
60              </xs:restriction>
61            </xs:complexContent>
62          </xs:complexType>
63        </xs:element>
64      </xs:sequence>
65    </xs:extension>
66  </xs:complexContent>
67</xs:complexType>

Fragment for the class DescriptorVariable (main ontology)

 1# class DescriptorVariable
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::DescriptorVariable
 3cdi:DescriptorVariable
 4  a rdfs:Class, owl:Class, ucmis:Class;
 5  rdfs:label "DescriptorVariable";
 6  rdfs:comment "Definition\n============\nVariable that provides codes for variable identification in the context of a data structure.\nVariable playing the role of a variable descriptor component.\n\nExamples\n==========\nConsider two variables, i.e. income and age, with values apearing in the same column. \nCodes \"income\" and \"age\" are descriptors that appear in the descriptor value domain corresponding to the descriptor variable."@en;
 7  rdfs:subClassOf cdi:RepresentedVariable;
 8.
 9
10
11cdi:DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain
12  a rdf:Property, owl:ObjectProperty, ucmis:Association;
13  # ASSOCIATION
14  rdfs:label "takesSubstantiveValuesFrom";
15  skos:altLabel "DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain";
16  
17  rdfs:domain cdi:DescriptorVariable;
18  rdfs:range cdi:DescriptorValueDomain;
19.

Fragment for the class DescriptorVariable (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      "DescriptorVariable": "cdi:DescriptorVariable",
 8      
 9      "takesSubstantiveValuesFrom": {
10        "@id": "cdi:DescriptorVariable_takesSubstantiveValuesFrom_DescriptorValueDomain",
11        "@type": "@id"      },
12      "isDefinedBy_OF_VariableDescriptorComponent": {
13        "@reverse": "cdi:VariableDescriptorComponent_isDefinedBy_DescriptorVariable",
14        "@type": "@id"
15      },
16      " comment ": "tag:json-should-support-trailing-commas" 
17    }
18  ],
19  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-09-23 21:52:58.",
20  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Long::DescriptorVariable"
21}