Merge pull request #188 from kit-data-manager/fix-#6-reserved-keywords-warnings

Fix invalid context check warnings

Author: Pfeil

src/main/java/edu/kit/datamanager/ro_crate/context/RoCrateMetadataContext.java

@@ -10,12 +10,10 @@
 import edu.kit.datamanager.ro_crate.objectmapper.MyObjectMapper;
 
 import java.io.IOException;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Collection;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
 import java.util.function.Consumer;
+
+import edu.kit.datamanager.ro_crate.special.IdentifierUtils;
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.client.methods.HttpGet;
 import org.apache.http.impl.client.CloseableHttpClient;
@@ -119,7 +117,22 @@ public boolean checkEntity(AbstractEntity entity) {
         new TypeReference<>() {
         });
     // check if the items in the array of types are present in the context
-    for (var s : types) {
+    for (String s : types) {
+      // special cases:
+      if (s.equals("@id")) {
+        // @id will refer to the value of the id of the node
+        // so we need to extract this value
+        s = entity.getId();
+      }
+      if (s.equals("@json")) {
+        // A linked data builtin type, which is fine.
+        continue;
+      }
+      if (IdentifierUtils.isUrl(s)) {
+        // full URLs are considered fine
+        continue;
+      }
+
       if (this.contextMap.get(s) == null) {
         System.err.println("type " + s + " is missing from the context!");
         return false;
@@ -129,8 +142,12 @@ public boolean checkEntity(AbstractEntity entity) {
     // check if the fields of the entity are present in the context
     for (var names = node.fieldNames(); names.hasNext();) {
       String s = names.next();
+      if (IdentifierUtils.isUrl(s)) {
+        // full URLs are considered fine
+        continue;
+      }
       if (this.contextMap.get(s) == null) {
-        System.err.println("entity " + s + " is missing from context;");
+        System.err.println("attribute name " + s + " is missing from context;");
         return false;
       }
     }

src/main/java/edu/kit/datamanager/ro_crate/special/IdentifierUtils.java

@@ -51,7 +51,7 @@ public static boolean isValidUri(String uri) {
     public static boolean isUrl(String uri) {
         try {
             return encode(uri)
-                    .map(decodedUri -> asUrl(decodedUri).isPresent())
+                    .map(encodedUri -> asUrl(encodedUri).isPresent())
                     .orElse(false);
         } catch (Exception e) {
             return false;

src/test/java/edu/kit/datamanager/ro_crate/context/ContextTest.java

@@ -6,6 +6,7 @@
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
 import edu.kit.datamanager.ro_crate.HelpFunctions;
+import edu.kit.datamanager.ro_crate.entities.AbstractEntity;
 import edu.kit.datamanager.ro_crate.entities.contextual.ContextualEntity;
 import edu.kit.datamanager.ro_crate.entities.data.DataEntity;
 import edu.kit.datamanager.ro_crate.objectmapper.MyObjectMapper;
@@ -190,4 +191,37 @@ void creationFromUrlAndPairsTest() {
     // house is in the context
     assertTrue(newContext.checkEntity(data));
   }
+
+  @Test
+  void testIdType() {
+    AbstractEntity validEntity = new DataEntity.DataEntityBuilder()
+            .setId("Airline")  // this is defined in the context!
+            .addType("@id")  // this is a JSON-LD feature to refer to the ID ("Airline") as a type
+            .addType("@json")  // this is a JSON-LD built-in type
+            .build();
+    assertTrue(this.context.checkEntity(validEntity));
+
+    AbstractEntity invalidEntity = new DataEntity.DataEntityBuilder()
+            .setId("Something which is definitely not in the context")
+            .addType("@id")
+            .build();
+    assertFalse(this.context.checkEntity(invalidEntity));
+  }
+
+  @Test
+  void testJsonType() {
+    AbstractEntity validEntity = new DataEntity.DataEntityBuilder()
+            .addType("@json")  // this is a JSON-LD built-in type
+            .build();
+    assertTrue(this.context.checkEntity(validEntity));
+  }
+
+  @Test
+  void testAbsoluteUrlType() {
+    AbstractEntity validEntity = new DataEntity.DataEntityBuilder()
+            .addType("http://example.org/Person")  // this is not in the context!
+            .addProperty("http://example.org/Thing", "Some thing")
+            .build();
+    assertTrue(this.context.checkEntity(validEntity));
+  }
 }