VariableDescriptorComponent

Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::VariableDescriptorComponent

Definition

Role given to a represented variable in the context of a data structure to provide codes for variable identification.

Examples

Consider {“income”, “age”} to be the value domain of the represented variable working as a variable descriptor component. The two codes, i.e. those designating “income” and “age”, are descriptors used to identify which values in the variable value component correspond to income and which ones to age.

Explanatory notes

Whenever more than one variable appears in the same column, we need a mechanism to distinguish which values correspond to which variable. This mechanism is provided by the variable descriptor component, which contains the codes used to link the variables to their values. This structure provides a flexible mechanism avoiding the need for a formal pointer.

Inheritance
  ᐊ── Components::VariableDescriptorComponent
Attributes
Associations
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 VariableDescriptorComponent (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-Components-VariableDescriptorComponent"
 5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#VariableDescriptorComponent"
 6                 xmi:type="uml:Class">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableDescriptorComponent-ownedComment"
 8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#VariableDescriptorComponent-ownedComment"
 9                 xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableDescriptorComponent"/>
11      <body>Definition 
12============ 
13Role given to a represented variable in the context of a data structure to provide codes for variable identification.   
14
15Examples 
16========== 
17Consider {"income", "age"} to be the value domain of the represented variable working as a variable descriptor component.  The two codes, i.e. those designating "income" and "age", are descriptors used to identify which values in the variable value component correspond to income and which ones to age.   
18
19Explanatory notes 
20=================== 
21Whenever more than one variable appears in the same column, we need a mechanism to distinguish which values correspond to which variable. This mechanism is provided by the variable descriptor component, which contains the codes used to link the variables to their values.  This structure provides a flexible mechanism avoiding the need for a formal pointer.</body>
22   </ownedComment>
23   <name>VariableDescriptorComponent</name>
24   <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableDescriptorComponent-generalization"
25                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#VariableDescriptorComponent-generalization"
26                   xmi:type="uml:Generalization">
27      <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent"/>
28   </generalization>
29   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableDescriptorComponent-ownedAttribute_1"
30                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#VariableDescriptorComponent-ownedAttribute_1"
31                   xmi:type="uml:Property">
32      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableDescriptorComponent-ownedAttribute_1-lowerValue"
33                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#VariableDescriptorComponent-ownedAttribute_1-lowerValue"
34                  xmi:type="uml:LiteralInteger"/>
35      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableDescriptorComponent-ownedAttribute_1-upperValue"
36                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#VariableDescriptorComponent-ownedAttribute_1-upperValue"
37                  xmi:type="uml:LiteralUnlimitedNatural">
38         <value>1</value>
39      </upperValue>
40      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableDescriptorComponent_isDefinedBy_DescriptorVariable"/>
41      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-DescriptorVariable"/>
42   </ownedAttribute>
43   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableDescriptorComponent-ownedAttribute_2"
44                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#VariableDescriptorComponent-ownedAttribute_2"
45                   xmi:type="uml:Property">
46      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableDescriptorComponent-ownedAttribute_2-lowerValue"
47                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#VariableDescriptorComponent-ownedAttribute_2-lowerValue"
48                  xmi:type="uml:LiteralInteger">
49         <value>1</value>
50      </lowerValue>
51      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableDescriptorComponent-ownedAttribute_2-upperValue"
52                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#VariableDescriptorComponent-ownedAttribute_2-upperValue"
53                  xmi:type="uml:LiteralUnlimitedNatural">
54         <value>1</value>
55      </upperValue>
56      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableDescriptorComponent_refersTo_VariableValueComponent"/>
57      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-VariableValueComponent"/>
58   </ownedAttribute>
59</packagedElement>

Fragment for the class VariableDescriptorComponent (entire XML Schema)

  1<xs:element name="VariableDescriptorComponent"
  2            type="VariableDescriptorComponentXsdType"
  3            xml:id="VariableDescriptorComponent">
  4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::VariableDescriptorComponent -->
  5  <xs:annotation>
  6    <xs:documentation>Definition 
  7          ============ 
  8          Role given to a represented variable in the context of a data structure to provide codes for variable identification.   
  9          
 10          Examples 
 11          ========== 
 12          Consider {"income", "age"} to be the value domain of the represented variable working as a variable descriptor component.  The two codes, i.e. those designating "income" and "age", are descriptors used to identify which values in the variable value component correspond to income and which ones to age.   
 13          
 14          Explanatory notes 
 15          =================== 
 16          Whenever more than one variable appears in the same column, we need a mechanism to distinguish which values correspond to which variable. This mechanism is provided by the variable descriptor component, which contains the codes used to link the variables to their values.  This structure provides a flexible mechanism avoiding the need for a formal pointer.</xs:documentation>
 17  </xs:annotation>
 18</xs:element>
 19<xs:complexType name="VariableDescriptorComponentXsdType"
 20                xml:id="VariableDescriptorComponentXsdType">
 21  <xs:annotation>
 22    <xs:documentation>Definition 
 23          ============ 
 24          Role given to a represented variable in the context of a data structure to provide codes for variable identification.   
 25          
 26          Examples 
 27          ========== 
 28          Consider {"income", "age"} to be the value domain of the represented variable working as a variable descriptor component.  The two codes, i.e. those designating "income" and "age", are descriptors used to identify which values in the variable value component correspond to income and which ones to age.   
 29          
 30          Explanatory notes 
 31          =================== 
 32          Whenever more than one variable appears in the same column, we need a mechanism to distinguish which values correspond to which variable. This mechanism is provided by the variable descriptor component, which contains the codes used to link the variables to their values.  This structure provides a flexible mechanism avoiding the need for a formal pointer.</xs:documentation>
 33  </xs:annotation>
 34  <xs:complexContent>
 35    <xs:extension base="DataStructureComponentXsdType">
 36      <xs:sequence>
 37        <xs:element name="VariableDescriptorComponent_isDefinedBy_DescriptorVariable"
 38                    minOccurs="0"
 39                    maxOccurs="1"
 40                    xml:id="VariableDescriptorComponent_isDefinedBy_DescriptorVariable">
 41          <xs:annotation>
 42            <xs:documentation></xs:documentation>
 43          </xs:annotation>
 44          <xs:complexType>
 45            <xs:complexContent>
 46              <xs:restriction base="AssociationReferenceXsdType">
 47                <xs:sequence>
 48                  <xs:element name="ddiReference"
 49                              type="InternationalRegistrationDataIdentifierXsdType"
 50                              minOccurs="0"
 51                              maxOccurs="1"
 52                              xml:id="VariableDescriptorComponent_isDefinedBy_DescriptorVariable-ddiReference"/>
 53                  <xs:element name="validType"
 54                              minOccurs="0"
 55                              maxOccurs="unbounded"
 56                              xml:id="VariableDescriptorComponent_isDefinedBy_DescriptorVariable-validType">
 57                    <xs:simpleType>
 58                      <xs:restriction base="xs:NMTOKEN">
 59                        <xs:enumeration value="DescriptorVariable"/>
 60                      </xs:restriction>
 61                    </xs:simpleType>
 62                  </xs:element>
 63                </xs:sequence>
 64              </xs:restriction>
 65            </xs:complexContent>
 66          </xs:complexType>
 67        </xs:element>
 68        <xs:element name="VariableDescriptorComponent_refersTo_VariableValueComponent"
 69                    minOccurs="1"
 70                    maxOccurs="1"
 71                    xml:id="VariableDescriptorComponent_refersTo_VariableValueComponent">
 72          <xs:annotation>
 73            <xs:documentation></xs:documentation>
 74          </xs:annotation>
 75          <xs:complexType>
 76            <xs:complexContent>
 77              <xs:restriction base="AssociationReferenceXsdType">
 78                <xs:sequence>
 79                  <xs:element name="ddiReference"
 80                              type="InternationalRegistrationDataIdentifierXsdType"
 81                              minOccurs="0"
 82                              maxOccurs="1"
 83                              xml:id="VariableDescriptorComponent_refersTo_VariableValueComponent-ddiReference"/>
 84                  <xs:element name="validType"
 85                              minOccurs="1"
 86                              maxOccurs="1"
 87                              xml:id="VariableDescriptorComponent_refersTo_VariableValueComponent-validType">
 88                    <xs:simpleType>
 89                      <xs:restriction base="xs:NMTOKEN">
 90                        <xs:enumeration value="VariableValueComponent"/>
 91                      </xs:restriction>
 92                    </xs:simpleType>
 93                  </xs:element>
 94                </xs:sequence>
 95              </xs:restriction>
 96            </xs:complexContent>
 97          </xs:complexType>
 98        </xs:element>
 99      </xs:sequence>
100    </xs:extension>
101  </xs:complexContent>
102</xs:complexType>

Fragment for the class VariableDescriptorComponent (main ontology)

 1# class VariableDescriptorComponent
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::VariableDescriptorComponent
 3cdi:VariableDescriptorComponent
 4  a rdfs:Class, owl:Class, ucmis:Class;
 5  rdfs:label "VariableDescriptorComponent";
 6  rdfs:comment "Definition \n============ \nRole given to a represented variable in the context of a data structure to provide codes for variable identification.   \n\nExamples \n========== \nConsider {\"income\", \"age\"} to be the value domain of the represented variable working as a variable descriptor component.  The two codes, i.e. those designating \"income\" and \"age\", are descriptors used to identify which values in the variable value component correspond to income and which ones to age.   \n\nExplanatory notes \n=================== \nWhenever more than one variable appears in the same column, we need a mechanism to distinguish which values correspond to which variable. This mechanism is provided by the variable descriptor component, which contains the codes used to link the variables to their values.  This structure provides a flexible mechanism avoiding the need for a formal pointer."@en;
 7  rdfs:subClassOf cdi:DataStructureComponent;
 8.
 9
10
11cdi:VariableDescriptorComponent_isDefinedBy_DescriptorVariable
12  a rdf:Property, owl:ObjectProperty, ucmis:Association;
13  # ASSOCIATION
14  rdfs:label "isDefinedBy_DescriptorVariable";
15  skos:altLabel "VariableDescriptorComponent_isDefinedBy_DescriptorVariable";
16  
17  rdfs:domain cdi:VariableDescriptorComponent;
18  rdfs:range cdi:DescriptorVariable;
19.
20
21cdi:VariableDescriptorComponent_refersTo_VariableValueComponent
22  a rdf:Property, owl:ObjectProperty, ucmis:Association;
23  # ASSOCIATION
24  rdfs:label "refersTo";
25  skos:altLabel "VariableDescriptorComponent_refersTo_VariableValueComponent";
26  
27  rdfs:domain cdi:VariableDescriptorComponent;
28  rdfs:range cdi:VariableValueComponent;
29.

Fragment for the class VariableDescriptorComponent (main JSON-LD)

 1{
 2  "@context": [
 3    "DataStructureComponent.jsonld",
 4    {
 5      "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
 6      "xsd": "http://www.w3.org/2001/XMLSchema#",
 7
 8      
 9      "isDefinedBy_DescriptorVariable": {
10        "@id": "cdi:VariableDescriptorComponent_isDefinedBy_DescriptorVariable",
11        "@type": "@id",
12        "@context": "DescriptorVariable.jsonld"
13      },
14      "refersTo": {
15        "@id": "cdi:VariableDescriptorComponent_refersTo_VariableValueComponent",
16        "@type": "@id",
17        "@context": "VariableValueComponent.jsonld"
18      },
19      " comment ": "tag:json-should-support-trailing-commas"
20    }
21  ],
22  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-01-25 16:58:30.",
23  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::VariableDescriptorComponent"
24}