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, EhCacheKVStorePlugin, H2KVStorePlugin, RedisKVStorePlugin, SpeedbKVStorePlugin
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 Details

    • getCollections

      List<KVCollection> getCollections()
      Returns the list of collections managed by this plugin.
      Returns:
      list of collections;

    • count

      int count(KVCollection collection)
      Parameters:
      collection - the collection
      Returns:
      count of elements into collection

    • put

      void put(KVCollection 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

      boolean remove(KVCollection collection, String id)
      Removes an element defined by an id from a collection.
      Parameters:
      collection - the collection
      id - the id
      Returns:
      if element exists before removed

    • clear

      void clear(KVCollection collection)
      Removes all elements from a collection.
      Parameters:
      collection - the collection

    • find

      <C> Optional<C> find(KVCollection 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(KVCollection 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.