Merge pull request #20 from bci-oss/feature/#19-load-complete-namespace

#19 Load complete namespaces and allow to traverse it

Author: michelu89

AUTHORS.md

@@ -2,10 +2,11 @@
 
 The following people have contributed to this repository:
 
-* [Sven Walter](https://github.com/waltersve), Robert Bosch GmbH, Sven.Walter@de.bosch.com
+* [Sven Walter](https://github.com/waltersve), Robert Bosch GmbH, Sven.Walter4@de.bosch.com
 * [Andreea Suditu](https://github.com/andreea-suditu)
 * [Michele Santoro](https://github.com/michelu89), Robert Bosch GmbH, [email protected]
-* Wolfgang Klenk
+* Hagen Wittlich, Robert Bosch GmbH 
+* Wolfgang Klenk, Robert Bosch GmbH
 * George Moscu
 
 Please add yourself to this list, if you contribute to the content.

README.md

@@ -16,8 +16,8 @@
 
 ## Introduction
 
-The main purpose of this package it to allow users to load and parse one or
-more [.ttl files](<https://en.wikipedia.org/wiki/Turtle_(syntax)>) into native TypeScript objects.
+This project enables developers to effortlessly load and parse one or more [.ttl files](<https://en.wikipedia.org/wiki/Turtle_(syntax)>) 
+and instantiate native TypeScript objects of the pared [SAMM](<https://projects.eclipse.org/projects/dt.esmf>) semantic concepts.
 
 ## Getting help
 
@@ -39,7 +39,7 @@ npm install @esmf/aspect-model-loader
 
 ## Usage
 
-This package contains two methods for loading ttl files(string value of the .ttl files).
+Instantiating an Aspect the following two methods for loading ttl files(string value of the .ttl files) are provided.
 
 Load an aspect model which is self-contained (includes no imports to other ttl file):
 
@@ -49,16 +49,27 @@ new AspectModelLoader().loadSelfContainedModel(ttl).subscribe((aspect: Aspect) =
 });
 ```
 
-or if the model contains imports to additional ttl files:
+or if the model contains imports to further ttl files:
 
 ```
-new AspectModelLoader().load('<aspect-model-urn>', ttl-1, ttl-2, ttl-3).subscribe((aspect: Aspect) => {
+new AspectModelLoader().load('<aspect-model-urn>', ttl-1, ttl-2, ttl-3, ...).subscribe((aspect: Aspect) => {
+...
+});
+```
+
+Besides loading an aspect the project also supports to load and group the SAMM definitions by namespace.
+
+Load all namespace and related SAMM semantic concepts:
+
+```
+new NamespaceLoader().load(ttl-1, ttl-2, ttl-3, ...).subscribe((namespaces: Observable<Map<string, Array<BaseMetaModelElement>>>) => {
 ...
 });
 ```
 
 If you are using external .ttl files you may need to parse the contents of these files to strings, to be passed to the
-methods params.
+methods params. Further all .ttl files must use the same SAMM version. Loading SAMM semantic concepts from different .ttl files
+having different SAMM versions is not supported yet.
 
 ## Helpful functions
 

src/aspect-meta-model/base.ts

@@ -14,10 +14,10 @@
 import {IsNamed} from './is-named';
 import {IsVersioned} from './is-versioned';
 import {IsDescribed} from './is-described';
-import {AspectModelVisitor} from '../visitor/aspect-model-visitor';
+import {ModelVisitor} from '../visitor/model-visitor';
 
 export interface BaseMetaModelElement extends IsNamed, IsVersioned, IsDescribed {
-    accept<T, U>(visitor: AspectModelVisitor<T, U>, context: U): T;
+    accept<T, U>(visitor: ModelVisitor<T, U>, context: U): T;
 
     parents: Array<BaseMetaModelElement>;
 }
@@ -36,6 +36,13 @@ export abstract class Base implements BaseMetaModelElement {
         private _isAnonymousNode: boolean = false
     ) {}
 
+    public get namespace(): string {
+        if (this._isAnonymousNode) {
+            return '';
+        }
+        return this._aspectModelUrn.split('#')[0] + '#';
+    }
+
     public get parents(): Array<BaseMetaModelElement> {
         return this._parents;
     }
@@ -124,5 +131,5 @@ export abstract class Base implements BaseMetaModelElement {
         return this._see;
     }
 
-    abstract accept<T, U>(visitor: AspectModelVisitor<T, U>, context: U): T;
+    abstract accept<T, U>(visitor: ModelVisitor<T, U>, context: U): T;
 }

src/aspect-meta-model/characteristic/default-characteristic.ts

@@ -13,7 +13,7 @@
 
 import {Type} from '../type';
 import {Base, BaseMetaModelElement} from '../base';
-import {AspectModelVisitor} from '../../visitor/aspect-model-visitor';
+import {ModelVisitor} from '../../visitor/model-visitor';
 
 export interface Characteristic extends BaseMetaModelElement {
     dataType?: Type;
@@ -32,7 +32,7 @@ export class DefaultCharacteristic extends Base implements Characteristic {
         return this._dataType;
     }
 
-    public accept<T, U>(visitor: AspectModelVisitor<T, U>, context: U): T {
+    public accept<T, U>(visitor: ModelVisitor<T, U>, context: U): T {
         return visitor.visitCharacteristic(this, context);
     }
 

src/aspect-meta-model/characteristic/default-trait.ts

@@ -13,7 +13,7 @@
 
 import {Characteristic, DefaultCharacteristic} from './default-characteristic';
 import {Constraint} from '../constraint/default-constraint';
-import {AspectModelVisitor} from '../../visitor/aspect-model-visitor';
+import {ModelVisitor} from '../../visitor/model-visitor';
 
 export interface Trait extends Characteristic {
     baseCharacteristic?: Characteristic;
@@ -43,7 +43,7 @@ export class DefaultTrait extends DefaultCharacteristic implements Trait {
         return this._constraints;
     }
 
-    accept<T, U>(visitor: AspectModelVisitor<T, U>, context: U): T {
+    accept<T, U>(visitor: ModelVisitor<T, U>, context: U): T {
         return visitor.visitCharacteristic(this, context);
     }
 }

src/aspect-meta-model/constraint/default-constraint.ts

@@ -12,7 +12,7 @@
  */
 
 import {Base, BaseMetaModelElement} from '../base';
-import {AspectModelVisitor} from '../../visitor/aspect-model-visitor';
+import {ModelVisitor} from '../../visitor/model-visitor';
 
 export type Constraint = BaseMetaModelElement;
 
@@ -21,7 +21,7 @@ export class DefaultConstraint extends Base implements Constraint {
         super(metaModelVersion, aspectModelUrn, name);
     }
 
-    accept<T, U>(visitor: AspectModelVisitor<T, U>, context: U): T {
+    accept<T, U>(visitor: ModelVisitor<T, U>, context: U): T {
         return visitor.visitConstraint(this, context);
     }
 }

src/aspect-meta-model/default-aspect.ts

@@ -12,9 +12,9 @@
  */
 
 import {Base, DefaultCollection, Event, Operation, Property} from './index';
-import {AspectModelVisitor} from '../visitor/aspect-model-visitor';
 import {BaseMetaModelElement} from './base';
 import {HasProperties} from './has-properties';
+import {ModelVisitor} from '../visitor/model-visitor';
 
 export interface Aspect extends BaseMetaModelElement, HasProperties {
     operations: Array<Operation>;
@@ -66,7 +66,7 @@ export class DefaultAspect extends Base implements Aspect {
         this._events = value;
     }
 
-    public accept<T, U>(visitor: AspectModelVisitor<T, U>, context: U): T {
+    public accept<T, U>(visitor: ModelVisitor<T, U>, context: U): T {
         return visitor.visitAspect(this, context);
     }
 }

src/aspect-meta-model/default-entity.ts

@@ -15,7 +15,7 @@ import {Base, BaseMetaModelElement} from './base';
 import {HasProperties} from './has-properties';
 import {Property} from './default-property';
 import {Type} from './type';
-import {AspectModelVisitor} from '../visitor/aspect-model-visitor';
+import {ModelVisitor} from '../visitor/model-visitor';
 
 export interface Entity extends BaseMetaModelElement, HasProperties, Type {
     /**
@@ -126,7 +126,7 @@ export class DefaultEntity extends Base implements Entity {
         this._extends = entity;
     }
 
-    public accept<T, U>(visitor: AspectModelVisitor<T, U>, context: U): T {
+    public accept<T, U>(visitor: ModelVisitor<T, U>, context: U): T {
         return visitor.visitEntity(this, context);
     }
 }

src/aspect-meta-model/default-event.ts

@@ -13,7 +13,7 @@
 
 import {Base, BaseMetaModelElement} from './base';
 import {Property} from './default-property';
-import {AspectModelVisitor} from '../visitor/aspect-model-visitor';
+import {ModelVisitor} from '../visitor/model-visitor';
 
 export interface Event extends BaseMetaModelElement {
     parameters: Array<Property>;
@@ -32,7 +32,7 @@ export class DefaultEvent extends Base implements Event {
         this._parameters = parameters;
     }
 
-    public accept<T, U>(visitor: AspectModelVisitor<T, U>, context: U): T {
+    public accept<T, U>(visitor: ModelVisitor<T, U>, context: U): T {
         return visitor.visitEvent(this, context);
     }
 }

src/aspect-meta-model/default-operation.ts

@@ -13,7 +13,7 @@
 
 import {Property} from './default-property';
 import {Base, BaseMetaModelElement} from './base';
-import {AspectModelVisitor} from '../visitor/aspect-model-visitor';
+import {ModelVisitor} from '../visitor/model-visitor';
 
 export interface Operation extends BaseMetaModelElement {
     input: Array<Property>;
@@ -62,7 +62,7 @@ export class DefaultOperation extends Base implements Operation {
         return this._output;
     }
 
-    public accept<T, U>(visitor: AspectModelVisitor<T, U>, context: U): T {
+    public accept<T, U>(visitor: ModelVisitor<T, U>, context: U): T {
         return visitor.visitOperation(this, context);
     }
 }