Class JpaQueryMethod

java.lang.Object

org.springframework.data.repository.query.QueryMethod

org.springframework.data.jpa.repository.query.JpaQueryMethod

public class JpaQueryMethod
extends QueryMethod

JPA specific extension of QueryMethod.

Author:

Oliver Gierke, Thomas Darimont, Christoph Strobl, Nicolas Cirigliano, Mark Paluch, Сергей Цыпанов, Réda Housni Alaoui, Greg Turnquist, Aleksei Elin

Constructor Summary

Constructors

Constructor	Description
JpaQueryMethod(Method method, RepositoryMetadata metadata, ProjectionFactory factory, QueryExtractor extractor)	Creates a JpaQueryMethod.
JpaQueryMethod(Method method, RepositoryMetadata metadata, ProjectionFactory factory, QueryExtractor extractor, Function<ParametersSource, JpaParameters> parametersFunction)	Creates a JpaQueryMethod.

Method Summary

Modifier and Type	Method	Description
@Nullable String	getAnnotatedQuery()	Returns the query string declared in a Query annotation or null if neither the annotation found nor the attribute was specified.
@Nullable String	getCountQuery()	Returns the countQuery string declared in a Query annotation or null if neither the annotation found nor the attribute was specified.
@Nullable DeclaredQuery	getDeclaredCountQuery()	Returns the declared count query from a Query annotation or null if neither the annotation found nor the attribute was specified.
JpaEntityMetadata<?>	getEntityInformation()
String	getNamedCountQueryName()	Returns the name of the NamedQuery that shall be used for count queries.
String	getNamedQueryName()
JpaParameters	getParameters()
QueryExtractor	getQueryExtractor()	Returns the QueryExtractor.
Meta	getQueryMetaAttributes()	Returns the Meta attributes to be applied.
Class<? extends QueryRewriter>	getQueryRewriter()	Returns the QueryRewriter type.
String	getRequiredAnnotatedQuery()	Returns the required query string declared in a Query annotation or throws IllegalStateException if neither the annotation found nor the attribute was specified.
DeclaredQuery	getRequiredDeclaredQuery()	Returns the required DeclaredQuery from a Query annotation or throws IllegalStateException if neither the annotation found nor the attribute was specified.
boolean	hasQueryMetaAttributes()
boolean	isCollectionQuery()
boolean	isModifyingQuery()	Returns whether the finder is a modifying one.
boolean	isProcedureQuery()	Return true if the method contains a Procedure annotation.

Methods inherited from class QueryMethod

createParameters, getDomainClass, getName, getResultProcessor, getReturnedObjectType, isPageQuery, isQueryForEntity, isScrollQuery, isSearchQuery, isSliceQuery, isStreamQuery, toString

Methods inherited from class Object

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

Constructor Details

JpaQueryMethod

public JpaQueryMethod(Method method,
 RepositoryMetadata metadata,
 ProjectionFactory factory,
 QueryExtractor extractor)

Creates a JpaQueryMethod.

Parameters:

method - must not be null.

metadata - must not be null.

factory - must not be null.

extractor - must not be null.

JpaQueryMethod

public JpaQueryMethod(Method method,
 RepositoryMetadata metadata,
 ProjectionFactory factory,
 QueryExtractor extractor,
 Function<ParametersSource, JpaParameters> parametersFunction)

Creates a JpaQueryMethod.

Parameters:

method - must not be null.

metadata - must not be null.

factory - must not be null.

extractor - must not be null.

parametersFunction - function to obtain JpaParameters, must not be null.

Since:

3.5

Method Details

getEntityInformation

public JpaEntityMetadata<?> getEntityInformation()

Overrides:

getEntityInformation in class QueryMethod

isModifyingQuery

public boolean isModifyingQuery()

Returns whether the finder is a modifying one.

Overrides:

isModifyingQuery in class QueryMethod

Returns:

getQueryExtractor

public QueryExtractor getQueryExtractor()

Returns the QueryExtractor.

Returns:

hasQueryMetaAttributes

public boolean hasQueryMetaAttributes()

Returns:

return true if Meta annotation is available.

Since:

3.0

getQueryMetaAttributes

public Meta getQueryMetaAttributes()

Returns the Meta attributes to be applied.

Returns:

never null.

Since:

1.6

getAnnotatedQuery

public @Nullable String getAnnotatedQuery()

Returns the query string declared in a Query annotation or null if neither the annotation found nor the attribute was specified.

Returns:

getRequiredAnnotatedQuery

public String getRequiredAnnotatedQuery()
                                 throws IllegalStateException

Returns the required query string declared in a Query annotation or throws IllegalStateException if neither the annotation found nor the attribute was specified.

Returns:

Throws:

IllegalStateException - if no Query annotation is present or the query is empty.

Since:

2.0

getRequiredDeclaredQuery

public DeclaredQuery getRequiredDeclaredQuery()
                                       throws IllegalStateException

Returns the required DeclaredQuery from a Query annotation or throws IllegalStateException if neither the annotation found nor the attribute was specified.

Returns:

Throws:

IllegalStateException - if no Query annotation is present or the query is empty.

Since:

4.0

getCountQuery

public @Nullable String getCountQuery()

Returns the countQuery string declared in a Query annotation or null if neither the annotation found nor the attribute was specified.

Returns:

getDeclaredCountQuery

public @Nullable DeclaredQuery getDeclaredCountQuery()

Returns the declared count query from a Query annotation or null if neither the annotation found nor the attribute was specified.

Returns:

Since:

4.0

getNamedQueryName

public String getNamedQueryName()

Overrides:

getNamedQueryName in class QueryMethod

getNamedCountQueryName

public String getNamedCountQueryName()

Returns the name of the NamedQuery that shall be used for count queries.

Returns:

getParameters

public JpaParameters getParameters()

Overrides:

getParameters in class QueryMethod

isCollectionQuery

public boolean isCollectionQuery()

Overrides:

isCollectionQuery in class QueryMethod

isProcedureQuery

public boolean isProcedureQuery()

Return true if the method contains a Procedure annotation.

Returns:

getQueryRewriter

public Class<? extends QueryRewriter> getQueryRewriter()

Returns the QueryRewriter type.

Returns:

type of the QueryRewriter

Since:

3.0