org.apache.deltaspike.data.api

Interface EntityRepository<E,PK extends Serializable>

Type Parameters:

E - Entity type.

PK - Primary key type.

All Superinterfaces:

Deactivatable, EntityCountRepository<E>, EntityPersistenceRepository<E,PK>

All Known Subinterfaces:

ArticleRepository, FullEntityRepository<E,PK>

All Known Implementing Classes:

AbstractEntityRepository, AbstractFullEntityRepository

public interface EntityRepository<E,PK extends Serializable>
extends EntityPersistenceRepository<E,PK>, EntityCountRepository<E>

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

Method Summary

Modifier and Type	Method and Description
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.
Optional<E>	findOptionalBy(PK primaryKey) Entity lookup by primary key.

Methods inherited from interface org.apache.deltaspike.data.api.EntityPersistenceRepository

attachAndRemove, flush, getPrimaryKey, refresh, remove, removeAndFlush, save, saveAndFlush, saveAndFlushAndRefresh

Methods inherited from interface org.apache.deltaspike.data.api.EntityCountRepository

count, count, countLike

Method Detail

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.

findOptionalBy

Optional<E> findOptionalBy(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, wrapped by Optional.

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.