CategorySet

Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::Conceptual::CategorySet

Definition

Concept system where the underlying concepts are categories.

Examples

“Male” and “Female” categories in a category set named “Gender”.

Explanatory notes

The categories in a category set help define the meaning of the category set. Gender can be defined as “male or female” - see example above. A category set can be used directly by questions to express a set of response choices.

Diagram

Inheritance
  ᐊ── Conceptual::CategorySet
Attributes

Name

Inherited from

Description

Data Type

Multiplicity

Default value

allowsDuplicates

Conceptual::ConceptSystem

If value is False, the members are unique within the collection - if True, there may be duplicates. (Note that a mathematical “bag” permits duplicates and is unordered - a “set” does not have duplicates and may be ordered.)

Boolean

1..1

catalogDetails

Conceptual::ConceptSystem

Bundles the information useful for a data catalog entry. Examples would be creator, contributor, title, copyright, embargo, and license information. A set of information useful for attribution, data discovery, and access. This is information that is tied to the identity of the object. If this information changes the version of the associated object changes.

CatalogDetails

0..1

externalDefinition

Conceptual::ConceptSystem

A reference to an external definition of a concept (that is, a concept which is described outside the content of the DDI-CDI metadata description). An example is a SKOS concept. The definition property is assumed to duplicate the external one referenced if externalDefinition is used. Other corresponding properties are assumed to be included unchanged if used.

Reference

0..1

identifier

Conceptual::ConceptSystem

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

Identifier

0..1

name

Conceptual::ConceptSystem

Human understandable name (liguistic signifier, word, phrase, or mnemonic). May follow ISO/IEC 11179-5 naming principles, and have context provided to specify usage.

ObjectName

0..*

purpose

Conceptual::ConceptSystem

Intent or reason for the object/the description of the object.

InternationalString

0..1

Associations

Direction

Association

Description

Multiplicity of CategorySet

Package of Other Class

Other Class

Multiplicity of other class

Aggregation Kind

Inherited from

to

ConceptStructure structures ConceptSystem

Concept structure structures concept system.

0..1

- own package -

ConceptStructure

0..*

none

Conceptual::ConceptSystem

from

ConceptSystem has Concept

Concept system has zero to many concepts.

0..*

- own package -

Concept

0..*

shared

Conceptual::ConceptSystem

from

ConceptSystem isDefinedBy Concept

Concept system is defined by zero to many concepts. The conceptual basis for the collection of members.

0..*

- own package -

Concept

0..*

none

Conceptual::ConceptSystem

to

ConceptSystemCorrespondence maps ConceptSystem

Concept system correspondence maps two to many concept systems. Realization of structures in symmetric relation. When concepts of a single concept system are mapped, the Concept has to appear twice as target.

2..*

- own package -

ConceptSystemCorrespondence

0..*

none

Conceptual::ConceptSystem

to

ConceptualDomain takesConceptsFrom ConceptSystem

Conceptual domain takes concept from zero to one concept system.

0..1

- own package -

ConceptualDomain

0..*

none

Conceptual::ConceptSystem

to

CategoryRelationStructure structures CategorySet

0..1

- own package -

CategoryRelationStructure

0..*

none

- own class -

from

CategorySet has Category

0..*

- own package -

Category

0..*

shared

- own class -

from

CategorySet has CategoryPosition

1..1

- own package -

CategoryPosition

0..*

composite

- own class -

to

EnumerationDomain references CategorySet

Category set associated with the enumeration.

0..1

Representations

EnumerationDomain

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 CategorySet (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-Conceptual-CategorySet"
 5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CategorySet"
 6                 xmi:type="uml:Class">
 7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategorySet-ownedComment"
 8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CategorySet-ownedComment"
 9                 xmi:type="uml:Comment">
10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategorySet"/>
11      <body>Definition
12============
13Concept system where the underlying concepts are categories.
14
15Examples
16==========
17"Male" and "Female" categories in a category set named "Gender".
18
19Explanatory notes
20===================
21The categories in a category set help define the meaning of the category set. Gender can be defined as "male or female" - see example above. A category set can be used directly by questions to express a set of response choices.</body>
22   </ownedComment>
23   <name>CategorySet</name>
24   <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategorySet-generalization"
25                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CategorySet-generalization"
26                   xmi:type="uml:Generalization">
27      <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-ConceptSystem"/>
28   </generalization>
29   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategorySet-ownedAttribute_1"
30                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CategorySet-ownedAttribute_1"
31                   xmi:type="uml:Property">
32      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategorySet-ownedAttribute_1-lowerValue"
33                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CategorySet-ownedAttribute_1-lowerValue"
34                  xmi:type="uml:LiteralInteger"/>
35      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategorySet-ownedAttribute_1-upperValue"
36                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CategorySet-ownedAttribute_1-upperValue"
37                  xmi:type="uml:LiteralUnlimitedNatural">
38         <value>*</value>
39      </upperValue>
40      <aggregation>shared</aggregation>
41      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategorySet_has_Category"/>
42      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-Category"/>
43   </ownedAttribute>
44   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategorySet-ownedAttribute_2"
45                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CategorySet-ownedAttribute_2"
46                   xmi:type="uml:Property">
47      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategorySet-ownedAttribute_2-lowerValue"
48                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CategorySet-ownedAttribute_2-lowerValue"
49                  xmi:type="uml:LiteralInteger"/>
50      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategorySet-ownedAttribute_2-upperValue"
51                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#CategorySet-ownedAttribute_2-upperValue"
52                  xmi:type="uml:LiteralUnlimitedNatural">
53         <value>*</value>
54      </upperValue>
55      <aggregation>composite</aggregation>
56      <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategorySet_has_CategoryPosition"/>
57      <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-CategoryPosition"/>
58   </ownedAttribute>
59</packagedElement>

Fragment for the class CategorySet (entire XML Schema)

  1<xs:element name="CategorySet"
  2            type="CategorySetXsdType"
  3            xml:id="CategorySet">
  4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::Conceptual::CategorySet -->
  5  <xs:annotation>
  6    <xs:documentation>Definition
  7          ============
  8          Concept system where the underlying concepts are categories.
  9          
 10          Examples
 11          ==========
 12          "Male" and "Female" categories in a category set named "Gender".
 13          
 14          Explanatory notes
 15          ===================
 16          The categories in a category set help define the meaning of the category set. Gender can be defined as "male or female" - see example above. A category set can be used directly by questions to express a set of response choices.</xs:documentation>
 17  </xs:annotation>
 18</xs:element>
 19<xs:complexType name="CategorySetXsdType"
 20                xml:id="CategorySetXsdType">
 21  <xs:annotation>
 22    <xs:documentation>Definition
 23          ============
 24          Concept system where the underlying concepts are categories.
 25          
 26          Examples
 27          ==========
 28          "Male" and "Female" categories in a category set named "Gender".
 29          
 30          Explanatory notes
 31          ===================
 32          The categories in a category set help define the meaning of the category set. Gender can be defined as "male or female" - see example above. A category set can be used directly by questions to express a set of response choices.</xs:documentation>
 33  </xs:annotation>
 34  <xs:complexContent>
 35    <xs:extension base="ConceptSystemXsdType">
 36      <xs:sequence>
 37        <xs:element name="CategorySet_has_Category"
 38                    minOccurs="0"
 39                    maxOccurs="unbounded"
 40                    xml:id="CategorySet_has_Category">
 41          <xs:annotation>
 42            <xs:documentation></xs:documentation>
 43          </xs:annotation>
 44          <xs:complexType>
 45            <xs:complexContent>
 46              <xs:restriction base="AssociationReferenceXsdType">
 47                <xs:sequence>
 48                  <xs:element name="ddiReference"
 49                              type="InternationalRegistrationDataIdentifierXsdType"
 50                              minOccurs="0"
 51                              maxOccurs="1"
 52                              xml:id="CategorySet_has_Category-ddiReference"/>
 53                  <xs:element name="validType"
 54                              minOccurs="0"
 55                              maxOccurs="unbounded"
 56                              xml:id="CategorySet_has_Category-validType">
 57                    <xs:simpleType>
 58                      <xs:restriction base="xs:NMTOKEN">
 59                        <xs:enumeration value="Category"/>
 60                      </xs:restriction>
 61                    </xs:simpleType>
 62                  </xs:element>
 63                </xs:sequence>
 64              </xs:restriction>
 65            </xs:complexContent>
 66          </xs:complexType>
 67        </xs:element>
 68        <xs:element name="CategorySet_has_CategoryPosition"
 69                    minOccurs="0"
 70                    maxOccurs="unbounded"
 71                    xml:id="CategorySet_has_CategoryPosition">
 72          <xs:annotation>
 73            <xs:documentation></xs:documentation>
 74          </xs:annotation>
 75          <xs:complexType>
 76            <xs:complexContent>
 77              <xs:restriction base="AssociationReferenceXsdType">
 78                <xs:sequence>
 79                  <xs:element name="ddiReference"
 80                              type="InternationalRegistrationDataIdentifierXsdType"
 81                              minOccurs="0"
 82                              maxOccurs="1"
 83                              xml:id="CategorySet_has_CategoryPosition-ddiReference"/>
 84                  <xs:element name="validType"
 85                              minOccurs="1"
 86                              maxOccurs="1"
 87                              xml:id="CategorySet_has_CategoryPosition-validType">
 88                    <xs:simpleType>
 89                      <xs:restriction base="xs:NMTOKEN">
 90                        <xs:enumeration value="CategoryPosition"/>
 91                      </xs:restriction>
 92                    </xs:simpleType>
 93                  </xs:element>
 94                </xs:sequence>
 95              </xs:restriction>
 96            </xs:complexContent>
 97          </xs:complexType>
 98        </xs:element>
 99      </xs:sequence>
100    </xs:extension>
101  </xs:complexContent>
102</xs:complexType>

Fragment for the class CategorySet (main ontology)

 1# class CategorySet
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::Conceptual::CategorySet
 3cdi:CategorySet
 4  a rdfs:Class, owl:Class, ucmis:Class;
 5  rdfs:label "CategorySet";
 6  rdfs:comment "Definition\n============\nConcept system where the underlying concepts are categories.\n\nExamples\n==========\n\"Male\" and \"Female\" categories in a category set named \"Gender\".\n\nExplanatory notes\n===================\nThe categories in a category set help define the meaning of the category set. Gender can be defined as \"male or female\" - see example above. A category set can be used directly by questions to express a set of response choices."@en;
 7  rdfs:subClassOf cdi:ConceptSystem;
 8.
 9
10
11cdi:CategorySet_has_Category
12  a rdf:Property, owl:ObjectProperty, ucmis:Association;
13  # ASSOCIATION
14  rdfs:label "has";
15  skos:altLabel "CategorySet_has_Category";
16  
17  rdfs:domain cdi:CategorySet;
18  rdfs:range cdi:Category;
19.
20
21cdi:CategorySet_has_CategoryPosition
22  a rdf:Property, owl:ObjectProperty, ucmis:Association;
23  # ASSOCIATION
24  rdfs:label "has";
25  skos:altLabel "CategorySet_has_CategoryPosition";
26  
27  rdfs:domain cdi:CategorySet;
28  rdfs:range cdi:CategoryPosition;
29.

Fragment for the class CategorySet (main JSON-LD)

 1{
 2  "@context": [
 3    "ConceptSystem.jsonld",
 4    {
 5      "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
 6      "xsd": "http://www.w3.org/2001/XMLSchema#",
 7      "CategorySet": "cdi:CategorySet",
 8      
 9      "has": {
10        "@id": "cdi:CategorySet_has_Category",
11        "@type": "@id"      },
12      "has": {
13        "@id": "cdi:CategorySet_has_CategoryPosition",
14        "@type": "@id"      },
15      "structures_OF_CategoryRelationStructure": {
16        "@reverse": "cdi:CategoryRelationStructure_structures_CategorySet",
17        "@type": "@id"
18      },
19      "references_OF_EnumerationDomain": {
20        "@reverse": "cdi:EnumerationDomain_references_CategorySet",
21        "@type": "@id"
22      },
23      " comment ": "tag:json-should-support-trailing-commas" 
24    }
25  ],
26  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-03-16 23:40:04.",
27  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::Conceptual::CategorySet"
28}