org.hibernate.search.mapper.orm.session

Interface SearchSession

All Known Subinterfaces:

SearchSessionImplementor

public interface SearchSession

Method Summary

Modifier and Type	Method and Description
MassIndexer	createIndexer(Class<?>... types) Creates a MassIndexer to rebuild the indexes of some or all indexed entity types.
default <T> SearchScope<T>	scope(Class<T> type) Create a SearchScope limited to the given type.
<T> SearchScope<T>	scope(Collection<? extends Class<? extends T>> types) Create a SearchScope limited to the given types.
default <T> HibernateOrmSearchQueryResultDefinitionContext<T>	search(Class<T> type) Initiate the building of a search query.
default <T> HibernateOrmSearchQueryResultDefinitionContext<T>	search(Collection<? extends Class<? extends T>> types) Initiate the building of a search query.
void	setAutomaticIndexingSynchronizationStrategy(AutomaticIndexingSynchronizationStrategy synchronizationStrategy) Set the AutomaticIndexingSynchronizationStrategy to use for this session.
EntityManager	toEntityManager()
Session	toOrmSession()

Method Detail

search

default <T> HibernateOrmSearchQueryResultDefinitionContext<T> search(Class<T> type)

Initiate the building of a search query.

The query will target the indexes mapped to the given type, or to any of its sub-types.

Type Parameters:

T - An indexed type, or a supertype of all indexed types that will be targeted by the search query.

Parameters:

type - An indexed type, or a supertype of all indexed types that will be targeted by the search query.

Returns:

A context allowing to define the search query, and ultimately get the resulting query.

See Also:

HibernateOrmSearchQueryResultDefinitionContext

search

default <T> HibernateOrmSearchQueryResultDefinitionContext<T> search(Collection<? extends Class<? extends T>> types)

Initiate the building of a search query.

The query will target the indexes mapped to the given types, or to any of their sub-types.

Type Parameters:

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

Parameters:

types - A collection of indexed types, or supertypes of all indexed types that will be targeted by the search query.

Returns:

A context allowing to define the search query, and ultimately get the resulting query.

See Also:

HibernateOrmSearchQueryResultDefinitionContext

scope

default <T> SearchScope<T> scope(Class<T> type)

Create a SearchScope limited to the given type.

Type Parameters:

T - A type to include in the scope.

Parameters:

type - A type to include in the scope.

Returns:

The created scope.

See Also:

SearchScope

scope

<T> SearchScope<T> scope(Collection<? extends Class<? extends T>> types)

Create a SearchScope limited to the given types.

Type Parameters:

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

Parameters:

types - A collection of types to include in the scope.

Returns:

The created scope.

See Also:

SearchScope

createIndexer

MassIndexer createIndexer(Class<?>... types)

Creates a MassIndexer to rebuild the indexes of some or all indexed entity types.

The indexer will apply to the indexes mapped to the given types, or to any of their sub-types.

MassIndexer instances cannot be reused.

Parameters:

types - An array of indexed types, or supertypes of all indexed types that will be reindexed. If empty, all indexed types will be reindexed.

Returns:

The created mass indexer.

toEntityManager

EntityManager toEntityManager()

Returns:

The underlying EntityManager used by this SearchSession.

toOrmSession

Session toOrmSession()

Returns:

The underlying Session used by this SearchSession.

setAutomaticIndexingSynchronizationStrategy

void setAutomaticIndexingSynchronizationStrategy(AutomaticIndexingSynchronizationStrategy synchronizationStrategy)

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.

Parameters:

synchronizationStrategy - The synchronization strategy to use

See Also:

AutomaticIndexingSynchronizationStrategy