Package io.vertigo.datastore.impl.entitystore

Interface EntityStorePlugin

All Superinterfaces:
io.vertigo.core.node.component.CoreComponent, io.vertigo.core.node.component.Plugin
All Known Implementing Classes:
AbstractStaticEntityStorePlugin, SqlEntityStorePlugin
public interface EntityStorePlugin extends io.vertigo.core.node.component.Plugin
The DataStorePlugin class defines the logical way used to read and write data in a data store. This plugin can be implemented in a sql or no sql way. this datatore is linked to a dataSpace. Several dtDefinition can be included in a dataSpace.
Author:
pchretien

  • Method Summary

    Modifier and Type
    Method
    Description
    <E extends io.vertigo.datamodel.data.model.Entity>
    Integer
    countByCriteria(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.criteria.Criteria<E> criteria)
    Returns the number of elements contained in the definition and matching a criteria.
    <E extends io.vertigo.datamodel.data.model.Entity>
    E
    create(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, E entity)
    Creates an object.
    <E extends io.vertigo.datamodel.data.model.Entity>
    io.vertigo.datamodel.data.model.DtList<E>
    createList(io.vertigo.datamodel.data.model.DtList<E> entities)
     
    void
    delete(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.model.UID<?> uid)
    Deletes an object identified by an uri.
    <E extends io.vertigo.datamodel.data.model.Entity>
    void
    deleteList(List<io.vertigo.datamodel.data.model.UID<E>> uids)
    Deletes a list of entities
    <E extends io.vertigo.datamodel.data.model.Entity>
    io.vertigo.datamodel.data.model.DtList<E>
    findAll(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.definitions.association.DtListURIForNNAssociation uid)
    Récupération d'une liste correspondant à l'URI fournie.
    <E extends io.vertigo.datamodel.data.model.Entity>
    io.vertigo.datamodel.data.model.DtList<E>
    findAll(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.definitions.association.DtListURIForSimpleAssociation uid)
    Récupération d'une liste correspondant à l'URI fournie.
    <E extends io.vertigo.datamodel.data.model.Entity>
    io.vertigo.datamodel.data.model.DtList<E>
    findByCriteria(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.criteria.Criteria<E> criteria, io.vertigo.datamodel.data.model.DtListState dtListState)
    Finds a list of entities matching a criteria.
    String
    getConnectionName()
     
    String
    getDataSpace()
     
    <E extends io.vertigo.datamodel.data.model.Entity>
    E
    readNullable(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.model.UID<E> uid)
    Récupération de l'objet correspondant à l'URI fournie.
    <E extends io.vertigo.datamodel.data.model.Entity>
    E
    readNullableForUpdate(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.model.UID<?> uid)
    Loads for update.
    void
    update(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.model.Entity entity)
    Updates an object.
    <E extends io.vertigo.datamodel.data.model.Entity>
    void
    updateList(io.vertigo.datamodel.data.model.DtList<E> entities)
    Update a list of entities

  • Method Details

    • getDataSpace

      String getDataSpace()
      Returns:
      the dataSpace

    • getConnectionName

      String getConnectionName()
      Returns:
      the name of the connection

    • readNullable

      <E extends io.vertigo.datamodel.data.model.Entity> E readNullable(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.model.UID<E> uid)
      Récupération de l'objet correspondant à l'URI fournie.
      Type Parameters:
      E - the type of entity
      Parameters:
      dataDefinition - Definition
      uid - UID de l'objet à charger
      Returns:
      D correspondant à l'URI fournie.

    • findAll

      <E extends io.vertigo.datamodel.data.model.Entity> io.vertigo.datamodel.data.model.DtList<E> findAll(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.definitions.association.DtListURIForNNAssociation uid)
      Récupération d'une liste correspondant à l'URI fournie. NOT NULL
      Type Parameters:
      E - the type of entity
      Parameters:
      dataDefinition - Definition
      uid - UID de la collection à charger
      Returns:
      DtList Liste correspondant à l'URI fournie

    • findAll

      <E extends io.vertigo.datamodel.data.model.Entity> io.vertigo.datamodel.data.model.DtList<E> findAll(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.definitions.association.DtListURIForSimpleAssociation uid)
      Récupération d'une liste correspondant à l'URI fournie. NOT NULL
      Type Parameters:
      E - the type of entity
      Parameters:
      dataDefinition - Definition
      uid - UID de la collection à charger
      Returns:
      DtList Liste correspondant à l'URI fournie

    • findByCriteria

      <E extends io.vertigo.datamodel.data.model.Entity> io.vertigo.datamodel.data.model.DtList<E> findByCriteria(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.criteria.Criteria<E> criteria, io.vertigo.datamodel.data.model.DtListState dtListState)
      Finds a list of entities matching a criteria.
      Parameters:
      dataDefinition - the definition of entities to find
      criteria - the criteria to match
      dtListState - listState of rows to retrieve
      Returns:
      the list

    • countByCriteria

      <E extends io.vertigo.datamodel.data.model.Entity> Integer countByCriteria(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.criteria.Criteria<E> criteria)
      Returns the number of elements contained in the definition and matching a criteria.
      Parameters:
      dataDefinition - the definition of entities to count
      criteria - the criteria to match
      Returns:
      the number of elements

    • create

      <E extends io.vertigo.datamodel.data.model.Entity> E create(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, E entity)
      Creates an object. No object with the same id must have been created previously.
      Parameters:
      dataDefinition - Definition
      entity - Object to create
      Returns:
      the created entity

    • createList

      <E extends io.vertigo.datamodel.data.model.Entity> io.vertigo.datamodel.data.model.DtList<E> createList(io.vertigo.datamodel.data.model.DtList<E> entities)

    • update

      void update(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.model.Entity entity)
      Updates an object. This object must have an id.
      Parameters:
      dataDefinition - Definition
      entity - Object to update

    • updateList

      <E extends io.vertigo.datamodel.data.model.Entity> void updateList(io.vertigo.datamodel.data.model.DtList<E> entities)
      Update a list of entities
      Parameters:
      entities - entities

    • delete

      void delete(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.model.UID<?> uid)
      Deletes an object identified by an uri.
      Parameters:
      dataDefinition - Definition
      uid - UID

    • deleteList

      <E extends io.vertigo.datamodel.data.model.Entity> void deleteList(List<io.vertigo.datamodel.data.model.UID<E>> uids)
      Deletes a list of entities
      Parameters:
      uids - uids of entities to delete

    • readNullableForUpdate

      <E extends io.vertigo.datamodel.data.model.Entity> E readNullableForUpdate(io.vertigo.datamodel.data.definitions.DataDefinition dataDefinition, io.vertigo.datamodel.data.model.UID<?> uid)
      Loads for update.
      Type Parameters:
      E - the type of entity
      Parameters:
      dataDefinition - Object's definition
      uid - Object's uid
      Returns:
      D Object value.