org.janelia.saalfeldlab.n5.shard

Interface PositionValueAccess

All Known Implementing Classes:

PositionValueAccess.KvaPositionValueAccess

public interface PositionValueAccess

Wrap a KeyValueAccess and a dataset URI to be able to get/set values (ReadData) by long[] key indicating the position of a top-level DataBlock (a top-level shard for sharded datasets, a chunk for non-sharded datasets).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PositionValueAccess.KvaPositionValueAccess

Method Summary

Modifier and Type	Method and Description
boolean	exists(long[] key)
static PositionValueAccess	fromKva(KeyValueAccess kva, URI uri, String normalPath, DatasetAttributes attributes)
VolatileReadData	get(long[] key) Gets the VolatileReadData for the DataBlock at the given position in the block grid.
boolean	remove(long[] key)
void	set(long[] key, ReadData data) Write the data for a DataBlock to the given position in the block grid.

Method Detail

get

VolatileReadData get(long[] key)
              throws N5Exception.N5IOException

Gets the VolatileReadData for the DataBlock at the given position in the block grid.

If the requested key does not exist, either null is returned or a lazy VolatileReadData that will throw N5NoSuchKeyException when trying to materialize.

Parameters:

key - The position of the block

Returns:

ReadData for the given key or null if the key doesn't exist

Throws:

N5Exception.N5IOException - if an error occurs while reading

set

void set(long[] key,
         ReadData data)
  throws N5Exception.N5IOException

Write the data for a DataBlock to the given position in the block grid.

Parameters:

key - The grid position of the DataBlock to write

data - The data to write

Throws:

N5Exception.N5IOException - if an error occurs while writing

exists

boolean exists(long[] key)
        throws N5Exception.N5IOException

Throws:

N5Exception.N5IOException

remove

boolean remove(long[] key)
        throws N5Exception.N5IOException

Throws:

N5Exception.N5IOException

fromKva

static PositionValueAccess fromKva(KeyValueAccess kva,
                                   URI uri,
                                   String normalPath,
                                   DatasetAttributes attributes)