org.hibernate.search.backend.lucene

Class LuceneExtension<H,R,E>

java.lang.Object

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

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() .

All Implemented Interfaces:

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

public final class LuceneExtension<H,R,E>
extends Object
implements SearchQueryDslExtension<LuceneSearchQueryHitTypeStep<R,E>,R,E>, 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 and Description
Optional<LuceneSearchAggregationFactory>	extendOptional(SearchAggregationFactory original, SearchAggregationDslContext<?> dslContext)
<C,B> Optional<LuceneSearchPredicateFactory>	extendOptional(SearchPredicateFactory original, SearchPredicateBuilderFactory<C,B> factory)
Optional<LuceneSearchProjectionFactory<R,E>>	extendOptional(SearchProjectionFactory<R,E> original, SearchProjectionBuilderFactory factory)
Optional<LuceneSearchQuery<H>>	extendOptional(SearchQuery<H> original, LoadingContext<?,?> loadingContext)
Optional<LuceneSearchQueryHitTypeStep<R,E>>	extendOptional(SearchQueryHitTypeStep<?,R,E,?,?> original, IndexScope<?> indexScope, BackendSessionContext sessionContext, LoadingContextBuilder<R,E> loadingContextBuilder)
Optional<LuceneSearchSortFactory>	extendOptional(SearchSortFactory original, SearchSortDslContext<?,?> dslContext)
LuceneIndexFieldTypeFactory	extendOrFail(IndexFieldTypeFactory original)
static <H,R,E> LuceneExtension<H,R,E>	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> LuceneExtension<H,R,E> 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() .

Returns:

The extension.

extendOptional

public Optional<LuceneSearchQueryHitTypeStep<R,E>> extendOptional(SearchQueryHitTypeStep<?,R,E,?,?> original,
                                                                  IndexScope<?> indexScope,
                                                                  BackendSessionContext sessionContext,
                                                                  LoadingContextBuilder<R,E> loadingContextBuilder)

Specified by:

extendOptional in interface SearchQueryDslExtension<LuceneSearchQueryHitTypeStep<R,E>,R,E>

extendOptional

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

Specified by:

extendOptional in interface SearchQueryExtension<LuceneSearchQuery<H>,H>

extendOptional

public <C,B> Optional<LuceneSearchPredicateFactory> extendOptional(SearchPredicateFactory original,
                                                                   SearchPredicateBuilderFactory<C,B> factory)

Specified by:

extendOptional in interface SearchPredicateFactoryExtension<LuceneSearchPredicateFactory>

extendOptional

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

Specified by:

extendOptional in interface SearchSortFactoryExtension<LuceneSearchSortFactory>

extendOptional

public Optional<LuceneSearchProjectionFactory<R,E>> extendOptional(SearchProjectionFactory<R,E> original,
                                                                   SearchProjectionBuilderFactory factory)

Specified by:

extendOptional in interface SearchProjectionFactoryExtension<LuceneSearchProjectionFactory<R,E>,R,E>

extendOptional

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

Specified by:

extendOptional in interface SearchAggregationFactoryExtension<LuceneSearchAggregationFactory>

extendOrFail

public LuceneIndexFieldTypeFactory extendOrFail(IndexFieldTypeFactory original)

Specified by:

extendOrFail in interface IndexFieldTypeFactoryExtension<LuceneIndexFieldTypeFactory>