Notation#
Fully qualified class name of the UML model DDI-CDI 1.0: DDICDIModels::DDICDILibrary::Classes::DataDescription::Notation
Definition#
Representation of a category in the context of a code or a classification item, as opposed of the corresponding instance value which would appear when used in a dataset.
Examples#
The number “334” used as a code for the “Computer and electronic product manufacturing” category in the North American Industry Classification System (NAICS).
Diagram#
Diagram
Attributes#
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
content |
- own class - |
The actual content of this value as a string. |
0..1 |
||
identifier |
- own class - |
Identifier for objects requiring short- or long-lasting referencing and management. |
0..1 |
||
whiteSpace |
- own class - |
The usual setting “collapse” states that leading and trailing white space will be removed and multiple adjacent white spaces will be treated as a single white space. When setting to “replace” all occurrences of #x9 (tab), #xA (line feed) and #xD (carriage return) are replaced with #x20 (space) but leading and trailing spaces will be retained. If the existence of any of these white spaces is critical to the understanding of the content, change the value of this attribute to “preserve”. |
0..1 |
Associations#
Associations
Direction |
Association |
Description |
Multiplicity of Notation |
Package of Other Class |
Other Class |
Multiplicity of other class |
Aggregation Kind |
Inherited from |
|---|---|---|---|---|---|---|---|---|
from |
Notation represents Category |
Notation represents zero to many categories. |
1..* |
0..* |
none |
own class |
||
to |
ClassificationItem uses Notation |
Classification item uses a notation. |
1..1 |
0..* |
none |
own class |
||
to |
Code uses Notation |
1..1 |
0..* |
none |
own class |
|||
to |
Datum uses Notation |
0..1 |
- own package - |
0..* |
none |
own class |
Encodings#
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 Notation (entire model as XMI)
1<packagedElement xmlns:StandardProfile="http://www.omg.org/spec/UML/20131001/StandardProfile"
2 xmlns:uml="http://www.omg.org/spec/UML/20131001"
3 xmlns:xmi="http://www.omg.org/spec/XMI/20131001"
4 xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation"
6 xmi:type="uml:Class">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation"/>
11 <body>Definition
12============
13Representation of a category in the context of a code or a classification item, as opposed of the corresponding instance value which would appear when used in a dataset.
14
15Examples
16==========
17The number "334" used as a code for the "Computer and electronic product manufacturing" category in the North American Industry Classification System (NAICS).</body>
18 </ownedComment>
19 <name>Notation</name>
20 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-content"
21 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-content"
22 xmi:type="uml:Property">
23 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-content-ownedComment"
24 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-content-ownedComment"
25 xmi:type="uml:Comment">
26 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-content"/>
27 <body>The actual content of this value as a string.</body>
28 </ownedComment>
29 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-content-lowerValue"
30 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-content-lowerValue"
31 xmi:type="uml:LiteralInteger"/>
32 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-content-upperValue"
33 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-content-upperValue"
34 xmi:type="uml:LiteralUnlimitedNatural">
35 <value>1</value>
36 </upperValue>
37 <name>content</name>
38 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-TypedString"/>
39 </ownedAttribute>
40 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-identifier"
41 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-identifier"
42 xmi:type="uml:Property">
43 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-identifier-ownedComment"
44 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-identifier-ownedComment"
45 xmi:type="uml:Comment">
46 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-identifier"/>
47 <body>Identifier for objects requiring short- or long-lasting referencing and management.</body>
48 </ownedComment>
49 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-identifier-lowerValue"
50 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-identifier-lowerValue"
51 xmi:type="uml:LiteralInteger"/>
52 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-identifier-upperValue"
53 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-identifier-upperValue"
54 xmi:type="uml:LiteralUnlimitedNatural">
55 <value>1</value>
56 </upperValue>
57 <name>identifier</name>
58 <isID>true</isID>
59 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Identifier"/>
60 </ownedAttribute>
61 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-ownedAttribute"
62 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-ownedAttribute"
63 xmi:type="uml:Property">
64 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-ownedAttribute-lowerValue"
65 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-ownedAttribute-lowerValue"
66 xmi:type="uml:LiteralInteger"/>
67 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-ownedAttribute-upperValue"
68 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-ownedAttribute-upperValue"
69 xmi:type="uml:LiteralUnlimitedNatural">
70 <value>*</value>
71 </upperValue>
72 <association xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-Notation_represents_Category"/>
73 <type xmi:idref="DDICDIModels-DDICDILibrary-Classes-Conceptual-Category"/>
74 </ownedAttribute>
75 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-whiteSpace"
76 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-whiteSpace"
77 xmi:type="uml:Property">
78 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-whiteSpace-ownedComment"
79 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-whiteSpace-ownedComment"
80 xmi:type="uml:Comment">
81 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-whiteSpace"/>
82 <body>The usual setting "collapse" states that leading and trailing white space will be removed and multiple adjacent white spaces will be treated as a single white space. When setting to "replace" all occurrences of #x9 (tab), #xA (line feed) and #xD (carriage return) are replaced with #x20 (space) but leading and trailing spaces will be retained. If the existence of any of these white spaces is critical to the understanding of the content, change the value of this attribute to "preserve".</body>
83 </ownedComment>
84 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-whiteSpace-lowerValue"
85 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-whiteSpace-lowerValue"
86 xmi:type="uml:LiteralInteger"/>
87 <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-DataDescription-Notation-whiteSpace-upperValue"
88 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Notation-whiteSpace-upperValue"
89 xmi:type="uml:LiteralUnlimitedNatural">
90 <value>1</value>
91 </upperValue>
92 <name>whiteSpace</name>
93 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-Enumerations-WhiteSpaceRule"/>
94 </ownedAttribute>
95</packagedElement>
Fragment for the class Notation (entire XML Schema)
1<xs:element name="Notation"
2 type="NotationXsdType"
3 xml:id="Notation">
4 <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Notation -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ============
8 Representation of a category in the context of a code or a classification item, as opposed of the corresponding instance value which would appear when used in a dataset.
9
10 Examples
11 ==========
12 The number "334" used as a code for the "Computer and electronic product manufacturing" category in the North American Industry Classification System (NAICS).</xs:documentation>
13 </xs:annotation>
14</xs:element>
15<xs:complexType name="NotationXsdType"
16 xml:id="NotationXsdType">
17 <xs:annotation>
18 <xs:documentation>Definition
19 ============
20 Representation of a category in the context of a code or a classification item, as opposed of the corresponding instance value which would appear when used in a dataset.
21
22 Examples
23 ==========
24 The number "334" used as a code for the "Computer and electronic product manufacturing" category in the North American Industry Classification System (NAICS).</xs:documentation>
25 </xs:annotation>
26 <xs:sequence>
27 <xs:element name="content"
28 type="TypedStringXsdType"
29 minOccurs="0"
30 maxOccurs="1"
31 xml:id="Notation-content">
32 <xs:annotation>
33 <xs:documentation>The actual content of this value as a string.</xs:documentation>
34 </xs:annotation>
35 </xs:element>
36 <xs:element name="identifier"
37 type="IdentifierXsdType"
38 minOccurs="0"
39 maxOccurs="1"
40 xml:id="Notation-identifier">
41 <xs:annotation>
42 <xs:documentation>Identifier for objects requiring short- or long-lasting referencing and management.</xs:documentation>
43 </xs:annotation>
44 </xs:element>
45 <xs:element name="whiteSpace"
46 type="WhiteSpaceRuleXsdType"
47 minOccurs="0"
48 maxOccurs="1"
49 xml:id="Notation-whiteSpace">
50 <xs:annotation>
51 <xs:documentation>The usual setting "collapse" states that leading and trailing white space will be removed and multiple adjacent white spaces will be treated as a single white space. When setting to "replace" all occurrences of #x9 (tab), #xA (line feed) and #xD (carriage return) are replaced with #x20 (space) but leading and trailing spaces will be retained. If the existence of any of these white spaces is critical to the understanding of the content, change the value of this attribute to "preserve".</xs:documentation>
52 </xs:annotation>
53 </xs:element>
54 <xs:element name="Notation_represents_Category"
55 minOccurs="0"
56 maxOccurs="unbounded"
57 xml:id="Notation_represents_Category">
58 <xs:annotation>
59 <xs:documentation>Notation represents zero to many categories.</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="Notation_represents_Category-ddiReference"/>
70 <xs:element name="validType"
71 minOccurs="1"
72 maxOccurs="unbounded"
73 xml:id="Notation_represents_Category-validType">
74 <xs:simpleType>
75 <xs:restriction base="xs:NMTOKEN">
76 <xs:enumeration value="Category"/>
77 </xs:restriction>
78 </xs:simpleType>
79 </xs:element>
80 </xs:sequence>
81 </xs:restriction>
82 </xs:complexContent>
83 </xs:complexType>
84 </xs:element>
85 </xs:sequence>
86</xs:complexType>
Fragment for the class Notation (entire JSON Schema)
1"cls-Notation": {
2 "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/Notation",
3 "type": "object",
4 "properties": {
5 "@context": {
6 "$ref": "#/defs/at-context"
7 },
8 "@id": {
9 "type": "string",
10 "format": "iri-reference"
11 },
12 "@type": {
13 "const": "Notation"
14 },
15 "content": {
16 "$comment": "cardinality 0..1 – from cdi:Notation",
17 "$ref": "#/defs/dt-TypedString"
18 },
19 "identifier": {
20 "$comment": "cardinality 0..1 – from cdi:Notation",
21 "$ref": "#/defs/dt-Identifier"
22 },
23 "whiteSpace": {
24 "$comment": "cardinality 0..1 – from cdi:Notation",
25 "$ref": "#/defs/enum-WhiteSpaceRule"
26 },
27 "represents": {
28 "description": "Notation_represents_Category",
29 "$comment": "cardinality 0..-1",
30 "anyOf": [
31 {
32 "$ref": "#/defs/target-Category"
33 },
34 {
35 "type": "array",
36 "items": {
37 "$ref": "#/defs/target-Category"
38 }
39 }
40 ]
41 },
42 "uses_Notation_OF_ClassificationItem": {
43 "description": "ClassificationItem_uses_Notation",
44 "$comment": "cardinality 0..-1",
45 "anyOf": [
46 {
47 "$ref": "#/defs/target-ClassificationItem"
48 },
49 {
50 "type": "array",
51 "items": {
52 "$ref": "#/defs/target-ClassificationItem"
53 }
54 }
55 ]
56 },
57 "uses_Notation_OF_Code": {
58 "description": "Code_uses_Notation",
59 "$comment": "cardinality 0..-1",
60 "anyOf": [
61 {
62 "$ref": "#/defs/target-Code"
63 },
64 {
65 "type": "array",
66 "items": {
67 "$ref": "#/defs/target-Code"
68 }
69 }
70 ]
71 },
72 "uses_Notation_OF_Datum": {
73 "description": "Datum_uses_Notation",
74 "$comment": "cardinality 0..-1",
75 "anyOf": [
76 {
77 "$ref": "#/defs/target-Datum"
78 },
79 {
80 "type": "array",
81 "items": {
82 "$ref": "#/defs/target-Datum"
83 }
84 }
85 ]
86 },
87 "sameAs": {
88 "$ref": "#/defs/owl:sameAs"
89 }
90 },
91 "required": ["@type"],
92 "additionalProperties": false
93},
94"target-Notation": {
95 "description": "all subclasses of http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/Notation",
96 "anyOf": [
97 { "$ref": "#/defs/cls-Notation" },
98 { "type": "string", "format": "iri-reference" }
99 ]
100},
Fragment for the class Notation (main ontology)
1# class Notation
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Notation
3cdi:Notation
4 a rdfs:Class, owl:Class, ucmis:Class;
5 rdfs:label "Notation";
6 rdfs:comment "Definition \n============ \nRepresentation of a category in the context of a code or a classification item, as opposed of the corresponding instance value which would appear when used in a dataset. \n\nExamples \n========== \nThe number \"334\" used as a code for the \"Computer and electronic product manufacturing\" category in the North American Industry Classification System (NAICS)."@en;
7
8.
9
10cdi:Notation-content
11 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
12 rdfs:label "content";
13 rdfs:comment "The actual content of this value as a string."@en;
14 rdfs:domain cdi:Notation;
15 rdfs:range cdi:TypedString;
16.
17
18cdi:Notation-identifier
19 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
20 rdfs:label "identifier";
21 rdfs:comment "Identifier for objects requiring short- or long-lasting referencing and management."@en;
22 rdfs:domain cdi:Notation;
23 rdfs:range cdi:Identifier;
24.
25
26cdi:Notation-whiteSpace
27 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
28 rdfs:label "whiteSpace";
29 rdfs:comment "The usual setting \"collapse\" states that leading and trailing white space will be removed and multiple adjacent white spaces will be treated as a single white space. When setting to \"replace\" all occurrences of #x9 (tab), #xA (line feed) and #xD (carriage return) are replaced with #x20 (space) but leading and trailing spaces will be retained. If the existence of any of these white spaces is critical to the understanding of the content, change the value of this attribute to \"preserve\"."@en;
30 rdfs:domain cdi:Notation;
31 rdfs:range cdi:WhiteSpaceRule;
32.
33
34
35cdi:Notation_represents_Category
36 a rdf:Property, owl:ObjectProperty, ucmis:Association;
37 # ASSOCIATION
38 rdfs:label "represents";
39 skos:altLabel "Notation_represents_Category";
40 rdfs:comment "Notation represents zero to many categories."@en;
41 rdfs:domain cdi:Notation;
42 rdfs:range cdi:Category;
43.
Fragment for the class Notation (entire 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
7 "content": {
8 "@id": "cdi:Notation-content",
9 "@type": "@id",
10 "@context": "TypedString.jsonld"
11 },
12 "identifier": {
13 "@id": "cdi:Notation-identifier",
14 "@type": "@id",
15 "@context": "Identifier.jsonld"
16 },
17 "whiteSpace": {
18 "@id": "cdi:Notation-whiteSpace",
19 "@type": "@vocab",
20 "@context": {
21 "Collapse": "cdi:Collapse"
22 , "Preserve": "cdi:Preserve"
23 , "Replace": "cdi:Replace"
24 }
25 },
26
27 "represents": {
28 "@id": "cdi:Notation_represents_Category",
29 "@type": "@id",
30 "@context": "Category.jsonld"
31 },
32 "uses_Notation_OF_ClassificationItem": {
33 "@reverse": "cdi:ClassificationItem_uses_Notation",
34 "@type": "@id",
35 "@context": "ClassificationItem.jsonld"
36 },
37 "uses_Notation_OF_Code": {
38 "@reverse": "cdi:Code_uses_Notation",
39 "@type": "@id",
40 "@context": "Code.jsonld"
41 },
42 "uses_Notation_OF_Datum": {
43 "@reverse": "cdi:Datum_uses_Notation",
44 "@type": "@id",
45 "@context": "Datum.jsonld"
46 },
47 " comment ": "tag:json-should-support-trailing-commas"
48 }
49 ],
50 "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:52.",
51 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::DataDescription::Notation"
52}
Fragment for the class Notation (entire SHACL - Shapes Constraint Language)
1# class Notation
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Notation
3<#Notation> a sh:NodeShape;
4 sh:targetClass cdi:Notation;
5 sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/Notation";
6 sh:closed true;
7 sh:ignoredProperties ( owl:sameAs );
8 sh:property [
9 sh:path rdf:type;
10 sh:in ( cdi:Notation
11 ) ;
12 ];
13 # attributes
14 sh:property <#Notation-content>;
15 sh:property <#Notation-identifier>;
16 sh:property <#Notation-whiteSpace>;
17 # associations from Notation
18 sh:property <#Notation_represents_Category>;
19 # associations to Notation
20 sh:property <#rev_ClassificationItem_uses_Notation>;
21 sh:property <#rev_Code_uses_Notation>;
22 sh:property <#rev_Datum_uses_Notation>;
23
24
25
26.
27
28<#Notation-content> a sh:PropertyShape ;
29 sh:path cdi:Notation-content;
30 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
31 cdi:TypedString
32
33 ) ]];
34 sh:maxCount 1;
35.
36<#Notation-identifier> a sh:PropertyShape ;
37 sh:path cdi:Notation-identifier;
38 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
39 cdi:Identifier
40
41 ) ]];
42 sh:maxCount 1;
43.
44<#Notation-whiteSpace> a sh:PropertyShape ;
45 sh:path cdi:Notation-whiteSpace;
46 sh:node <#WhiteSpaceRule>
47 ;
48 sh:maxCount 1;
49.
50
51<#Notation_represents_Category> a sh:PropertyShape ;
52 sh:path cdi:Notation_represents_Category;
53 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
54 cdi:Category
55
56 ) ]];
57.
58<#rev_Notation_represents_Category> a sh:PropertyShape ;
59 sh:path [ sh:inversePath cdi:Notation_represents_Category ];
60 sh:minCount 1;
61.
Fragment for the class Notation (entire ShEx - Shape Expressions)
1# class Notation
2# based on the UML class DDICDIModels::DDICDILibrary::Classes::DataDescription::Notation
3cdi:NotationShape CLOSED {
4 a [cdi:Notation];
5 cdi:Notation-content @cdi:TypedStringShape?;
6 cdi:Notation-identifier @cdi:IdentifierShape?;
7 cdi:Notation-whiteSpace @cdi:WhiteSpaceRuleShape?;
8 cdi:Notation_represents_Category @cdi:CategoryShape *;
9
10 ^cdi:ClassificationItem_uses_Notation @cdi:ClassificationItemShape *;
11 ^cdi:Code_uses_Notation @cdi:CodeShape *;
12 ^cdi:Datum_uses_Notation @cdi:DatumShape OR @cdi:RevisableDatumShape*;
13 }