Package org.hibernate.search.backend.lucene

Class LuceneExtension<H,R,E,LOS>

java.lang.Object

org.hibernate.search.backend.lucene.LuceneExtension<H,R,E,LOS>

Type Parameters:

H - The type of query hits. Users should not have to care about this, as the parameter will automatically take the appropriate value when calling .extension( LuceneExtension.get() ).

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

E - entity type for projections. Users should not have to care about this, as the parameter will automatically take the appropriate value when calling .extension( LuceneExtension.get() ).

LOS - The type of the initial step of the loading options definition DSL. Users should not have to care about this, as the parameter will automatically take the appropriate value when calling .extension( LuceneExtension.get() ).

All Implemented Interfaces:

IndexFieldTypeFactoryExtension<LuceneIndexFieldTypeFactory>, SearchAggregationFactoryExtension<LuceneSearchAggregationFactory>, SearchPredicateFactoryExtension<LuceneSearchPredicateFactory>, SearchProjectionFactoryExtension<LuceneSearchProjectionFactory<R,E>,R,E>, SearchQueryDslExtension<LuceneSearchQuerySelectStep<R,E,LOS>,R,E,LOS>, SearchQueryExtension<LuceneSearchQuery<H>,H>, SearchSortFactoryExtension<LuceneSearchSortFactory>

public final class LuceneExtension<H,R,E,LOS>
extends Object
implements SearchQueryDslExtension<LuceneSearchQuerySelectStep<R,E,LOS>,R,E,LOS>, SearchQueryExtension<LuceneSearchQuery<H>,H>, SearchPredicateFactoryExtension<LuceneSearchPredicateFactory>, SearchSortFactoryExtension<LuceneSearchSortFactory>, SearchProjectionFactoryExtension<LuceneSearchProjectionFactory<R,E>,R,E>, SearchAggregationFactoryExtension<LuceneSearchAggregationFactory>, IndexFieldTypeFactoryExtension<LuceneIndexFieldTypeFactory>

An extension for the Lucene backend, giving access to Lucene-specific features.

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 directly by users. In short, users are only expected to get instances of this type from an API and pass it to another API.

See Also:

get()

Method Summary

Modifier and Type	Method	Description
Optional<LuceneSearchAggregationFactory>	extendOptional(SearchAggregationFactory original, SearchAggregationDslContext<?,?> dslContext)	Attempt to extend a given factory, returning an empty Optional in case of failure.
Optional<LuceneSearchPredicateFactory>	extendOptional(SearchPredicateFactory original, SearchPredicateDslContext<?> dslContext)	Attempt to extend a given factory, returning an empty Optional in case of failure.
Optional<LuceneSearchProjectionFactory<R,E>>	extendOptional(SearchProjectionFactory<R,E> original, SearchProjectionDslContext<?> dslContext)	Attempt to extend a given factory, returning an empty Optional in case of failure.
Optional<LuceneSearchQuerySelectStep<R,E,LOS>>	extendOptional(SearchQuerySelectStep<?,R,E,LOS,?,?> original, IndexScope<?> indexScope, BackendSessionContext sessionContext, LoadingContextBuilder<R,E,LOS> loadingContextBuilder)	Attempt to extend a given DSL step, returning an empty Optional in case of failure.
Optional<LuceneSearchQuery<H>>	extendOptional(SearchQuery<H> original, LoadingContext<?,?> loadingContext)	Attempt to extend a given query, returning an empty Optional in case of failure.
Optional<LuceneSearchSortFactory>	extendOptional(SearchSortFactory original, SearchSortDslContext<?,?> dslContext)	Attempt to extend a given factory, returning an empty Optional in case of failure.
LuceneIndexFieldTypeFactory	extendOrFail(IndexFieldTypeFactory original)	Attempt to extend a given factory, throwing an exception in case of failure.
static <H,R,E,LOS> LuceneExtension<H,R,E,LOS>	get()	Get the extension with generic parameters automatically set as appropriate for the context in which it's used.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static <H,R,E,LOS> LuceneExtension<H,R,E,LOS> get()

Get the extension with generic parameters automatically set as appropriate for the context in which it's used.

Type Parameters:

H - The type of query hits. Users should not have to care about this, as the parameter will automatically take the appropriate value when calling .extension( LuceneExtension.get() .

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

E - entity type for projections. Users should not have to care about this, as the parameter will automatically take the appropriate value when calling .extension( LuceneExtension.get() .

LOS - The type of the initial step of the loading options definition DSL. Users should not have to care about this, as the parameter will automatically take the appropriate value when calling .extension( LuceneExtension.get() .

Returns:

The extension.

extendOptional

public Optional<LuceneSearchQuerySelectStep<R,E,LOS>> extendOptional(SearchQuerySelectStep<?,R,E,LOS,?,?> original,
                                                                                 IndexScope<?> indexScope,
                                                                                 BackendSessionContext sessionContext,
                                                                                 LoadingContextBuilder<R,E,LOS> loadingContextBuilder)

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

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

Specified by:

extendOptional in interface SearchQueryDslExtension<H,R,E,LOS>

Parameters:

original - The original, non-extended SearchQuerySelectStep.

indexScope - An IndexScope.

sessionContext - A BackendSessionContext.

loadingContextBuilder - A LoadingContextBuilder.

Returns:

An optional containing the extended search query DSL step (SearchQueryDslExtension) in case of success, or an empty optional otherwise.

extendOptional

public Optional<LuceneSearchQuery<H>> extendOptional(SearchQuery<H> original,
                                                     LoadingContext<?,?> loadingContext)

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

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

Specified by:

extendOptional in interface SearchQueryExtension<H,R>

Parameters:

original - The original, non-extended SearchQuery.

loadingContext - The LoadingContext used by the original query.

Returns:

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

extendOptional

public Optional<LuceneSearchPredicateFactory> extendOptional(SearchPredicateFactory original,
                                                             SearchPredicateDslContext<?> dslContext)

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

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

Specified by:

extendOptional in interface SearchPredicateFactoryExtension<H>

Parameters:

original - The original, non-extended SearchPredicateFactory.

dslContext - A SearchPredicateDslContext.

Returns:

An optional containing the extended search predicate factory (SearchPredicateFactoryExtension) in case of success, or an empty optional otherwise.

extendOptional

public Optional<LuceneSearchSortFactory> extendOptional(SearchSortFactory original,
                                                        SearchSortDslContext<?,?> dslContext)

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

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

Specified by:

extendOptional in interface SearchSortFactoryExtension<H>

Parameters:

original - The original, non-extended SearchSortFactory.

dslContext - A SearchSortDslContext.

Returns:

An optional containing the extended sort factory (SearchSortFactoryExtension) in case of success, or an empty optional otherwise.

extendOptional

public Optional<LuceneSearchProjectionFactory<R,E>> extendOptional(SearchProjectionFactory<R,E> original,
                                                                         SearchProjectionDslContext<?> dslContext)

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

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

Specified by:

extendOptional in interface SearchProjectionFactoryExtension<H,R,E>

Parameters:

original - The original, non-extended SearchProjectionFactory.

dslContext - A SearchProjectionDslContext.

Returns:

An optional containing the extended projection factory (SearchProjectionFactoryExtension) in case of success, or an empty optional otherwise.

extendOptional

public Optional<LuceneSearchAggregationFactory> extendOptional(SearchAggregationFactory original,
                                                               SearchAggregationDslContext<?,?> dslContext)

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

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

Specified by:

extendOptional in interface SearchAggregationFactoryExtension<H>

Parameters:

original - The original, non-extended SearchAggregationFactory.

dslContext - A SearchAggregationDslContext.

Returns:

An optional containing the extended aggregation factory (SearchAggregationFactoryExtension) in case of success, or an empty optional otherwise.

extendOrFail

public LuceneIndexFieldTypeFactory extendOrFail(IndexFieldTypeFactory original)

Attempt to extend a given factory, throwing an exception in case of failure.

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

Specified by:

extendOrFail in interface IndexFieldTypeFactoryExtension<H>

Parameters:

original - The original, non-extended IndexFieldTypeFactory.

Returns:

An extended index field type factory (IndexFieldTypeFactoryExtension)