KeyValueStructure

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

Definition

Structure of a key-value datastore (organized collection of key-value data). It is described by identifier, contextual, synthetic id, dimension, variable descriptor and variable value components.

Examples

The structure described by [Income distribution, Unit id, Period, Income] where Income distribution is the contextual component, Unit id identifies a statistical unit, period is a effective period and Income is the variable of interest.

Diagram

Inheritance
    ᐊ── KeyValue::KeyValueStructure
Attributes

Name

Inherited from

Description

Data Type

Multiplicity

Default value

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 KeyValueStructure

Package of Other Class

Other Class

Multiplicity of other class

Aggregation Kind

Inherited from

to

DataSet isStructuredBy DataStructure

0..*

DataDescription

DataSet

0..*

none

DataDescription::DataStructure

from

DataStructure has ComponentPosition

1..1

Components

ComponentPosition

0..*

composite

DataDescription::DataStructure

from

DataStructure has DataStructureComponent

0..1

Components

DataStructureComponent

0..*

composite

DataDescription::DataStructure

from

DataStructure has ForeignKey

1..1

Components

ForeignKey

0..*

composite

DataDescription::DataStructure

from

DataStructure has PrimaryKey

1..1

Components

PrimaryKey

0..1

composite

DataDescription::DataStructure

to

PhysicalDataSetStructure correspondsTo DataStructure

0..1

FormatDescription

PhysicalDataSetStructure

0..*

none

DataDescription::DataStructure

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..*

Components

AttributeComponent

0..*

none

Components::DataStructureComponent

to

ComponentPosition indexes DataStructureComponent

0..1

Components

ComponentPosition

0..*

none

Components::DataStructureComponent

to

ForeignKeyComponent correspondsTo DataStructureComponent

1..1

Components

ForeignKeyComponent

0..1

none

Components::DataStructureComponent

to

PrimaryKeyComponent correspondsTo DataStructureComponent

1..1

Components

PrimaryKeyComponent

0..1

none

Components::DataStructureComponent

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 KeyValueStructure (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-KeyValueStructure"
 5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyValueStructure"
 6                 xmi:type="uml:Class">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-KeyValueStructure-ownedComment"
 8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyValueStructure-ownedComment"
 9                 xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-KeyValueStructure"/>
11      <body>Definition
12============
13Structure of a key-value datastore (organized collection of key-value data). It is described by identifier, contextual, synthetic id, dimension, variable descriptor and variable value components.
14
15Examples
16==========
17The structure described by [Income distribution, Unit id, Period, Income] where Income distribution is the contextual component, Unit id identifies a statistical unit, period is a effective period and Income is the variable of interest.</body>
18   </ownedComment>
19   <name>KeyValueStructure</name>
20   <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-KeyValue-KeyValueStructure-generalization"
21                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#KeyValueStructure-generalization"
22                   xmi:type="uml:Generalization">
23      <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-DataStructure"/>
24   </generalization>
25</packagedElement>

Fragment for the class KeyValueStructure (entire XML Schema)

 1<xs:element name="KeyValueStructure"
 2            type="KeyValueStructureXsdType"
 3            xml:id="KeyValueStructure">
 4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::KeyValueStructure -->
 5  <xs:annotation>
 6    <xs:documentation>Definition
 7          ============
 8          Structure of a key-value datastore (organized collection of key-value data). It is described by identifier, contextual, synthetic id, dimension, variable descriptor and variable value components.
 9          
10          Examples
11          ==========
12          The structure described by [Income distribution, Unit id, Period, Income] where Income distribution is the contextual component, Unit id identifies a statistical unit, period is a effective period and Income is the variable of interest.</xs:documentation>
13  </xs:annotation>
14</xs:element>
15<xs:complexType name="KeyValueStructureXsdType"
16                xml:id="KeyValueStructureXsdType">
17  <xs:annotation>
18    <xs:documentation>Definition
19          ============
20          Structure of a key-value datastore (organized collection of key-value data). It is described by identifier, contextual, synthetic id, dimension, variable descriptor and variable value components.
21          
22          Examples
23          ==========
24          The structure described by [Income distribution, Unit id, Period, Income] where Income distribution is the contextual component, Unit id identifies a statistical unit, period is a effective period and Income is the variable of interest.</xs:documentation>
25  </xs:annotation>
26  <xs:complexContent>
27    <xs:extension base="DataStructureXsdType">
28      
29    </xs:extension>
30  </xs:complexContent>
31</xs:complexType>

Fragment for the class KeyValueStructure (main ontology)

1# class KeyValueStructure
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::KeyValueStructure
3cdi:KeyValueStructure
4  a rdfs:Class, owl:Class, ucmis:Class;
5  rdfs:label "KeyValueStructure";
6  rdfs:comment "Definition\n============\nStructure of a key-value datastore (organized collection of key-value data). It is described by identifier, contextual, synthetic id, dimension, variable descriptor and variable value components.\n\nExamples\n==========\nThe structure described by [Income distribution, Unit id, Period, Income] where Income distribution is the contextual component, Unit id identifies a statistical unit, period is a effective period and Income is the variable of interest."@en;
7  rdfs:subClassOf cdi:DataStructure;
8.

Fragment for the class KeyValueStructure (main JSON-LD)

 1{
 2  "@context": [
 3    "DataStructure.jsonld",
 4    {
 5      "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
 6      "xsd": "http://www.w3.org/2001/XMLSchema#",
 7      "KeyValueStructure": "cdi:KeyValueStructure",
 8      
 9      " comment ": "tag:json-should-support-trailing-commas" 
10    }
11  ],
12  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-09-23 21:52:57.",
13  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::KeyValue::KeyValueStructure"
14}