Rename all depending files

This PR renames all occurrences of the Open Manufacturing Platform (OMP), Semantic Data Structuring (SDS) working group and BAMM Aspect Meta Model (BAMM) to Eclipse Semantic Modeling Framework (ESMF) and Semantic Aspect Meta Model (SAMM), respectively.

Author: michelu89

CONTRIBUTING.md

@@ -1,13 +1,12 @@
-# SDS SDK JS Aspect Model loader Code Conventions
+# ESMF JS Aspect Model loader Code Conventions
 
 The following document contains a compilation of conventions and guidelines to format, structure and write code for the
-SDS SDK JS Aspect Model loader.
+ESMF JS Aspect Model loader.
 
 ## General Conventions
 
 Our code conventions are based on the [Google Typescript Style Guide](https://google.github.io/styleguide/tsguide.html)
-but
-detailed and adjusted for the needs of the SDS SDK JS Aspect Model loader.
+but detailed and adjusted for the needs of the ESMF JS Aspect Model loader.
 
 ## Copyright header
 
@@ -34,8 +33,7 @@ Developer documentation is put into a README.md placed in the project root. This
 ### User documentation
 
 User documentation (this includes technical documentation on how to use an application or tool from
-the SDS SDK JS Aspect Model loader) should be on
-its own.
+the ESMF JS Aspect Model loader) should be on its own.
 It is written in AsciiDoc, rendered with [Antora](https://antora.org) and the generated static content is
 publically hosted for direct user access.
 The source files of the documentation are placed in a subfolder /documentation from the project root.
@@ -54,4 +52,4 @@ Publishing is realized by means of [Github pages](https://docs.antora.org/antora
 Technical documentation targeted towards components and architecture should be accessible via the developer
 documentation.
 Corresponding discussions on design etc. can be placed in the project wiki on
-[Github](https://github.com/OpenManufacturingPlatform/sds-sdk-js-Aspect Model loader/wiki).
+[Github](https://github.com/eclipse-esmf/esmf-sdk-js-aspect-model-loader/wiki).

CONVENTIONS.md

@@ -1,4 +1,4 @@
-# SDS JS SDK :: Aspect Model Loader 🚀
+# ESMF JS SDK :: Aspect Model Loader 🚀
 
 ## Table of Contents
 
@@ -21,24 +21,20 @@ more [.ttl files](<https://en.wikipedia.org/wiki/Turtle_(syntax)>) into native T
 
 ## Getting help
 
-Are you having trouble with SDS SDK JS? We want to help!
+Are you having trouble with ESMF JS? We want to help!
 
-* Check the [developer documentation](https://openmanufacturingplatform.github.io)
-* Having issues with the SDS SDK JS? Open
-  a [GitHub issue](https://github.com/OpenManufacturingPlatform/sds-sdk-js-aspect-model-loader/issues).
+- Check the [developer documentation](https://openmanufacturingplatform.github.io)
+- Having issues with the ESMF JS? Open
+  a [GitHub issue](https://github.com/eclipse-esmf/esmf-sdk-js-aspect-model-loader/issues).
 
 ## Getting started
 
-### Install from the public npm (Currently not available):
+### Install from the public npm:
 
-```
-npm install @sds/aspect-model-loader
-```
-
-### Install from github release repository:
+<!-- TODO: Replace this with esmf -->
 
 ```
-npm install https://github.com/OpenManufacturingPlatform/sds-sdk-js-aspect-model-loader/releases/download/<TAG_VERSION>/sds-aspect-model-loader-x.x.x.tgz
+npm install @omp-sdk/aspect-model-loader
 ```
 
 ## Usage
@@ -101,7 +97,7 @@ to update all index files under `src`. For more information see the project http
 ## Documentation
 
 Further documentation and howto's are provided in the
-official [JS SDK Aspect Model loader User Documentation](https://openmanufacturingplatform.github.io/sds-documentation/js-sdk-aml-guide/index.html)
+official [JS SDK User Documentation](https://openmanufacturingplatform.github.io/sds-documentation/js-sdk-guide/1.0.0/index.html)
 
 ## License
 
@@ -111,4 +107,3 @@ This program and the accompanying materials are made available under the terms o
 [Mozilla Public License, v. 2.0](LICENSE).
 
 The [Notice file](NOTICE.md) details contained third party materials.
-

README.md

@@ -22,14 +22,14 @@ For example a newly added property and the related value could be shown in the U
 
 [source,bash]
 ----
-npm install @sds/aspect-model-loader
+npm install @esmf/aspect-model-loader
 ----
 
 === Install from github release repository:
 
 [source,bash]
 ----
-npm install https://github.com/OpenManufacturingPlatform/sds-sdk-js-aspect-model-loader/releases/download/<TAG_VERSION>/sds-aspect-model-loader-x.x.x.tgz
+npm install https://github.com/eclipse-esmf/esmf-sdk-js-aspect-model-loader/releases/download/<TAG_VERSION>/esmf-aspect-model-loader-x.x.x.tgz
 ----
 
 == Usage

documentation/js-sdk-aml-guide/modules/ROOT/pages/index.adoc

@@ -1,5 +1,5 @@
 {
-  "name": "@sds/aspect-model-loader",
+  "name": "@esmf/aspect-model-loader",
   "version": "",
   "description": "Instantiate and traverse defined Aspect Models natively in your TypeScript applications",
   "main": "dist/index.js",
@@ -23,15 +23,15 @@
     "Twin",
     "Digital Twin",
     "Aspect Meta Model",
-    "BAMM"
+    "SAMM"
   ],
   "author": "",
   "license": "mpl-2.0",
   "engines": {
     "node": ">=12.18.0"
   },
   "devDependencies": {
-    "@babel/core": "7.18.5",
+    "@babel/core": "7.18.13",
     "@babel/preset-env": "7.18.2",
     "@babel/preset-typescript": "7.17.12",
     "@types/jest": "28.1.1",

package.json

@@ -119,7 +119,7 @@ export class DefaultProperty extends Base implements Property {
 }
 
 /**
- * Properties which are defined inline e.g. bamm:properties ( [ bamm:extends :abstractTestProperty ; bamm:characteristic bamm-c:Text ] ).
+ * Properties which are defined inline e.g. samm:properties ( [ samm:extends :abstractTestProperty ; samm:characteristic samm-c:Text ] ).
  */
 export class DefaultPropertyInstanceDefinition implements Property {
     /**

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

@@ -43,8 +43,8 @@ export class AspectModelLoader {
      * @param modelAspectUrn URN of the Aspect Model to load and instantiate
      *
      * @param rdfContent List of all RDF/Turtle representation to load, including
-     *                   all referenced models imports. The default BAMM related imports
-     *                   e.g. with prefixes "bamm", "bamm-c", "bamm-e", "unit" and "xsd"
+     *                   all referenced models imports. The default SAMM related imports
+     *                   e.g. with prefixes "samm", "samm-c", "samm-e", "unit" and "xsd"
      *                   are already provided. No needs to provided that(content) is not
      *                   required.
      *

src/aspect-model-loader.ts

@@ -34,7 +34,7 @@ export class AspectInstantiator {
 
     createAspect(): Aspect {
         const aspectNode = <NamedNode>(
-            this.rdfModel.store.getQuads(null, this.rdfModel.BAMM().RdfType(), this.rdfModel.BAMM().Aspect(), null)[0].subject
+            this.rdfModel.store.getQuads(null, this.rdfModel.samm.RdfType(), this.rdfModel.samm.Aspect(), null)[0].subject
         );
         const metaModelElementInstantiator = new MetaModelElementInstantiator(
             this.rdfModel,

src/instantiator/aspect-instantiator.ts

@@ -14,18 +14,18 @@
 import {NamedNode, Quad, Util} from 'n3';
 import {BaseMetaModelElement, DefaultConstraint} from '../aspect-meta-model';
 import {MetaModelElementInstantiator} from './meta-model-element-instantiator';
-import {Bamm, Bammc} from '../vocabulary';
+import {Samm, SammC} from '../vocabulary';
 
 export class BaseConstraintCharacteristicInstantiator {
-    public bamm: Bamm;
-    public bammc: Bammc;
+    public samm: Samm;
+    public sammC: SammC;
 
     constructor(
         protected metaModelElementInstantiator: MetaModelElementInstantiator,
         public nextProcessor?: BaseConstraintCharacteristicInstantiator
     ) {
-        this.bamm = metaModelElementInstantiator.BAMM();
-        this.bammc = metaModelElementInstantiator.BAMMC();
+        this.samm = metaModelElementInstantiator.samm;
+        this.sammC = metaModelElementInstantiator.sammC;
     }
 
     create(quad: Quad): BaseMetaModelElement {

src/instantiator/base-constraint-characteristic-instantiator.ts

@@ -14,20 +14,20 @@
 import {MetaModelElementInstantiator} from '../meta-model-element-instantiator';
 import {NamedNode, Quad, Util} from 'n3';
 import {Characteristic, DefaultCharacteristic, DefaultEntity, DefaultScalar, Entity, Type} from '../../aspect-meta-model';
-import {BammCharacteristicInstantiator} from './bamm-characteristic-instantiator';
+import {PredefinedCharacteristicInstantiator} from './predefined-characteristic-instantiator';
 import {EntityInstantiator} from '../entity-instantiator';
 import {BaseConstraintCharacteristicInstantiator} from '../base-constraint-characteristic-instantiator';
 
 export class CharacteristicInstantiator extends BaseConstraintCharacteristicInstantiator {
-    private standardCharacteristicInstantiator: BammCharacteristicInstantiator;
+    private standardCharacteristicInstantiator: PredefinedCharacteristicInstantiator;
 
     constructor(protected metaModelElementInstantiator: MetaModelElementInstantiator, public nextProcessor?: CharacteristicInstantiator) {
         super(metaModelElementInstantiator, nextProcessor);
-        this.standardCharacteristicInstantiator = new BammCharacteristicInstantiator(metaModelElementInstantiator);
+        this.standardCharacteristicInstantiator = new PredefinedCharacteristicInstantiator(metaModelElementInstantiator);
     }
 
     create(quad: Quad): Characteristic {
-        let characteristic: Characteristic = this.determineBAMMDefaultCharacteristic(quad);
+        let characteristic: Characteristic = this.determineDefaultCharacteristic(quad);
         if (characteristic) {
             return characteristic;
         }
@@ -36,7 +36,7 @@ export class CharacteristicInstantiator extends BaseConstraintCharacteristicInst
         characteristic.dataType = this.getDataType(
             this.metaModelElementInstantiator.rdfModel
                 .findAnyProperty(quad)
-                .find(propertyQuad => this.bamm.isDataTypeProperty(propertyQuad.predicate.value))
+                .find(propertyQuad => this.samm.isDataTypeProperty(propertyQuad.predicate.value))
         );
 
         if (characteristic.dataType && characteristic.dataType.isComplex) {
@@ -55,16 +55,16 @@ export class CharacteristicInstantiator extends BaseConstraintCharacteristicInst
         return <Characteristic>this.metaModelElementInstantiator.cacheService.resolveInstance(characteristic);
     }
 
-    private determineBAMMDefaultCharacteristic(quad: Quad): Characteristic | undefined {
+    private determineDefaultCharacteristic(quad: Quad): Characteristic | undefined {
         // resolve actual element quad in case of a blank node which is most likely the case
         // for characteristics
         const elementQuad = Util.isBlankNode(quad.object)
             ? this.metaModelElementInstantiator.rdfModel.resolveBlankNodes(quad.object.value).shift()
             : quad;
 
-        // check if the found quad target a default BAMM characteristic e.g. Text or Code in this case
+        // check if the found quad target a default SAMM characteristic e.g. Text or Code in this case
         // return the exiting default characteristic
-        if (elementQuad.object.value.startsWith(this.metaModelElementInstantiator.BAMMC().getNamespace())) {
+        if (elementQuad.object.value.startsWith(this.metaModelElementInstantiator.sammC.getNamespace())) {
             const standardCharacteristic = this.standardCharacteristicInstantiator.createCharacteristic(<NamedNode>elementQuad.object);
             if (standardCharacteristic) {
                 return standardCharacteristic;
@@ -86,13 +86,13 @@ export class CharacteristicInstantiator extends BaseConstraintCharacteristicInst
     }
 
     isEntity(quad: Quad): boolean {
-        if (this.bamm.Entity().equals(quad.object) || this.bamm.AbstractEntity().equals(quad.object)) {
+        if (this.samm.Entity().equals(quad.object) || this.samm.AbstractEntity().equals(quad.object)) {
             return true;
         }
 
         const propertyFound = this.metaModelElementInstantiator.rdfModel
             .findAnyProperty(quad)
-            .find(quadProperty => this.bamm.Entity().equals(quadProperty.subject));
+            .find(quadProperty => this.samm.Entity().equals(quadProperty.subject));
 
         return !!propertyFound;
     }
@@ -119,7 +119,7 @@ export class CharacteristicInstantiator extends BaseConstraintCharacteristicInst
             const entity = new EntityInstantiator(this.metaModelElementInstantiator).createEntity(
                 quadEntity,
                 quadEntity.find(
-                    quad => this.bamm.isRdfTypeProperty(quad.predicate.value) && this.bamm.isAbstractEntity(quad.object.value)
+                    quad => this.samm.isRdfTypeProperty(quad.predicate.value) && this.samm.isAbstractEntity(quad.object.value)
                 ) !== undefined
             );
             return <Entity>this.metaModelElementInstantiator.cacheService.resolveInstance(entity);
@@ -131,17 +131,17 @@ export class CharacteristicInstantiator extends BaseConstraintCharacteristicInst
     private getEffectiveType(quad: Quad): Quad {
         if (Util.isBlankNode(quad.subject)) {
             let resolvedQuad: Array<Quad>;
-            if (this.bamm.isDataTypeProperty(quad.predicate.value)) {
+            if (this.samm.isDataTypeProperty(quad.predicate.value)) {
                 resolvedQuad = [quad];
             } else {
                 resolvedQuad = this.metaModelElementInstantiator.rdfModel.store.getQuads(quad.subject, null, null, null);
             }
 
-            quad = resolvedQuad.find(propertyQuad => this.bamm.isDataTypeProperty(propertyQuad.predicate.value));
-        } else if (quad.predicate.value === `${this.bamm.getRdfSyntaxNameSpace()}type`) {
+            quad = resolvedQuad.find(propertyQuad => this.samm.isDataTypeProperty(propertyQuad.predicate.value));
+        } else if (quad.predicate.value === `${this.samm.getRdfSyntaxNameSpace()}type`) {
             const resolvedQuad = this.metaModelElementInstantiator.rdfModel.store.getQuads(quad.subject, null, null, null);
 
-            quad = resolvedQuad.find(propertyQuad => this.bamm.isDataTypeProperty(propertyQuad.predicate.value));
+            quad = resolvedQuad.find(propertyQuad => this.samm.isDataTypeProperty(propertyQuad.predicate.value));
         }
 
         return quad;