Update documentation and Quantity model

eclipse-esmf · Feb 4, 2025 · 042b415 · 042b415
1 parent dc9f18e
commit 042b415
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 43 deletions.
diff --git a/documentation/modules/ROOT/examples/aspect-sample.ttl b/documentation/modules/ROOT/examples/aspect-sample.ttl
@@ -78,25 +78,11 @@
 # tag::quantity-declaration[]
 :Parameter a samm:Entity ;
   samm:extends samm-e:Quantity ;
-  samm:properties ( :parameterValue :parameterUnit ) .
-
-:parameterValue a samm:Property ;
-  samm:characteristic :ParameterValueCharacteristic .
-
+  samm:properties (
+    [ samm:extends samm-e:value ; samm:characteristic :ParameterValueCharacteristic ]
+  ) .
 :ParameterValueCharacteristic a samm:Characteristic ;
   samm:dataType xsd:integer .
-
-:parameterUnit a samm:Property ;
-  samm:characteristic samm-c:UnitReference .
-
-:ProcessParameterDetails a samm:Entity ;
-  samm:properties ( :parameter ) .
-
-:parameter a samm:Property ;
-  samm:characteristic [
-    a samm-c:SingleEntity ;
-    samm:dataType :Parameter ;
-  ] .
 # end::quantity-declaration[]
 
 # tag::enumeration-simple-declaration-string[]

diff --git a/esmf-semantic-aspect-meta-model/src/main/resources/samm/entity/2.2.0/Quantity.ttl b/esmf-semantic-aspect-meta-model/src/main/resources/samm/entity/2.2.0/Quantity.ttl
@@ -14,8 +14,10 @@
 @prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:2.2.0#> .
 
 samm-e:Quantity a samm:AbstractEntity ;
-  samm:description "A numeric value and the physical unit of the value"@en ;
-  samm:properties ( samm-e:value samm-e:unit ) .
+   samm:preferredName "Quantity"@en ;
+   samm:description "A numeric value and the physical unit of the value."@en ;
+   samm:properties ( samm-e:value samm-e:unit ) .
 
 samm-e:unit a samm:Property ;
-  samm:characteristic samm-c:UnitReference .
+   samm:characteristic samm-c:UnitReference .
+
diff --git a/esmf-semantic-aspect-meta-model/src/test/java/org/eclipse/esmf/samm/AbstractShapeTest.java b/esmf-semantic-aspect-meta-model/src/test/java/org/eclipse/esmf/samm/AbstractShapeTest.java
@@ -16,18 +16,19 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import java.io.StringWriter;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Stream;
 
-import org.apache.jena.rdf.model.Model;
-
 import org.eclipse.esmf.samm.validation.ModelLoader;
 import org.eclipse.esmf.samm.validation.SemanticError;
 import org.eclipse.esmf.samm.validation.ValidationReport;
 import org.eclipse.esmf.samm.validation.Validator;
 
+import org.apache.jena.rdf.model.Model;
+
 public abstract class AbstractShapeTest {
    final static String TEST_NAMESPACE = "org.eclipse.esmf.test";
    final static String TEST_NAMESPACE_VERSION = "1.0.0";
@@ -134,7 +135,7 @@ protected static Stream<KnownVersion> versionsUpToIncluding1_0_0() {
          + "Property's '{$this}' Characteristic's dataType.";
 
    Model loadMetaModelDefinitions( final KnownVersion version ) {
-      return ModelLoader.createModel( List.of(
+      List<String> files = new ArrayList<>( List.of(
             "samm/meta-model/" + version.toVersionString() + "/aspect-meta-model-definitions.ttl",
             "samm/meta-model/" + version.toVersionString() + "/type-conversions.ttl",
             "samm/characteristic/" + version.toVersionString() + "/characteristic-definitions.ttl",
@@ -144,6 +145,12 @@ Model loadMetaModelDefinitions( final KnownVersion version ) {
             "samm/entity/" + version.toVersionString() + "/Point3d.ttl",
             "samm/unit/" + version.toVersionString() + "/units.ttl"
       ) );
+
+      if ( version.isNewerThan( KnownVersion.SAMM_2_1_0 ) ) {
+         files.add( "samm/entity/" + version.toVersionString() + "/Quantity.ttl" );
+      }
+
+      return ModelLoader.createModel( files );
    }
 
    protected void checkValidity( final String path, final String ttlDefinition, final KnownVersion testedVersion ) {

diff --git a/...src/test/resources/samm_2_2_0/quantity/org.eclipse.esmf.test/1.0.0/QuantityTestEntity.ttl b/...src/test/resources/samm_2_2_0/quantity/org.eclipse.esmf.test/1.0.0/QuantityTestEntity.ttl
@@ -11,30 +11,16 @@
 # SPDX-License-Identifier: MPL-2.0
 #
 @prefix : <urn:samm:org.eclipse.esmf.samm.test:1.0.0#> .
-@prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.2.0#> .
 @prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.2.0#> .
+@prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.2.0#> .
 @prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:2.2.0#> .
-@prefix unit: <urn:samm:org.eclipse.esmf.samm:unit:2.2.0#> .
 @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
 
 :Parameter a samm:Entity ;
-  samm:extends samm-e:Quantity ;
-  samm:properties ( :parameterValue :parameterUnit ) .
-
-:parameterValue a samm:Property ;
-  samm:characteristic :ParameterValueCharacteristic .
+   samm:extends samm-e:Quantity ;
+   samm:properties (
+      [ samm:extends samm-e:value ; samm:characteristic :ParameterValueCharacteristic ]
+   ) .
 
 :ParameterValueCharacteristic a samm:Characteristic ;
-  samm:dataType xsd:integer .
-
-:parameterUnit a samm:Property ;
-  samm:characteristic samm-c:UnitReference .
-
-:ProcessParameterDetails a samm:Entity ;
-  samm:properties ( :parameter ) .
-
-:parameter a samm:Property ;
-  samm:characteristic [
-    a samm-c:SingleEntity ;
-    samm:dataType :Parameter ;
-  ] .
+   samm:dataType xsd:integer .