DataStructureComponent

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

Definition

Role given to a represented variable in the context of a data structure.

Explanatory notes

A represented variable can have different roles in different data structures. For instance, the variable sex can be a measure in a wide data structure and a dimension in a dimensional data structure.

Diagram

Attributes

Name

Inherited from

Description

Data Type

Multiplicity

Default value

identifier

- own class -

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

Identifier

0..1

semantic

- own class -

Qualifies the purpose or use expressed as a paired external controlled vocabulary.

PairedControlledVocabularyEntry

0..*

specialization

- own class -

The role played by the component for the data set for purposes of harmonization and integration, typically regarding geography, time, etc.

SpecializationRole

0..1

Associations

Direction

Association

Description

Multiplicity of DataStructureComponent

Package of Other Class

Other Class

Multiplicity of other class

Aggregation Kind

Inherited from

from

DataStructureComponent isDefinedBy RepresentedVariable

Data structure component is defined by zero to one represented variable.

0..*

Conceptual

RepresentedVariable

0..1

none

- own class -

to

DataPoint correspondsTo DataStructureComponent

0..*

DataDescription

DataPoint

0..*

none

- own class -

to

DataStructure has DataStructureComponent

0..*

DataDescription

DataStructure

0..1

none

- own class -

to

KeyMember isBasedOn DataStructureComponent

0..*

DataDescription

KeyMember

0..*

none

- own class -

to

AttributeComponent qualifies DataStructureComponent

0..*

- own package -

AttributeComponent

0..*

none

- own class -

to

ComponentPosition indexes DataStructureComponent

0..1

- own package -

ComponentPosition

0..*

none

- own class -

to

ForeignKeyComponent correspondsTo DataStructureComponent

1..1

- own package -

ForeignKeyComponent

0..1

none

- own class -

to

PrimaryKeyComponent correspondsTo DataStructureComponent

1..1

- own package -

PrimaryKeyComponent

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 DataStructureComponent (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-DataStructureComponent"
 5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent"
 6                 xmi:type="uml:Class">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-ownedComment"
 8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-ownedComment"
 9                 xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent"/>
11      <body>Definition 
12============ 
13Role given to a represented variable in the context of a data structure.  
14
15Explanatory notes 
16=================== 
17A represented variable can have different roles in different data structures. For instance, the variable sex can be a measure in a wide data structure and a dimension in a dimensional data structure.</body>
18   </ownedComment>
19   <name>DataStructureComponent</name>
20   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-identifier"
21                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-identifier"
22                   xmi:type="uml:Property">
23      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-identifier-ownedComment"
24                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-identifier-ownedComment"
25                    xmi:type="uml:Comment">
26         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-identifier"/>
27         <body>Identifier for objects requiring short- or long-lasting referencing and management.</body>
28      </ownedComment>
29      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-identifier-lowerValue"
30                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-identifier-lowerValue"
31                  xmi:type="uml:LiteralInteger"/>
32      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-identifier-upperValue"
33                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-identifier-upperValue"
34                  xmi:type="uml:LiteralUnlimitedNatural">
35         <value>1</value>
36      </upperValue>
37      <name>identifier</name>
38      <isID>true</isID>
39      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Identifier"/>
40   </ownedAttribute>
41   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-ownedAttribute"
42                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-ownedAttribute"
43                   xmi:type="uml:Property">
44      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-ownedAttribute-lowerValue"
45                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-ownedAttribute-lowerValue"
46                  xmi:type="uml:LiteralInteger"/>
47      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-ownedAttribute-upperValue"
48                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-ownedAttribute-upperValue"
49                  xmi:type="uml:LiteralUnlimitedNatural">
50         <value>1</value>
51      </upperValue>
52      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-DataStructureComponent_isDefinedBy_RepresentedVariable"/>
53      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-RepresentedVariable"/>
54   </ownedAttribute>
55   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-semantic"
56                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-semantic"
57                   xmi:type="uml:Property">
58      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-semantic-ownedComment"
59                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-semantic-ownedComment"
60                    xmi:type="uml:Comment">
61         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-semantic"/>
62         <body>Qualifies the purpose or use expressed as a paired external controlled vocabulary.</body>
63      </ownedComment>
64      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-semantic-lowerValue"
65                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-semantic-lowerValue"
66                  xmi:type="uml:LiteralInteger"/>
67      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-semantic-upperValue"
68                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-semantic-upperValue"
69                  xmi:type="uml:LiteralUnlimitedNatural">
70         <value>*</value>
71      </upperValue>
72      <name>semantic</name>
73      <isOrdered>true</isOrdered>
74      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-PairedControlledVocabularyEntry"/>
75   </ownedAttribute>
76   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-specialization"
77                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-specialization"
78                   xmi:type="uml:Property">
79      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-specialization-ownedComment"
80                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-specialization-ownedComment"
81                    xmi:type="uml:Comment">
82         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-specialization"/>
83         <body>The role played by the component for the data set for purposes of harmonization and integration, typically regarding geography, time, etc.</body>
84      </ownedComment>
85      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-specialization-lowerValue"
86                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-specialization-lowerValue"
87                  xmi:type="uml:LiteralInteger"/>
88      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent-specialization-upperValue"
89                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DataStructureComponent-specialization-upperValue"
90                  xmi:type="uml:LiteralUnlimitedNatural">
91         <value>1</value>
92      </upperValue>
93      <name>specialization</name>
94      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-SpecializationRole"/>
95   </ownedAttribute>
96</packagedElement>

Fragment for the class DataStructureComponent (entire XML Schema)

 1<xs:element name="DataStructureComponent"
 2            type="DataStructureComponentXsdType"
 3            xml:id="DataStructureComponent">
 4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::DataStructureComponent -->
 5  <xs:annotation>
 6    <xs:documentation>Definition 
 7          ============ 
 8          Role given to a represented variable in the context of a data structure.  
 9          
10          Explanatory notes 
11          =================== 
12          A represented variable can have different roles in different data structures. For instance, the variable sex can be a measure in a wide data structure and a dimension in a dimensional data structure.</xs:documentation>
13  </xs:annotation>
14</xs:element>
15<xs:complexType name="DataStructureComponentXsdType"
16                xml:id="DataStructureComponentXsdType">
17  <xs:annotation>
18    <xs:documentation>Definition 
19          ============ 
20          Role given to a represented variable in the context of a data structure.  
21          
22          Explanatory notes 
23          =================== 
24          A represented variable can have different roles in different data structures. For instance, the variable sex can be a measure in a wide data structure and a dimension in a dimensional data structure.</xs:documentation>
25  </xs:annotation>
26  <xs:sequence>
27    <xs:element name="identifier"
28                type="IdentifierXsdType"
29                minOccurs="0"
30                maxOccurs="1"
31                xml:id="DataStructureComponent-identifier">
32      <xs:annotation>
33        <xs:documentation>Identifier for objects requiring short- or long-lasting referencing and management.</xs:documentation>
34      </xs:annotation>
35    </xs:element>
36    <xs:element name="semantic"
37                type="PairedControlledVocabularyEntryXsdType"
38                minOccurs="0"
39                maxOccurs="unbounded"
40                xml:id="DataStructureComponent-semantic">
41      <xs:annotation>
42        <xs:documentation>Qualifies the purpose or use expressed as a paired external controlled vocabulary.</xs:documentation>
43      </xs:annotation>
44    </xs:element>
45    <xs:element name="specialization"
46                type="SpecializationRoleXsdType"
47                minOccurs="0"
48                maxOccurs="1"
49                xml:id="DataStructureComponent-specialization">
50      <xs:annotation>
51        <xs:documentation>The role played by the component for the data set for purposes of harmonization and integration, typically regarding geography, time, etc.</xs:documentation>
52      </xs:annotation>
53    </xs:element>
54    <xs:element name="DataStructureComponent_isDefinedBy_RepresentedVariable"
55                minOccurs="0"
56                maxOccurs="1"
57                xml:id="DataStructureComponent_isDefinedBy_RepresentedVariable">
58      <xs:annotation>
59        <xs:documentation>Data structure component is defined by zero to one represented variable.</xs:documentation>
60      </xs:annotation>
61      <xs:complexType>
62        <xs:complexContent>
63          <xs:restriction base="AssociationReferenceXsdType">
64            <xs:sequence>
65              <xs:element name="ddiReference"
66                          type="InternationalRegistrationDataIdentifierXsdType"
67                          minOccurs="0"
68                          maxOccurs="1"
69                          xml:id="DataStructureComponent_isDefinedBy_RepresentedVariable-ddiReference"/>
70              <xs:element name="validType"
71                          minOccurs="0"
72                          maxOccurs="unbounded"
73                          xml:id="DataStructureComponent_isDefinedBy_RepresentedVariable-validType">
74                <xs:simpleType>
75                  <xs:restriction base="xs:NMTOKEN">
76                    <xs:enumeration value="DescriptorVariable"/>
77                    <xs:enumeration value="InstanceVariable"/>
78                    <xs:enumeration value="ReferenceVariable"/>
79                    <xs:enumeration value="RepresentedVariable"/>
80                  </xs:restriction>
81                </xs:simpleType>
82              </xs:element>
83            </xs:sequence>
84          </xs:restriction>
85        </xs:complexContent>
86      </xs:complexType>
87    </xs:element>
88  </xs:sequence>
89</xs:complexType>

Fragment for the class DataStructureComponent (main ontology)

 1# class DataStructureComponent
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::DataStructureComponent
 3cdi:DataStructureComponent
 4  a rdfs:Class, owl:Class, ucmis:Class;
 5  rdfs:label "DataStructureComponent";
 6  rdfs:comment "Definition \n============ \nRole given to a represented variable in the context of a data structure.  \n\nExplanatory notes \n=================== \nA represented variable can have different roles in different data structures. For instance, the variable sex can be a measure in a wide data structure and a dimension in a dimensional data structure."@en;
 7  
 8.
 9
10cdi:DataStructureComponent-identifier
11  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
12  rdfs:label "identifier";
13  rdfs:comment "Identifier for objects requiring short- or long-lasting referencing and management."@en;
14  rdfs:domain cdi:DataStructureComponent;
15  rdfs:range cdi:Identifier;
16.
17
18cdi:DataStructureComponent-semantic
19  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
20  rdfs:label "semantic";
21  rdfs:comment "Qualifies the purpose or use expressed as a paired external controlled vocabulary."@en;
22  rdfs:domain cdi:DataStructureComponent;
23  rdfs:range cdi:PairedControlledVocabularyEntry;
24.
25
26cdi:DataStructureComponent-specialization
27  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
28  rdfs:label "specialization";
29  rdfs:comment "The role played by the component for the data set for purposes of harmonization and integration, typically regarding geography, time, etc."@en;
30  rdfs:domain cdi:DataStructureComponent;
31  rdfs:range cdi:SpecializationRole;
32.
33
34
35cdi:DataStructureComponent_isDefinedBy_RepresentedVariable
36  a rdf:Property, owl:ObjectProperty, ucmis:Association;
37  # ASSOCIATION
38  rdfs:label "isDefinedBy";
39  skos:altLabel "DataStructureComponent_isDefinedBy_RepresentedVariable";
40  rdfs:comment "Data structure component is defined by zero to one represented variable."@en;
41  rdfs:domain cdi:DataStructureComponent;
42  rdfs:range cdi:RepresentedVariable;
43.

Fragment for the class DataStructureComponent (main 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      "DataStructureComponent": "cdi:DataStructureComponent",
 7      "identifier": {
 8        "@id": "cdi:DataStructureComponent-identifier",
 9        "@type": "@id",
10        "@context": "Identifier.jsonld"
11      },
12      "semantic": {
13        "@id": "cdi:DataStructureComponent-semantic",
14        "@type": "@id",
15        "@context": "PairedControlledVocabularyEntry.jsonld"
16      },
17      "specialization": {
18        "@id": "cdi:DataStructureComponent-specialization",
19        "@type": "@id",
20        "@context": "SpecializationRole.jsonld"
21      },
22      
23      "isDefinedBy": {
24        "@id": "cdi:DataStructureComponent_isDefinedBy_RepresentedVariable",
25        "@type": "@id"      },
26      "correspondsTo_OF_DataPoint": {
27        "@reverse": "cdi:DataPoint_correspondsTo_DataStructureComponent",
28        "@type": "@id"
29      },
30      "has_OF_DataStructure": {
31        "@reverse": "cdi:DataStructure_has_DataStructureComponent",
32        "@type": "@id"
33      },
34      "isBasedOn_OF_KeyMember": {
35        "@reverse": "cdi:KeyMember_isBasedOn_DataStructureComponent",
36        "@type": "@id"
37      },
38      "qualifies_OF_AttributeComponent": {
39        "@reverse": "cdi:AttributeComponent_qualifies_DataStructureComponent",
40        "@type": "@id"
41      },
42      "indexes_OF_ComponentPosition": {
43        "@reverse": "cdi:ComponentPosition_indexes_DataStructureComponent",
44        "@type": "@id"
45      },
46      "correspondsTo_OF_ForeignKeyComponent": {
47        "@reverse": "cdi:ForeignKeyComponent_correspondsTo_DataStructureComponent",
48        "@type": "@id"
49      },
50      "correspondsTo_OF_PrimaryKeyComponent": {
51        "@reverse": "cdi:PrimaryKeyComponent_correspondsTo_DataStructureComponent",
52        "@type": "@id"
53      },
54      " comment ": "tag:json-should-support-trailing-commas" 
55    }
56  ],
57  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-09-23 21:52:56.",
58  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::DataStructureComponent"
59}