Merge pull request #290 from bci-oss/282-update-validation-documentation

Update Java tooling documentation

Author: atextor

core/sds-aspect-meta-model-interface/pom.xml

@@ -40,7 +40,10 @@
             <groupId>io.openmanufacturing</groupId>
             <artifactId>sds-aspect-model-urn</artifactId>
         </dependency>
-
+        <dependency>
+            <groupId>io.openmanufacturing</groupId>
+            <artifactId>sds-aspect-meta-model</artifactId>
+        </dependency>
 
         <dependency>
             <groupId>org.junit.jupiter</groupId>

core/sds-aspect-meta-model-interface/src/main/java/io/openmanufacturing/sds/aspectmodel/resolver/AspectMetaModelResourceResolver.java

@@ -2,7 +2,7 @@
  * Copyright (c) 2021 Robert Bosch Manufacturing Solutions GmbH
  *
  * See the AUTHORS file(s) distributed with this work for additional
- * information regarding authorship. 
+ * 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
@@ -19,13 +19,12 @@
 import org.apache.jena.rdf.model.Model;
 import org.apache.jena.rdf.model.Statement;
 
+import io.openmanufacturing.sds.aspectmetamodel.KnownVersion;
 import io.openmanufacturing.sds.aspectmodel.MissingMetaModelVersionException;
 import io.openmanufacturing.sds.aspectmodel.MultipleMetaModelVersionsException;
 import io.openmanufacturing.sds.aspectmodel.UnsupportedVersionException;
 import io.openmanufacturing.sds.aspectmodel.VersionNumber;
 import io.openmanufacturing.sds.aspectmodel.resolver.services.VersionedModel;
-import io.openmanufacturing.sds.aspectmodel.urn.AspectModelUrn;
-import io.openmanufacturing.sds.aspectmodel.urn.UrnSyntaxException;
 import io.vavr.control.Try;
 
 /**
@@ -43,6 +42,10 @@ public interface AspectMetaModelResourceResolver {
     */
    Try<VersionedModel> mergeMetaModelIntoRawModel( final Model rawModel, final VersionNumber version );
 
+   default Try<VersionedModel> mergeMetaModelIntoRawModel( final Model rawModel, final KnownVersion version ) {
+      return mergeMetaModelIntoRawModel( rawModel, VersionNumber.parse( version.toVersionString() ) );
+   }
+
    /**
     * Retrieves the meta model version an Aspect model uses
     *

core/sds-aspect-meta-model-interface/src/main/java/io/openmanufacturing/sds/aspectmodel/resolver/services/VersionedModel.java

@@ -2,7 +2,7 @@
  * Copyright (c) 2021 Robert Bosch Manufacturing Solutions GmbH
  *
  * See the AUTHORS file(s) distributed with this work for additional
- * information regarding authorship. 
+ * 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
@@ -15,6 +15,7 @@
 
 import org.apache.jena.rdf.model.Model;
 
+import io.openmanufacturing.sds.aspectmetamodel.KnownVersion;
 import io.openmanufacturing.sds.aspectmodel.VersionNumber;
 
 /**
@@ -42,6 +43,10 @@ public VersionedModel( final Model model, final VersionNumber version, final Mod
       this.rawModel = rawModel;
    }
 
+   public VersionedModel( final Model model, final KnownVersion version, final Model rawModel ) {
+      this( model, VersionNumber.parse( version.toVersionString() ), rawModel );
+   }
+
    public Model getModel() {
       return model;
    }

core/sds-aspect-model-serializer/src/main/java/io/openmanufacturing/sds/aspectmodel/serializer/PrettyPrinter.java

@@ -45,6 +45,7 @@
 import org.apache.jena.graph.impl.LiteralLabel;
 import org.apache.jena.rdf.model.Literal;
 import org.apache.jena.rdf.model.Model;
+import org.apache.jena.rdf.model.ModelFactory;
 import org.apache.jena.rdf.model.Property;
 import org.apache.jena.rdf.model.RDFList;
 import org.apache.jena.rdf.model.RDFNode;
@@ -87,11 +88,23 @@ public class PrettyPrinter {
    private final PrintVisitor printVisitor;
 
    /**
-    * Constructor.
+    * Constructor that takes a raw RDF {@link Model}
     *
-    * @param versionedModel The model to write
-    * @param rootElementUrn The URN of the root model element
-    * @param writer The writer to write to.
+    * @param model the Aspect Model to write
+    * @param metaModelVersion the meta model version
+    * @param rootElementUrn the URN of the root model element
+    * @param writer the writer to write to
+    */
+   public PrettyPrinter( final Model model, final KnownVersion metaModelVersion, final AspectModelUrn rootElementUrn, final PrintWriter writer ) {
+      this( new VersionedModel( ModelFactory.createDefaultModel(), metaModelVersion, model ), rootElementUrn, writer );
+   }
+
+   /**
+    * Constructor that takes a {@link VersionedModel}
+    *
+    * @param versionedModel the Aspect Model to write
+    * @param rootElementUrn the URN of the root model element
+    * @param writer the writer to write to
     */
    public PrettyPrinter( final VersionedModel versionedModel, final AspectModelUrn rootElementUrn, final PrintWriter writer ) {
       model = versionedModel.getRawModel();
@@ -415,7 +428,7 @@ private String print( final RDFNode node ) {
    }
 
    record PrintVisitor(Model model) implements NodeVisitor {
-      
+
       @Override
       public Object visitAny( final Node_ANY it ) {
          return "*";

core/sds-aspect-model-serializer/src/test/java/io/openmanufacturing/sds/aspectmodel/serializer/PrettyPrinterTest.java

@@ -47,10 +47,8 @@ public void testPrettyPrinter( final TestAspect testAspect ) {
 
       final ByteArrayOutputStream buffer = new ByteArrayOutputStream();
       final PrintWriter writer = new PrintWriter( buffer, false, StandardCharsets.UTF_8 );
-      new PrettyPrinter( new VersionedModel( ModelFactory.createDefaultModel(),
-            VersionNumber.parse( metaModelVersion.toVersionString() ), originalModel ),
-            testAspect.getUrn(), writer )
-            .print();
+      new PrettyPrinter( new VersionedModel( ModelFactory.createDefaultModel(), metaModelVersion, originalModel ),
+            testAspect.getUrn(), writer ).print();
       writer.flush();
 
       final InputStream bufferInput = new ByteArrayInputStream( buffer.toByteArray() );