Merged with remote dev

Author: ThomasJejkal

.github/workflows/gradle.yml

@@ -26,12 +26,6 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-    - name: Debug trigger conditions
-      run: |
-        echo "github.event_name=${{ github.event_name }}"
-        echo "github.event.pull_request.head.repo.full_name=${{ github.event.pull_request.head.repo.full_name }}"
-        echo "github.event.pull_request.base.repo.full_name=${{ github.event.pull_request.base.repo.full_name }}"
-        echo "github.event.action=${{ github.event.action }}"
     - uses: actions/checkout@v4
     - name: Set up openJDK version
       uses: actions/setup-java@v4

README.md

@@ -182,7 +182,7 @@ For StaticPreview, the constuctor is a bit different, such that it looks as foll
 File pathToMainPreviewHtml = new File("localPath");
 File pathToAdditionalFiles = new File("localFolder");
 RoCrate roCrate = new RoCrateBuilder("name", "description", "datePublished", "licenseIdentifier")
-    .setPreview(new StaticPreview(pathToMainPreviewHtml, pathToAdditionalFiles)
+    .setPreview(new StaticPreview(pathToMainPreviewHtml, pathToAdditionalFiles))
     .build();
 ```
 

build.gradle

@@ -43,7 +43,7 @@ ext {
 
 dependencies {
     // JUnit setup for testing
-    testImplementation(platform("org.junit:junit-bom:5.12.1"))
+    testImplementation(platform("org.junit:junit-bom:5.12.2"))
     testImplementation('org.junit.jupiter:junit-jupiter')
     testRuntimeOnly('org.junit.platform:junit-platform-launcher')
     // JSON object mapping / (de-)serialization
@@ -52,7 +52,7 @@ dependencies {
     // http client
     implementation group: 'org.apache.httpcomponents', name: 'httpclient', version: '4.5.14'
     // common file system operations
-    implementation group: 'commons-io', name: 'commons-io', version: '2.18.0'
+    implementation group: 'commons-io', name: 'commons-io', version: '2.19.0'
     // read from and write to zip files
     implementation group: 'net.lingala.zip4j', name: 'zip4j', version: '2.11.5'
     // compare json documents in tests

ro-crate-preview.html

@@ -2,6 +2,7 @@
 
 import java.io.File;
 import java.util.Collection;
+import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
 
@@ -51,6 +52,25 @@ public interface Crate {
 
   void setMetadataContext(CrateMetadataContext metadataContext);
 
+  /**
+   * Get the value of a key from the metadata context.
+   * @param key the key to be searched
+   * @return the value of the key, null if not found
+   */
+  String getMetadataContextValueOf(String key);
+
+  /**
+   * Get an immutable collection of the keys in the metadata context.
+   * @return the keys in the metadata context
+   */
+  Set<String> getMetadataContextKeys();
+
+  /**
+   * Get an immutable map of the context.
+   * @return an immutable map containing the context key-value pairs
+   */
+  Map<String, String> getMetadataContextPairs();
+
   RootDataEntity getRootDataEntity();
 
   void setRootDataEntity(RootDataEntity rootDataEntity);

src/main/java/edu/kit/datamanager/ro_crate/Crate.java

@@ -71,6 +71,20 @@ public void setMetadataContext(CrateMetadataContext metadataContext) {
     }
 
     @Override
+    public String getMetadataContextValueOf(String key) {
+        return this.metadataContext.getValueOf(key);
+    }
+
+    @Override
+    public Set<String> getMetadataContextKeys() {
+        return this.metadataContext.getKeys();
+    }
+
+    @Override
+    public Map<String, String> getMetadataContextPairs() {
+        return this.metadataContext.getPairs();
+    }
+
     public ContextualEntity getJsonDescriptor() {
         return jsonDescriptor;
     }

src/main/java/edu/kit/datamanager/ro_crate/RoCrate.java

@@ -4,6 +4,9 @@
 
 import edu.kit.datamanager.ro_crate.entities.AbstractEntity;
 
+import java.util.Map;
+import java.util.Set;
+
 /**
  * Interface for the metadata context.
  * Most often in an ROCrate this is the default context,
@@ -22,6 +25,25 @@ public interface CrateMetadataContext {
 
   void addToContext(String key, String value);
 
+  /**
+   * Get the value of a key from the context.
+   * @param key the key to be searched
+   * @return the value of the key, null if not found
+   */
+  String getValueOf(String key);
+
+  /**
+   * Get an immutable collection of the keys in the metadata context.
+   * @return the keys in the metadata context
+   */
+  Set<String> getKeys();
+
+  /**
+  * Get an immutable map of the context.
+  * @return an immutable map containing the context key-value pairs
+  */
+  Map<String, String> getPairs();
+
   void deleteValuePairFromContext(String key);
 
   void deleteUrlFromContext(String url);

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

@@ -31,7 +31,7 @@ public class RoCrateMetadataContext implements CrateMetadataContext {
   protected static final String DEFAULT_CONTEXT_LOCATION = "default_context/version1.1.json";
   protected static JsonNode defaultContext = null;
 
-  protected final Set<String> url = new HashSet<>();
+  protected final Set<String> urls = new HashSet<>();
   protected final HashMap<String, String> contextMap = new HashMap<>();
   // we need to keep the ones that are no coming from url
   // for the final representation
@@ -89,7 +89,7 @@ public ObjectNode getContextJsonEntity() {
     ArrayNode array = objectMapper.createArrayNode();
     ObjectNode jsonNode = objectMapper.createObjectNode();
     ObjectNode finalNode = objectMapper.createObjectNode();
-    for (String e : url) {
+    for (String e : urls) {
       array.add(e);
     }
     for (Map.Entry<String, String> s : other.entrySet()) {
@@ -156,7 +156,7 @@ public boolean checkEntity(AbstractEntity entity) {
 
   @Override
   public void addToContextFromUrl(String url) {
-    this.url.add(url);
+    this.urls.add(url);
 
     ObjectMapper objectMapper = MyObjectMapper.getMapper();
 
@@ -200,6 +200,29 @@ public void addToContext(String key, String value) {
     this.other.put(key, value);
   }
 
+  @Override
+  public String getValueOf(String key) {
+    return Optional.ofNullable(this.contextMap.get(key))
+            .orElseGet(() -> this.other.get(key));
+  }
+
+  @Override
+  public Set<String> getKeys() {
+    List<String> merged = new ArrayList<>();
+    merged.addAll(this.contextMap.keySet());
+    merged.addAll(this.other.keySet());
+    return Set.copyOf(merged);
+  }
+
+  @Override
+  public Map<String, String> getPairs() {
+    Map<String, String> merged = new HashMap<>();
+    merged.putAll(this.contextMap);
+    merged.putAll(this.other);
+    return Map.copyOf(merged);
+  }
+
+
   @Override
   public void deleteValuePairFromContext(String key) {
     this.contextMap.remove(key);
@@ -208,7 +231,7 @@ public void deleteValuePairFromContext(String key) {
 
   @Override
   public void deleteUrlFromContext(String url) {
-    this.url.remove(url);
+    this.urls.remove(url);
   }
 
 }