Package dev.zarr.zarrjava.v3

Class Group

java.lang.Object

dev.zarr.zarrjava.core.AbstractNode

dev.zarr.zarrjava.core.Group

dev.zarr.zarrjava.v3.Group

All Implemented Interfaces:

Node, Node

public class Group
extends Group
implements Node

Field Summary

Fields

Modifier and Type	Field	Description
GroupMetadata	metadata

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

storeHandle

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

ZARR_JSON, ZARRAY, ZATTRS, ZGROUP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Group(StoreHandle storeHandle, GroupMetadata groupMetadata)

Method Summary

Modifier and Type	Method	Description
static Group	create(StoreHandle storeHandle)
static Group	create(StoreHandle storeHandle, Attributes attributes)
static Group	create(StoreHandle storeHandle, GroupMetadata groupMetadata)
static Group	create(String path)
static Group	create(String path, GroupMetadata groupMetadata)
static Group	create(Path path)
static Group	create(Path path, GroupMetadata groupMetadata)
Array	createArray(String key, ArrayMetadata arrayMetadata)
Array	createArray(String key, Function<ArrayMetadataBuilder,ArrayMetadataBuilder> arrayMetadataBuilderMapper)
Group	createGroup(String key)
Group	createGroup(String key, Attributes attributes)
Group	createGroup(String key, GroupMetadata groupMetadata)
Node	get(String key)
GroupMetadata	metadata()
static Group	open(StoreHandle storeHandle)	Opens an existing Zarr array or group at a specified storage location.
static Group	open(String path)	Opens an existing Zarr array or group at a specified storage location.
static Group	open(Path path)	Opens an existing Zarr array or group at a specified storage location.
Group	setAttributes(Attributes newAttributes)
String	toString()
Group	updateAttributes(Function<Attributes,Attributes> attributeMapper)

Methods inherited from class dev.zarr.zarrjava.core.Group

list, listAsArray

Methods inherited from class java.lang.Object

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

Field Details

metadata

public GroupMetadata metadata

Constructor Details

Group

protected Group(@Nonnull
 StoreHandle storeHandle,
 @Nonnull
 GroupMetadata groupMetadata)
         throws IOException

Throws:

IOException

Method Details

open

public static Group open(@Nonnull
 StoreHandle storeHandle)
                  throws IOException

Description copied from interface: Node

Opens an existing Zarr array or group at a specified storage location.

Parameters:

storeHandle - the storage location of the Zarr array or group

Throws:

IOException - throws IOException if the metadata cannot be read

open

public static Group open(Path path)
                  throws IOException

Description copied from interface: Node

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

Parameters:

path - the storage location of the Zarr array

Throws:

IOException - throws IOException if the metadata cannot be read

open

public static Group open(String path)
                  throws IOException

Description copied from interface: Node

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

Parameters:

path - the storage location of the Zarr array

Throws:

IOException - throws IOException if the metadata cannot be read

create

public static Group create(@Nonnull
 StoreHandle storeHandle,
 @Nonnull
 GroupMetadata groupMetadata)
                    throws IOException

Throws:

IOException

create

public static Group create(@Nonnull
 StoreHandle storeHandle,
 @Nonnull
 Attributes attributes)
                    throws IOException,
ZarrException

Throws:

IOException

ZarrException

create

public static Group create(@Nonnull
 StoreHandle storeHandle)
                    throws IOException,
ZarrException

Throws:

IOException

ZarrException

create

public static Group create(Path path,
 GroupMetadata groupMetadata)
                    throws IOException,
ZarrException

Throws:

IOException

ZarrException

create

public static Group create(String path,
 GroupMetadata groupMetadata)
                    throws IOException,
ZarrException

Throws:

IOException

ZarrException

create

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

Throws:

IOException

ZarrException

create

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

Throws:

IOException

ZarrException

get

@Nullable
public Node get(String key)
         throws ZarrException

Specified by:

get in class Group

Throws:

ZarrException

createGroup

public Group createGroup(String key,
 GroupMetadata groupMetadata)
                  throws IOException,
ZarrException

Throws:

IOException

ZarrException

createGroup

public Group createGroup(String key,
 Attributes attributes)
                  throws IOException,
ZarrException

Throws:

IOException

ZarrException

createGroup

public Group createGroup(String key)
                  throws IOException,
ZarrException

Throws:

IOException

ZarrException

createArray

public Array createArray(String key,
 ArrayMetadata arrayMetadata)
                  throws IOException,
ZarrException

Throws:

IOException

ZarrException

createArray

public Array createArray(String key,
 Function<ArrayMetadataBuilder,ArrayMetadataBuilder> arrayMetadataBuilderMapper)
                  throws IOException,
ZarrException

Throws:

IOException

ZarrException

setAttributes

public Group setAttributes(Attributes newAttributes)
                    throws ZarrException,
IOException

Throws:

ZarrException

IOException

updateAttributes

public Group updateAttributes(Function<Attributes,Attributes> attributeMapper)
                       throws ZarrException,
IOException

Throws:

ZarrException

IOException

toString

public String toString()

Overrides:

toString in class Object

metadata

public GroupMetadata metadata()

Specified by:

metadata in class Group