io.georocket.storage

Interface Store

public interface Store

A store for chunks

Since:

1.0.0

Author:

Michel Kraemer

Method Summary

Modifier and Type	Method and Description
void	add(String chunk, ChunkMeta chunkMeta, String path, IndexMeta indexMeta, Handler<AsyncResult<Void>> handler) Add a chunk to the store
void	delete(String search, String path, Handler<AsyncResult<Void>> handler) Delete all chunks from the store that match a given query
void	get(String search, String path, Handler<AsyncResult<StoreCursor>> handler) Get a number of chunks from the store using quick-search
void	getOne(String path, Handler<AsyncResult<ChunkReadStream>> handler) Get a chunk from the store.

Method Detail

add

void add(String chunk,
         ChunkMeta chunkMeta,
         String path,
         IndexMeta indexMeta,
         Handler<AsyncResult<Void>> handler)

Add a chunk to the store

Parameters:

chunk - the chunk to add

chunkMeta - the chunk's metadata

path - the path where the chunk should be stored (may be null)

indexMeta - metadata affecting the way the chunk will be indexed

handler - will be called when the chunk has been added to the store

getOne

void getOne(String path,
            Handler<AsyncResult<ChunkReadStream>> handler)

Get a chunk from the store. The returned ChunkReadStream must be closed after use to release all resources.

Parameters:

path - the absolute path to the chunk

handler - will be called when the chunk has been retrieved from the store

delete

void delete(String search,
            String path,
            Handler<AsyncResult<Void>> handler)

Delete all chunks from the store that match a given query

Parameters:

search - the search query

path - the path where to search for the chunks (may be null)

handler - will be called when the chunk has been deleted

get

void get(String search,
         String path,
         Handler<AsyncResult<StoreCursor>> handler)

Get a number of chunks from the store using quick-search

Parameters:

search - the search query

path - the path where to search for the chunks (may be null)

handler - will be called when the chunks have been retrieved from the store