org.apache.deltaspike.data.api

Interface EntityRepository<E,PK extends Serializable>

Type Parameters:

E - Entity type.

PK - Primary key type.

All Superinterfaces:

Deactivatable

All Known Implementing Classes:

AbstractEntityRepository

public interface EntityRepository<E,PK extends Serializable>
extends Deactivatable

Base Repository interface. All methods are implemented by the CDI extension.

Method Summary

Modifier and Type	Method and Description
void	attachAndRemove(E entity) Convenience access to EntityManager.remove(Object) with an detached entity.
Long	count() Count all existing entities of entity class <E>.
Long	count(E example, javax.persistence.metamodel.SingularAttribute<E,?>... attributes) Count existing entities of entity class <E> with for a given object and a specific set of properties..
Long	countLike(E example, javax.persistence.metamodel.SingularAttribute<E,?>... attributes) Count existing entities of entity class using the like operator for String attributes <E> with for a given object and a specific set of properties..
List<E>	findAll() Lookup all existing entities of entity class <E>.
List<E>	findAll(int start, int max) Lookup a range of existing entities of entity class <E> with support for pagination.
List<E>	findBy(E example, int start, int max, javax.persistence.metamodel.SingularAttribute<E,?>... attributes) Query by example - for a given object and a specific set of properties with support for pagination.
List<E>	findBy(E example, javax.persistence.metamodel.SingularAttribute<E,?>... attributes) Query by example - for a given object and a specific set of properties.
E	findBy(PK primaryKey) Entity lookup by primary key.
List<E>	findByLike(E example, int start, int max, javax.persistence.metamodel.SingularAttribute<E,?>... attributes) Query by example - for a given object and a specific set of properties using a like operator for Strings with support for pagination.
List<E>	findByLike(E example, javax.persistence.metamodel.SingularAttribute<E,?>... attributes) Query by example - for a given object and a specific set of properties using a like operator for Strings.
void	flush() Convenience access to EntityManager.flush().
void	refresh(E entity) Convenience access to EntityManager.refresh(Object).
void	remove(E entity) Convenience access to EntityManager.remove(Object).
void	removeAndFlush(E entity) Convenience access to EntityManager.remove(Object) with a following flush.
E	save(E entity) Persist (new entity) or merge the given entity.
E	saveAndFlush(E entity) save(Object)s the given entity and flushes the persistence context afterwards.
E	saveAndFlushAndRefresh(E entity) save(Object)s the given entity and flushes the persistence context afterwards, followed by a refresh (e.g.

Method Detail

save

E save(E entity)

Persist (new entity) or merge the given entity. The distinction on calling either method is done based on the primary key field being null or not. If this results in wrong behavior for a specific case, consider using the EntityManagerDelegate which offers both persist and merge.

Parameters:

entity - Entity to save.

Returns:

Returns the modified entity.

saveAndFlush

E saveAndFlush(E entity)

save(Object)s the given entity and flushes the persistence context afterwards.

Parameters:

entity - Entity to save.

Returns:

Returns the modified entity.

saveAndFlushAndRefresh

E saveAndFlushAndRefresh(E entity)

save(Object)s the given entity and flushes the persistence context afterwards, followed by a refresh (e.g. to load DB trigger modifications).

Parameters:

entity - Entity to save.

Returns:

Returns the modified entity.

remove

void remove(E entity)

Convenience access to EntityManager.remove(Object).

Parameters:

entity - Entity to remove.

removeAndFlush

void removeAndFlush(E entity)

Convenience access to EntityManager.remove(Object) with a following flush.

Parameters:

entity - Entity to remove.

attachAndRemove

void attachAndRemove(E entity)

Convenience access to EntityManager.remove(Object) with an detached entity.

Parameters:

entity - Entity to remove.

refresh

void refresh(E entity)

Convenience access to EntityManager.refresh(Object).

Parameters:

entity - Entity to refresh.

flush

void flush()

Convenience access to EntityManager.flush().

findBy

E findBy(PK primaryKey)

Entity lookup by primary key. Convenicence method around EntityManager.find(Class, Object).

Parameters:

primaryKey - DB primary key.

Returns:

Entity identified by primary or null if it does not exist.

findAll

List<E> findAll()

Lookup all existing entities of entity class <E>.

Returns:

List of entities, empty if none found.

findAll

List<E> findAll(int start,
                int max)

Lookup a range of existing entities of entity class <E> with support for pagination.

Parameters:

start - The starting position.

max - The maximum number of results to return

Returns:

List of entities, empty if none found.

findBy

List<E> findBy(E example,
               javax.persistence.metamodel.SingularAttribute<E,?>... attributes)

Query by example - for a given object and a specific set of properties.

Parameters:

example - Sample entity. Query all like.

attributes - Which attributes to consider for the query.

Returns:

List of entities matching the example, or empty if none found.

findBy

List<E> findBy(E example,
               int start,
               int max,
               javax.persistence.metamodel.SingularAttribute<E,?>... attributes)

Query by example - for a given object and a specific set of properties with support for pagination.

Parameters:

example - Sample entity. Query all like.

start - The starting position.

max - The maximum number of results to return

attributes - Which attributes to consider for the query.

Returns:

List of entities matching the example, or empty if none found.

findByLike

List<E> findByLike(E example,
                   javax.persistence.metamodel.SingularAttribute<E,?>... attributes)

Query by example - for a given object and a specific set of properties using a like operator for Strings.

Parameters:

example - Sample entity. Query all like.

attributes - Which attributes to consider for the query.

Returns:

List of entities matching the example, or empty if none found.

findByLike

List<E> findByLike(E example,
                   int start,
                   int max,
                   javax.persistence.metamodel.SingularAttribute<E,?>... attributes)

Query by example - for a given object and a specific set of properties using a like operator for Strings with support for pagination.

Parameters:

example - Sample entity. Query all like.

start - The starting position.

max - The maximum number of results to return

attributes - Which attributes to consider for the query.

Returns:

List of entities matching the example, or empty if none found.

count

Long count()

Count all existing entities of entity class <E>.

Returns:

Counter.

count

Long count(E example,
           javax.persistence.metamodel.SingularAttribute<E,?>... attributes)

Count existing entities of entity class <E> with for a given object and a specific set of properties..

Parameters:

example - Sample entity. Query all like.

attributes - Which attributes to consider for the query.

Returns:

Counter.

countLike

Long countLike(E example,
               javax.persistence.metamodel.SingularAttribute<E,?>... attributes)

Count existing entities of entity class using the like operator for String attributes <E> with for a given object and a specific set of properties..

Parameters:

example - Sample entity. Query all like.

attributes - Which attributes to consider for the query.

Returns:

Counter.