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

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(java.lang.Object entity)
void	deleteInBatch(java.lang.Iterable<?> entities)
int	executeUpdate(java.lang.String updateQuery, ParameterSource source) Executes the given update statement and uses the given parameter source to set the required query parameters.
int	executeUpdateWithNamedQuery(java.lang.String updateQuery, ParameterSource source)
int	executeUpdateWithNativeQuery(java.lang.String updateQuery, ParameterSource source)
<T> T	find(java.lang.Class<T> entityType, java.lang.Object id) Find an Entity of given type with the given primary key type.
void	flush() Executes EntityManager.flush().
java.util.List<?>	getResultListForClass(java.lang.Class<?> entityClass, int firstResult, int maxNumberOfReturnedObjects)
java.util.List<?>	getResultListForNamedQuery(java.lang.String selectNamedQuery, ParameterSource jpaQLParameterSource, int firstResult, int maxNumberOfResults)
java.util.List<?>	getResultListForNativeQuery(java.lang.String selectQuery, java.lang.Class<?> entityClass, ParameterSource jpaQLParameterSource, int firstResult, int maxNumberOfResults)
java.util.List<?>	getResultListForQuery(java.lang.String query, ParameterSource source) Executes the provided query to return a list of results
java.util.List<?>	getResultListForQuery(java.lang.String query, ParameterSource source, int firstResult, int maxNumberOfResults) Executes the provided query to return a list of results.
java.lang.Object	getSingleResultForQuery(java.lang.String query, ParameterSource source) Executes the provided query to return a single element
java.lang.Object	merge(java.lang.Object entity) The entity to be merged with the EntityManager.
java.lang.Object	merge(java.lang.Object entity, int flushSize, boolean clearOnFlush) The entity to be merged with the EntityManager.
void	persist(java.lang.Object entity) Persists the entity.
void	persist(java.lang.Object entity, int flushSize, boolean clearOnFlush) Persists the entity.

Method Detail

delete

void delete(java.lang.Object entity)

Parameters:

entity -

deleteInBatch

void deleteInBatch(java.lang.Iterable<?> entities)

Parameters:

entities -

executeUpdate

int executeUpdate(java.lang.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(java.lang.String updateQuery,
                              ParameterSource source)

Parameters:

updateQuery -

source -

Returns:

The number of entities updated

executeUpdateWithNativeQuery

int executeUpdateWithNativeQuery(java.lang.String updateQuery,
                               ParameterSource source)

Parameters:

updateQuery -

source -

Returns:

The number of entities updated

find

<T> T find(java.lang.Class<T> entityType,
         java.lang.Object id)

Find an Entity of given type with the given primary key type.

Type Parameters:

T -

Parameters:

entityType -

id -

Returns:

The entity if it exist, null is returned otherwise

getResultListForClass

java.util.List<?> getResultListForClass(java.lang.Class<?> entityClass,
                                      int firstResult,
                                      int maxNumberOfReturnedObjects)

Parameters:

entityClass -

firstResult -

maxNumberOfReturnedObjects -

Returns:

List of found entities

getResultListForNamedQuery

java.util.List<?> getResultListForNamedQuery(java.lang.String selectNamedQuery,
                                           ParameterSource jpaQLParameterSource,
                                           int firstResult,
                                           int maxNumberOfResults)

Parameters:

selectNamedQuery -

jpaQLParameterSource -

firstResult -

maxNumberOfResults -

Returns:

List of found entities

getResultListForNativeQuery

java.util.List<?> getResultListForNativeQuery(java.lang.String selectQuery,
                                            java.lang.Class<?> entityClass,
                                            ParameterSource jpaQLParameterSource,
                                            int firstResult,
                                            int maxNumberOfResults)

Parameters:

selectQuery -

entityClass -

jpaQLParameterSource -

firstResult -

maxNumberOfResults -

Returns:

List of found entities

getResultListForQuery

java.util.List<?> getResultListForQuery(java.lang.String query,
                                      ParameterSource source)

Executes the provided query to return a list of results

Parameters:

query -

source - the Parameter source for this query to be executed, if none then set as null

Returns:

List of found entities

getResultListForQuery

java.util.List<?> getResultListForQuery(java.lang.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:

List of found entities

getSingleResultForQuery

java.lang.Object getSingleResultForQuery(java.lang.String query,
                                       ParameterSource source)

Executes 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

java.lang.Object merge(java.lang.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

java.lang.Object merge(java.lang.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. clearOnFlushparameter specifies, if the EntityManager.clear() should be called after each EntityManager.flush().

persist

void persist(java.lang.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(java.lang.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().

flush

void flush()

Executes EntityManager.flush().