ClassificationIndexEntry

Fully qualified class name: DDICDIModels::DDICDILibrary::Classes::Representations::ClassificationIndexEntry

Definition

Word or a short phrase corresponding to a classification item in a statistical classification, together with the code of the corresponding classification item.

Examples

The name of a locality, an economic activity, or an occupational title with the associated code from a corresponding classification item.

Explanatory notes

Each Classification Index Entry (CIE) typically corresponds to one item of a Statistical Classification (SC). Although a CIE may be associated with a Classification Item (CI) at any Level of a SC, CIEs are normally associated with items at the lowest Level. A CIE corresponds to a CI if the CI classifies the CIE with respect to the SC of which the CI is a member. CIEs typically come from responses to survey questions or are verbatim descriptions in administrative records.

Diagram

Attributes

Name

Inherited from

Description

Data Type

Multiplicity

Default value

catalogDetails

- own class -

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

codingInstruction

- own class -

Additional information which drives the coding process for the Index Entry. Required when coding is dependent upon one or many other factors.

CommandCode

0..1

entry

- own class -

Text describing the type of object/unit or object property.

InternationalString

0..1

identifier

- own class -

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

Identifier

0..1

validDates

- own class -

The dates describing the validity period of the object. The date from which the object became valid must be defined if the map belongs to a “floating” construct. The date at which the object became invalid must be defined if the map belongs to a “floating” construct and is no longer valid.

DateRange

0..1

Associations

Direction

Association

Description

Multiplicity of ClassificationIndexEntry

Package of Other Class

Other Class

Multiplicity of other class

Aggregation Kind

Inherited from

to

ClassificationIndex has ClassificationIndexEntry

0..*

- own package -

ClassificationIndex

0..*

none

- own class -

to

ClassificationIndexEntryPosition indexes ClassificationIndexEntry

Restricts member target class to classification index entry.

1..1

- own package -

ClassificationIndexEntryPosition

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 ClassificationIndexEntry (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-Representations-ClassificationIndexEntry"
  5                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry"
  6                 xmi:type="uml:Class">
  7   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-ownedComment"
  8                 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-ownedComment"
  9                 xmi:type="uml:Comment">
 10      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry"/>
 11      <body>Definition
 12============
 13Word or a short phrase corresponding to a classification item in a statistical classification, together with the code of the corresponding classification item.
 14
 15Examples
 16==========
 17The name of a locality, an economic activity, or an occupational title with the associated code from a corresponding classification item.
 18
 19Explanatory notes
 20===================
 21Each Classification Index Entry (CIE) typically corresponds to one item of a Statistical Classification (SC). Although a CIE may be associated with a Classification Item (CI) at any Level of a SC, CIEs are normally associated with items at the lowest Level.
 22A CIE corresponds to a CI if the CI classifies the CIE with respect to the SC of which the CI is a member.
 23CIEs typically come from responses to survey questions or are verbatim descriptions in administrative records.</body>
 24   </ownedComment>
 25   <name>ClassificationIndexEntry</name>
 26   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-catalogDetails"
 27                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-catalogDetails"
 28                   xmi:type="uml:Property">
 29      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-catalogDetails-ownedComment"
 30                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-catalogDetails-ownedComment"
 31                    xmi:type="uml:Comment">
 32         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-catalogDetails"/>
 33         <body>Bundles the information useful for a data catalog entry. 
 34
 35Examples would be creator, contributor, title, copyright, embargo, and license information
 36
 37A set of information useful for attribution, data discovery, and access.
 38This is information that is tied to the identity of the object. If this information changes the version of the associated object changes.</body>
 39      </ownedComment>
 40      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-catalogDetails-lowerValue"
 41                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-catalogDetails-lowerValue"
 42                  xmi:type="uml:LiteralInteger"/>
 43      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-catalogDetails-upperValue"
 44                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-catalogDetails-upperValue"
 45                  xmi:type="uml:LiteralUnlimitedNatural">
 46         <value>1</value>
 47      </upperValue>
 48      <name>catalogDetails</name>
 49      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CatalogDetails"/>
 50   </ownedAttribute>
 51   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-codingInstruction"
 52                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-codingInstruction"
 53                   xmi:type="uml:Property">
 54      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-codingInstruction-ownedComment"
 55                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-codingInstruction-ownedComment"
 56                    xmi:type="uml:Comment">
 57         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-codingInstruction"/>
 58         <body>Additional information which drives the coding process for the Index Entry. Required when coding is dependent upon one or many other factors.</body>
 59      </ownedComment>
 60      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-codingInstruction-lowerValue"
 61                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-codingInstruction-lowerValue"
 62                  xmi:type="uml:LiteralInteger"/>
 63      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-codingInstruction-upperValue"
 64                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-codingInstruction-upperValue"
 65                  xmi:type="uml:LiteralUnlimitedNatural">
 66         <value>1</value>
 67      </upperValue>
 68      <name>codingInstruction</name>
 69      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-CommandCode"/>
 70   </ownedAttribute>
 71   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-entry"
 72                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-entry"
 73                   xmi:type="uml:Property">
 74      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-entry-ownedComment"
 75                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-entry-ownedComment"
 76                    xmi:type="uml:Comment">
 77         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-entry"/>
 78         <body>Text describing the type of object/unit or object property.</body>
 79      </ownedComment>
 80      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-entry-lowerValue"
 81                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-entry-lowerValue"
 82                  xmi:type="uml:LiteralInteger"/>
 83      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-entry-upperValue"
 84                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-entry-upperValue"
 85                  xmi:type="uml:LiteralUnlimitedNatural">
 86         <value>1</value>
 87      </upperValue>
 88      <name>entry</name>
 89      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-InternationalString"/>
 90   </ownedAttribute>
 91   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-identifier"
 92                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-identifier"
 93                   xmi:type="uml:Property">
 94      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-identifier-ownedComment"
 95                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-identifier-ownedComment"
 96                    xmi:type="uml:Comment">
 97         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-identifier"/>
 98         <body>Identifier for objects requiring short- or long-lasting referencing and management.</body>
 99      </ownedComment>
100      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-identifier-lowerValue"
101                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-identifier-lowerValue"
102                  xmi:type="uml:LiteralInteger"/>
103      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-identifier-upperValue"
104                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-identifier-upperValue"
105                  xmi:type="uml:LiteralUnlimitedNatural">
106         <value>1</value>
107      </upperValue>
108      <name>identifier</name>
109      <isID>true</isID>
110      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Identifier"/>
111   </ownedAttribute>
112   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-validDates"
113                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-validDates"
114                   xmi:type="uml:Property">
115      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-validDates-ownedComment"
116                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-validDates-ownedComment"
117                    xmi:type="uml:Comment">
118         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-validDates"/>
119         <body>The dates describing the validity period of the object. The date from which the object became valid must be defined if the map belongs to a "floating" construct. The date at which the object became invalid must be defined if the map belongs to a "floating" construct and is no longer valid.</body>
120      </ownedComment>
121      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-validDates-lowerValue"
122                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-validDates-lowerValue"
123                  xmi:type="uml:LiteralInteger"/>
124      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-Representations-ClassificationIndexEntry-validDates-upperValue"
125                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#ClassificationIndexEntry-validDates-upperValue"
126                  xmi:type="uml:LiteralUnlimitedNatural">
127         <value>1</value>
128      </upperValue>
129      <name>validDates</name>
130      <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-DateRange"/>
131   </ownedAttribute>
132</packagedElement>

Fragment for the class ClassificationIndexEntry (entire XML Schema)

 1<xs:element name="ClassificationIndexEntry"
 2            type="ClassificationIndexEntryXsdType"
 3            xml:id="ClassificationIndexEntry">
 4  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::Representations::ClassificationIndexEntry -->
 5  <xs:annotation>
 6    <xs:documentation>Definition
 7          ============
 8          Word or a short phrase corresponding to a classification item in a statistical classification, together with the code of the corresponding classification item.
 9          
10          Examples
11          ==========
12          The name of a locality, an economic activity, or an occupational title with the associated code from a corresponding classification item.
13          
14          Explanatory notes
15          ===================
16          Each Classification Index Entry (CIE) typically corresponds to one item of a Statistical Classification (SC). Although a CIE may be associated with a Classification Item (CI) at any Level of a SC, CIEs are normally associated with items at the lowest Level.
17          A CIE corresponds to a CI if the CI classifies the CIE with respect to the SC of which the CI is a member.
18          CIEs typically come from responses to survey questions or are verbatim descriptions in administrative records.</xs:documentation>
19  </xs:annotation>
20</xs:element>
21<xs:complexType name="ClassificationIndexEntryXsdType"
22                xml:id="ClassificationIndexEntryXsdType">
23  <xs:annotation>
24    <xs:documentation>Definition
25          ============
26          Word or a short phrase corresponding to a classification item in a statistical classification, together with the code of the corresponding classification item.
27          
28          Examples
29          ==========
30          The name of a locality, an economic activity, or an occupational title with the associated code from a corresponding classification item.
31          
32          Explanatory notes
33          ===================
34          Each Classification Index Entry (CIE) typically corresponds to one item of a Statistical Classification (SC). Although a CIE may be associated with a Classification Item (CI) at any Level of a SC, CIEs are normally associated with items at the lowest Level.
35          A CIE corresponds to a CI if the CI classifies the CIE with respect to the SC of which the CI is a member.
36          CIEs typically come from responses to survey questions or are verbatim descriptions in administrative records.</xs:documentation>
37  </xs:annotation>
38  <xs:sequence>
39    <xs:element name="catalogDetails"
40                type="CatalogDetailsXsdType"
41                minOccurs="0"
42                maxOccurs="1"
43                xml:id="ClassificationIndexEntry-catalogDetails">
44      <xs:annotation>
45        <xs:documentation>Bundles the information useful for a data catalog entry. 
46  
47  Examples would be creator, contributor, title, copyright, embargo, and license information
48  
49  A set of information useful for attribution, data discovery, and access.
50  This is information that is tied to the identity of the object. If this information changes the version of the associated object changes.</xs:documentation>
51      </xs:annotation>
52    </xs:element>
53    <xs:element name="codingInstruction"
54                type="CommandCodeXsdType"
55                minOccurs="0"
56                maxOccurs="1"
57                xml:id="ClassificationIndexEntry-codingInstruction">
58      <xs:annotation>
59        <xs:documentation>Additional information which drives the coding process for the Index Entry. Required when coding is dependent upon one or many other factors.</xs:documentation>
60      </xs:annotation>
61    </xs:element>
62    <xs:element name="entry"
63                type="InternationalStringXsdType"
64                minOccurs="0"
65                maxOccurs="1"
66                xml:id="ClassificationIndexEntry-entry">
67      <xs:annotation>
68        <xs:documentation>Text describing the type of object/unit or object property.</xs:documentation>
69      </xs:annotation>
70    </xs:element>
71    <xs:element name="identifier"
72                type="IdentifierXsdType"
73                minOccurs="0"
74                maxOccurs="1"
75                xml:id="ClassificationIndexEntry-identifier">
76      <xs:annotation>
77        <xs:documentation>Identifier for objects requiring short- or long-lasting referencing and management.</xs:documentation>
78      </xs:annotation>
79    </xs:element>
80    <xs:element name="validDates"
81                type="DateRangeXsdType"
82                minOccurs="0"
83                maxOccurs="1"
84                xml:id="ClassificationIndexEntry-validDates">
85      <xs:annotation>
86        <xs:documentation>The dates describing the validity period of the object. The date from which the object became valid must be defined if the map belongs to a "floating" construct. The date at which the object became invalid must be defined if the map belongs to a "floating" construct and is no longer valid.</xs:documentation>
87      </xs:annotation>
88    </xs:element>
89  </xs:sequence>
90</xs:complexType>

Fragment for the class ClassificationIndexEntry (main ontology)

 1# class ClassificationIndexEntry
 2# based on the UML class DDICDIModels::DDICDILibrary::Classes::Representations::ClassificationIndexEntry
 3cdi:ClassificationIndexEntry
 4  a rdfs:Class, owl:Class, ucmis:Class;
 5  rdfs:label "ClassificationIndexEntry";
 6  rdfs:comment "Definition\n============\nWord or a short phrase corresponding to a classification item in a statistical classification, together with the code of the corresponding classification item.\n\nExamples\n==========\nThe name of a locality, an economic activity, or an occupational title with the associated code from a corresponding classification item.\n\nExplanatory notes\n===================\nEach Classification Index Entry (CIE) typically corresponds to one item of a Statistical Classification (SC). Although a CIE may be associated with a Classification Item (CI) at any Level of a SC, CIEs are normally associated with items at the lowest Level.\nA CIE corresponds to a CI if the CI classifies the CIE with respect to the SC of which the CI is a member.\nCIEs typically come from responses to survey questions or are verbatim descriptions in administrative records."@en;
 7  
 8.
 9
10cdi:ClassificationIndexEntry-catalogDetails
11  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
12  rdfs:label "catalogDetails";
13  rdfs:comment "Bundles the information useful for a data catalog entry. \n\nExamples would be creator, contributor, title, copyright, embargo, and license information\n\nA set of information useful for attribution, data discovery, and access.\nThis is information that is tied to the identity of the object. If this information changes the version of the associated object changes."@en;
14  rdfs:domain cdi:ClassificationIndexEntry;
15  rdfs:range cdi:CatalogDetails;
16.
17
18cdi:ClassificationIndexEntry-codingInstruction
19  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
20  rdfs:label "codingInstruction";
21  rdfs:comment "Additional information which drives the coding process for the Index Entry. Required when coding is dependent upon one or many other factors."@en;
22  rdfs:domain cdi:ClassificationIndexEntry;
23  rdfs:range cdi:CommandCode;
24.
25
26cdi:ClassificationIndexEntry-entry
27  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
28  rdfs:label "entry";
29  rdfs:comment "Text describing the type of object/unit or object property."@en;
30  rdfs:domain cdi:ClassificationIndexEntry;
31  rdfs:range cdi:InternationalString;
32.
33
34cdi:ClassificationIndexEntry-identifier
35  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
36  rdfs:label "identifier";
37  rdfs:comment "Identifier for objects requiring short- or long-lasting referencing and management."@en;
38  rdfs:domain cdi:ClassificationIndexEntry;
39  rdfs:range cdi:Identifier;
40.
41
42cdi:ClassificationIndexEntry-validDates
43  a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
44  rdfs:label "validDates";
45  rdfs:comment "The dates describing the validity period of the object. The date from which the object became valid must be defined if the map belongs to a \"floating\" construct. The date at which the object became invalid must be defined if the map belongs to a \"floating\" construct and is no longer valid."@en;
46  rdfs:domain cdi:ClassificationIndexEntry;
47  rdfs:range cdi:DateRange;
48.

Fragment for the class ClassificationIndexEntry (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      "ClassificationIndexEntry": "cdi:ClassificationIndexEntry",
 7      "catalogDetails": {
 8        "@id": "cdi:ClassificationIndexEntry-catalogDetails",
 9        "@type": "@id",
10        "@context": "CatalogDetails.jsonld"
11      },
12      "codingInstruction": {
13        "@id": "cdi:ClassificationIndexEntry-codingInstruction",
14        "@type": "@id",
15        "@context": "CommandCode.jsonld"
16      },
17      "entry": {
18        "@id": "cdi:ClassificationIndexEntry-entry",
19        "@type": "@id",
20        "@context": "InternationalString.jsonld"
21      },
22      "identifier": {
23        "@id": "cdi:ClassificationIndexEntry-identifier",
24        "@type": "@id",
25        "@context": "Identifier.jsonld"
26      },
27      "validDates": {
28        "@id": "cdi:ClassificationIndexEntry-validDates",
29        "@type": "@id",
30        "@context": "DateRange.jsonld"
31      },
32      
33      "has_OF_ClassificationIndex": {
34        "@reverse": "cdi:ClassificationIndex_has_ClassificationIndexEntry",
35        "@type": "@id"
36      },
37      "indexes_OF_ClassificationIndexEntryPosition": {
38        "@reverse": "cdi:ClassificationIndexEntryPosition_indexes_ClassificationIndexEntry",
39        "@type": "@id"
40      },
41      " comment ": "tag:json-should-support-trailing-commas" 
42    }
43  ],
44  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2024-03-16 23:40:11.",
45  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::Representations::ClassificationIndexEntry"
46}