overload open and create for Path and String arguments

Author: brokkoli71

src/main/java/dev/zarr/zarrjava/core/Array.java

@@ -1,6 +1,7 @@
 package dev.zarr.zarrjava.core;
 
 import dev.zarr.zarrjava.ZarrException;
+import dev.zarr.zarrjava.store.FilesystemStore;
 import dev.zarr.zarrjava.store.StoreHandle;
 import dev.zarr.zarrjava.utils.IndexingUtils;
 import dev.zarr.zarrjava.utils.MultiArrayUtils;
@@ -12,6 +13,8 @@
 import javax.annotation.Nullable;
 import java.io.IOException;
 import java.nio.ByteBuffer;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.Arrays;
 import java.util.stream.Stream;
 
@@ -44,7 +47,27 @@ public static Array open(StoreHandle storeHandle) throws IOException, ZarrExcept
             throw new ZarrException("No Zarr array found at the specified location.");
         }
     }
+     /**
+     * Opens an existing Zarr array at a specified storage location. Automatically detects the Zarr version.
+     *
+     * @param path the storage location of the Zarr array
+     * @throws IOException   throws IOException if the metadata cannot be read
+     * @throws ZarrException throws ZarrException if the Zarr array cannot be opened
+     */
+    public static Array open(Path path) throws IOException, ZarrException {
+        return open(new StoreHandle(new FilesystemStore(path)));
+    }
 
+    /**
+     * Opens an existing Zarr array at a specified storage location. Automatically detects the Zarr version.
+     *
+     * @param path the storage location of the Zarr array
+     * @throws IOException   throws IOException if the metadata cannot be read
+     * @throws ZarrException throws ZarrException if the Zarr array cannot be opened
+     */
+    public static Array open(String path) throws IOException, ZarrException {
+        return open(Paths.get(path));
+    }
 
     /**
      * Writes a ucar.ma2.Array into the Zarr array at a specified offset. The shape of the Zarr array
@@ -357,4 +380,4 @@ public void write(@Nonnull ucar.ma2.Array content) throws ZarrException {
         }
 
     }
-}
+}

src/main/java/dev/zarr/zarrjava/core/Group.java

@@ -1,11 +1,14 @@
 package dev.zarr.zarrjava.core;
 
 import dev.zarr.zarrjava.ZarrException;
+import dev.zarr.zarrjava.store.FilesystemStore;
 import dev.zarr.zarrjava.store.StoreHandle;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.Objects;
 import java.util.stream.Stream;
 
@@ -38,6 +41,28 @@ public static Group open(StoreHandle storeHandle) throws IOException, ZarrExcept
     }
 
 
+    /**
+     * Opens an existing Zarr group at a specified storage location. Automatically detects the Zarr version.
+     *
+     * @param path the storage location of the Zarr group
+     * @throws IOException   throws IOException if the metadata cannot be read
+     * @throws ZarrException throws ZarrException if the Zarr group cannot be opened
+     */
+    public static Group open(Path path) throws IOException, ZarrException {
+        return open(new StoreHandle(new FilesystemStore(path)));
+    }
+
+    /**
+     * Opens an existing Zarr group at a specified storage location. Automatically detects the Zarr version.
+     *
+     * @param path the storage location of the Zarr group
+     * @throws IOException   throws IOException if the metadata cannot be read
+     * @throws ZarrException throws ZarrException if the Zarr group cannot be opened
+     */
+    public static Group open(String path) throws IOException, ZarrException {
+        return open(Paths.get(path));
+    }
+
     @Nullable
     public abstract Node get(String key) throws ZarrException;
 

src/main/java/dev/zarr/zarrjava/core/Node.java

@@ -1,10 +1,13 @@
 package dev.zarr.zarrjava.core;
 
 import dev.zarr.zarrjava.ZarrException;
+import dev.zarr.zarrjava.store.FilesystemStore;
 import dev.zarr.zarrjava.store.StoreHandle;
 
 import java.io.IOException;
 import java.nio.file.NoSuchFileException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 
 public interface Node {
 
@@ -33,5 +36,27 @@ static Node open(StoreHandle storeHandle) throws IOException, ZarrException {
             throw new NoSuchFileException("No Zarr node found at " + storeHandle);
         }
     }
+
+    /**
+     * Opens an existing Zarr array or group at a specified storage location. Automatically detects the Zarr version.
+     *
+     * @param path the storage location of the Zarr array
+     * @throws IOException   throws IOException if the metadata cannot be read
+     * @throws ZarrException throws ZarrException if the Zarr array cannot be opened
+     */
+    static Node open(Path path) throws IOException, ZarrException {
+        return open(new StoreHandle(new FilesystemStore(path)));
+    }
+
+    /**
+     * Opens an existing Zarr array or group at a specified storage location. Automatically detects the Zarr version.
+     *
+     * @param path the storage location of the Zarr array
+     * @throws IOException   throws IOException if the metadata cannot be read
+     * @throws ZarrException throws ZarrException if the Zarr array cannot be opened
+     */
+    static Node open(String path) throws IOException, ZarrException {
+        return open(Paths.get(path));
+    }
 }
 

src/main/java/dev/zarr/zarrjava/v2/Array.java

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import dev.zarr.zarrjava.ZarrException;
+import dev.zarr.zarrjava.store.FilesystemStore;
 import dev.zarr.zarrjava.store.StoreHandle;
 import dev.zarr.zarrjava.utils.Utils;
 import dev.zarr.zarrjava.core.codec.CodecPipeline;
@@ -11,6 +12,8 @@
 import javax.annotation.Nonnull;
 import java.io.IOException;
 import java.nio.ByteBuffer;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.Arrays;
 import java.util.function.Function;
 import java.util.stream.Collectors;
@@ -53,7 +56,57 @@ public static Array open(StoreHandle storeHandle) throws IOException, ZarrExcept
     );
   }
 
+  /**
+   * Opens an existing Zarr array at a specified storage location.
+   *
+   * @param path the storage location of the Zarr array
+   * @throws IOException throws IOException if the metadata cannot be read
+   * @throws ZarrException throws ZarrException if the Zarr array cannot be opened
+   */
+  public static Array open(Path path) throws IOException, ZarrException {
+    return open(new StoreHandle(new FilesystemStore(path)));
+  }
+
+    /**
+     * Opens an existing Zarr array at a specified storage location.
+     *
+     * @param path the storage location of the Zarr array
+     * @throws IOException throws IOException if the metadata cannot be read
+     * @throws ZarrException throws ZarrException if the Zarr array cannot be opened
+     */
+    public static Array open(String path) throws IOException, ZarrException {
+      return open(Paths.get(path));
+    }
+
+  /**
+   * Creates a new Zarr array with the provided metadata at a specified storage location. This
+   * method will raise an exception if a Zarr array already exists at the specified storage
+   * location.
+   *
+   * @param path the storage location of the Zarr array
+   * @param arrayMetadata the metadata of the Zarr array
+   * @throws IOException if the metadata cannot be serialized
+   * @throws ZarrException if the Zarr array cannot be created
+   */
+  public static Array create(Path path, ArrayMetadata arrayMetadata)
+      throws IOException, ZarrException {
+      return create(new StoreHandle(new FilesystemStore(path)), arrayMetadata);
+  }
 
+  /**
+   * Creates a new Zarr array with the provided metadata at a specified storage location. This
+   * method will raise an exception if a Zarr array already exists at the specified storage
+   * location.
+   *
+   * @param path the storage location of the Zarr array
+   * @param arrayMetadata the metadata of the Zarr array
+   * @throws IOException if the metadata cannot be serialized
+   * @throws ZarrException if the Zarr array cannot be created
+   */
+  public static Array create(String path, ArrayMetadata arrayMetadata)
+      throws IOException, ZarrException {
+      return create(Paths.get(path), arrayMetadata);
+  }
   /**
    * Creates a new Zarr array with the provided metadata at a specified storage location. This
    * method will raise an exception if a Zarr array already exists at the specified storage

src/main/java/dev/zarr/zarrjava/v2/Group.java

@@ -2,13 +2,16 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import dev.zarr.zarrjava.ZarrException;
+import dev.zarr.zarrjava.store.FilesystemStore;
 import dev.zarr.zarrjava.store.StoreHandle;
 import dev.zarr.zarrjava.utils.Utils;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import java.io.IOException;
 import java.nio.ByteBuffer;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.function.Function;
 import static dev.zarr.zarrjava.v2.Node.makeObjectMapper;
 
@@ -27,6 +30,14 @@ public static Group open(@Nonnull StoreHandle storeHandle) throws IOException {
         .readValue(Utils.toArray(metadataBytes), GroupMetadata.class));
   }
 
+  public static Group open(Path path) throws IOException {
+      return open(new StoreHandle(new FilesystemStore(path)));
+    }
+
+    public static Group open(String path) throws IOException {
+      return open(Paths.get(path));
+    }
+
   public static Group create(
       @Nonnull StoreHandle storeHandle, @Nonnull GroupMetadata groupMetadata
   ) throws IOException {
@@ -39,7 +50,23 @@ public static Group create(
   public static Group create(
       @Nonnull StoreHandle storeHandle
   ) throws IOException, ZarrException {
-    return new Group(storeHandle, new GroupMetadata());
+    return create(storeHandle, new GroupMetadata());
+  }
+
+  public static Group create(Path path, GroupMetadata groupMetadata) throws IOException {
+    return create(new StoreHandle(new FilesystemStore(path)), groupMetadata);
+  }
+
+  public static Group create(String path, GroupMetadata groupMetadata) throws IOException {
+    return create(Paths.get(path), groupMetadata);
+  }
+
+  public static Group create(Path path) throws IOException, ZarrException {
+    return create(new StoreHandle(new FilesystemStore(path)));
+  }
+
+  public static Group create(String path) throws IOException, ZarrException {
+    return create(Paths.get(path));
   }
 
   @Nullable

src/main/java/dev/zarr/zarrjava/v2/Node.java

@@ -3,11 +3,14 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
 import dev.zarr.zarrjava.ZarrException;
+import dev.zarr.zarrjava.store.FilesystemStore;
 import dev.zarr.zarrjava.store.StoreHandle;
 import dev.zarr.zarrjava.v2.codec.CodecRegistry;
 
 import java.io.IOException;
 import java.nio.file.NoSuchFileException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 
 public interface Node extends dev.zarr.zarrjava.core.Node {
 
@@ -42,4 +45,12 @@ static Node open(StoreHandle storeHandle) throws IOException, ZarrException {
     }
     throw new NoSuchFileException("Store handle '" + storeHandle + "' does not contain a " + ZGROUP + " or a " + ZARRAY + " file.");
   }
+
+  static Node open(Path path) throws IOException, ZarrException {
+    return open(new StoreHandle(new FilesystemStore(path)));
+  }
+
+  static Node open(String path) throws IOException, ZarrException {
+    return open(Paths.get(path));
+  }
 }

src/main/java/dev/zarr/zarrjava/v3/Array.java

@@ -2,11 +2,14 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import dev.zarr.zarrjava.ZarrException;
+import dev.zarr.zarrjava.store.FilesystemStore;
 import dev.zarr.zarrjava.store.StoreHandle;
 import dev.zarr.zarrjava.utils.Utils;
 import dev.zarr.zarrjava.core.codec.CodecPipeline;
 import java.io.IOException;
 import java.nio.ByteBuffer;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
@@ -47,6 +50,58 @@ public static Array open(StoreHandle storeHandle) throws IOException, ZarrExcept
     );
   }
 
+  /**
+     * Opens an existing Zarr array at a specified storage location using a Path.
+     *
+     * @param path the storage location of the Zarr array
+     * @throws IOException if the metadata cannot be read
+     * @throws ZarrException if the Zarr array cannot be opened
+     */
+    public static Array open(Path path) throws IOException, ZarrException {
+      return open(new FilesystemStore(path).resolve());
+    }
+
+    /**
+     * Opens an existing Zarr array at a specified storage location using a String path.
+     *
+     * @param path the storage location of the Zarr array
+     * @throws IOException if the metadata cannot be read
+     * @throws ZarrException if the Zarr array cannot be opened
+     */
+    public static Array open(String path) throws IOException, ZarrException {
+      return open(Paths.get(path));
+    }
+
+  /**
+   * Creates a new Zarr array with the provided metadata at a specified storage location. This
+   * method will raise an exception if a Zarr array already exists at the specified storage
+   * location.
+   *
+   * @param path the storage location of the Zarr array
+   * @param arrayMetadata the metadata of the Zarr array
+   * @throws IOException if the metadata cannot be serialized
+   * @throws ZarrException if the Zarr array cannot be created
+   */
+  public static Array create(Path path, ArrayMetadata arrayMetadata)
+      throws IOException, ZarrException {
+    return Array.create(new FilesystemStore(path).resolve(), arrayMetadata);
+  }
+
+  /**
+   * Creates a new Zarr array with the provided metadata at a specified storage location. This
+   * method will raise an exception if a Zarr array already exists at the specified storage
+   * location.
+   *
+   * @param path the storage location of the Zarr array
+   * @param arrayMetadata the metadata of the Zarr array
+   * @throws IOException if the metadata cannot be serialized
+   * @throws ZarrException if the Zarr array cannot be created
+   */
+  public static Array create(String path, ArrayMetadata arrayMetadata)
+      throws IOException, ZarrException {
+    return Array.create(Paths.get(path), arrayMetadata);
+  }
+
   /**
    * Creates a new Zarr array with the provided metadata at a specified storage location. This
    * method will raise an exception if a Zarr array already exists at the specified storage
@@ -106,6 +161,16 @@ public static Array create(StoreHandle storeHandle,
         arrayMetadataBuilderMapper.apply(new ArrayMetadataBuilder()).build(), existsOk);
   }
 
+  public static Array create(Path path, Function<ArrayMetadataBuilder, ArrayMetadataBuilder> arrayMetadataBuilderMapper, boolean existsOk)
+      throws IOException, ZarrException {
+    return Array.create(new FilesystemStore(path).resolve(), arrayMetadataBuilderMapper, existsOk);
+  }
+
+  public static Array create(String path, Function<ArrayMetadataBuilder, ArrayMetadataBuilder> arrayMetadataBuilderMapper, boolean existsOk)
+      throws IOException, ZarrException {
+    return Array.create(Paths.get(path), arrayMetadataBuilderMapper, existsOk);
+  }
+
   @Nonnull
   public static ArrayMetadataBuilder metadataBuilder() {
     return new ArrayMetadataBuilder();