Package org.hibernate.search.mapper.orm.session.impl

Class DelegatingSearchSession

java.lang.Object

org.hibernate.search.mapper.orm.session.impl.DelegatingSearchSession

All Implemented Interfaces:

SearchScopeProvider, SearchSession

public class DelegatingSearchSession
extends Object
implements SearchSession

A lazily initializing SearchSession.

This implementation allows to call Search.session(Session) before Hibernate Search is fully initialized, which can be useful in CDI/Spring environments.

Constructor Summary

Constructors

Constructor	Description
DelegatingSearchSession(Supplier<? extends HibernateOrmSearchSessionMappingContext> mappingContextProvider, Session session)

Method Summary

Modifier and Type	Method	Description
void	automaticIndexingSynchronizationStrategy(AutomaticIndexingSynchronizationStrategy synchronizationStrategy)	Set the AutomaticIndexingSynchronizationStrategy to use for this session.
SearchIndexingPlan	indexingPlan()
void	indexingPlanFilter(SearchIndexingPlanFilter filter)	Set a filter configuration and define which types must be included/excluded when indexed within indexing plans of the current session (either automatically or manually).
void	indexingPlanSynchronizationStrategy(IndexingPlanSynchronizationStrategy synchronizationStrategy)	Set the IndexingPlanSynchronizationStrategy to use for this session.
MassIndexer	massIndexer(Collection<? extends Class<?>> classes)	Creates a MassIndexer to rebuild the indexes mapped to indexed entity types among the given classes and their subtypes.
SearchSchemaManager	schemaManager(Collection<? extends Class<?>> classes)	Create a SearchSchemaManager for the indexes mapped to indexed entity types among the given classes and their subtypes.
<T> SearchScope<T>	scope(Class<T> expectedSuperType, Collection<String> entityNames)	Creates a SearchScope limited to indexed entity types among the entities with the given names and their subtypes.
<T> SearchScope<T>	scope(Collection<? extends Class<? extends T>> classes)	Creates a SearchScope limited to indexed entity types among the given classes and their subtypes.
<T> SearchQuerySelectStep<?,EntityReference,T,SearchLoadingOptionsStep,?,?>	search(Collection<? extends Class<? extends T>> classes)	Initiate the building of a search query.
<T> SearchQuerySelectStep<?,EntityReference,T,SearchLoadingOptionsStep,?,?>	search(SearchScope<T> scope)	Initiate the building of a search query.
EntityManager	toEntityManager()
Session	toOrmSession()
SearchWorkspace	workspace(Collection<? extends Class<?>> classes)	Create a SearchWorkspace for the indexes mapped to indexed entity types among the given classes and their subtypes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.mapper.orm.scope.SearchScopeProvider

scope, scope

Methods inherited from interface org.hibernate.search.mapper.orm.session.SearchSession

massIndexer, massIndexer, schemaManager, schemaManager, search, workspace, workspace

Constructor Details

DelegatingSearchSession

public DelegatingSearchSession(Supplier<? extends HibernateOrmSearchSessionMappingContext> mappingContextProvider,
 Session session)

Method Details

search

public <T>
SearchQuerySelectStep<?,EntityReference,T,SearchLoadingOptionsStep,?,?> search(Collection<? extends Class<? extends T>> classes)

Description copied from interface: SearchSession

Initiate the building of a search query.

The query will target the indexes mapped to indexed entity types among the given classes and their subtypes.

Specified by:

search in interface SearchSession

Type Parameters:

T - A supertype of all indexed types that will be targeted by the search query.

Parameters:

classes - A collection of classes. Each must be an indexed entity type or a supertype of such type.

Returns:

The initial step of a DSL where the search query can be defined.

See Also:

• SearchQuerySelectStep

search

public <T>
SearchQuerySelectStep<?,EntityReference,T,SearchLoadingOptionsStep,?,?> search(SearchScope<T> scope)

Description copied from interface: SearchSession

Initiate the building of a search query.

The query will target the indexes in the given scope.

Specified by:

search in interface SearchSession

Type Parameters:

T - A supertype of all types in the given scope.

Parameters:

scope - A scope representing all indexed types that will be targeted by the search query.

Returns:

The initial step of a DSL where the search query can be defined.

See Also:

• SearchQuerySelectStep

schemaManager

public SearchSchemaManager schemaManager(Collection<? extends Class<?>> classes)

Description copied from interface: SearchSession

Create a SearchSchemaManager for the indexes mapped to indexed entity types among the given classes and their subtypes.

Specified by:

schemaManager in interface SearchSession

Parameters:

classes - A collection of classes. Each must be an indexed entity type or a supertype of such type.

Returns:

A SearchSchemaManager.

workspace

public SearchWorkspace workspace(Collection<? extends Class<?>> classes)

Description copied from interface: SearchSession

Create a SearchWorkspace for the indexes mapped to indexed entity types among the given classes and their subtypes.

Specified by:

workspace in interface SearchSession

Parameters:

classes - A collection of classes. Each must be an indexed entity type or a supertype of such type.

Returns:

A SearchWorkspace.

massIndexer

public MassIndexer massIndexer(Collection<? extends Class<?>> classes)

Description copied from interface: SearchSession

Creates a MassIndexer to rebuild the indexes mapped to indexed entity types among the given classes and their subtypes.

Specified by:

massIndexer in interface SearchSession

Parameters:

classes - A collection of classes. Each must be an indexed entity type or a supertype of such type.

Returns:

The created mass indexer.

scope

public <T> SearchScope<T> scope(Collection<? extends Class<? extends T>> classes)

Description copied from interface: SearchScopeProvider

Creates a SearchScope limited to indexed entity types among the given classes and their subtypes.

Specified by:

scope in interface SearchScopeProvider

Type Parameters:

T - A supertype of all indexed entity types to include in the scope.

Parameters:

classes - A collection of classes. Each must be an indexed entity type or a supertype of such type.

Returns:

The created scope.

See Also:

• SearchScope

scope

public <T> SearchScope<T> scope(Class<T> expectedSuperType,
 Collection<String> entityNames)

Description copied from interface: SearchScopeProvider

Creates a SearchScope limited to indexed entity types among the entities with the given names and their subtypes.

Specified by:

scope in interface SearchScopeProvider

Type Parameters:

T - A supertype of all indexed entity types to include in the scope.

Parameters:

expectedSuperType - A supertype of all indexed entity types to include in the scope.

entityNames - A collection of entity names. See Entity.name(). Each entity type referenced in the collection must be an indexed entity type or a supertype of such type.

Returns:

The created scope.

See Also:

• SearchScope

toEntityManager

public EntityManager toEntityManager()

Specified by:

toEntityManager in interface SearchSession

Returns:

The underlying EntityManager used by this SearchSession.

toOrmSession

public Session toOrmSession()

Specified by:

toOrmSession in interface SearchSession

Returns:

The underlying Session used by this SearchSession.

indexingPlan

public SearchIndexingPlan indexingPlan()

Specified by:

indexingPlan in interface SearchSession

Returns:

The indexing plan for this session, allowing to explicitly index entities or delete them from the index, or to process entity changes or even write to the indexes before the transaction is committed.

automaticIndexingSynchronizationStrategy

public void automaticIndexingSynchronizationStrategy(AutomaticIndexingSynchronizationStrategy synchronizationStrategy)

Description copied from interface: SearchSession

Set the AutomaticIndexingSynchronizationStrategy to use for this session.

Behavior is undefined if called while entity changes are pending: be sure to call this only just after creating a session, or just after committing a transaction.

Specified by:

automaticIndexingSynchronizationStrategy in interface SearchSession

Parameters:

synchronizationStrategy - The synchronization strategy to use

See Also:

• AutomaticIndexingSynchronizationStrategy

indexingPlanSynchronizationStrategy

public void indexingPlanSynchronizationStrategy(IndexingPlanSynchronizationStrategy synchronizationStrategy)

Description copied from interface: SearchSession

Set the IndexingPlanSynchronizationStrategy to use for this session.

Behavior is undefined if called while entity changes are pending: be sure to call this only just after creating a session, or just after committing a transaction.

Specified by:

indexingPlanSynchronizationStrategy in interface SearchSession

Parameters:

synchronizationStrategy - The synchronization strategy to use

See Also:

• IndexingPlanSynchronizationStrategy

indexingPlanFilter

public void indexingPlanFilter(SearchIndexingPlanFilter filter)

Description copied from interface: SearchSession

Set a filter configuration and define which types must be included/excluded when indexed within indexing plans of the current session (either automatically or manually).

This does not affect indexing that does not rely on indexing plans, like the mass indexer.

If a type is not explicitly included/excluded directly or through an included/excluded supertype, the decision will be made by an application filter, which defaults to including all types.

Specified by:

indexingPlanFilter in interface SearchSession

Parameters:

filter - The filter that includes/excludes types when indexed.