Package org.springframework.data.jdbc.core

Interface JdbcAggregateOperations

All Known Implementing Classes:
JdbcAggregateTemplate
public interface JdbcAggregateOperations
Specifies operations one can perform on a database, based on an Domain Type.
Author:
Jens Schauder, Thomas Lang, Milan Milanov, Chirag Tailor, Diego Krupitza, Myeonghyeon Lee, Sergey Korotaev, Tomohiko Ozawa

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    count(Class<?> domainType)
    Counts the number of aggregates of a given type.
    <T> long
    count(Query query, Class<T> domainType)
    Counts the number of aggregates of a given type that match the given query.
    <T> void
    delete(T aggregateRoot)
    Delete an aggregate identified by its aggregate root.
    void
    deleteAll(Class<?> domainType)
    Delete all aggregates of a given type.
    <T> void
    deleteAll(Iterable<? extends T> aggregateRoots)
    Delete all aggregates identified by their aggregate roots.
    <T> void
    deleteAllById(Iterable<?> ids, Class<T> domainType)
    Deletes all aggregates identified by their aggregate root ids.
    <T> void
    deleteById(Object id, Class<T> domainType)
    Deletes a single Aggregate including all entities contained in that aggregate.
    <T> boolean
    exists(Query query, Class<T> domainType)
    Determine whether there are aggregates that match the Query
    <T> boolean
    existsById(Object id, Class<T> domainType)
    Checks if an aggregate identified by type and id exists in the database.
    <T> List<T>
    findAll(Class<T> domainType)
    Load all aggregates of a given type.
    <T> Page<T>
    findAll(Class<T> domainType, Pageable pageable)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 4.0.
    <T> List<T>
    findAll(Class<T> domainType, Sort sort)
    Load all aggregates of a given type, sorted.
    <T> List<T>
    findAll(Query query, Class<T> domainType)
    Execute a SELECT query and convert the resulting items to a List that is sorted.
    <T> Page<T>
    findAll(Query query, Class<T> domainType, Pageable pageable)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 4.0.
    <T> List<T>
    findAllById(Iterable<?> ids, Class<T> domainType)
    Load all aggregates of a given type that are identified by the given ids.
    <T> @Nullable T
    findById(Object id, Class<T> domainType)
    Load an aggregate from the database.
    <T> Optional<T>
    findOne(Query query, Class<T> domainType)
    Execute a SELECT query and convert the resulting item to an entity ensuring exactly one result.
    JdbcConverter
    getConverter()
    Returns the JdbcConverter.
    DataAccessStrategy
    getDataAccessStrategy()
    Return the DataAccessStrategy
    <T> RowMapper<? extends T>
    getRowMapper(Class<T> type)
    Return a RowMapper that can map rows of a ResultSet to instances of the specified type.
    <T> T
    insert(T instance)
    Dedicated insert function.
    <T> Iterable<T>
    insertAll(Iterable<T> instances)
    Inserts all aggregate instances, including all the members of each aggregate instance.
    <T> T
    save(T instance)
    Saves an instance of an aggregate, including all the members of the aggregate.
    <T> List<T>
    saveAll(Iterable<T> instances)
    Saves all aggregate instances, including all the members of each aggregate instance.
    <T> Stream<T>
    streamAll(Class<T> domainType)
    Load all aggregates of a given type to a Stream.
    <T> Stream<T>
    streamAll(Class<T> domainType, Sort sort)
    Loads all entities of the given type to a Stream, sorted.
    <T> Stream<T>
    streamAll(Query query, Class<T> domainType)
    Execute a SELECT query and convert the resulting items to a Stream.
    <T> Stream<T>
    streamAllByIds(Iterable<?> ids, Class<T> domainType)
    Loads all entities that match one of the ids passed as an argument to a Stream.
    <T> T
    update(T instance)
    Dedicated update function.
    <T> List<T>
    updateAll(Iterable<T> instances)
    Updates all aggregate instances, including all the members of each aggregate instance.

  • Method Details

    • save

      <T> T save(T instance)
      Saves an instance of an aggregate, including all the members of the aggregate.
      Type Parameters:
      T - the type of the aggregate root.
      Parameters:
      instance - the aggregate root of the aggregate to be saved. Must not be null.
      Returns:
      the saved instance.
      Throws:
      IncorrectUpdateSemanticsDataAccessException - when the instance is determined to be not new and the resulting update does not update any rows.

    • saveAll

      <T> List<T> saveAll(Iterable<T> instances)
      Saves all aggregate instances, including all the members of each aggregate instance.
      Type Parameters:
      T - the type of the aggregate root.
      Parameters:
      instances - the aggregate roots to be saved. Must not be null.
      Returns:
      the saved instances.
      Throws:
      IncorrectUpdateSemanticsDataAccessException - when at least one instance is determined to be not new and the resulting update does not update any rows.
      Since:
      3.0

    • insert

      <T> T insert(T instance)
      Dedicated insert function. This skips the test if the aggregate root is new and makes an insert.

      This is useful if the client provides an id for new aggregate roots.

      Type Parameters:
      T - the type of the aggregate root.
      Parameters:
      instance - the aggregate root of the aggregate to be inserted. Must not be null.
      Returns:
      the saved instance.

    • insertAll

      <T> Iterable<T> insertAll(Iterable<T> instances)
      Inserts all aggregate instances, including all the members of each aggregate instance.

      This is useful if the client provides an id for new aggregate roots.

      Type Parameters:
      T - the type of the aggregate root.
      Parameters:
      instances - the aggregate roots to be inserted. Must not be null.
      Returns:
      the saved instances.
      Since:
      3.1

    • update

      <T> T update(T instance)
      Dedicated update function. This skips the test if the aggregate root is new or not and always performs an update operation.
      Type Parameters:
      T - the type of the aggregate root.
      Parameters:
      instance - the aggregate root of the aggregate to be inserted. Must not be null.
      Returns:
      the saved instance.

    • updateAll

      <T> List<T> updateAll(Iterable<T> instances)
      Updates all aggregate instances, including all the members of each aggregate instance.
      Type Parameters:
      T - the type of the aggregate root.
      Parameters:
      instances - the aggregate roots to be inserted. Must not be null.
      Returns:
      the saved instances.
      Since:
      3.1

    • count

      long count(Class<?> domainType)
      Counts the number of aggregates of a given type.
      Parameters:
      domainType - the type of the aggregates to be counted.
      Returns:
      the number of instances stored in the database. Guaranteed to be not null.

    • count

      <T> long count(Query query, Class<T> domainType)
      Counts the number of aggregates of a given type that match the given query.
      Parameters:
      query - must not be null.
      domainType - the entity type must not be null.
      Returns:
      the number of instances stored in the database. Guaranteed to be not null.
      Since:
      3.0

    • exists

      <T> boolean exists(Query query, Class<T> domainType)
      Determine whether there are aggregates that match the Query
      Parameters:
      query - must not be null.
      domainType - the entity type must not be null.
      Returns:
      true if the object exists.
      Since:
      3.0

    • existsById

      <T> boolean existsById(Object id, Class<T> domainType)
      Checks if an aggregate identified by type and id exists in the database.
      Type Parameters:
      T - the type of the aggregate root.
      Parameters:
      id - the id of the aggregate root.
      domainType - the type of the aggregate root.
      Returns:
      whether the aggregate exists.

    • findById

      <T> @Nullable T findById(Object id, Class<T> domainType)
      Load an aggregate from the database.
      Type Parameters:
      T - the type of the aggregate root.
      Parameters:
      id - the id of the aggregate to load. Must not be null.
      domainType - the type of the aggregate root. Must not be null.
      Returns:
      the loaded aggregate. Might return null.

    • findAllById

      <T> List<T> findAllById(Iterable<?> ids, Class<T> domainType)
      Load all aggregates of a given type that are identified by the given ids.
      Type Parameters:
      T - the type of the aggregate roots. Must not be null.
      Parameters:
      ids - of the aggregate roots identifying the aggregates to load. Must not be null.
      domainType - the type of the aggregate roots. Must not be null.
      Returns:
      Guaranteed to be not null.

    • streamAllByIds

      <T> Stream<T> streamAllByIds(Iterable<?> ids, Class<T> domainType)
      Loads all entities that match one of the ids passed as an argument to a Stream. It is not guaranteed that the number of ids passed in matches the number of entities returned.
      Type Parameters:
      T - type of entities to load.
      Parameters:
      ids - the Ids of the entities to load. Must not be null.
      domainType - the type of entities to load. Must not be null.
      Returns:
      the loaded entities. Guaranteed to be not null.

    • findAll

      <T> List<T> findAll(Class<T> domainType)
      Load all aggregates of a given type.
      Type Parameters:
      T - the type of the aggregate roots. Must not be null.
      Parameters:
      domainType - the type of the aggregate roots. Must not be null.
      Returns:
      Guaranteed to be not null.

    • streamAll

      <T> Stream<T> streamAll(Class<T> domainType)
      Load all aggregates of a given type to a Stream.
      Type Parameters:
      T - the type of the aggregate roots. Must not be null.
      Parameters:
      domainType - the type of the aggregate roots. Must not be null.
      Returns:
      Guaranteed to be not null.

    • findAll

      <T> List<T> findAll(Class<T> domainType, Sort sort)
      Load all aggregates of a given type, sorted.
      Type Parameters:
      T - the type of the aggregate roots. Must not be null.
      Parameters:
      domainType - the type of the aggregate roots. Must not be null.
      sort - the sorting information. Must not be null.
      Returns:
      Guaranteed to be not null.
      Since:
      2.0

    • streamAll

      <T> Stream<T> streamAll(Class<T> domainType, Sort sort)
      Loads all entities of the given type to a Stream, sorted.
      Type Parameters:
      T - the type of entities to load.
      Parameters:
      domainType - the type of entities to load. Must not be null.
      sort - the sorting information. Must not be null.
      Returns:
      Guaranteed to be not null.
      Since:
      2.0

    • findAll

      @Deprecated(since="4.0", forRemoval=true) <T> Page<T> findAll(Class<T> domainType, Pageable pageable)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.0. Use findAll(Class, Sort) together with count(Class) to construct results of type Page.The API design is conflicts regarding pagination information. Also, pagination is primarily a feature of the repository and not the template API.
      Load a page of (potentially sorted) aggregates of a given type.
      Type Parameters:
      T - the type of the aggregate roots. Must not be null.
      Parameters:
      domainType - the type of the aggregate roots. Must not be null.
      pageable - the pagination information. Must not be null.
      Returns:
      Guaranteed to be not null.
      Since:
      2.0

    • findOne

      <T> Optional<T> findOne(Query query, Class<T> domainType)
      Execute a SELECT query and convert the resulting item to an entity ensuring exactly one result.
      Parameters:
      query - must not be null.
      domainType - the entity type must not be null.
      Returns:
      exactly one result or Optional.empty() if no match found.
      Throws:
      IncorrectResultSizeDataAccessException - if more than one match found.
      Since:
      3.0

    • findAll

      <T> List<T> findAll(Query query, Class<T> domainType)
      Execute a SELECT query and convert the resulting items to a List that is sorted.
      Parameters:
      query - must not be null.
      domainType - the entity type must not be null.
      Returns:
      a non-null sorted list with all the matching results.
      Throws:
      IncorrectResultSizeDataAccessException - if more than one match found.
      Since:
      3.0

    • streamAll

      <T> Stream<T> streamAll(Query query, Class<T> domainType)
      Execute a SELECT query and convert the resulting items to a Stream.
      Parameters:
      query - must not be null.
      domainType - the type of entities. Must not be null.
      Returns:
      a non-null list with all the matching results.
      Throws:
      IncorrectResultSizeDataAccessException - if more than one match found.
      Since:
      3.0

    • findAll

      @Deprecated(since="4.0", forRemoval=true) <T> Page<T> findAll(Query query, Class<T> domainType, Pageable pageable)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.0. Use findAll(Query, Class) together with count(Query, Class) to construct results of type Page. The API design is conflicts regarding pagination information. Also, pagination is primarily a feature of the repository and not the template API.
      Returns a Page of entities matching the given Query. In case no match could be found, an empty Page is returned.
      Parameters:
      query - must not be null.
      domainType - the entity type must not be null.
      pageable - can be null.
      Returns:
      a Page of entities matching the given Example.
      Since:
      3.0

    • deleteById

      <T> void deleteById(Object id, Class<T> domainType)
      Deletes a single Aggregate including all entities contained in that aggregate.

      Since no version attribute is provided this method will never throw a OptimisticLockingFailureException. If no rows match the generated delete operation this fact will be silently ignored.

      Type Parameters:
      T - the type of the aggregate root.
      Parameters:
      id - the id of the aggregate root of the aggregate to be deleted. Must not be null.
      domainType - the type of the aggregate root.

    • deleteAllById

      <T> void deleteAllById(Iterable<?> ids, Class<T> domainType)
      Deletes all aggregates identified by their aggregate root ids.

      Since no version attribute is provided this method will never throw a OptimisticLockingFailureException. If no rows match the generated delete operation this fact will be silently ignored.

      Type Parameters:
      T - the type of the aggregate root.
      Parameters:
      ids - the ids of the aggregate roots of the aggregates to be deleted. Must not be null.
      domainType - the type of the aggregate root.

    • delete

      <T> void delete(T aggregateRoot)
      Delete an aggregate identified by its aggregate root.
      Type Parameters:
      T - the type of the aggregate root.
      Parameters:
      aggregateRoot - to delete. Must not be null.

    • deleteAll

      void deleteAll(Class<?> domainType)
      Delete all aggregates of a given type.
      Parameters:
      domainType - type of the aggregate roots to be deleted. Must not be null.

    • deleteAll

      <T> void deleteAll(Iterable<? extends T> aggregateRoots)
      Delete all aggregates identified by their aggregate roots.
      Type Parameters:
      T - the type of the aggregate roots.
      Parameters:
      aggregateRoots - to delete. Must not be null.

    • getConverter

      JdbcConverter getConverter()
      Returns the JdbcConverter.
      Returns:
      the JdbcConverter.

    • getDataAccessStrategy

      DataAccessStrategy getDataAccessStrategy()
      Return the DataAccessStrategy
      Returns:
      the DataAccessStrategy

    • getRowMapper

      <T> RowMapper<? extends T> getRowMapper(Class<T> type)
      Return a RowMapper that can map rows of a ResultSet to instances of the specified type. The row mapper supports entity callbacks and lifecycle events if enabled and configured on the underlying template instance.
      Type Parameters:
      T -
      Parameters:
      type - type of the entity to map.
      Returns:
      a row mapper for the given type.
      Since:
      4.0