Package dev.zarr.zarrjava.core

Class Group

java.lang.Object

dev.zarr.zarrjava.core.AbstractNode

dev.zarr.zarrjava.core.Group

All Implemented Interfaces:

Node

Direct Known Subclasses:

Group, Group

public abstract class Group
extends AbstractNode

Field Summary

Fields inherited from class dev.zarr.zarrjava.core.AbstractNode

storeHandle

Fields inherited from interface dev.zarr.zarrjava.core.Node

ZARR_JSON, ZARRAY, ZGROUP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Group(StoreHandle storeHandle)

Method Summary

Modifier and Type	Method	Description
abstract Node	get(String key)
Stream<Node>	list()
Node[]	listAsArray()
static Group	open(StoreHandle storeHandle)	Opens an existing Zarr group at a specified storage location.
static Group	open(String path)	Opens an existing Zarr group at a specified storage location.
static Group	open(Path path)	Opens an existing Zarr group at a specified storage location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Group

protected Group(@Nonnull
 StoreHandle storeHandle)

Method Details

open

public static Group open(StoreHandle storeHandle)
                  throws IOException,
ZarrException

Opens an existing Zarr group at a specified storage location. Automatically detects the Zarr version.

Parameters:

storeHandle - the storage location of the Zarr group

Throws:

IOException - throws IOException if the metadata cannot be read

ZarrException - throws ZarrException if the Zarr group cannot be opened

open

public static Group open(Path path)
                  throws IOException,
ZarrException

Opens an existing Zarr group at a specified storage location. Automatically detects the Zarr version.

Parameters:

path - the storage location of the Zarr group

Throws:

IOException - throws IOException if the metadata cannot be read

ZarrException - throws ZarrException if the Zarr group cannot be opened

open

public static Group open(String path)
                  throws IOException,
ZarrException

Opens an existing Zarr group at a specified storage location. Automatically detects the Zarr version.

Parameters:

path - the storage location of the Zarr group

Throws:

IOException - throws IOException if the metadata cannot be read

ZarrException - throws ZarrException if the Zarr group cannot be opened

get

@Nullable
public abstract Node get(String key)
                  throws ZarrException

Throws:

ZarrException

list

public Stream<Node> list()

listAsArray

public Node[] listAsArray()