Class AbstractJpaQuery

java.lang.Object

org.springframework.data.jpa.repository.query.AbstractJpaQuery

All Implemented Interfaces:

RepositoryQuery

Direct Known Subclasses:

PartTreeJpaQuery

public abstract class AbstractJpaQuery
extends Object
implements RepositoryQuery

Abstract base class to implement RepositoryQuerys.

Author:

Oliver Gierke, Thomas Darimont, Mark Paluch, Christoph Strobl, Nicolas Cirigliano, Jens Schauder, Сергей Цыпанов, Wonchul Heo, Julia Lee, Yanming Zhou

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractJpaQuery.TupleConverter

Constructor Summary

Constructors

Constructor	Description
AbstractJpaQuery(JpaQueryMethod method, EntityManager em)	Creates a new AbstractJpaQuery from the given JpaQueryMethod.

Method Summary

Modifier and Type	Method	Description
protected <T extends Query> T	applyHints(T query, JpaQueryMethod method)	Applies the declared query hints to the given query.
protected <T extends Query> void	applyQueryHint(T query, QueryHint hint)	Protected to be able to customize in sub-classes.
protected Query	createCountQuery(JpaParametersParameterAccessor values)
protected Query	createQuery(JpaParametersParameterAccessor parameters)
protected abstract Query	doCreateCountQuery(JpaParametersParameterAccessor accessor)	Creates a TypedQuery for counting using the given values.
protected abstract Query	doCreateQuery(JpaParametersParameterAccessor accessor)	Creates a Query instance for the given values.
@Nullable Object	execute(Object[] parameters)
protected EntityManager	getEntityManager()	Returns the EntityManager.
protected JpaQueryExecution	getExecution(JpaParametersParameterAccessor accessor)
protected JpaMetamodel	getMetamodel()	Returns the JpaMetamodel.
JpaQueryMethod	getQueryMethod()
protected @Nullable Class<?>	getTypeToRead(ReturnedType returnedType)	Returns the type to be used when creating the JPA query.
abstract boolean	hasDeclaredCountQuery()	Returns true if the query has a dedicated count query associated with it or false if the count query shall be derived.

Methods inherited from class Object

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

Constructor Details

AbstractJpaQuery

public AbstractJpaQuery(JpaQueryMethod method,
 EntityManager em)

Creates a new AbstractJpaQuery from the given JpaQueryMethod.

Parameters:

method -

em -

Method Details

getQueryMethod

public JpaQueryMethod getQueryMethod()

Specified by:

getQueryMethod in interface RepositoryQuery

hasDeclaredCountQuery

public abstract boolean hasDeclaredCountQuery()

Returns true if the query has a dedicated count query associated with it or false if the count query shall be derived.

Returns:

true if the query has a dedicated count query false if the * count query is derived.

Since:

3.5

getEntityManager

protected EntityManager getEntityManager()

Returns the EntityManager.

Returns:

will never be null.

getMetamodel

protected JpaMetamodel getMetamodel()

Returns the JpaMetamodel.

Returns:

execute

public @Nullable Object execute(Object[] parameters)

Specified by:

execute in interface RepositoryQuery

getExecution

protected JpaQueryExecution getExecution(JpaParametersParameterAccessor accessor)

applyHints

@Contract("_, _ -> param1")
protected <T extends Query> T applyHints(T query,
 JpaQueryMethod method)

Applies the declared query hints to the given query.

Parameters:

query -

Returns:

applyQueryHint

protected <T extends Query> void applyQueryHint(T query,
 QueryHint hint)

Protected to be able to customize in sub-classes.

Parameters:

query - must not be null.

hint - must not be null.

createQuery

protected Query createQuery(JpaParametersParameterAccessor parameters)

createCountQuery

protected Query createCountQuery(JpaParametersParameterAccessor values)

getTypeToRead

protected @Nullable Class<?> getTypeToRead(ReturnedType returnedType)

Returns the type to be used when creating the JPA query.

Returns:

Since:

2.0.5

doCreateQuery

protected abstract Query doCreateQuery(JpaParametersParameterAccessor accessor)

Creates a Query instance for the given values.

Parameters:

accessor - must not be null.

Returns:

doCreateCountQuery

protected abstract Query doCreateCountQuery(JpaParametersParameterAccessor accessor)

Creates a TypedQuery for counting using the given values.

Parameters:

accessor - must not be null.

Returns: