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 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:

IndexFieldTypeFactoryContextExtension<LuceneIndexFieldTypeFactoryContext>, SearchPredicateFactoryContextExtension<LuceneSearchPredicateFactoryContext>, SearchProjectionFactoryContextExtension<LuceneSearchProjectionFactoryContext<R,E>,R,E>, SearchQueryContextExtension<LuceneSearchQueryResultDefinitionContext<R,E>,R,E>, SearchSortContainerContextExtension<LuceneSearchSortContainerContext>, SearchQueryExtension<LuceneSearchQuery<H>,H>

public final class LuceneExtension<H,R,E>
extends Object
implements SearchQueryContextExtension<LuceneSearchQueryResultDefinitionContext<R,E>,R,E>, SearchQueryExtension<LuceneSearchQuery<H>,H>, SearchPredicateFactoryContextExtension<LuceneSearchPredicateFactoryContext>, SearchSortContainerContextExtension<LuceneSearchSortContainerContext>, SearchProjectionFactoryContextExtension<LuceneSearchProjectionFactoryContext<R,E>,R,E>, IndexFieldTypeFactoryContextExtension<LuceneIndexFieldTypeFactoryContext>

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.

Method Summary

Modifier and Type	Method and Description
<C,B> Optional<LuceneSearchPredicateFactoryContext>	extendOptional(SearchPredicateFactoryContext original, SearchPredicateBuilderFactory<C,B> factory)
Optional<LuceneSearchProjectionFactoryContext<R,E>>	extendOptional(SearchProjectionFactoryContext<R,E> original, SearchProjectionBuilderFactory factory)
Optional<LuceneSearchQuery<H>>	extendOptional(SearchQuery<H> original, LoadingContext<?,?> loadingContext)
Optional<LuceneSearchQueryResultDefinitionContext<R,E>>	extendOptional(SearchQueryResultDefinitionContext<?,R,E,?,?> original, IndexSearchScope<?> indexSearchScope, SessionContextImplementor sessionContext, LoadingContextBuilder<R,E> loadingContextBuilder)
<C,B> Optional<LuceneSearchSortContainerContext>	extendOptional(SearchSortContainerContext original, SearchSortBuilderFactory<C,B> factory, SearchSortDslContext<? super B> dslContext)
LuceneIndexFieldTypeFactoryContext	extendOrFail(IndexFieldTypeFactoryContext original)
static <H,R,E> LuceneExtension<H,R,E>	get()

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

extendOptional

public Optional<LuceneSearchQueryResultDefinitionContext<R,E>> extendOptional(SearchQueryResultDefinitionContext<?,R,E,?,?> original,
                                                                              IndexSearchScope<?> indexSearchScope,
                                                                              SessionContextImplementor sessionContext,
                                                                              LoadingContextBuilder<R,E> loadingContextBuilder)

Specified by:

extendOptional in interface SearchQueryContextExtension<LuceneSearchQueryResultDefinitionContext<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<LuceneSearchPredicateFactoryContext> extendOptional(SearchPredicateFactoryContext original,
                                                                          SearchPredicateBuilderFactory<C,B> factory)

Specified by:

extendOptional in interface SearchPredicateFactoryContextExtension<LuceneSearchPredicateFactoryContext>

extendOptional

public <C,B> Optional<LuceneSearchSortContainerContext> extendOptional(SearchSortContainerContext original,
                                                                       SearchSortBuilderFactory<C,B> factory,
                                                                       SearchSortDslContext<? super B> dslContext)

Specified by:

extendOptional in interface SearchSortContainerContextExtension<LuceneSearchSortContainerContext>

extendOptional

public Optional<LuceneSearchProjectionFactoryContext<R,E>> extendOptional(SearchProjectionFactoryContext<R,E> original,
                                                                          SearchProjectionBuilderFactory factory)

Specified by:

extendOptional in interface SearchProjectionFactoryContextExtension<LuceneSearchProjectionFactoryContext<R,E>,R,E>

extendOrFail

public LuceneIndexFieldTypeFactoryContext extendOrFail(IndexFieldTypeFactoryContext original)

Specified by:

extendOrFail in interface IndexFieldTypeFactoryContextExtension<LuceneIndexFieldTypeFactoryContext>