Add SAMM LSP server

.development/esmf-checkstyle.xml

@@ -191,7 +191,7 @@
              value="Local variable name ''{0}'' must match pattern ''{1}''."/>
     </module>
     <module name="PatternVariableName">
-      <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
+      <property name="format" value="^(_|[a-z]([a-z0-9][a-zA-Z0-9]*)?)$"/>
       <message key="name.invalidPattern"
              value="Pattern variable name ''{0}'' must match pattern ''{1}''."/>
     </module>

.github/workflows/pull-request-check.yml

@@ -124,7 +124,7 @@ jobs:
           cp tools/samm-cli/scripts/windows/run.bat ./${bundle}/
 
           curl -Lo warp-packer.exe https://github.com/dgiagio/warp/releases/download/v0.3.0/windows-x64.warp-packer.exe
-          if [ "$(sha256sum warp-packer | cut -d' ' -f1)" != "4f9a0f223f0e9f689fc718fdf86a147a357921ffa69c236deadc3274091070c1" ]; then
+          if [ "$(sha256sum warp-packer.exe | cut -d' ' -f1)" != "4f9a0f223f0e9f689fc718fdf86a147a357921ffa69c236deadc3274091070c1" ]; then
             echo "Warp packer checksum does not match"
             exit 1
           fi
@@ -145,7 +145,7 @@ jobs:
           chmod +x ./${bundle}/run.sh
 
           curl -Lo warp-packer https://github.com/dgiagio/warp/releases/download/v0.3.0/macos-x64.warp-packer
-          if [ "$(sha256sum warp-packer | cut -d' ' -f1)" != "01d00038dbbe4e5a6e2ca19c1235f051617ac0e6e582d2407a06cec33125044b" ]; then
+          if [ "$(shasum -a 256 warp-packer | cut -d' ' -f1)" != "01d00038dbbe4e5a6e2ca19c1235f051617ac0e6e582d2407a06cec33125044b" ]; then
             echo "Warp packer checksum does not match"
             exit 1
           fi

core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/aspectmodel/AspectLoadingException.java

@@ -13,18 +13,35 @@
 
 package org.eclipse.esmf.aspectmodel;
 
+import org.apache.jena.rdf.model.RDFNode;
+import org.jspecify.annotations.Nullable;
+
 public class AspectLoadingException extends RuntimeException {
    private static final long serialVersionUID = 7687644022103150329L;
 
+   private final @Nullable RDFNode highlightElement;
+
    public AspectLoadingException( final Throwable cause ) {
       super( cause );
+      highlightElement = null;
    }
 
    public AspectLoadingException( final String message ) {
       super( message );
+      highlightElement = null;
    }
 
    public AspectLoadingException( final String message, final Throwable cause ) {
       super( message, cause );
+      highlightElement = null;
+   }
+
+   public AspectLoadingException( final String message, final RDFNode highlightElement ) {
+      super( message );
+      this.highlightElement = highlightElement;
+   }
+
+   public @Nullable RDFNode highlightElement() {
+      return highlightElement;
    }
 }

core/esmf-aspect-meta-model-java/pom.xml

@@ -34,6 +34,10 @@
    </properties>
 
    <dependencies>
+      <dependency>
+         <groupId>org.eclipse.esmf</groupId>
+         <artifactId>esmf-util</artifactId>
+      </dependency>
       <dependency>
          <groupId>org.eclipse.esmf</groupId>
          <artifactId>esmf-semantic-aspect-meta-model</artifactId>
@@ -42,6 +46,10 @@
          <groupId>org.eclipse.esmf</groupId>
          <artifactId>esmf-aspect-meta-model-interface</artifactId>
       </dependency>
+      <dependency>
+         <groupId>org.eclipse.esmf</groupId>
+         <artifactId>esmf-tree-sitter-turtle</artifactId>
+      </dependency>
       <dependency>
          <groupId>org.apache.commons</groupId>
          <artifactId>commons-text</artifactId>

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/loader/AspectModelLoader.java

@@ -38,6 +38,15 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.apache.jena.rdf.model.Model;
+import org.apache.jena.rdf.model.ModelFactory;
+import org.apache.jena.rdf.model.RDFNode;
+import org.apache.jena.rdf.model.Resource;
+import org.apache.jena.rdf.model.Statement;
+import org.apache.jena.rdf.model.StmtIterator;
+import org.apache.jena.vocabulary.RDF;
+import org.apache.jena.vocabulary.XSD;
+
 import org.eclipse.esmf.aspectmodel.AspectLoadingException;
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
 import org.eclipse.esmf.aspectmodel.RdfUtil;
@@ -68,19 +77,13 @@
 import org.eclipse.esmf.metamodel.impl.DefaultNamespace;
 import org.eclipse.esmf.metamodel.vocabulary.SammNs;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import com.google.common.collect.Streams;
+
 import io.vavr.control.Either;
 import io.vavr.control.Try;
-import org.apache.jena.rdf.model.Model;
-import org.apache.jena.rdf.model.ModelFactory;
-import org.apache.jena.rdf.model.RDFNode;
-import org.apache.jena.rdf.model.Resource;
-import org.apache.jena.rdf.model.Statement;
-import org.apache.jena.rdf.model.StmtIterator;
-import org.apache.jena.vocabulary.RDF;
-import org.apache.jena.vocabulary.XSD;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * The core class to load an {@link AspectModel}. The AspectModelLoader is also a
@@ -339,6 +342,23 @@ public AspectModel loadUrns( final Collection<AspectModelUrn> urns ) {
       return loadAspectModelFiles( loaderContext.loadedFiles() );
    }
 
+   /**
+    * Load an Aspect Model from a String containing the RDF/Turtle represenatation and set the srouce
+    * location
+    * for this input
+    *
+    * @param turtleRepresentation the document as RDF/Turtle
+    * @param sourceLocation the source location for the model
+    * @return the Aspect Model
+    */
+   public AspectModel load( final String turtleRepresentation, final URI sourceLocation ) {
+      final AspectModelFile rawFile = AspectModelFileLoader.load( turtleRepresentation, sourceLocation );
+      final AspectModelFile migratedModel = migrate( rawFile );
+      final LoaderContext loaderContext = new LoaderContext();
+      resolve( List.of( migratedModel ), loaderContext );
+      return loadAspectModelFiles( loaderContext.loadedFiles() );
+   }
+
    /**
     * Load an Aspect Model (.ttl) from an input stream and set the source location for this input. For
     * loading an Aspect Model Namespace Package (.zip), use
@@ -640,7 +660,11 @@ public AspectModel loadAspectModelFiles( final Collection<AspectModelFile> input
                .filter( statement -> !statement.getObject().isURIResource() || !statement.getResource().equals( SammNs.SAMM.Namespace() ) )
                .map( Statement::getSubject )
                .filter( RDFNode::isURIResource )
-               .map( resource -> mergedModel.createResource( resource.getURI() ) )
+               .map( resource -> {
+                  final Resource newResource = mergedModel.createResource( resource.getURI() );
+                  TokenRegistry.updateNode( resource.asNode(), newResource.asNode() );
+                  return newResource;
+               } )
                .map( resource -> modelElementFactory.create( ModelElement.class, resource ) )
                .toList();
          aspectModelFile.setElements( fileElements );

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/loader/Instantiator.java

@@ -23,6 +23,14 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.apache.jena.rdf.model.Literal;
+import org.apache.jena.rdf.model.Model;
+import org.apache.jena.rdf.model.RDFList;
+import org.apache.jena.rdf.model.RDFNode;
+import org.apache.jena.rdf.model.Resource;
+import org.apache.jena.rdf.model.Statement;
+import org.apache.jena.vocabulary.RDF;
+
 import org.eclipse.esmf.aspectmodel.AspectLoadingException;
 import org.eclipse.esmf.aspectmodel.RdfUtil;
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
@@ -44,14 +52,6 @@
 import org.eclipse.esmf.metamodel.vocabulary.SAMM;
 import org.eclipse.esmf.metamodel.vocabulary.SammNs;
 
-import org.apache.jena.rdf.model.Literal;
-import org.apache.jena.rdf.model.Model;
-import org.apache.jena.rdf.model.RDFList;
-import org.apache.jena.rdf.model.RDFNode;
-import org.apache.jena.rdf.model.Resource;
-import org.apache.jena.rdf.model.Statement;
-import org.apache.jena.vocabulary.RDF;
-
 public abstract class Instantiator<T extends ModelElement> extends AttributeValueRetriever implements Function<Resource, T> {
    protected final ModelElementFactory modelElementFactory;
    protected Class<T> targetClass;
@@ -128,7 +128,8 @@ private Statement getDataType( final Resource resource ) {
                final Statement dataType = resource.getProperty( SammNs.SAMM.dataType() );
                if ( dataType == null ) {
                   throw new AspectLoadingException(
-                        String.format( "No datatype is defined on the Characteristic instance '%s: '.", resource.getLocalName() ) );
+                        String.format( "No datatype is defined on the Characteristic instance '%s'.", resource.getLocalName() ),
+                        resource );
                }
                return dataType;
             } );
@@ -157,7 +158,7 @@ protected Value buildValue( final RDFNode node, final Optional<Resource> charact
       if ( node.isLiteral() ) {
          final Literal literal = node.asLiteral();
          return valueInstantiator.buildScalarValue( literal.getLexicalForm(), literal.getLanguage(), literal.getDatatypeURI() )
-               .orElseThrow( () -> new AspectLoadingException( "Literal can not be parsed: " + literal ) );
+               .orElseThrow( () -> new AspectLoadingException( "Literal can not be parsed: " + literal, literal ) );
       }
 
       if ( node.isResource() ) {
@@ -166,7 +167,7 @@ protected Value buildValue( final RDFNode node, final Optional<Resource> charact
             final Optional<String> valueOpt = optionalAttributeValue( resource, SammNs.SAMM.value() ).map( Statement::getString );
 
             if ( valueOpt.isEmpty() ) {
-               throw new AspectLoadingException( "samm:Value must contain a samm:value property" );
+               throw new AspectLoadingException( "samm:Value must contain a samm:value property", resource );
             }
 
             return new DefaultScalarValue( buildBaseAttributes( resource ), valueOpt.get(), new DefaultScalar( type.getUrn() ) );
@@ -196,7 +197,7 @@ protected Value buildValue( final RDFNode node, final Optional<Resource> charact
 
       // This could happen if an entity instance should be constructed for an AbstractEntity type
       if ( !type.is( Entity.class ) ) {
-         throw new AspectLoadingException( "Expected type of value " + node + " to be samm:Entity, but it is not" );
+         throw new AspectLoadingException( "Expected type of value " + node + " to be samm:Entity, but it is not", node );
       }
 
       // Entities
@@ -221,11 +222,12 @@ protected EntityInstance buildEntityInstance( final Resource entityInstance, fin
             if ( property.isOptional() ) {
                return;
             }
-            throw new AspectLoadingException( "Mandatory Property " + property + " not found in Entity instance " + entityInstance );
+            throw new AspectLoadingException( "Mandatory Property " + property + " not found in Entity instance " + entityInstance,
+                  entityInstance );
          }
          final RDFNode rdfValue = entityInstance.getProperty( rdfProperty ).getObject();
          final Type propertyType = property.getDataType()
-               .orElseThrow( () -> new AspectLoadingException( "Invalid Property without a dataType found" ) );
+               .orElseThrow( () -> new AspectLoadingException( "Invalid Property without a dataType found", entityInstance ) );
          final Resource characteristic = attributeValue( rdfProperty, SammNs.SAMM.characteristic() ).getResource();
          final Value value = buildValue( rdfValue, Optional.of( characteristic ), propertyType );
          assertions.put( property, value );

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/loader/ModelElementFactory.java

@@ -26,6 +26,15 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.apache.commons.lang3.StringUtils;
+import org.apache.jena.rdf.model.Model;
+import org.apache.jena.rdf.model.RDFNode;
+import org.apache.jena.rdf.model.Resource;
+import org.apache.jena.rdf.model.Statement;
+import org.apache.jena.rdf.model.StmtIterator;
+import org.apache.jena.vocabulary.RDF;
+import org.apache.jena.vocabulary.RDFS;
+
 import org.eclipse.esmf.aspectmodel.AspectLoadingException;
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
 import org.eclipse.esmf.aspectmodel.loader.instantiator.AbstractEntityInstantiator;
@@ -77,14 +86,6 @@
 import org.eclipse.esmf.metamodel.vocabulary.SammNs;
 
 import com.google.common.collect.Streams;
-import org.apache.commons.lang3.StringUtils;
-import org.apache.jena.rdf.model.Model;
-import org.apache.jena.rdf.model.RDFNode;
-import org.apache.jena.rdf.model.Resource;
-import org.apache.jena.rdf.model.Statement;
-import org.apache.jena.rdf.model.StmtIterator;
-import org.apache.jena.vocabulary.RDF;
-import org.apache.jena.vocabulary.RDFS;
 
 /**
  * Used as part of the loading process in the {@link AspectModelLoader}, it creates instance for the
@@ -170,11 +171,12 @@ public <T extends ModelElement> T create( final Class<T> clazz, final Resource m
 
       // No generic instantiator could be found. This means the element is an entity instance
       if ( !model.contains( targetType, RDF.type, (RDFNode) null ) ) {
-         throw new AspectLoadingException( "Could not load " + modelElement + ": Unknown type " + targetType );
+         throw new AspectLoadingException( "Could not load " + modelElement + ": Unknown type " + targetType, modelElement );
       }
       final Entity entity = create( Entity.class, targetType );
       if ( entity == null ) {
-         throw new AspectLoadingException( "Could not load " + modelElement + ": Expected " + targetType + " to be an Entity" );
+         throw new AspectLoadingException( "Could not load " + modelElement + ": Expected " + targetType + " to be an Entity",
+               modelElement );
       }
       return (T) new EntityInstanceInstantiator( this, entity ).apply( modelElement );
    }
@@ -190,7 +192,7 @@ public Unit findOrCreateUnit( final Resource unitResource ) {
       if ( SammNs.UNIT.getNamespace().equals( unitResource.getNameSpace() ) ) {
          final AspectModelUrn unitUrn = AspectModelUrn.fromUrn( unitResource.getURI() );
          return Units.fromName( unitUrn.getName() )
-               .orElseThrow( () -> new AspectLoadingException( "Unit definition for " + unitUrn + " is invalid" ) );
+               .orElseThrow( () -> new AspectLoadingException( "Unit definition for " + unitUrn + " is invalid", unitResource ) );
       }
 
       final Set<QuantityKind> quantityKinds = Streams.stream(
@@ -220,7 +222,7 @@ private Resource resourceType( final Resource resource ) {
             .filter( Optional::isPresent )
             .map( Optional::get )
             .findFirst()
-            .orElseThrow( () -> new AspectLoadingException( "Resource " + resource + " has no type" ) );
+            .orElseThrow( () -> new AspectLoadingException( "Resource " + resource + " has no type", resource ) );
    }
 
    protected Model getModel() {
@@ -301,7 +303,8 @@ private static List<String> getSeeValues( final Resource resource, final Attribu
    private static String getSyntheticName( final Resource modelElement ) {
       final Resource namedParent = getNamedParent( modelElement, modelElement.getModel() );
       if ( namedParent == null ) {
-         throw new AspectLoadingException( "At least one anonymous node in the model does not have a parent with a regular name." );
+         throw new AspectLoadingException( "At least one anonymous node in the model does not have a parent with a regular name.",
+               modelElement );
       }
       final String parentModelElementUri = namedParent.getURI();
       final String parentModelElementName = AspectModelUrn.from( parentModelElementUri )
@@ -365,7 +368,7 @@ private static Resource getModelElementType( final Resource modelElement ) {
       // This model element has no type, but maybe it extends another element
       final Statement extendsStatement = modelElement.getProperty( SammNs.SAMM._extends() );
       if ( extendsStatement == null ) {
-         throw new AspectLoadingException( "Model element has no type and does not extend another type: " + modelElement );
+         throw new AspectLoadingException( "Model element has no type and does not extend another type: " + modelElement, modelElement );
       }
 
       final Resource superElement = extendsStatement.getObject().asResource();

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/loader/instantiator/PropertyInstantiator.java

@@ -98,7 +98,7 @@ private ScalarValue buildScalarValue( final RDFNode node, final Type expectedTyp
       if ( node.isLiteral() ) {
          final Literal literal = node.asLiteral();
          return valueInstantiator.buildScalarValue( literal.getLexicalForm(), literal.getLanguage(), literal.getDatatypeURI() )
-               .orElseThrow( () -> new AspectLoadingException( "Literal cannot be parsed: " + literal ) );
+               .orElseThrow( () -> new AspectLoadingException( "Literal cannot be parsed: " + literal, literal ) );
       }
 
       if ( node.isResource() ) {
@@ -108,7 +108,7 @@ private ScalarValue buildScalarValue( final RDFNode node, final Type expectedTyp
             final Optional<String> valueOpt = optionalAttributeValue( resource, SammNs.SAMM.value() ).map( Statement::getString );
 
             if ( valueOpt.isEmpty() ) {
-               throw new AspectLoadingException( "samm:Value must contain a samm:value property" );
+               throw new AspectLoadingException( "samm:Value must contain a samm:value property", resource );
             }
 
             return new DefaultScalarValue( buildBaseAttributes( resource ), valueOpt.get(), new DefaultScalar( expectedType.toString() ) );
@@ -117,6 +117,6 @@ private ScalarValue buildScalarValue( final RDFNode node, final Type expectedTyp
          return new DefaultScalarValue( buildBaseAttributes( resource ), resource.getURI(), new DefaultScalar( expectedType.toString() ) );
       }
 
-      throw new AspectLoadingException( "Unexpected RDF node type: " + node );
+      throw new AspectLoadingException( "Unexpected RDF node type: " + node, node );
    }
 }