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:
org.hibernate.search.engine.backend.scope.IndexScopeExtension<LuceneIndexScope>, org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeFactoryExtension<LuceneIndexFieldTypeFactory>, org.hibernate.search.engine.common.schema.management.SchemaExportExtension<LuceneIndexSchemaExport>, org.hibernate.search.engine.search.aggregation.dsl.SearchAggregationFactoryExtension<LuceneSearchAggregationFactory>, org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactoryExtension<LuceneSearchPredicateFactory>, org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactoryExtension<LuceneSearchProjectionFactory<R,E>,R,E>, org.hibernate.search.engine.search.query.dsl.SearchQueryDslExtension<LuceneSearchQuerySelectStep<R,E,LOS>,R,E,LOS>, org.hibernate.search.engine.search.query.SearchQueryExtension<LuceneSearchQuery<H>,H>, org.hibernate.search.engine.search.sort.dsl.SearchSortFactoryExtension<LuceneSearchSortFactory>
public final class LuceneExtension<H,R,E,LOS> extends Object implements org.hibernate.search.engine.search.query.dsl.SearchQueryDslExtension<LuceneSearchQuerySelectStep<R,E,LOS>,R,E,LOS>, org.hibernate.search.engine.search.query.SearchQueryExtension<LuceneSearchQuery<H>,H>, org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactoryExtension<LuceneSearchPredicateFactory>, org.hibernate.search.engine.search.sort.dsl.SearchSortFactoryExtension<LuceneSearchSortFactory>, org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactoryExtension<LuceneSearchProjectionFactory<R,E>,R,E>, org.hibernate.search.engine.search.aggregation.dsl.SearchAggregationFactoryExtension<LuceneSearchAggregationFactory>, org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeFactoryExtension<LuceneIndexFieldTypeFactory>, org.hibernate.search.engine.backend.scope.IndexScopeExtension<LuceneIndexScope>, org.hibernate.search.engine.common.schema.management.SchemaExportExtension<LuceneIndexSchemaExport>
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:

  • Method Details

    • 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(org.hibernate.search.engine.search.query.dsl.SearchQuerySelectStep<?,R,E,LOS,?,?> original, org.hibernate.search.engine.search.query.spi.SearchQueryIndexScope<?> scope, org.hibernate.search.engine.backend.session.spi.BackendSessionContext sessionContext, org.hibernate.search.engine.search.loading.spi.SearchLoadingContextBuilder<E,LOS> loadingContextBuilder)
      Specified by:
      extendOptional in interface org.hibernate.search.engine.search.query.dsl.SearchQueryDslExtension<H,R,E,LOS>

    • extendOptional

      public Optional<LuceneSearchQuery<H>> extendOptional(org.hibernate.search.engine.search.query.SearchQuery<H> original, org.hibernate.search.engine.search.loading.spi.SearchLoadingContext<?> loadingContext)
      Specified by:
      extendOptional in interface org.hibernate.search.engine.search.query.SearchQueryExtension<H,R>

    • extendOptional

      public Optional<LuceneSearchPredicateFactory> extendOptional(org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactory original)
      Specified by:
      extendOptional in interface org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactoryExtension<H>

    • extendOptional

      public Optional<LuceneSearchSortFactory> extendOptional(org.hibernate.search.engine.search.sort.dsl.SearchSortFactory original)
      Specified by:
      extendOptional in interface org.hibernate.search.engine.search.sort.dsl.SearchSortFactoryExtension<H>

    • extendOptional

      public Optional<LuceneSearchProjectionFactory<R,E>> extendOptional(org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory<R,E> original)
      Specified by:
      extendOptional in interface org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactoryExtension<H,R,E>

    • extendOptional

      public Optional<LuceneSearchAggregationFactory> extendOptional(org.hibernate.search.engine.search.aggregation.dsl.SearchAggregationFactory original)
      Specified by:
      extendOptional in interface org.hibernate.search.engine.search.aggregation.dsl.SearchAggregationFactoryExtension<H>

    • extendOrFail

      public LuceneIndexFieldTypeFactory extendOrFail(org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeFactory original)
      Specified by:
      extendOrFail in interface org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeFactoryExtension<H>

    • extendOrFail

      public LuceneIndexScope extendOrFail(org.hibernate.search.engine.backend.scope.spi.IndexScope original)
      Specified by:
      extendOrFail in interface org.hibernate.search.engine.backend.scope.IndexScopeExtension<H>

    • extendOrFail

      public LuceneIndexSchemaExport extendOrFail(org.hibernate.search.engine.common.schema.management.SchemaExport original)
      Specified by:
      extendOrFail in interface org.hibernate.search.engine.common.schema.management.SchemaExportExtension<H>