Package org.springframework.integration.jpa.core

Interface JpaOperations

All Known Implementing Classes:
DefaultJpaOperations
public interface JpaOperations
The Interface containing all the JpaOperations those will be executed by the Jpa Spring Integration components.
Since:
2.2
Author:
Amol Nayak, Gunnar Hillert, Gary Russell, Artem Bilan

  • Method Details

    • delete

      void delete(Object entity)
      Parameters:
      entity - The entity to delete.

    • deleteInBatch

      void deleteInBatch(Iterable<?> entities)
      Parameters:
      entities - The entities to delete.

    • executeUpdate

      int executeUpdate(String updateQuery, ParameterSource source)
      Executes the given update statement and uses the given parameter source to set the required query parameters.
      Parameters:
      updateQuery - Must Not be empty.
      source - Must Not be null.
      Returns:
      The number of entities updated

    • executeUpdateWithNamedQuery

      int executeUpdateWithNamedQuery(String updateQuery, ParameterSource source)
      Parameters:
      updateQuery - The update query.
      source - The parameter source.
      Returns:
      The number of entities updated.

    • executeUpdateWithNativeQuery

      int executeUpdateWithNativeQuery(String updateQuery, ParameterSource source)
      Parameters:
      updateQuery - The update query.
      source - The parameter source.
      Returns:
      The number of entities updated

    • find

      <T> T find(Class<T> entityType, Object id)
      Find an Entity of given type with the given primary key type.
      Type Parameters:
      T - The type to return.
      Parameters:
      entityType - The type.
      id - The object identifier.
      Returns:
      The entity if it exists, null otherwise.

    • getResultListForClass

      List<?> getResultListForClass(Class<?> entityClass, int firstResult, int maxNumberOfReturnedObjects)
      Parameters:
      entityClass - The entity class.
      firstResult - The index of the first result to return.
      maxNumberOfReturnedObjects - The number of objects to return.
      Returns:
      The list of found entities.

    • getResultListForNamedQuery

      List<?> getResultListForNamedQuery(String selectNamedQuery, ParameterSource jpaQLParameterSource, int firstResult, int maxNumberOfResults)
      Parameters:
      selectNamedQuery - The select named query.
      jpaQLParameterSource - The paramter source.
      firstResult - The index of the first result to return.
      maxNumberOfResults - The number of objects to return.
      Returns:
      The list of found entities.

    • getResultListForNativeQuery

      List<?> getResultListForNativeQuery(String selectQuery, @Nullable Class<?> entityClass, ParameterSource jpaQLParameterSource, int firstResult, int maxNumberOfResults)
      Parameters:
      selectQuery - The select query.
      entityClass - The entity class.
      jpaQLParameterSource - The parameter source.
      firstResult - The index of the first result to return.
      maxNumberOfResults - The number of objects to return.
      Returns:
      The list of found entities.

    • getResultListForQuery

      List<?> getResultListForQuery(String query, ParameterSource source)
      Execute the provided query to return a list of results.
      Parameters:
      query - The query.
      source - the Parameter source for this query to be executed, if none then set as null
      Returns:
      The list of found entities.

    • getResultListForQuery

      List<?> getResultListForQuery(String query, ParameterSource source, int firstResult, int maxNumberOfResults)
      Executes the provided query to return a list of results.
      Parameters:
      query - Must not be null or empty
      firstResult - The first result.
      maxNumberOfResults - Must be a non-negative value, any negative or zero will be ignored.
      source - the Parameter source for this query to be executed, if none then set null.
      Returns:
      The list of found entities.

    • getSingleResultForQuery

      Object getSingleResultForQuery(String query, ParameterSource source)
      Execute the provided query to return a single element.
      Parameters:
      query - Must not be empty
      source - the Parameter source for this query to be executed, if none then set as null
      Returns:
      Will always return a result. If no object was found in the database an exception is raised.

    • merge

      Object merge(Object entity)
      The entity to be merged with the EntityManager. The provided object can also be an Iterable in which case each object of the Iterable is treated as an entity and merged with the EntityManager. Null values returned while iterating over the Iterable are ignored.
      Parameters:
      entity - Must not be null.
      Returns:
      The merged managed instance of the entity.

    • merge

      Object merge(Object entity, int flushSize, boolean clearOnFlush)
      The entity to be merged with the EntityManager. The provided object can also be an Iterable in which case each object of the Iterable is treated as an entity and merged with the EntityManager. In addition the EntityManager.flush() is called after the merge and after each batch, as it is specified using flushSize parameter and if provided object is Iterable. clearOnFlush parameter specifies, if the EntityManager.clear() should be called after each EntityManager.flush().
      Parameters:
      entity - The entity.
      flushSize - The flush size.
      clearOnFlush - true to clear after flushing.
      Returns:
      The merged object.

    • persist

      void persist(Object entity)
      Persists the entity. The provided object can also be an Iterable in which case each object of the Iterable is treated as an entity and persisted with the EntityManager. Null values returned while iterating over the Iterable are ignored.
      Parameters:
      entity - Must not be null

    • persist

      void persist(Object entity, int flushSize, boolean clearOnFlush)
      Persists the entity. The provided object can also be an Iterable in which case each object of the Iterable is treated as an entity and persisted with the EntityManager. Null values returned while iterating over the Iterable are ignored. In addition the EntityManager.flush() is called after the persist and after each batch, as it is specified using flushSize parameter and if provided object is Iterable. clearOnFlushparameter specifies, if the EntityManager.clear() should be called after each EntityManager.flush().
      Parameters:
      entity - The entity.
      flushSize - The flush size.
      clearOnFlush - true to clear after flushing.

    • flush

      void flush()
      Executes EntityManager.flush().