InstanceKey

Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::InstanceKey

Definition

Single-valued key representation produced from the merge of the representations of all key members and a descriptor.

Examples

The string “cluster:income_distribution:unitid:20:period:2020/02:income”, where “cluster:income_distribution” is a key member based on a contextual component, “unitid:20” is based on an identifier component, “period:2020/02” is based on a component with a time role and “income” is based on a descriptor.

Explanatory notes

For value strings, the merge is the string concatenation operation. For other classes, an appropriate merge representation can be defined.

Diagram

Inheritance
  ᐊ── KeyValue::InstanceKey
Attributes

Name

Inherited from

Description

Data Type

Multiplicity

Default value

identifier

DataDescription::Key

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

Identifier

0..1

Associations

Direction

Association

Description

Multiplicity of InstanceKey

Package of Other Class

Other Class

Multiplicity of other class

Aggregation Kind

Inherited from

from

Key correspondsTo Unit

0..*

Conceptual

Unit

0..1

none

DataDescription::Key

from

Key correspondsTo Universe

0..*

Conceptual

Universe

0..1

none

DataDescription::Key

to

DataSet has Key

0..*

DataDescription

DataSet

1..1

none

DataDescription::Key

from

Key has KeyMember

0..1

DataDescription

KeyMember

0..*

shared

DataDescription::Key

from

Key identifies DataPoint

0..1

DataDescription

DataPoint

1..*

none

DataDescription::Key

from

Key represents KeyDefinition

1..*

DataDescription

KeyDefinition

0..1

none

DataDescription::Key

from

InstanceKey has InstanceValue

0..*

DataDescription

InstanceValue

0..1

none

- own class -

from

InstanceKey refersTo ReferenceValue

0..*

Long

ReferenceValue

1..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 InstanceKey (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-KeyValue-InstanceKey"
 5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceKey"
 6                 xmi:type="uml:Class">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-InstanceKey-ownedComment"
 8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceKey-ownedComment"
 9                 xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-InstanceKey"/>
11      <body>Definition
12============
13Single-valued key representation produced from the merge of the representations of all key members and a descriptor. 
14
15Examples
16==========
17The string "cluster:income_distribution:unitid:20:period:2020/02:income", where "cluster:income_distribution" is a key member based on a contextual component, "unitid:20" is based on an identifier component, "period:2020/02" is based on a component with a time role and "income" is based on a descriptor.
18
19
20Explanatory notes
21===================
22For value strings, the merge is the string concatenation operation.
23For other classes, an appropriate merge representation can be defined.</body>
24   </ownedComment>
25   <name>InstanceKey</name>
26   <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-InstanceKey-generalization"
27                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceKey-generalization"
28                   xmi:type="uml:Generalization">
29      <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Key"/>
30   </generalization>
31   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-InstanceKey-ownedAttribute_1"
32                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceKey-ownedAttribute_1"
33                   xmi:type="uml:Property">
34      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-InstanceKey-ownedAttribute_1-lowerValue"
35                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceKey-ownedAttribute_1-lowerValue"
36                  xmi:type="uml:LiteralInteger"/>
37      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-InstanceKey-ownedAttribute_1-upperValue"
38                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceKey-ownedAttribute_1-upperValue"
39                  xmi:type="uml:LiteralUnlimitedNatural">
40         <value>1</value>
41      </upperValue>
42      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-InstanceKey_has_InstanceValue"/>
43      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-InstanceValue"/>
44   </ownedAttribute>
45   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-InstanceKey-ownedAttribute_2"
46                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceKey-ownedAttribute_2"
47                   xmi:type="uml:Property">
48      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-InstanceKey-ownedAttribute_2-lowerValue"
49                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceKey-ownedAttribute_2-lowerValue"
50                  xmi:type="uml:LiteralInteger">
51         <value>1</value>
52      </lowerValue>
53      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-InstanceKey-ownedAttribute_2-upperValue"
54                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#InstanceKey-ownedAttribute_2-upperValue"
55                  xmi:type="uml:LiteralUnlimitedNatural">
56         <value>1</value>
57      </upperValue>
58      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-InstanceKey_refersTo_ReferenceValue"/>
59      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Long-ReferenceValue"/>
60   </ownedAttribute>
61</packagedElement>

Fragment for the class InstanceKey (entire XML Schema)

  1<xs:element name="InstanceKey"
  2            type="InstanceKeyXsdType"
  3            xml:id="InstanceKey">
  4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::InstanceKey -->
  5  <xs:annotation>
  6    <xs:documentation>Definition
  7          ============
  8          Single-valued key representation produced from the merge of the representations of all key members and a descriptor. 
  9          
 10          Examples
 11          ==========
 12          The string "cluster:income_distribution:unitid:20:period:2020/02:income", where "cluster:income_distribution" is a key member based on a contextual component, "unitid:20" is based on an identifier component, "period:2020/02" is based on a component with a time role and "income" is based on a descriptor.
 13          
 14          
 15          Explanatory notes
 16          ===================
 17          For value strings, the merge is the string concatenation operation.
 18          For other classes, an appropriate merge representation can be defined.</xs:documentation>
 19  </xs:annotation>
 20</xs:element>
 21<xs:complexType name="InstanceKeyXsdType"
 22                xml:id="InstanceKeyXsdType">
 23  <xs:annotation>
 24    <xs:documentation>Definition
 25          ============
 26          Single-valued key representation produced from the merge of the representations of all key members and a descriptor. 
 27          
 28          Examples
 29          ==========
 30          The string "cluster:income_distribution:unitid:20:period:2020/02:income", where "cluster:income_distribution" is a key member based on a contextual component, "unitid:20" is based on an identifier component, "period:2020/02" is based on a component with a time role and "income" is based on a descriptor.
 31          
 32          
 33          Explanatory notes
 34          ===================
 35          For value strings, the merge is the string concatenation operation.
 36          For other classes, an appropriate merge representation can be defined.</xs:documentation>
 37  </xs:annotation>
 38  <xs:complexContent>
 39    <xs:extension base="KeyXsdType">
 40      <xs:sequence>
 41        <xs:element name="InstanceKey_has_InstanceValue"
 42                    minOccurs="0"
 43                    maxOccurs="1"
 44                    xml:id="InstanceKey_has_InstanceValue">
 45          <xs:annotation>
 46            <xs:documentation></xs:documentation>
 47          </xs:annotation>
 48          <xs:complexType>
 49            <xs:complexContent>
 50              <xs:restriction base="AssociationReferenceXsdType">
 51                <xs:sequence>
 52                  <xs:element name="ddiReference"
 53                              type="InternationalRegistrationDataIdentifierXsdType"
 54                              minOccurs="0"
 55                              maxOccurs="1"
 56                              xml:id="InstanceKey_has_InstanceValue-ddiReference"/>
 57                  <xs:element name="validType"
 58                              minOccurs="0"
 59                              maxOccurs="unbounded"
 60                              xml:id="InstanceKey_has_InstanceValue-validType">
 61                    <xs:simpleType>
 62                      <xs:restriction base="xs:NMTOKEN">
 63                        <xs:enumeration value="Descriptor"/>
 64                        <xs:enumeration value="DimensionalKeyMember"/>
 65                        <xs:enumeration value="InstanceValue"/>
 66                        <xs:enumeration value="KeyMember"/>
 67                        <xs:enumeration value="LongMainKeyMember"/>
 68                        <xs:enumeration value="MainKeyMember"/>
 69                        <xs:enumeration value="ReferenceValue"/>
 70                        <xs:enumeration value="WideKeyMember"/>
 71                      </xs:restriction>
 72                    </xs:simpleType>
 73                  </xs:element>
 74                </xs:sequence>
 75              </xs:restriction>
 76            </xs:complexContent>
 77          </xs:complexType>
 78        </xs:element>
 79        <xs:element name="InstanceKey_refersTo_ReferenceValue"
 80                    minOccurs="1"
 81                    maxOccurs="1"
 82                    xml:id="InstanceKey_refersTo_ReferenceValue">
 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="InstanceKey_refersTo_ReferenceValue-ddiReference"/>
 95                  <xs:element name="validType"
 96                              minOccurs="0"
 97                              maxOccurs="unbounded"
 98                              xml:id="InstanceKey_refersTo_ReferenceValue-validType">
 99                    <xs:simpleType>
100                      <xs:restriction base="xs:NMTOKEN">
101                        <xs:enumeration value="ReferenceValue"/>
102                      </xs:restriction>
103                    </xs:simpleType>
104                  </xs:element>
105                </xs:sequence>
106              </xs:restriction>
107            </xs:complexContent>
108          </xs:complexType>
109        </xs:element>
110      </xs:sequence>
111    </xs:extension>
112  </xs:complexContent>
113</xs:complexType>

Fragment for the class InstanceKey (main ontology)

 1# class InstanceKey
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::InstanceKey
 3cdi:InstanceKey
 4  a rdfs:Class, owl:Class, ucmis:Class;
 5  rdfs:label "InstanceKey";
 6  rdfs:comment "Definition\n============\nSingle-valued key representation produced from the merge of the representations of all key members and a descriptor. \n\nExamples\n==========\nThe string \"cluster:income_distribution:unitid:20:period:2020/02:income\", where \"cluster:income_distribution\" is a key member based on a contextual component, \"unitid:20\" is based on an identifier component, \"period:2020/02\" is based on a component with a time role and \"income\" is based on a descriptor.\n\n\nExplanatory notes\n===================\nFor value strings, the merge is the string concatenation operation.\nFor other classes, an appropriate merge representation can be defined."@en;
 7  rdfs:subClassOf cdi:Key;
 8.
 9
10
11cdi:InstanceKey_has_InstanceValue
12  a rdf:Property, owl:ObjectProperty, ucmis:Association;
13  # ASSOCIATION
14  rdfs:label "has";
15  skos:altLabel "InstanceKey_has_InstanceValue";
16  
17  rdfs:domain cdi:InstanceKey;
18  rdfs:range cdi:InstanceValue;
19.
20
21cdi:InstanceKey_refersTo_ReferenceValue
22  a rdf:Property, owl:ObjectProperty, ucmis:Association;
23  # ASSOCIATION
24  rdfs:label "refersTo";
25  skos:altLabel "InstanceKey_refersTo_ReferenceValue";
26  
27  rdfs:domain cdi:InstanceKey;
28  rdfs:range cdi:ReferenceValue;
29.

Fragment for the class InstanceKey (main JSON-LD)

 1{
 2  "@context": [
 3    "Key.jsonld",
 4    {
 5      "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
 6      "xsd": "http://www.w3.org/2001/XMLSchema#",
 7      "InstanceKey": "cdi:InstanceKey",
 8      
 9      "has": {
10        "@id": "cdi:InstanceKey_has_InstanceValue",
11        "@type": "@id"      },
12      "refersTo": {
13        "@id": "cdi:InstanceKey_refersTo_ReferenceValue",
14        "@type": "@id"      },
15      " comment ": "tag:json-should-support-trailing-commas" 
16    }
17  ],
18  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-03-16 23:40:07.",
19  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::InstanceKey"
20}