DimensionComponent

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

Definition

Role given to a represented variable in the context of a dimensional data structure to identify the universes associated with data points. The variable acts as a field in the compound identifier (the key structure) to disambiguate the cells in the multi-dimensional “cube”.

Explanatory notes

The categories from each dimension often are used in combination to identify a cell. The meaning of the combination of the categories supplies meaning to the cell.

Diagram

Inheritance
  ᐊ── Components::DimensionComponent
Attributes

Name

Inherited from

Description

Data Type

Multiplicity

Default value

categoricalAdditivity

- own class -

Indicates whether categories at a specific level can be combined to provide the value for their shared parent category. Value is True if categories can be added together (collapsed) to create higher-level categories.

An example would be age categories. Five-year age categories can be collapsed into 10-year age categories.

Boolean

0..1

identifier

Components::DataStructureComponent

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

Identifier

0..1

semantic

Components::DataStructureComponent

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

PairedControlledVocabularyEntry

0..*

specialization

Components::DataStructureComponent

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 DimensionComponent

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

Components::DataStructureComponent

to

DataPoint correspondsTo DataStructureComponent

0..*

DataDescription

DataPoint

0..*

none

Components::DataStructureComponent

to

DataStructure has DataStructureComponent

0..*

DataDescription

DataStructure

0..1

none

Components::DataStructureComponent

to

KeyMember isBasedOn DataStructureComponent

0..*

DataDescription

KeyMember

0..*

none

Components::DataStructureComponent

to

AttributeComponent qualifies DataStructureComponent

0..*

- own package -

AttributeComponent

0..*

none

Components::DataStructureComponent

to

ComponentPosition indexes DataStructureComponent

0..1

- own package -

ComponentPosition

0..*

none

Components::DataStructureComponent

to

ForeignKeyComponent correspondsTo DataStructureComponent

1..1

- own package -

ForeignKeyComponent

0..1

none

Components::DataStructureComponent

to

PrimaryKeyComponent correspondsTo DataStructureComponent

1..1

- own package -

PrimaryKeyComponent

0..1

none

Components::DataStructureComponent

from

DimensionComponent isStructuredBy ValueDomain

0..*

Representations

ValueDomain

0..1

none

- own class -

to

DimensionGroup has DimensionComponent

1..*

Dimensional

DimensionGroup

0..*

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 DimensionComponent (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-DimensionComponent"
 5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DimensionComponent"
 6                 xmi:type="uml:Class">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent-ownedComment"
 8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DimensionComponent-ownedComment"
 9                 xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent"/>
11      <body>Definition 
12============ 
13Role given to a represented variable in the context of a dimensional data structure to identify the universes associated with data points. The variable acts as a field in the compound identifier (the key structure) to disambiguate the cells in the multi-dimensional "cube".  
14
15Explanatory notes 
16=================== 
17The categories from each dimension often are used in combination to identify a cell. The meaning of the combination of the categories supplies meaning to the cell.</body>
18   </ownedComment>
19   <name>DimensionComponent</name>
20   <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent-generalization"
21                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DimensionComponent-generalization"
22                   xmi:type="uml:Generalization">
23      <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DataStructureComponent"/>
24   </generalization>
25   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent-categoricalAdditivity"
26                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DimensionComponent-categoricalAdditivity"
27                   xmi:type="uml:Property">
28      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent-categoricalAdditivity-ownedComment"
29                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DimensionComponent-categoricalAdditivity-ownedComment"
30                    xmi:type="uml:Comment">
31         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent-categoricalAdditivity"/>
32         <body>Indicates whether categories at a specific level can be combined to provide the value for their shared parent category. Value is True if categories can be added together (collapsed) to create higher-level categories.  
33
34An example would be age categories. Five-year age categories can be collapsed into 10-year age categories.</body>
35      </ownedComment>
36      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent-categoricalAdditivity-lowerValue"
37                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DimensionComponent-categoricalAdditivity-lowerValue"
38                  xmi:type="uml:LiteralInteger"/>
39      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent-categoricalAdditivity-upperValue"
40                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DimensionComponent-categoricalAdditivity-upperValue"
41                  xmi:type="uml:LiteralUnlimitedNatural">
42         <value>1</value>
43      </upperValue>
44      <name>categoricalAdditivity</name>
45      <type href="http://www.eclipse.org/uml2/5.0.0/UML/PrimitiveTypes.xmi#Boolean"
46            xmi:type="uml:PrimitiveType"/>
47   </ownedAttribute>
48   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent-ownedAttribute"
49                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DimensionComponent-ownedAttribute"
50                   xmi:type="uml:Property">
51      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent-ownedAttribute-lowerValue"
52                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DimensionComponent-ownedAttribute-lowerValue"
53                  xmi:type="uml:LiteralInteger"/>
54      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent-ownedAttribute-upperValue"
55                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#DimensionComponent-ownedAttribute-upperValue"
56                  xmi:type="uml:LiteralUnlimitedNatural">
57         <value>1</value>
58      </upperValue>
59      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Components-DimensionComponent_isStructuredBy_ValueDomain"/>
60      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-ValueDomain"/>
61   </ownedAttribute>
62</packagedElement>

Fragment for the class DimensionComponent (entire XML Schema)

 1<xs:element name="DimensionComponent"
 2            type="DimensionComponentXsdType"
 3            xml:id="DimensionComponent">
 4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::DimensionComponent -->
 5  <xs:annotation>
 6    <xs:documentation>Definition 
 7          ============ 
 8          Role given to a represented variable in the context of a dimensional data structure to identify the universes associated with data points. The variable acts as a field in the compound identifier (the key structure) to disambiguate the cells in the multi-dimensional "cube".  
 9          
10          Explanatory notes 
11          =================== 
12          The categories from each dimension often are used in combination to identify a cell. The meaning of the combination of the categories supplies meaning to the cell.</xs:documentation>
13  </xs:annotation>
14</xs:element>
15<xs:complexType name="DimensionComponentXsdType"
16                xml:id="DimensionComponentXsdType">
17  <xs:annotation>
18    <xs:documentation>Definition 
19          ============ 
20          Role given to a represented variable in the context of a dimensional data structure to identify the universes associated with data points. The variable acts as a field in the compound identifier (the key structure) to disambiguate the cells in the multi-dimensional "cube".  
21          
22          Explanatory notes 
23          =================== 
24          The categories from each dimension often are used in combination to identify a cell. The meaning of the combination of the categories supplies meaning to the cell.</xs:documentation>
25  </xs:annotation>
26  <xs:complexContent>
27    <xs:extension base="DataStructureComponentXsdType">
28      <xs:sequence>
29        <xs:element name="categoricalAdditivity"
30                    type="xs:boolean"
31                    minOccurs="0"
32                    maxOccurs="1"
33                    xml:id="DimensionComponent-categoricalAdditivity">
34          <xs:annotation>
35            <xs:documentation>Indicates whether categories at a specific level can be combined to provide the value for their shared parent category. Value is True if categories can be added together (collapsed) to create higher-level categories.  
36      
37      An example would be age categories. Five-year age categories can be collapsed into 10-year age categories.</xs:documentation>
38          </xs:annotation>
39        </xs:element>
40        <xs:element name="DimensionComponent_isStructuredBy_ValueDomain"
41                    minOccurs="0"
42                    maxOccurs="1"
43                    xml:id="DimensionComponent_isStructuredBy_ValueDomain">
44          <xs:annotation>
45            <xs:documentation></xs:documentation>
46          </xs:annotation>
47          <xs:complexType>
48            <xs:complexContent>
49              <xs:restriction base="AssociationReferenceXsdType">
50                <xs:sequence>
51                  <xs:element name="ddiReference"
52                              type="InternationalRegistrationDataIdentifierXsdType"
53                              minOccurs="0"
54                              maxOccurs="1"
55                              xml:id="DimensionComponent_isStructuredBy_ValueDomain-ddiReference"/>
56                  <xs:element name="validType"
57                              minOccurs="0"
58                              maxOccurs="unbounded"
59                              xml:id="DimensionComponent_isStructuredBy_ValueDomain-validType">
60                    <xs:simpleType>
61                      <xs:restriction base="xs:NMTOKEN">
62                        <xs:enumeration value="DescriptorValueDomain"/>
63                        <xs:enumeration value="ReferenceValueDomain"/>
64                        <xs:enumeration value="SentinelValueDomain"/>
65                        <xs:enumeration value="SubstantiveValueDomain"/>
66                        <xs:enumeration value="ValueDomain"/>
67                      </xs:restriction>
68                    </xs:simpleType>
69                  </xs:element>
70                </xs:sequence>
71              </xs:restriction>
72            </xs:complexContent>
73          </xs:complexType>
74        </xs:element>
75      </xs:sequence>
76    </xs:extension>
77  </xs:complexContent>
78</xs:complexType>

Fragment for the class DimensionComponent (main ontology)

 1# class DimensionComponent
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::DimensionComponent
 3cdi:DimensionComponent
 4  a rdfs:Class, owl:Class, ucmis:Class;
 5  rdfs:label "DimensionComponent";
 6  rdfs:comment "Definition \n============ \nRole given to a represented variable in the context of a dimensional data structure to identify the universes associated with data points. The variable acts as a field in the compound identifier (the key structure) to disambiguate the cells in the multi-dimensional \"cube\".  \n\nExplanatory notes \n=================== \nThe categories from each dimension often are used in combination to identify a cell. The meaning of the combination of the categories supplies meaning to the cell."@en;
 7  rdfs:subClassOf cdi:DataStructureComponent;
 8.
 9
10cdi:DimensionComponent-categoricalAdditivity
11  a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
12  rdfs:label "categoricalAdditivity";
13  rdfs:comment "Indicates whether categories at a specific level can be combined to provide the value for their shared parent category. Value is True if categories can be added together (collapsed) to create higher-level categories.  \n\nAn example would be age categories. Five-year age categories can be collapsed into 10-year age categories."@en;
14  rdfs:domain cdi:DimensionComponent;
15  rdfs:range xsd:boolean;
16.
17
18
19cdi:DimensionComponent_isStructuredBy_ValueDomain
20  a rdf:Property, owl:ObjectProperty, ucmis:Association;
21  # ASSOCIATION
22  rdfs:label "isStructuredBy";
23  skos:altLabel "DimensionComponent_isStructuredBy_ValueDomain";
24  
25  rdfs:domain cdi:DimensionComponent;
26  rdfs:range cdi:ValueDomain;
27.

Fragment for the class DimensionComponent (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      "DimensionComponent": "cdi:DimensionComponent",
 8      "categoricalAdditivity": {
 9        "@id": "cdi:DimensionComponent-categoricalAdditivity",
10        "@type": "xsd:boolean"
11      },
12      
13      "isStructuredBy": {
14        "@id": "cdi:DimensionComponent_isStructuredBy_ValueDomain",
15        "@type": "@id"      },
16      "has_OF_DimensionGroup": {
17        "@reverse": "cdi:DimensionGroup_has_DimensionComponent",
18        "@type": "@id"
19      },
20      " comment ": "tag:json-should-support-trailing-commas" 
21    }
22  ],
23  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-09-23 21:52:56.",
24  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Components::DimensionComponent"
25}