org.janelia.saalfeldlab.n5.cache

Interface N5JsonCacheableContainer

All Known Subinterfaces:

CachedGsonKeyValueN5Reader, CachedGsonKeyValueN5Writer

All Known Implementing Classes:

N5FSReader, N5FSWriter, N5KeyValueReader, N5KeyValueWriter

public interface N5JsonCacheableContainer

An N5 container whose structure and attributes can be cached.

Implementations of interface methods must explicitly query the backing storage unless noted otherwise. Cached implementations (e.g CachedGsonKeyValueN5Reader) call these methods to update their N5JsonCache. Corresponding N5Reader methods should use the cache, if present.

Method Summary

Modifier and Type	Method and Description
boolean	existsFromContainer(String normalPathName, String normalCacheKey) Query whether a resource exists in this container.
com.google.gson.JsonElement	getAttributesFromContainer(String normalPathName, String normalCacheKey) Returns a JsonElement containing attributes at a given path, for a given cache key.
boolean	isDatasetFromAttributes(String normalCacheKey, com.google.gson.JsonElement attributes) Returns true if a path is a dataset, given that the the given attributes exist for the given cache key.
boolean	isDatasetFromContainer(String normalPathName) Query whether a path in this container is a dataset.
boolean	isGroupFromAttributes(String normalCacheKey, com.google.gson.JsonElement attributes) Returns true if a path is a group, given that the the given attributes exist for the given cache key.
boolean	isGroupFromContainer(String normalPathName) Query whether a path in this container is a group.
String[]	listFromContainer(String normalPathName) List the children of a path for this container.

Method Detail

getAttributesFromContainer

com.google.gson.JsonElement getAttributesFromContainer(String normalPathName,
                                                       String normalCacheKey)

Returns a JsonElement containing attributes at a given path, for a given cache key.

Parameters:

normalPathName - the normalized path name

normalCacheKey - the cache key

Returns:

the attributes as a json element.

See Also:

GsonKeyValueN5Reader.getAttributes(java.lang.String)

existsFromContainer

boolean existsFromContainer(String normalPathName,
                            String normalCacheKey)

Query whether a resource exists in this container.

Parameters:

normalPathName - the normalized path name

normalCacheKey - the normalized resource name (may be null).

Returns:

true if the resouce exists

isGroupFromContainer

boolean isGroupFromContainer(String normalPathName)

Query whether a path in this container is a group.

Parameters:

normalPathName - the normalized path name

Returns:

true if the path is a group

isDatasetFromContainer

boolean isDatasetFromContainer(String normalPathName)

Query whether a path in this container is a dataset.

Parameters:

normalPathName - the normalized path name

Returns:

true if the path is a dataset

See Also:

N5Reader.datasetExists(java.lang.String)

isGroupFromAttributes

boolean isGroupFromAttributes(String normalCacheKey,
                              com.google.gson.JsonElement attributes)

Returns true if a path is a group, given that the the given attributes exist for the given cache key.

Should not call the backing storage.

Parameters:

normalCacheKey - the cache key

attributes - the attributes

Returns:

true if the path is a group

isDatasetFromAttributes

boolean isDatasetFromAttributes(String normalCacheKey,
                                com.google.gson.JsonElement attributes)

Returns true if a path is a dataset, given that the the given attributes exist for the given cache key.

Should not call the backing storage.

Parameters:

normalCacheKey - the cache key

attributes - the attributes

Returns:

true if the path is a dataset

listFromContainer

String[] listFromContainer(String normalPathName)

List the children of a path for this container.

Parameters:

normalPathName - the normalized path name

Returns:

list of children

See Also:

N5Reader.list(java.lang.String)