Merge pull request #773 from bci-oss/767-fix-error-reporting

767 fix error reporting

Author: atextor

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

@@ -37,6 +37,13 @@ public interface AspectModelFile extends ModelElementGroup {
     */
    Model sourceModel();
 
+   /**
+    * Returns the RDF/Turtle representation of this Aspect Model File
+    *
+    * @return the source representation
+    */
+   String sourceRepresentation();
+
    /**
     * The list of Strings that are contained as a comment block at the start of the file. This is often used
     * for copyright and license information.
@@ -69,6 +76,16 @@ default Optional<String> spdxLicenseIdentifier() {
     */
    Optional<URI> sourceLocation();
 
+   /**
+    * Convenience method to help printing the location of a file: It returns its source location URI if present, or "unknown file"
+    * if the file does not have a source location.
+    *
+    * @return the human readable source location
+    */
+   default String humanReadableLocation() {
+      return sourceLocation().map( URI::toString ).orElse( "(unknown file)" );
+   }
+
    /**
     * Returns the local file name ("something.ttl") of this AspectModelFile, based on its source location.
     *

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

@@ -13,24 +13,33 @@
 
 package org.eclipse.esmf.aspectmodel;
 
+import java.net.URI;
+
+import org.apache.jena.rdf.model.Resource;
+
+/**
+ * Failure to parse a RDF literal
+ */
 public class ValueParsingException extends RuntimeException {
-   private final String type;
+   private final Resource type;
    private final Object value;
    private long line;
    private long column;
+   private URI sourceLocation;
+   private String sourceDocument;
 
-   public ValueParsingException( final String type, final Object value ) {
+   public ValueParsingException( final Resource type, final Object value ) {
       this.type = type;
       this.value = value;
    }
 
-   public ValueParsingException( final String type, final Object value, final Throwable cause ) {
+   public ValueParsingException( final Resource type, final Object value, final Throwable cause ) {
       super( cause );
       this.type = type;
       this.value = value;
    }
 
-   public String getType() {
+   public Resource getType() {
       return type;
    }
 
@@ -55,4 +64,20 @@ public long getLine() {
    public long getColumn() {
       return column;
    }
+
+   public String getSourceDocument() {
+      return sourceDocument;
+   }
+
+   public URI getSourceLocation() {
+      return sourceLocation;
+   }
+
+   public void setSourceDocument( final String sourceDocument ) {
+      this.sourceDocument = sourceDocument;
+   }
+
+   public void setSourceLocation( final URI sourceLocation ) {
+      this.sourceLocation = sourceLocation;
+   }
 }

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

@@ -113,9 +113,9 @@ public static Try<VersionNumber> tryParse( final String versionString ) {
       }
       final VersionNumberParser parser = new VersionNumberParser( versionString );
 
-      int major = 0;
-      int minor = 0;
-      int micro = 0;
+      int major;
+      int minor;
+      int micro;
 
       major = parser.parseNextDigit();
       minor = parser.parseNextDigit();

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

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2025 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for additional
+ * information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.aspectmodel.validation;
+
+import java.util.Collection;
+import java.util.function.Supplier;
+
+import org.eclipse.esmf.metamodel.AspectModel;
+
+import io.vavr.control.Either;
+import io.vavr.control.Try;
+import org.apache.jena.rdf.model.Model;
+
+/**
+ * Generic validator for Aspect Models, either on the raw RDF input or on the already loaded Aspect Model
+ *
+ * @param <P> the "problem" type that describes loading or validation failures
+ * @param <C> the "collection of problem" type that constitutes a validation report
+ */
+public interface Validator<P, C extends Collection<? super P>> {
+   /**
+    * Validates a complete RDF input (i.e., this model is expected to contain all necessary definitions, including meta model definitions)
+    *
+    * @param model the input model
+    * @return the validation report
+    */
+   C validateModel( Model model );
+
+   /**
+    * Validates a loaded Aspect Model
+    *
+    * @param aspectModel the Aspect Model
+    * @return the validation report
+    */
+   C validateModel( AspectModel aspectModel );
+
+   /**
+    * Convenience function that takes an Aspect Model loading function as an input and returns the resulting Aspect Model on success,
+    * or a validation report describing the loading failures on failure
+    *
+    * @param aspectModelLoader the Aspect Model loading function
+    * @return the validation report on failure ({@link Try.Failure}) or the Aspect Model on success ({@link Try.Success})
+    */
+   Either<C, AspectModel> loadModel( Supplier<AspectModel> aspectModelLoader );
+
+   /**
+    * If {@link #loadModel(Supplier)} is called with a loading function that itself makes use of the Validator, the loading function can
+    * short-circuit the loading-and-validation process and directly return validation results by throwing the exception returned by this
+    * method.
+    *
+    * @param violations the results to return from the loading-and-validation process
+    * @param <E> the type of exception that is thrown
+    * @return the exception
+    */
+   <E extends RuntimeException> E cancelValidation( C violations );
+}

core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/metamodel/ModelElement.java

@@ -19,7 +19,6 @@
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 import org.eclipse.esmf.aspectmodel.visitor.AspectVisitor;
-import org.eclipse.esmf.samm.KnownVersion;
 
 /**
  * The ModelElement interface provides all facilities that all Aspect Model elements have.

core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/metamodel/characteristic/StructuredValue.java

@@ -16,7 +16,6 @@
 import java.util.List;
 
 import org.eclipse.esmf.metamodel.Characteristic;
-import org.eclipse.esmf.metamodel.Property;
 
 /**
  * @since SAMM 1.0.0