Package io.vertigo.datastore.impl.kvstore

Interface KVStorePlugin

All Superinterfaces:

io.vertigo.core.node.component.CoreComponent, io.vertigo.core.node.component.Plugin

All Known Implementing Classes:

BerkeleyKVStorePlugin, DelayedMemoryKVStorePlugin

public interface KVStorePlugin
extends io.vertigo.core.node.component.Plugin

This plugin defines the strategy used to store a 'collection' of elements. Each element is identified by a name.

Author:

pchretien

Method Summary

Modifier and Type	Method	Description
void	clear(String collection)	Removes all elements from a collection.
int	count(String collection)
<C> Optional<C>	find(String collection, String id, Class<C> clazz)	Finds the optional element to which the id is mapped inside the specified collection.
<C> List<C>	findAll(String collection, int skip, Integer limit, Class<C> clazz)	Finds all elements contained inside the specified collection.
List<String>	getCollections()	Returns the list of collections managed by this plugin.
void	put(String collection, String id, Object element)	Adds an element defined by an id in a collection.
void	remove(String collection, String id)	Removes an element defined by an id from a collection.

Method Detail

getCollections

List<String> getCollections()

Returns the list of collections managed by this plugin.

Returns:

list of collections;

count

int count(String collection)

Parameters:

collection - the collection

Returns:

count of elements into collection

put

void put(String collection,
         String id,
         Object element)

Adds an element defined by an id in a collection.

Parameters:

collection - the collection

id - the id

element - the element

remove

void remove(String collection,
            String id)

Removes an element defined by an id from a collection. If the collection doesn't contain the is then a exception is thrown.

Parameters:

collection - the collection

id - the id

clear

void clear(String collection)

Removes all elements from a collection.

Parameters:

collection - the collection

find

<C> Optional<C> find(String collection,
                     String id,
                     Class<C> clazz)

Finds the optional element to which the id is mapped inside the specified collection. If the element is not found then an empty option is returned.

Type Parameters:

C - Element type

Parameters:

collection - the collection

id - the id

clazz - the type of the searched element

Returns:

the option

findAll

<C> List<C> findAll(String collection,
                    int skip,
                    Integer limit,
                    Class<C> clazz)

Finds all elements contained inside the specified collection.

Type Parameters:

C - Element type

Parameters:

collection - the collection

skip - the position from which the elements are returned

limit - the limit size of elements

clazz - the type of the searched element

Returns:

the list of elements.