org.springframework.data.elasticsearch.repository.query

Class ElasticsearchQueryMethod

java.lang.Object

org.springframework.data.repository.query.QueryMethod

org.springframework.data.elasticsearch.repository.query.ElasticsearchQueryMethod

Direct Known Subclasses:

ReactiveElasticsearchQueryMethod

public class ElasticsearchQueryMethod
extends QueryMethod

ElasticsearchQueryMethod

Author:

Rizwan Idrees, Mohsin Husen, Oliver Gierke, Mark Paluch, Christoph Strobl, Peter-Josef Meisch

Constructor Summary

Constructors

Constructor and Description
ElasticsearchQueryMethod(Method method, RepositoryMetadata repositoryMetadata, ProjectionFactory factory, MappingContext<? extends ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty> mappingContext)

Method Summary

Modifier and Type	Method and Description
HighlightQuery	getAnnotatedHighlightQuery()
String	getAnnotatedQuery()
ElasticsearchEntityMetadata<?>	getEntityInformation()
protected MappingContext<? extends ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty>	getMappingContext()
boolean	hasAnnotatedHighlight()
boolean	hasAnnotatedQuery()
protected boolean	isAllowedGenericType(ParameterizedType methodGenericReturnType)
boolean	isNotSearchHitMethod() checks whether the return type of the underlying method is a SearchHits or a collection of SearchHit.
boolean	isSearchHitMethod() checks whether the return type of the underlying method is a SearchHits or a collection of SearchHit.
boolean	isSearchPageMethod() checks if the return type is SearchPage.
Class<?>	methodReturnType() retusn the declared return type for this method.

Methods inherited from class org.springframework.data.repository.query.QueryMethod

createParameters, getDomainClass, getName, getNamedQueryName, getParameters, getResultProcessor, getReturnedObjectType, isCollectionQuery, isModifyingQuery, isPageQuery, isQueryForEntity, isSliceQuery, isStreamQuery, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ElasticsearchQueryMethod

public ElasticsearchQueryMethod(Method method,
                                RepositoryMetadata repositoryMetadata,
                                ProjectionFactory factory,
                                MappingContext<? extends ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty> mappingContext)

Method Detail

hasAnnotatedQuery

public boolean hasAnnotatedQuery()

getAnnotatedQuery

public String getAnnotatedQuery()

hasAnnotatedHighlight

public boolean hasAnnotatedHighlight()

Returns:

true if there is a Highlight annotation present.

Since:

4.0

getAnnotatedHighlightQuery

public HighlightQuery getAnnotatedHighlightQuery()

Returns:

a HighlightQuery built from the Highlight annotation.

Throws:

IllegalArgumentException - if no Highlight annotation is present on the method

See Also:

hasAnnotatedHighlight()

getEntityInformation

public ElasticsearchEntityMetadata<?> getEntityInformation()

Overrides:

getEntityInformation in class QueryMethod

Returns:

the ElasticsearchEntityMetadata for the query methods return type.

Since:

3.2

getMappingContext

protected MappingContext<? extends ElasticsearchPersistentEntity<?>,ElasticsearchPersistentProperty> getMappingContext()

isSearchHitMethod

public boolean isSearchHitMethod()

checks whether the return type of the underlying method is a SearchHits or a collection of SearchHit.

Returns:

true if the method has a SearchHitt related return type

Since:

4.0

isSearchPageMethod

public boolean isSearchPageMethod()

checks if the return type is SearchPage.

Since:

4.0

methodReturnType

public Class<?> methodReturnType()

retusn the declared return type for this method.

Returns:

the return type

Since:

4.0

isAllowedGenericType

protected boolean isAllowedGenericType(ParameterizedType methodGenericReturnType)

isNotSearchHitMethod

public boolean isNotSearchHitMethod()

checks whether the return type of the underlying method is a SearchHits or a collection of SearchHit.

Returns:

true if the method has not a SearchHitt related return type

Since:

4.0