Merge pull request #22 from bci-oss/feature/support-entity-instances-of-type-rdf-lang

Add support for entity instances of type rdf lang string

Author: michelu89

src/instantiator/characteristic/enumeration-characteristic-instantiator.ts

@@ -113,7 +113,14 @@ export class EnumerationCharacteristicInstantiator extends CharacteristicInstant
             // create the related instance and attach the metamodel element to it
             const entityInstance = new DefaultEntityInstance(quad.object.value.split('#')[1], entity, descriptions);
             entityInstanceQuads.forEach(quad => {
-                entityInstance[quad.predicate.value.split('#')[1]] = quad.object.value;
+                const predicateKey = this.getPredicateKey(quad);
+                if (Util.isBlankNode(quad.object)) {
+                    entityInstance[predicateKey] =
+                        this.solveBlankNodeValues([...this.metaModelElementInstantiator.rdfModel.resolveBlankNodes(quad.object.value)]);
+                }
+                else {
+                    entityInstance[predicateKey] = quad.object.value;
+                }
             });
 
             return entityInstance;
@@ -124,4 +131,21 @@ export class EnumerationCharacteristicInstantiator extends CharacteristicInstant
     shouldProcess(nameNode: NamedNode): boolean {
         return this.metaModelElementInstantiator.sammC.EnumerationCharacteristic().equals(nameNode);
     }
+
+    solveBlankNodeValues(resolvedBlankNodes: Array<Quad>) {
+        return resolvedBlankNodes.length > 0
+            ? resolvedBlankNodes.map(item => this.createLanguageObject(item))
+            : '';
+    }
+
+    private getPredicateKey(quad: Quad): string {
+        return quad.predicate.value.split('#')[1];
+    }
+
+    private createLanguageObject(quad: Quad): any {
+        return (quad.object as any).language
+            ? {value: quad.object.value, language: (quad.object as any).language}
+            : quad.object.value;
+    }
+
 }

test/characteristic.spec.ts

@@ -31,6 +31,7 @@ import {
     collectionCharacteristicClassString,
     eitherCharacteristicClass,
     enumerationCharacteristicClassEntity,
+    enumerationCharacteristicWithEntityInstanceClass
 } from './models/characteristics';
 import DoneCallback = jest.DoneCallback;
 
@@ -168,6 +169,42 @@ describe('Characteristics tests', (): void => {
         });
     });
 
+    describe('Enumeration class with Entity Instance', (): void => {
+        beforeAll((done: DoneCallback): void => {
+            loader = new AspectModelLoader();
+            subscription = loader.loadSelfContainedModel(enumerationCharacteristicWithEntityInstanceClass).subscribe((_aspect: TestAspect): void => {
+                aspect = _aspect;
+                testProperty = aspect.properties[0];
+                done();
+            });
+        });
+
+        it('should have enumeration type', (): void => {
+            expect(testProperty.characteristic instanceof DefaultEnumeration).toBe(true);
+        });
+
+        it('should have correct model urn', (): void => {
+            expect((testProperty.characteristic.dataType as DefaultEntity).properties[1].aspectModelUrn)
+                .toEqual('urn:samm:org.eclipse.esmf.test:1.0.0#resultTypeDescription');
+        });
+
+        it('should have two entries', (): void => {
+            const enumeration = testProperty.characteristic as DefaultEnumeration;
+            expect(enumeration.values.length).toBe(2);
+        });
+
+        it('Result type values should be instanceof DefaultEntityInstance class', (): void => {
+            const enumeration = testProperty.characteristic as DefaultEnumeration;
+            expect(enumeration.values[0] instanceof DefaultEntityInstance).toBe(true);
+        });
+
+        afterAll((): void => {
+            if (subscription) {
+                subscription.unsubscribe();
+            }
+        });
+    });
+
     describe('Either class with list and simple characteristic', (): void => {
         beforeAll((done: DoneCallback): void => {
             loader = new AspectModelLoader();

test/models/characteristics.ts

@@ -130,6 +130,71 @@ export const enumerationCharacteristicClassEntity = `
     :resultStateAttributeValue       "ok"^^xsd:string .
 `;
 
+export const enumerationCharacteristicWithEntityInstanceClass = `
+@prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#> .
+@prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#> .
+@prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:2.1.0#> .
+@prefix unit: <urn:samm:org.eclipse.esmf.samm:unit:2.1.0#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix : <urn:samm:org.eclipse.esmf.test:1.0.0#> .
+
+:TestAspect a samm:Aspect ;
+   samm:properties ( :result :metadata ) ;
+   samm:operations ( ) ;
+   samm:events ( ) .
+
+:result a samm:Property ;
+   samm:preferredName "result"@en ;
+   samm:characteristic :ResultTypes .
+
+:metadata a samm:Property ;
+   samm:characteristic :MetadataCharacteristic .
+
+:ResultTypes a samm-c:Enumeration ;
+   samm:preferredName "result types"@en ;
+   samm:description "The collection of known result types"@en ;
+   samm:dataType :ResultType ;
+   samm-c:values ( :ResultType1 :ResultType2 ) .
+
+:MetadataCharacteristic a samm:Characteristic ;
+   samm:dataType xsd:string .
+
+:ResultType a samm:Entity ;
+   samm:preferredName "Result Type"@en ;
+   samm:properties ( :resultTypeNumber [ samm:property :resultTypeDescription; samm:notInPayload true ] ) .
+
+:ResultType1 a :ResultType ;
+   :resultTypeDescription ( "ein"@de "one"@en ) ;
+   :resultTypeNumber "1"^^xsd:positiveInteger .
+
+:ResultType2 a :ResultType ;
+   :resultTypeDescription ( "zwei"@de "two"@en ) ;
+   :resultTypeNumber "2"^^xsd:positiveInteger .
+
+:resultTypeNumber a samm:Property ;
+   samm:preferredName "Result type number"@en ;
+   samm:description "result type number"@en ;
+   samm:characteristic :ResultNumbers .
+
+:resultTypeDescription a samm:Property ;
+   samm:preferredName "Result Type Description"@en ;
+   samm:description "Description of result type"@en ;
+   samm:characteristic :ResultTypeDescription .
+
+:ResultNumbers a samm-c:Enumeration ;
+   samm:preferredName "Result Numbers"@en ;
+   samm:description "result numbers"@en ;
+   samm:dataType xsd:positiveInteger ;
+   samm-c:values ( "1"^^xsd:positiveInteger "2"^^xsd:positiveInteger "21"^^xsd:positiveInteger "30"^^xsd:positiveInteger "35"^^xsd:positiveInteger "40"^^xsd:positiveInteger "41"^^xsd:positiveInteger "42"^^xsd:positiveInteger "43"^^xsd:positiveInteger "50"^^xsd:positiveInteger "60"^^xsd:positiveInteger "61"^^xsd:positiveInteger "70"^^xsd:positiveInteger "75"^^xsd:positiveInteger ) .
+
+:ResultTypeDescription a samm-c:Collection ;
+   samm:preferredName "Result Type Description"@en ;
+   samm:description "Descriptions of result types in English and German"@en ;
+   samm:dataType rdf:langString .
+`;
+
 export const eitherCharacteristicClass = `
 @prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
 @prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#>.