Merge pull request #304 from bci-oss/303-load-curie-values

Successfully load models containing and generate JSON for bamm:curie

Author: atextor

core/sds-aspect-meta-model-java/src/main/java/io/openmanufacturing/sds/metamodel/loader/CurieRdfType.java

@@ -0,0 +1,103 @@
+/*
+ * Copyright (c) 2023 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 io.openmanufacturing.sds.metamodel.loader;
+
+import java.util.Optional;
+
+import org.apache.jena.datatypes.DatatypeFormatException;
+import org.apache.jena.datatypes.RDFDatatype;
+import org.apache.jena.graph.impl.LiteralLabel;
+
+import io.openmanufacturing.sds.aspectmetamodel.KnownVersion;
+import io.openmanufacturing.sds.aspectmodel.resolver.services.TypedRdfDatatype;
+import io.openmanufacturing.sds.aspectmodel.vocabulary.BAMM;
+import io.openmanufacturing.sds.metamodel.datatypes.Curie;
+
+public class CurieRdfType implements TypedRdfDatatype<Curie> {
+   @Override
+   public Optional<Curie> parseTyped( final String lexicalForm ) {
+      if ( isValid( lexicalForm ) ) {
+         return Optional.of( new Curie( lexicalForm ) );
+      }
+      return Optional.empty();
+   }
+
+   @Override
+   public String unparseTyped( final Curie value ) {
+      return value.getValue();
+   }
+
+   @Override
+   public String getURI() {
+      return new BAMM( KnownVersion.getLatest() ).curie().getURI();
+   }
+
+   @Override
+   public String unparse( final Object value ) {
+      if ( value instanceof Curie curie ) {
+         return unparseTyped( curie );
+      }
+      throw new AspectLoadingException( "Value is no valid curie: " + value );
+   }
+
+   @Override
+   public Object parse( final String lexicalForm ) throws DatatypeFormatException {
+      return parseTyped( lexicalForm ).orElseThrow( () -> new DatatypeFormatException() );
+   }
+
+   @Override
+   public boolean isValid( final String lexicalForm ) {
+      return lexicalForm.matches( "[^:]*:.*" );
+   }
+
+   @Override
+   public boolean isValidValue( final Object valueForm ) {
+      return isValid( valueForm.toString() );
+   }
+
+   @Override
+   public boolean isValidLiteral( final LiteralLabel lit ) {
+      return isValid( lit.getLexicalForm() );
+   }
+
+   @Override
+   public boolean isEqual( final LiteralLabel value1, final LiteralLabel value2 ) {
+      return value1.getLexicalForm().equals( value2.getLexicalForm() );
+   }
+
+   @Override
+   public int getHashCode( final LiteralLabel lit ) {
+      return lit.getDefaultHashcode();
+   }
+
+   @Override
+   public Class<Curie> getJavaClass() {
+      return (Class<Curie>) Curie.class;
+   }
+
+   @Override
+   public Object cannonicalise( final Object value ) {
+      return value;
+   }
+
+   @Override
+   public Object extendedTypeDefinition() {
+      return null;
+   }
+
+   @Override
+   public RDFDatatype normalizeSubType( final Object value, final RDFDatatype datatype ) {
+      return datatype;
+   }
+}

core/sds-aspect-meta-model-java/src/main/java/io/openmanufacturing/sds/metamodel/loader/Instantiator.java

@@ -22,9 +22,11 @@
 import java.util.Map;
 import java.util.Optional;
 import java.util.function.Function;
+import java.util.function.Predicate;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.apache.jena.datatypes.RDFDatatype;
 import org.apache.jena.rdf.model.Literal;
 import org.apache.jena.rdf.model.Model;
 import org.apache.jena.rdf.model.RDFList;
@@ -51,6 +53,7 @@
 import io.openmanufacturing.sds.metamodel.ScalarValue;
 import io.openmanufacturing.sds.metamodel.Type;
 import io.openmanufacturing.sds.metamodel.Value;
+import io.openmanufacturing.sds.metamodel.datatypes.Curie;
 import io.openmanufacturing.sds.metamodel.datatypes.LangString;
 import io.openmanufacturing.sds.metamodel.impl.DefaultCollectionValue;
 import io.openmanufacturing.sds.metamodel.impl.DefaultEntityInstance;
@@ -64,6 +67,7 @@ public abstract class Instantiator<T extends ModelElement> extends AttributeValu
    protected UNIT unit;
    protected Model model;
    protected KnownVersion metaModelVersion;
+   protected final RDFDatatype curieDataType = new CurieRdfType();
 
    public Instantiator( final ModelElementFactory modelElementFactory, final Class<T> targetClass ) {
       super( modelElementFactory.getBamm() );
@@ -226,7 +230,7 @@ private ScalarValue buildScalarValue( final Literal literal ) {
          return new DefaultScalarValue( langString, type );
       }
 
-      return ExtendedXsdDataType.supportedXsdTypes.stream()
+      return Stream.concat( ExtendedXsdDataType.supportedXsdTypes.stream(), Stream.of( curieDataType ) )
             .filter( type -> type.getURI().equals( literal.getDatatypeURI() ) )
             .map( type -> type.parse( literal.getLexicalForm() ) )
             .map( value -> new DefaultScalarValue( value, new DefaultScalar( literal.getDatatypeURI(), metaModelVersion ) ) )

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

@@ -45,7 +45,7 @@ public class ExtendedXsdDataType<T> extends XSDDatatype implements TypedRdfDatat
    private static boolean checking = true;
    private static final ExtendedSchemaDVFactoryImpl extendedSchemaDVFactory = new ExtendedSchemaDVFactoryImpl();
 
-   private ExtendedXsdDataType( final Resource dataTypeResource, final Class<T> correspondingJavaClass,
+   public ExtendedXsdDataType( final Resource dataTypeResource, final Class<T> correspondingJavaClass,
          final Function<String, T> parser,
          final Function<T, String> unparser,
          final Predicate<String> lexicalValidator ) {

core/sds-aspect-meta-model-types/src/main/java/io/openmanufacturing/sds/metamodel/datatypes/Curie.java

@@ -45,4 +45,9 @@ public boolean equals( final Object o ) {
    public int hashCode() {
       return value != null ? value.hashCode() : 0;
    }
+
+   @Override
+   public String toString() {
+      return value;
+   }
 }

core/sds-aspect-model-document-generators/src/main/java/io/openmanufacturing/sds/aspectmodel/generator/json/ValueToPayloadStructure.java

@@ -21,12 +21,13 @@
 
 import com.google.common.collect.ImmutableMap;
 
-import io.openmanufacturing.sds.metamodel.ModelElement;
 import io.openmanufacturing.sds.metamodel.CollectionValue;
 import io.openmanufacturing.sds.metamodel.EntityInstance;
+import io.openmanufacturing.sds.metamodel.ModelElement;
 import io.openmanufacturing.sds.metamodel.Property;
 import io.openmanufacturing.sds.metamodel.ScalarValue;
 import io.openmanufacturing.sds.metamodel.Value;
+import io.openmanufacturing.sds.metamodel.datatypes.Curie;
 import io.openmanufacturing.sds.metamodel.datatypes.LangString;
 import io.openmanufacturing.sds.metamodel.visitor.AspectVisitor;
 
@@ -47,6 +48,9 @@ public Object visitScalarValue( final ScalarValue scalarValue, final Void contex
          final LangString langString = (LangString) scalarValue.getValue();
          return ImmutableMap.of( langString.getLanguageTag().toLanguageTag(), langString.getValue() );
       }
+      if ( scalarValue.getValue() instanceof Curie curie ) {
+         return curie.getValue();
+      }
       return scalarValue.getValue();
    }
 

core/sds-aspect-model-document-generators/src/test/java/io/openmanufacturing/sds/aspectmodel/generator/jsonschema/AspectModelJsonSchemaGeneratorTest.java

@@ -13,8 +13,8 @@
 
 package io.openmanufacturing.sds.aspectmodel.generator.jsonschema;
 
-import static org.assertj.core.api.Assertions.*;
-import static org.assertj.core.api.AssertionsForClassTypes.assertThatCode;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 import static org.junit.jupiter.api.Assertions.fail;
 
 import java.io.ByteArrayOutputStream;
@@ -111,17 +111,19 @@ private JsonSchema parseSchema( final JsonNode jsonSchema ) {
    }
 
    private void assertPayloadIsValid( final JsonNode schema, final JsonNode payload ) {
-      System.out.println( "Payload:" );
-      showJson( payload );
-      System.out.println( "Schema:" );
-      showJson( schema );
-      assertThatCode( () -> {
+      try {
          final ProcessingReport report = parseSchema( schema ).validate( payload );
          if ( !report.isSuccess() ) {
             System.out.println( report );
          }
          assertThat( report.isSuccess() ).isTrue();
-      } ).doesNotThrowAnyException();
+      } catch ( final Throwable throwable ) {
+         System.out.println( "Payload:" );
+         showJson( payload );
+         System.out.println( "Schema:" );
+         showJson( schema );
+         fail();
+      }
    }
 
    private void assertPayloadIsValid( final JsonNode schema, final Aspect aspect ) {

core/sds-test-aspect-models/src/main/java/io/openmanufacturing/sds/test/TestAspect.java

@@ -54,6 +54,7 @@ public enum TestAspect implements TestModel {
    ASPECT_WITH_CONSTRAINT_WITH_MULTIPLE_SEE_ATTRIBUTES,
    ASPECT_WITH_CONSTRAINT_WITH_SEE_ATTRIBUTE,
    ASPECT_WITH_CURIE,
+   ASPECT_WITH_CURIE_ENUMERATION,
    ASPECT_WITH_CUSTOM_NAMESPACE,
    ASPECT_WITH_CUSTOM_UNIT,
    ASPECT_WITH_DATE_TIME_TYPE_FOR_RANGE_CONSTRAINTS,

core/sds-test-aspect-models/src/main/resources/valid/bamm_2_0_0/io.openmanufacturing.test/1.0.0/AspectWithCurieEnumeration.ttl

@@ -0,0 +1,29 @@
+# Copyright (c) 2023 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
+
+@prefix : <urn:bamm:io.openmanufacturing.test:1.0.0#> .
+@prefix bamm: <urn:bamm:io.openmanufacturing:meta-model:2.0.0#> .
+@prefix bamm-c: <urn:bamm:io.openmanufacturing:characteristic:2.0.0#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+:AspectWithCurieEnumeration a bamm:Aspect ;
+   bamm:properties ( :testProperty ) ;
+   bamm:operations ( ) .
+
+:testProperty a bamm:Property ;
+   bamm:exampleValue "unit:hectopascal"^^bamm:curie ;
+   bamm:characteristic :TestEnumeration .
+
+:TestEnumeration a bamm-c:Enumeration ;
+   bamm:preferredName "Test Enumeration"@en ;
+   bamm:description "This is a test for enumeration."@en ;
+   bamm:dataType bamm:curie ;
+   bamm-c:values ( "unit:hectopascal"^^bamm:curie "unit:gram"^^bamm:curie ) .