Package dev.zarr.zarrjava.v2

Class Array

java.lang.Object

dev.zarr.zarrjava.v2.Array

All Implemented Interfaces:

Array

public class Array
extends Object
implements Array

Nested Class Summary

Nested classes/interfaces inherited from interface dev.zarr.zarrjava.core.Array

Array.ArrayAccessor

Field Summary

Fields

Modifier and Type	Field	Description
ArrayMetadata	metadata
StoreHandle	storeHandle

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Array(StoreHandle storeHandle, ArrayMetadata arrayMetadata)

Method Summary

Modifier and Type	Method	Description
CodecPipeline	codecPipeline()
static Array	create(StoreHandle storeHandle, ArrayMetadata arrayMetadata)	Creates a new Zarr array with the provided metadata at a specified storage location.
static Array	create(StoreHandle storeHandle, ArrayMetadata arrayMetadata, boolean existsOk)	Creates a new Zarr array with the provided metadata at a specified storage location.
static Array	create(StoreHandle storeHandle, Function<ArrayMetadataBuilder,ArrayMetadataBuilder> arrayMetadataBuilderMapper, boolean existsOk)
static com.fasterxml.jackson.databind.ObjectMapper	makeObjectMapper()
ArrayMetadata	metadata()
static ArrayMetadataBuilder	metadataBuilder()
static ArrayMetadataBuilder	metadataBuilder(ArrayMetadata existingMetadata)
static Array	open(StoreHandle storeHandle)	Opens an existing Zarr array at a specified storage location.
StoreHandle	storeHandle()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.zarr.zarrjava.core.Array

access, chunkIsInArray, read, read, read, read, readChunk, write, write, write, write, writeChunk

Field Details

metadata

public ArrayMetadata metadata

storeHandle

public StoreHandle storeHandle

Constructor Details

Array

protected Array(StoreHandle storeHandle,
 ArrayMetadata arrayMetadata)
         throws IOException,
ZarrException

Throws:

IOException

ZarrException

Method Details

open

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

Opens an existing Zarr array at a specified storage location.

Parameters:

storeHandle - the storage location of the Zarr array

Throws:

IOException - throws IOException if the metadata cannot be read

ZarrException - throws ZarrException if the Zarr array cannot be opened

makeObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper makeObjectMapper()

create

public static Array create(StoreHandle storeHandle,
 ArrayMetadata arrayMetadata)
                    throws IOException,
ZarrException

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.

Parameters:

storeHandle - the storage location of the Zarr array

arrayMetadata - the metadata of the Zarr array

Throws:

IOException - if the metadata cannot be serialized

ZarrException - if the Zarr array cannot be created

create

public static Array create(StoreHandle storeHandle,
 ArrayMetadata arrayMetadata,
 boolean existsOk)
                    throws IOException,
ZarrException

Creates a new Zarr array with the provided metadata at a specified storage location. If `existsOk` is false, this method will raise an exception if a Zarr array already exists at the specified storage location.

Parameters:

storeHandle - the storage location of the Zarr array

arrayMetadata - the metadata of the Zarr array

existsOk - if true, no exception is raised if the Zarr array already exists

Throws:

IOException - throws IOException if the metadata cannot be serialized

ZarrException - throws ZarrException if the Zarr array cannot be created

create

public static Array create(StoreHandle storeHandle,
 Function<ArrayMetadataBuilder,ArrayMetadataBuilder> arrayMetadataBuilderMapper,
 boolean existsOk)
                    throws IOException,
ZarrException

Throws:

IOException

ZarrException

metadataBuilder

@Nonnull
public static ArrayMetadataBuilder metadataBuilder()

metadataBuilder

@Nonnull
public static ArrayMetadataBuilder metadataBuilder(ArrayMetadata existingMetadata)

toString

public String toString()

Overrides:

toString in class Object

metadata

public ArrayMetadata metadata()

Specified by:

metadata in interface Array

storeHandle

public StoreHandle storeHandle()

Specified by:

storeHandle in interface Array

codecPipeline

public CodecPipeline codecPipeline()

Specified by:

codecPipeline in interface Array