org.hibernate.search.mapper.orm.session

Interface SearchSession

public interface SearchSession

Method Summary

Modifier and Type	Method and Description
default MassIndexer	createIndexer(Class<?>... types) Deprecated. Use massIndexer() or massIndexer(Class[]) instead.
default MassIndexer	massIndexer() Creates a MassIndexer to rebuild the indexes of all indexed entity types.
default MassIndexer	massIndexer(Class<?>... types) Creates a MassIndexer to rebuild the indexes mapped to the given types, or to any of their sub-types.
default MassIndexer	massIndexer(Collection<? extends Class<?>> types) Creates a MassIndexer to rebuild the indexes mapped to the given types, or to any of their sub-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> HibernateOrmSearchQueryHitTypeStep<T>	search(Class<T> type) Initiate the building of a search query.
default <T> HibernateOrmSearchQueryHitTypeStep<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()
SearchSessionWritePlan	writePlan()
default SearchWriter	writer() Create a SearchWriter for the indexes mapped to all indexed types.
default SearchWriter	writer(Class<?>... types) Create a SearchWriter for the indexes mapped to the given type, or to any of its sub-types.
default SearchWriter	writer(Collection<? extends Class<?>> types) Create a SearchWriter for the indexes mapped to the given types, or to any of their sub-types.

Method Detail

search

default <T> HibernateOrmSearchQueryHitTypeStep<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:

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

See Also:

HibernateOrmSearchQueryHitTypeStep

search

default <T> HibernateOrmSearchQueryHitTypeStep<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:

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

See Also:

HibernateOrmSearchQueryHitTypeStep

writer

default SearchWriter writer()

Create a SearchWriter for the indexes mapped to all indexed types.

Returns:

A SearchWriter.

writer

default SearchWriter writer(Class<?>... types)

Create a SearchWriter for the indexes mapped to the given type, or to any of its sub-types.

Parameters:

types - One or more indexed types, or supertypes of all indexed types that will be targeted by the writer.

Returns:

A SearchWriter.

writer

default SearchWriter writer(Collection<? extends Class<?>> types)

Create a SearchWriter for the indexes mapped to the given types, or to any of their sub-types.

Parameters:

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

Returns:

A SearchWriter.

massIndexer

default MassIndexer massIndexer()

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

MassIndexer instances cannot be reused.

Returns:

The created mass indexer.

massIndexer

default MassIndexer massIndexer(Class<?>... types)

Creates a MassIndexer to rebuild 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 targeted by the writer.

Returns:

The created mass indexer.

massIndexer

default MassIndexer massIndexer(Collection<? extends Class<?>> types)

Creates a MassIndexer to rebuild the indexes mapped to the given types, or to any of their sub-types.

Parameters:

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

Returns:

A SearchWriter.

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

@Deprecated
default MassIndexer createIndexer(Class<?>... types)

Deprecated. Use massIndexer() or massIndexer(Class[]) instead.

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.

writePlan

SearchSessionWritePlan writePlan()

Returns:

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

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