org.springframework.data.jdbc.core

Interface DataAccessStrategy

All Known Implementing Classes:

CascadingDataAccessStrategy, DefaultDataAccessStrategy, DelegatingDataAccessStrategy, MyBatisDataAccessStrategy

public interface DataAccessStrategy

Abstraction for accesses to the database that should be implementable with a single SQL statement per method and relates to a single entity as opposed to JdbcAggregateOperations which provides interactions related to complete aggregates.

Author:

Jens Schauder

Method Summary

Modifier and Type	Method and Description
long	count(Class<?> domainType) Counts the rows in the table representing the given domain type.
void	delete(Object id, Class<?> domainType) deletes a single row identified by the id, from the table identified by the domainType.
void	delete(Object rootId, PersistentPropertyPath<RelationalPersistentProperty> propertyPath) Deletes all entities reachable via propertyPath from the instance identified by rootId.
<T> void	deleteAll(Class<T> domainType) Deletes all entities of the given domain type.
void	deleteAll(PersistentPropertyPath<RelationalPersistentProperty> propertyPath) Deletes all entities reachable via propertyPath from any instance.
<T> boolean	existsById(Object id, Class<T> domainType) returns if a row with the given id exists for the given type.
<T> Iterable<T>	findAll(Class<T> domainType) Loads all entities of the given type.
<T> Iterable<T>	findAllById(Iterable<?> ids, Class<T> domainType) Loads all entities that match one of the ids passed as an argument.
<T> Iterable<T>	findAllByProperty(Object rootId, RelationalPersistentProperty property) Finds all entities reachable via property from the instance identified by rootId.
<T> T	findById(Object id, Class<T> domainType) Loads a single entity identified by type and id.
<T> Object	insert(T instance, Class<T> domainType, Map<String,Object> additionalParameters) Inserts a the data of a single entity.
<T> boolean	update(T instance, Class<T> domainType) Updates the data of a single entity in the database.

Method Detail

insert

<T> Object insert(T instance,
                  Class<T> domainType,
                  Map<String,Object> additionalParameters)

Inserts a the data of a single entity. Referenced entities don't get handled.

Type Parameters:

T - the type of the instance.

Parameters:

instance - the instance to be stored. Must not be null.

domainType - the type of the instance. Must not be null.

additionalParameters - name-value pairs of additional parameters. Especially ids of parent entities that need to get referenced are contained in this map. Must not be null.

Returns:

the id generated by the database if any.

update

<T> boolean update(T instance,
                   Class<T> domainType)

Updates the data of a single entity in the database. Referenced entities don't get handled.

Type Parameters:

T - the type of the instance to save.

Parameters:

instance - the instance to save. Must not be null.

domainType - the type of the instance to save. Must not be null.

Returns:

whether the update actually updated a row.

delete

void delete(Object id,
            Class<?> domainType)

deletes a single row identified by the id, from the table identified by the domainType. Does not handle cascading deletes.

Parameters:

id - the id of the row to be deleted. Must not be null.

domainType - the type of entity to be deleted. Implicitly determines the table to operate on. Must not be null.

delete

void delete(Object rootId,
            PersistentPropertyPath<RelationalPersistentProperty> propertyPath)

Deletes all entities reachable via propertyPath from the instance identified by rootId.

Parameters:

rootId - Id of the root object on which the propertyPath is based. Must not be null.

propertyPath - Leading from the root object to the entities to be deleted. Must not be null.

deleteAll

<T> void deleteAll(Class<T> domainType)

Deletes all entities of the given domain type.

Type Parameters:

T - type of the domain type.

Parameters:

domainType - the domain type for which to delete all entries. Must not be null.

deleteAll

void deleteAll(PersistentPropertyPath<RelationalPersistentProperty> propertyPath)

Deletes all entities reachable via propertyPath from any instance.

Parameters:

propertyPath - Leading from the root object to the entities to be deleted. Must not be null.

count

long count(Class<?> domainType)

Counts the rows in the table representing the given domain type.

Parameters:

domainType - the domain type for which to count the elements. Must not be null.

Returns:

the count. Guaranteed to be not null.

findById

@Nullable
<T> T findById(Object id,
                         Class<T> domainType)

Loads a single entity identified by type and id.

Type Parameters:

T - the type of the entity.

Parameters:

id - the id of the entity to load. Must not be null.

domainType - the domain type of the entity. Must not be null.

Returns:

Might return null.

findAll

<T> Iterable<T> findAll(Class<T> domainType)

Loads all entities of the given type.

Type Parameters:

T - the type of entities to load.

Parameters:

domainType - the type of entities to load. Must not be null.

Returns:

Guaranteed to be not null.

findAllById

<T> Iterable<T> findAllById(Iterable<?> ids,
                            Class<T> domainType)

Loads all entities that match one of the ids passed as an argument. 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 laod. Must not be null.

Returns:

the loaded entities. Guaranteed to be not null.

findAllByProperty

<T> Iterable<T> findAllByProperty(Object rootId,
                                  RelationalPersistentProperty property)

Finds all entities reachable via property from the instance identified by rootId.

Parameters:

rootId - Id of the root object on which the propertyPath is based.

property - Leading from the root object to the entities to be found.

existsById

<T> boolean existsById(Object id,
                       Class<T> domainType)

returns if a row with the given id exists for the given type.

Type Parameters:

T - the type of the entity.

Parameters:

id - the id of the entity for which to check. Must not be null.

domainType - the type of the entity to check for. Must not be null.

Returns:

true if a matching row exists, otherwise false.