Package org.hibernate.search.spi

Interface SearchIntegrator

@Deprecated
public interface SearchIntegrator

Deprecated.

This class will be removed without replacement. Use actual API instead.

This contract gives access to lower level APIs of Hibernate Search for frameworks integrating with it. Frameworks should not expose this as public API though, but expose a simplified view; for example the Hibernate Search ORM module expose the org.hibernate.search.SearchFactory contract to its clients.

Author:

Emmanuel Bernard, Sanne Grinovero

Method Summary

Modifier and Type	Method	Description
default QueryContextBuilder	buildQueryBuilder()	Deprecated.
default <LOS> HSQuery	createHSQuery(Query fullTextQuery, V5MigrationSearchSession<LOS> session, Consumer<LOS> loadOptionsContributor, Class<?>... entityTypes)	Deprecated. Return an Hibernate Search query object.
V5MigrationSearchScope	scope(Class<?>... targetTypes)	Deprecated.

Method Detail

scope

V5MigrationSearchScope scope(Class<?>... targetTypes)

Deprecated.

createHSQuery

default <LOS> HSQuery createHSQuery(Query fullTextQuery,
                                    V5MigrationSearchSession<LOS> session,
                                    Consumer<LOS> loadOptionsContributor,
                                    Class<?>... entityTypes)

Deprecated.

Return an Hibernate Search query object.

This method DOES support non-Lucene backends (e.g. Elasticsearch).

The returned object uses fluent APIs to define additional query settings.

Type Parameters:

LOS - The type of the initial step of the loading options definition DSL accessible through SearchQueryOptionsStep.loading(Consumer).

Parameters:

fullTextQuery - the full-text engine query

session - the session (for entity loading)

loadOptionsContributor - a contributor of loading options (for entity loading)

entityTypes - the targeted entity types

Returns:

an Hibernate Search query object

buildQueryBuilder

default QueryContextBuilder buildQueryBuilder()

Deprecated.

Returns:

return a query builder providing a fluent API to create Lucene queries