org.hibernate.search.engine.search.dsl.query

Interface SearchQueryContextExtension<T,R,E>

Type Parameters:

T - The type of extended search query contexts. Should generally extend SearchQueryResultDefinitionContext.

R - The reference type. Users should not have to care about this, as the parameter will automatically take the appropriate value when calling .extension( ElasticsearchExtension.get() .

E - The entity type. Users should not have to care about this, as the parameter will automatically take the appropriate value when calling

public interface SearchQueryContextExtension<T,R,E>

An extension to the search query DSL, allowing to add non-standard predicates to a query.

WARNING: while this type is API, because instances should be manipulated by users, all of its methods are considered SPIs and therefore should never be called or implemented directly by users. In short, users are only expected to get instances of this type from an API (SomeExtension.get()) and pass it to another API.

See Also:

SearchQueryResultDefinitionContext.extension(SearchQueryContextExtension), AbstractSearchQueryContext

Method Summary

Modifier and Type	Method and Description
Optional<T>	extendOptional(SearchQueryResultDefinitionContext<?,R,E,?,?> original, IndexScope<?> indexScope, SessionContextImplementor sessionContext, LoadingContextBuilder<R,E> loadingContextBuilder) Attempt to extend a given context, returning an empty Optional in case of failure.

Method Detail

extendOptional

Optional<T> extendOptional(SearchQueryResultDefinitionContext<?,R,E,?,?> original,
                           IndexScope<?> indexScope,
                           SessionContextImplementor sessionContext,
                           LoadingContextBuilder<R,E> loadingContextBuilder)

Attempt to extend a given context, returning an empty Optional in case of failure.

WARNING: this method is not API, see comments at the type level.

Parameters:

original - The original, non-extended SearchQueryResultContext.

indexScope - An IndexScope.

sessionContext - A SessionContextImplementor.

loadingContextBuilder - A LoadingContextBuilder.

Returns:

An optional containing the extended search query context (T) in case of success, or an empty optional otherwise.