Class DaoHelper<TT>

java.lang.Object

com.flowlogix.jeedao.DaoHelper<TT>

Type Parameters:

TT -

All Implemented Interfaces:

JPAFinder<TT>, JPAFinderHelper<TT>, JPANativeQuery<TT>, Serializable

public final class DaoHelper<TT>
extends Object
implements JPANativeQuery<TT>, Serializable

Lightweight wrapper around common JPA methods This is the primary class in the com.flowlogix.jeedao package Implementation of JPAFinder interface

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.flowlogix.api.dao.JPAFinder

JPAFinder.CountQueryCriteria<TT>, JPAFinder.CriteriaBuilderAndRoot<TT>, JPAFinder.QueryCriteria<TT>, JPAFinder.QueryEnhancement<TT>

Nested classes/interfaces inherited from interface com.flowlogix.api.dao.JPAFinderHelper

JPAFinderHelper.EntityManagerExclusions

Constructor Summary

Constructors

Constructor	Description
DaoHelper(@NonNull Lazy.SerializableSupplier<EntityManager> entityManager, @NonNull Class<TT> entityClass)

Method Summary

Modifier and Type	Method	Description
JPAFinder.QueryCriteria<TT>	buildQueryCriteria()	Convenience method for building JPAFinder.QueryCriteria record, which contains CriteriaBuilder, Root and CriteriaQuery
<RR> JPAFinder.QueryCriteria<RR>	buildQueryCriteria(Class<RR> cls)	Convenience method for building JPAFinder.QueryCriteria record of any type, which contains CriteriaBuilder, Root and CriteriaQuery
long	count()	count rows
long	count(Consumer<JPAFinder.CountQueryCriteria<TT>> countQueryCriteria)	count with enriched, composable criteria
TypedNativeQuery	createNativeQuery(String sql, Class<?> resultClass)	Creates a type-safe JPA native query
TypedNativeQuery	createNativeQuery(String sql, String resultMapping)	Creates a type-safe JPA native query
TypedQuery<TT>	findAll()	finds all entities
TypedQuery<TT>	findAll(Consumer<JPAFinder.QueryCriteria<TT>> queryCriteria)	find all entities with enriched, composable criteria
static Lazy.SerializableSupplier<EntityManager>	findEntityManager()	Finds a reference to entity manager via CDI
static Lazy.SerializableSupplier<EntityManager>	findEntityManager(@NonNull List<Class<? extends Annotation>> qualifiers)	Finds a reference to entity manager via CDI
TypedQuery<TT>	findRange(long min, long max)	find entities given a specified range
TypedQuery<TT>	findRange(long min, long max, Consumer<JPAFinder.QueryCriteria<TT>> queryCriteria)	find entities with enriched, composable criteria given a specified range
Class<TT>	getEntityClass()	Returns the entity class
Supplier<EntityManager>	getEntityManager()	Entity Manager cannot be saved because it's not thread-safe However, supplier can be returned

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DaoHelper

public DaoHelper(@NonNull
 @NonNull Lazy.SerializableSupplier<EntityManager> entityManager,
 @NonNull
 @NonNull Class<TT> entityClass)

Method Details

findAll

public TypedQuery<TT> findAll()

finds all entities

Specified by:

findAll in interface JPAFinder<TT>

Returns:

query

findAll

public TypedQuery<TT> findAll(Consumer<JPAFinder.QueryCriteria<TT>> queryCriteria)

find all entities with enriched, composable criteria

Example:

findAll(enhancement::accept)

public record CountAndList(long count, List<UserEntity> list) { };
public CountAndList countAndList(String userName) {
    // add "where fullName = 'userName'" clause
    QueryEnhancement<UserEntity> enhancement = (partial, criteria) -> criteria
            .where(partial.builder().equal(partial.root()
                    .get(UserEntity_.fullName), userName));

    return new CountAndList(jpaFinder.count(enhancement::accept),
            jpaFinder.findAll(enhancement::accept)
            .setHint(QueryHints.BATCH_TYPE, BatchFetchType.IN)
            .getResultList());
}

Specified by:

findAll in interface JPAFinder<TT>

Parameters:

queryCriteria -

Returns:

query

findRange

public TypedQuery<TT> findRange(long min,
 long max)

find entities given a specified range

Specified by:

findRange in interface JPAFinder<TT>

Parameters:

min - minimum index, starting with zero

max - maximum index

Returns:

query

findRange

public TypedQuery<TT> findRange(long min,
 long max,
 Consumer<JPAFinder.QueryCriteria<TT>> queryCriteria)

find entities with enriched, composable criteria given a specified range

Specified by:

findRange in interface JPAFinder<TT>

Parameters:

min - minimum index, starting with zero

max - maximum index

queryCriteria -

Returns:

query

count

public long count()

count rows

Specified by:

count in interface JPAFinder<TT>

Returns:

row count

count

public long count(Consumer<JPAFinder.CountQueryCriteria<TT>> countQueryCriteria)

count with enriched, composable criteria

Specified by:

count in interface JPAFinder<TT>

Parameters:

countQueryCriteria -

Returns:

row count

getEntityManager

public Supplier<EntityManager> getEntityManager()

Entity Manager cannot be saved because it's not thread-safe However, supplier can be returned

Specified by:

getEntityManager in interface JPAFinderHelper<TT>

Returns:

Supplier of EntityManager

getEntityClass

public Class<TT> getEntityClass()

Returns the entity class

Specified by:

getEntityClass in interface JPAFinderHelper<TT>

Returns:

entity class

buildQueryCriteria

public JPAFinder.QueryCriteria<TT> buildQueryCriteria()

Convenience method for building JPAFinder.QueryCriteria record, which contains CriteriaBuilder, Root and CriteriaQuery

Specified by:

buildQueryCriteria in interface JPAFinderHelper<TT>

Returns:

QueryCriteria of Entity Type

buildQueryCriteria

public <RR> JPAFinder.QueryCriteria<RR> buildQueryCriteria(Class<RR> cls)

Convenience method for building JPAFinder.QueryCriteria record of any type, which contains CriteriaBuilder, Root and CriteriaQuery

Specified by:

buildQueryCriteria in interface JPAFinderHelper<TT>

Parameters:

cls - Type of Query Criteria

Returns:

QueryCriteria of the same Entity Type as the parameter

createNativeQuery

public TypedNativeQuery createNativeQuery(String sql,
 Class<?> resultClass)

Creates a type-safe JPA native query

public List<UserEntity> findByNative(String sql) {
    return jpaFinder.createNativeQuery(sql, jpaFinder.getEntityClass()).getResultList();
}

Specified by:

createNativeQuery in interface JPANativeQuery<TT>

Parameters:

sql -

resultClass - EntityManager.createNativeQuery(String, Class)

Returns:

TypedNativeQuery

createNativeQuery

public TypedNativeQuery createNativeQuery(String sql,
 String resultMapping)

Creates a type-safe JPA native query

public List<UserEntity> findByNative(String sql) {
    return jpaFinder.createNativeQuery(sql, jpaFinder.getEntityClass()).getResultList();
}

Specified by:

createNativeQuery in interface JPANativeQuery<TT>

Parameters:

sql -

resultMapping - EntityManager.createNativeQuery(String, String)

Returns:

TypedNativeQuery

findEntityManager

public static Lazy.SerializableSupplier<EntityManager> findEntityManager()

Finds a reference to entity manager via CDI

Returns:

Lazy.SerializableSupplier of default EntityManager

findEntityManager

public static Lazy.SerializableSupplier<EntityManager> findEntityManager(@NonNull
 @NonNull List<Class<? extends Annotation>> qualifiers)

Finds a reference to entity manager via CDI

Parameters:

qualifiers - for the entity manager, or empty list

Returns:

Lazy.SerializableSupplier of EntityManager