InstanceVariableMap#

Fully qualified class name of the UML model DDI-CDI 1.0: DDICDIModels::DDICDILibrary::Classes::FormatDescription::InstanceVariableMap

Definition#

Key value relationship for two or more logical records where the key is one or more equivalent instance variables and the value is a defined relationship or a relationship to a set value.

Explanatory notes#

The instance variable map identifies the variables which are used to connect two data sets, as when persons in one structure are associated with households in another structure. For logical records Household and Person, the keys are Household ID (HHID in Household Record), and Person ID (HHIDP in Person Record). Their value relationship is Equal, and set value is n.a. For each person in the person record, the value of HHIDP will be exactly the same as the value of HHID in the household record for the household to which they belong. (Correspondence type refers to the variables themselves rather than the value of the variables concerned.) In this context correspondence type will normally be set to ExactMatch.

Diagram#

Diagram
⤢

Attributes#

Attributes
Attributes#

Name

Inherited from

Description

Data Type

Multiplicity

Default value

comparison

- own class -

Relationship between the source and target instance variables or to the setValue if provided.

ComparisonOperator

1..1

correspondence

- own class -

Describes the relationship between the source and target members using both controlled vocabularies and descriptive text. In this context the correspondence refers to the two instance variables, not their value. The relationship would normally be ExactMatch.

CorrespondenceDefinition

1..1

identifier

- own class -

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

Identifier

0..1

setValue

- own class -

A fixed value for the key source Instance Variables.

String

1..1

Associations#

Associations
Associations#

Direction

Association

Description

Multiplicity of InstanceVariableMap

Package of Other Class

Other Class

Multiplicity of other class

Aggregation Kind

Inherited from

from

InstanceVariableMap hasSource InstanceVariable

The source instance variable for the relationship.

0..*

Conceptual

InstanceVariable

1..*

none

own class

from

InstanceVariableMap hasTarget InstanceVariable

Target instance variables if a directional relation is used.

0..*

Conceptual

InstanceVariable

0..*

none

own class

to

RecordRelation has InstanceVariableMap

0..*

- own package -

RecordRelation

0..1

none

own class

Encodings#

Syntax representations / encodings

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

Fragment for the class InstanceVariableMap (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-FormatDescription-InstanceVariableMap"
  5                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap"
  6                  xmi:type="uml:Class">
  7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-ownedComment"
  8                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-ownedComment"
  9                  xmi:type="uml:Comment">
 10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap"/>
 11      <body>Definition 
 12============ 
 13Key value relationship for two or more logical records where the key is one or more equivalent instance variables and the value is a defined relationship or a relationship to a set value.  
 14
 15Explanatory notes 
 16=================== 
 17The instance variable map identifies the variables which are used to connect two data sets, as when persons in one structure are associated with households in another structure. For logical records Household and Person, the keys are Household ID (HHID in Household Record), and Person ID (HHIDP in Person Record). Their value relationship is Equal, and set value is n.a. For each person in the person record, the value of HHIDP will be exactly the same as the value of HHID in the household record for the household to which they belong. (Correspondence type refers to the variables themselves rather than the value of the variables concerned.) In this context correspondence type will normally be set to ExactMatch.</body>
 18   </ownedComment>
 19   <name>InstanceVariableMap</name>
 20   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-comparison"
 21                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-comparison"
 22                    xmi:type="uml:Property">
 23      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-comparison-ownedComment"
 24                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-comparison-ownedComment"
 25                     xmi:type="uml:Comment">
 26         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-comparison"/>
 27         <body>Relationship between the source and target instance variables or to the setValue if provided.</body>
 28      </ownedComment>
 29      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-comparison-lowerValue"
 30                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-comparison-lowerValue"
 31                   xmi:type="uml:LiteralInteger">
 32         <value>1</value>
 33      </lowerValue>
 34      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-comparison-upperValue"
 35                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-comparison-upperValue"
 36                   xmi:type="uml:LiteralUnlimitedNatural">
 37         <value>1</value>
 38      </upperValue>
 39      <name>comparison</name>
 40      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-Enumerations-ComparisonOperator"/>
 41   </ownedAttribute>
 42   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-correspondence"
 43                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-correspondence"
 44                    xmi:type="uml:Property">
 45      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-correspondence-ownedComment"
 46                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-correspondence-ownedComment"
 47                     xmi:type="uml:Comment">
 48         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-correspondence"/>
 49         <body>Describes the relationship between the source and target members using both controlled vocabularies and descriptive text. In this context the correspondence refers to the two instance variables, not their value. The relationship would normally be ExactMatch.</body>
 50      </ownedComment>
 51      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-correspondence-lowerValue"
 52                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-correspondence-lowerValue"
 53                   xmi:type="uml:LiteralInteger">
 54         <value>1</value>
 55      </lowerValue>
 56      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-correspondence-upperValue"
 57                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-correspondence-upperValue"
 58                   xmi:type="uml:LiteralUnlimitedNatural">
 59         <value>1</value>
 60      </upperValue>
 61      <name>correspondence</name>
 62      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CorrespondenceDefinition"/>
 63   </ownedAttribute>
 64   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-identifier"
 65                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-identifier"
 66                    xmi:type="uml:Property">
 67      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-identifier-ownedComment"
 68                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-identifier-ownedComment"
 69                     xmi:type="uml:Comment">
 70         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-identifier"/>
 71         <body>Identifier for objects requiring short- or long-lasting referencing and management.</body>
 72      </ownedComment>
 73      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-identifier-lowerValue"
 74                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-identifier-lowerValue"
 75                   xmi:type="uml:LiteralInteger"/>
 76      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-identifier-upperValue"
 77                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-identifier-upperValue"
 78                   xmi:type="uml:LiteralUnlimitedNatural">
 79         <value>1</value>
 80      </upperValue>
 81      <name>identifier</name>
 82      <isID>true</isID>
 83      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Identifier"/>
 84   </ownedAttribute>
 85   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-ownedAttribute_1"
 86                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-ownedAttribute_1"
 87                    xmi:type="uml:Property">
 88      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-ownedAttribute_1-lowerValue"
 89                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-ownedAttribute_1-lowerValue"
 90                   xmi:type="uml:LiteralInteger"/>
 91      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-ownedAttribute_1-upperValue"
 92                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-ownedAttribute_1-upperValue"
 93                   xmi:type="uml:LiteralUnlimitedNatural">
 94         <value>*</value>
 95      </upperValue>
 96      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariableMap_hasTarget_InstanceVariable"/>
 97      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable"/>
 98   </ownedAttribute>
 99   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-ownedAttribute_2"
100                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-ownedAttribute_2"
101                    xmi:type="uml:Property">
102      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-ownedAttribute_2-lowerValue"
103                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-ownedAttribute_2-lowerValue"
104                   xmi:type="uml:LiteralInteger">
105         <value>1</value>
106      </lowerValue>
107      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-ownedAttribute_2-upperValue"
108                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-ownedAttribute_2-upperValue"
109                   xmi:type="uml:LiteralUnlimitedNatural">
110         <value>*</value>
111      </upperValue>
112      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariableMap_hasSource_InstanceVariable"/>
113      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-InstanceVariable"/>
114   </ownedAttribute>
115   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-setValue"
116                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-setValue"
117                    xmi:type="uml:Property">
118      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-setValue-ownedComment"
119                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-setValue-ownedComment"
120                     xmi:type="uml:Comment">
121         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-setValue"/>
122         <body>A fixed value for the key source Instance Variables.</body>
123      </ownedComment>
124      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-setValue-lowerValue"
125                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-setValue-lowerValue"
126                   xmi:type="uml:LiteralInteger">
127         <value>1</value>
128      </lowerValue>
129      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-InstanceVariableMap-setValue-upperValue"
130                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceVariableMap-setValue-upperValue"
131                   xmi:type="uml:LiteralUnlimitedNatural">
132         <value>1</value>
133      </upperValue>
134      <name>setValue</name>
135      <type href="http://www.omg.org/spec/UML/20131001/PrimitiveTypes.xmi#String"
136             xmi:type="uml:PrimitiveType"/>
137   </ownedAttribute>
138</packagedElement>

Fragment for the class InstanceVariableMap (entire XML Schema)

  1<xs:element name="InstanceVariableMap"
  2            type="InstanceVariableMapXsdType"
  3            xml:id="InstanceVariableMap">
  4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::InstanceVariableMap -->
  5  <xs:annotation>
  6    <xs:documentation>Definition 
  7          ============ 
  8          Key value relationship for two or more logical records where the key is one or more equivalent instance variables and the value is a defined relationship or a relationship to a set value.  
  9          
 10          Explanatory notes 
 11          =================== 
 12          The instance variable map identifies the variables which are used to connect two data sets, as when persons in one structure are associated with households in another structure. For logical records Household and Person, the keys are Household ID (HHID in Household Record), and Person ID (HHIDP in Person Record). Their value relationship is Equal, and set value is n.a. For each person in the person record, the value of HHIDP will be exactly the same as the value of HHID in the household record for the household to which they belong. (Correspondence type refers to the variables themselves rather than the value of the variables concerned.) In this context correspondence type will normally be set to ExactMatch.</xs:documentation>
 13  </xs:annotation>
 14</xs:element>
 15<xs:complexType name="InstanceVariableMapXsdType"
 16                xml:id="InstanceVariableMapXsdType">
 17  <xs:annotation>
 18    <xs:documentation>Definition 
 19          ============ 
 20          Key value relationship for two or more logical records where the key is one or more equivalent instance variables and the value is a defined relationship or a relationship to a set value.  
 21          
 22          Explanatory notes 
 23          =================== 
 24          The instance variable map identifies the variables which are used to connect two data sets, as when persons in one structure are associated with households in another structure. For logical records Household and Person, the keys are Household ID (HHID in Household Record), and Person ID (HHIDP in Person Record). Their value relationship is Equal, and set value is n.a. For each person in the person record, the value of HHIDP will be exactly the same as the value of HHID in the household record for the household to which they belong. (Correspondence type refers to the variables themselves rather than the value of the variables concerned.) In this context correspondence type will normally be set to ExactMatch.</xs:documentation>
 25  </xs:annotation>
 26  <xs:sequence>
 27    <xs:element name="comparison"
 28                type="ComparisonOperatorXsdType"
 29                minOccurs="1"
 30                maxOccurs="1"
 31                xml:id="InstanceVariableMap-comparison">
 32      <xs:annotation>
 33        <xs:documentation>Relationship between the source and target instance variables or to the setValue if provided.</xs:documentation>
 34      </xs:annotation>
 35    </xs:element>
 36    <xs:element name="correspondence"
 37                type="CorrespondenceDefinitionXsdType"
 38                minOccurs="1"
 39                maxOccurs="1"
 40                xml:id="InstanceVariableMap-correspondence">
 41      <xs:annotation>
 42        <xs:documentation>Describes the relationship between the source and target members using both controlled vocabularies and descriptive text. In this context the correspondence refers to the two instance variables, not their value. The relationship would normally be ExactMatch.</xs:documentation>
 43      </xs:annotation>
 44    </xs:element>
 45    <xs:element name="identifier"
 46                type="IdentifierXsdType"
 47                minOccurs="0"
 48                maxOccurs="1"
 49                xml:id="InstanceVariableMap-identifier">
 50      <xs:annotation>
 51        <xs:documentation>Identifier for objects requiring short- or long-lasting referencing and management.</xs:documentation>
 52      </xs:annotation>
 53    </xs:element>
 54    <xs:element name="setValue"
 55                type="xs:string"
 56                minOccurs="1"
 57                maxOccurs="1"
 58                xml:id="InstanceVariableMap-setValue">
 59      <xs:annotation>
 60        <xs:documentation>A fixed value for the key source Instance Variables.</xs:documentation>
 61      </xs:annotation>
 62    </xs:element>
 63    <xs:element name="InstanceVariableMap_hasTarget_InstanceVariable"
 64                minOccurs="0"
 65                maxOccurs="unbounded"
 66                xml:id="InstanceVariableMap_hasTarget_InstanceVariable">
 67      <xs:annotation>
 68        <xs:documentation>Target instance variables if a directional relation is used.</xs:documentation>
 69      </xs:annotation>
 70      <xs:complexType>
 71        <xs:complexContent>
 72          <xs:restriction base="AssociationReferenceXsdType">
 73            <xs:sequence>
 74              <xs:element name="ddiReference"
 75                          type="InternationalRegistrationDataIdentifierXsdType"
 76                          minOccurs="0"
 77                          maxOccurs="1"
 78                          xml:id="InstanceVariableMap_hasTarget_InstanceVariable-ddiReference"/>
 79              <xs:element name="validType"
 80                          minOccurs="0"
 81                          maxOccurs="unbounded"
 82                          xml:id="InstanceVariableMap_hasTarget_InstanceVariable-validType">
 83                <xs:simpleType>
 84                  <xs:restriction base="xs:NMTOKEN">
 85                    <xs:enumeration value="DescriptorVariable"/>
 86                    <xs:enumeration value="InstanceVariable"/>
 87                    <xs:enumeration value="ReferenceVariable"/>
 88                  </xs:restriction>
 89                </xs:simpleType>
 90              </xs:element>
 91            </xs:sequence>
 92          </xs:restriction>
 93        </xs:complexContent>
 94      </xs:complexType>
 95    </xs:element>
 96    <xs:element name="InstanceVariableMap_hasSource_InstanceVariable"
 97                minOccurs="1"
 98                maxOccurs="unbounded"
 99                xml:id="InstanceVariableMap_hasSource_InstanceVariable">
100      <xs:annotation>
101        <xs:documentation>The source instance variable for the relationship.</xs:documentation>
102      </xs:annotation>
103      <xs:complexType>
104        <xs:complexContent>
105          <xs:restriction base="AssociationReferenceXsdType">
106            <xs:sequence>
107              <xs:element name="ddiReference"
108                          type="InternationalRegistrationDataIdentifierXsdType"
109                          minOccurs="0"
110                          maxOccurs="1"
111                          xml:id="InstanceVariableMap_hasSource_InstanceVariable-ddiReference"/>
112              <xs:element name="validType"
113                          minOccurs="0"
114                          maxOccurs="unbounded"
115                          xml:id="InstanceVariableMap_hasSource_InstanceVariable-validType">
116                <xs:simpleType>
117                  <xs:restriction base="xs:NMTOKEN">
118                    <xs:enumeration value="DescriptorVariable"/>
119                    <xs:enumeration value="InstanceVariable"/>
120                    <xs:enumeration value="ReferenceVariable"/>
121                  </xs:restriction>
122                </xs:simpleType>
123              </xs:element>
124            </xs:sequence>
125          </xs:restriction>
126        </xs:complexContent>
127      </xs:complexType>
128    </xs:element>
129  </xs:sequence>
130</xs:complexType>

Fragment for the class InstanceVariableMap (entire JSON Schema)

 1"cls-InstanceVariableMap": {
 2  "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/InstanceVariableMap",
 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": "InstanceVariableMap"
14    },
15    "comparison": {
16      "$comment": "cardinality 1..1 – from cdi:InstanceVariableMap",
17      "$ref": "#/defs/enum-ComparisonOperator"
18    },
19    "correspondence": {
20      "$comment": "cardinality 1..1 – from cdi:InstanceVariableMap",
21      "$ref": "#/defs/dt-CorrespondenceDefinition"
22    },
23    "identifier": {
24      "$comment": "cardinality 0..1 – from cdi:InstanceVariableMap",
25      "$ref": "#/defs/dt-Identifier"
26    },
27    "setValue": {
28      "$comment": "cardinality 1..1 – from cdi:InstanceVariableMap",
29      "$ref": "#/defs/xsd:string"
30    },
31    "hasSource": {
32      "description": "InstanceVariableMap_hasSource_InstanceVariable",
33      "$comment": "cardinality 1..-1",
34      "anyOf": [
35        {
36          "$ref": "#/defs/target-InstanceVariable"
37        },
38        {
39          "type": "array",
40          "items": {
41            "$ref": "#/defs/target-InstanceVariable"
42          }
43        }
44      ]
45    },
46    "hasTarget": {
47      "description": "InstanceVariableMap_hasTarget_InstanceVariable",
48      "$comment": "cardinality 0..-1",
49      "anyOf": [
50        {
51          "$ref": "#/defs/target-InstanceVariable"
52        },
53        {
54          "type": "array",
55          "items": {
56            "$ref": "#/defs/target-InstanceVariable"
57          }
58        }
59      ]
60    },
61    "has_InstanceVariableMap_OF_RecordRelation": {
62      "description": "RecordRelation_has_InstanceVariableMap",
63      "$comment": "cardinality 0..1",
64      "$ref": "#/defs/target-RecordRelation"
65    },
66    "sameAs": {
67      "$ref": "#/defs/owl:sameAs"
68    }
69  },
70  "required": ["comparison","correspondence","setValue","hasSource","@type"],
71  "additionalProperties": false
72},
73"target-InstanceVariableMap": {
74  "description": "all subclasses of http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/InstanceVariableMap",
75  "anyOf": [
76    { "$ref": "#/defs/cls-InstanceVariableMap" },
77    { "type": "string", "format": "iri-reference" }
78  ]
79},

Fragment for the class InstanceVariableMap (main ontology)

 1# class InstanceVariableMap
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::InstanceVariableMap
 3cdi:InstanceVariableMap
 4  a rdfs:Class, owl:Class, ucmis:Class;
 5  rdfs:label "InstanceVariableMap";
 6  rdfs:comment "Definition \n============ \nKey value relationship for two or more logical records where the key is one or more equivalent instance variables and the value is a defined relationship or a relationship to a set value.  \n\nExplanatory notes \n=================== \nThe instance variable map identifies the variables which are used to connect two data sets, as when persons in one structure are associated with households in another structure. For logical records Household and Person, the keys are Household ID (HHID in Household Record), and Person ID (HHIDP in Person Record). Their value relationship is Equal, and set value is n.a. For each person in the person record, the value of HHIDP will be exactly the same as the value of HHID in the household record for the household to which they belong. (Correspondence type refers to the variables themselves rather than the value of the variables concerned.) In this context correspondence type will normally be set to ExactMatch."@en;
 7  
 8.
 9
10cdi:InstanceVariableMap-comparison
11  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
12  rdfs:label "comparison";
13  rdfs:comment "Relationship between the source and target instance variables or to the setValue if provided."@en;
14  rdfs:domain cdi:InstanceVariableMap;
15  rdfs:range cdi:ComparisonOperator;
16.
17
18cdi:InstanceVariableMap-correspondence
19  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
20  rdfs:label "correspondence";
21  rdfs:comment "Describes the relationship between the source and target members using both controlled vocabularies and descriptive text. In this context the correspondence refers to the two instance variables, not their value. The relationship would normally be ExactMatch."@en;
22  rdfs:domain cdi:InstanceVariableMap;
23  rdfs:range cdi:CorrespondenceDefinition;
24.
25
26cdi:InstanceVariableMap-identifier
27  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
28  rdfs:label "identifier";
29  rdfs:comment "Identifier for objects requiring short- or long-lasting referencing and management."@en;
30  rdfs:domain cdi:InstanceVariableMap;
31  rdfs:range cdi:Identifier;
32.
33
34cdi:InstanceVariableMap-setValue
35  a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
36  rdfs:label "setValue";
37  rdfs:comment "A fixed value for the key source Instance Variables."@en;
38  rdfs:domain cdi:InstanceVariableMap;
39  rdfs:range xsd:string;
40.
41
42
43cdi:InstanceVariableMap_hasSource_InstanceVariable
44  a rdf:Property, owl:ObjectProperty, ucmis:Association;
45  # ASSOCIATION
46  rdfs:label "hasSource";
47  skos:altLabel "InstanceVariableMap_hasSource_InstanceVariable";
48  rdfs:comment "The source instance variable for the relationship."@en;
49  rdfs:domain cdi:InstanceVariableMap;
50  rdfs:range cdi:InstanceVariable;
51.
52
53cdi:InstanceVariableMap_hasTarget_InstanceVariable
54  a rdf:Property, owl:ObjectProperty, ucmis:Association;
55  # ASSOCIATION
56  rdfs:label "hasTarget";
57  skos:altLabel "InstanceVariableMap_hasTarget_InstanceVariable";
58  rdfs:comment "Target instance variables if a directional relation is used."@en;
59  rdfs:domain cdi:InstanceVariableMap;
60  rdfs:range cdi:InstanceVariable;
61.

Fragment for the class InstanceVariableMap (entire JSON-LD)

 1{
 2  "@context": [
 3    {
 4      "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
 5      "xsd": "http://www.w3.org/2001/XMLSchema#",
 6
 7      "comparison": {
 8        "@id": "cdi:InstanceVariableMap-comparison",
 9        "@type": "@vocab",
10        "@context": {
11          "Equal": "cdi:Equal"
12      ,    "GreaterThan": "cdi:GreaterThan"
13      ,    "GreaterThanOrEqualTo": "cdi:GreaterThanOrEqualTo"
14      ,    "LessThan": "cdi:LessThan"
15      ,    "LessThanOrEqualTo": "cdi:LessThanOrEqualTo"
16      ,    "NotEqual": "cdi:NotEqual"
17        }
18      },
19      "correspondence": {
20        "@id": "cdi:InstanceVariableMap-correspondence",
21        "@type": "@id",
22        "@context": "CorrespondenceDefinition.jsonld"
23      },
24      "identifier": {
25        "@id": "cdi:InstanceVariableMap-identifier",
26        "@type": "@id",
27        "@context": "Identifier.jsonld"
28      },
29      "setValue": {
30        "@id": "cdi:InstanceVariableMap-setValue",
31        "@type": "xsd:string"
32      },
33      
34      "hasSource": {
35        "@id": "cdi:InstanceVariableMap_hasSource_InstanceVariable",
36        "@type": "@id",
37        "@context": "InstanceVariable.jsonld"
38      },
39      "hasTarget": {
40        "@id": "cdi:InstanceVariableMap_hasTarget_InstanceVariable",
41        "@type": "@id",
42        "@context": "InstanceVariable.jsonld"
43      },
44      "has_InstanceVariableMap_OF_RecordRelation": {
45        "@reverse": "cdi:RecordRelation_has_InstanceVariableMap",
46        "@type": "@id",
47        "@context": "RecordRelation.jsonld"
48      },
49      " comment ": "tag:json-should-support-trailing-commas"
50    }
51  ],
52  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:52.",
53  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::FormatDescription::InstanceVariableMap"
54}

Fragment for the class InstanceVariableMap (entire SHACL - Shapes Constraint Language)

 1# class InstanceVariableMap
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::InstanceVariableMap
 3<#InstanceVariableMap> a sh:NodeShape;
 4    sh:targetClass cdi:InstanceVariableMap;
 5	sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/InstanceVariableMap";
 6	sh:closed true;
 7	sh:ignoredProperties ( owl:sameAs );
 8    sh:property [
 9			sh:path rdf:type;
10			sh:in (   cdi:InstanceVariableMap
11			 ) ;
12    ];
13    # attributes
14    sh:property <#InstanceVariableMap-comparison>;
15    sh:property <#InstanceVariableMap-correspondence>;
16    sh:property <#InstanceVariableMap-identifier>;
17    sh:property <#InstanceVariableMap-setValue>;
18    # associations from InstanceVariableMap
19    sh:property <#InstanceVariableMap_hasSource_InstanceVariable>;
20    sh:property <#InstanceVariableMap_hasTarget_InstanceVariable>;
21    # associations to InstanceVariableMap
22    sh:property <#rev_RecordRelation_has_InstanceVariableMap>;
23
24
25
26.
27
28<#InstanceVariableMap-comparison> a sh:PropertyShape ;
29    sh:path cdi:InstanceVariableMap-comparison;
30    sh:node <#ComparisonOperator>
31    ;
32    sh:minCount 1;
33    sh:maxCount 1;
34.
35<#InstanceVariableMap-correspondence> a sh:PropertyShape ;
36    sh:path cdi:InstanceVariableMap-correspondence;
37    sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
38        cdi:CorrespondenceDefinition
39      
40    ) ]];
41    sh:minCount 1;
42    sh:maxCount 1;
43.
44<#InstanceVariableMap-identifier> a sh:PropertyShape ;
45    sh:path cdi:InstanceVariableMap-identifier;
46    sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
47        cdi:Identifier
48      
49    ) ]];
50    sh:maxCount 1;
51.
52<#InstanceVariableMap-setValue> a sh:PropertyShape ;
53    sh:path cdi:InstanceVariableMap-setValue;
54    sh:datatype xsd:string;
55    sh:minCount 1;
56    sh:maxCount 1;
57.
58
59<#InstanceVariableMap_hasSource_InstanceVariable> a sh:PropertyShape ;
60    sh:path cdi:InstanceVariableMap_hasSource_InstanceVariable;
61	sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
62        cdi:InstanceVariable
63        cdi:DescriptorVariable
64        cdi:ReferenceVariable
65      
66    ) ]];
67    sh:minCount 1;
68.
69<#rev_InstanceVariableMap_hasSource_InstanceVariable> a sh:PropertyShape ;
70    sh:path [ sh:inversePath cdi:InstanceVariableMap_hasSource_InstanceVariable ];
71.
72<#InstanceVariableMap_hasTarget_InstanceVariable> a sh:PropertyShape ;
73    sh:path cdi:InstanceVariableMap_hasTarget_InstanceVariable;
74	sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
75        cdi:InstanceVariable
76        cdi:DescriptorVariable
77        cdi:ReferenceVariable
78      
79    ) ]];
80.
81<#rev_InstanceVariableMap_hasTarget_InstanceVariable> a sh:PropertyShape ;
82    sh:path [ sh:inversePath cdi:InstanceVariableMap_hasTarget_InstanceVariable ];
83.

Fragment for the class InstanceVariableMap (entire ShEx - Shape Expressions)

 1# class InstanceVariableMap
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::InstanceVariableMap
 3cdi:InstanceVariableMapShape CLOSED {
 4	a [cdi:InstanceVariableMap];
 5	cdi:InstanceVariableMap-comparison	@cdi:ComparisonOperatorShape;
 6	cdi:InstanceVariableMap-correspondence	@cdi:CorrespondenceDefinitionShape;
 7	cdi:InstanceVariableMap-identifier	@cdi:IdentifierShape?;
 8	cdi:InstanceVariableMap-setValue	xsd:string;
 9	cdi:InstanceVariableMap_hasSource_InstanceVariable	@cdi:InstanceVariableShape OR @cdi:DescriptorVariableShape OR @cdi:ReferenceVariableShape+;
10	
11	cdi:InstanceVariableMap_hasTarget_InstanceVariable	@cdi:InstanceVariableShape OR @cdi:DescriptorVariableShape OR @cdi:ReferenceVariableShape*;
12	
13	^cdi:RecordRelation_has_InstanceVariableMap @cdi:RecordRelationShape ?;
14	}