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

Class HibernateOrmSearchSession

java.lang.Object

org.hibernate.search.mapper.pojo.session.spi.AbstractPojoSearchSession

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

All Implemented Interfaces:

BackendSessionContext, AutomaticIndexingEventSendingSessionContext, LoadingSessionContext, HibernateOrmMassIndexingSessionContext, HibernateOrmScopeSessionContext, HibernateOrmSessionContext, SearchSession, BatchSessionContext, SearchIndexingPlanSessionContext, PojoImplicitReindexingResolverSessionContext, BridgeSessionContext, PojoMassIndexingSessionContext, PojoIndexingProcessorSessionContext, PojoScopeSessionContext, PojoWorkSessionContext

public class HibernateOrmSearchSession
extends AbstractPojoSearchSession
implements SearchSession, HibernateOrmSessionContext, HibernateOrmScopeSessionContext, SearchIndexingPlanSessionContext, AutomaticIndexingEventSendingSessionContext

The actual implementation of SearchSession.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HibernateOrmSearchSession.Builder

Method Summary

Modifier and Type	Method	Description
void	automaticIndexingSynchronizationStrategy(AutomaticIndexingSynchronizationStrategy synchronizationStrategy)	Set the AutomaticIndexingSynchronizationStrategy to use for this session.
void	checkOpen()
ConfiguredIndexingPlanSynchronizationStrategy	configuredAutomaticIndexingSynchronizationStrategy()
ConfiguredSearchIndexingPlanFilter	configuredIndexingPlanFilter()
PojoIndexer	createIndexer()
PojoIndexingQueueEventProcessingPlan	createIndexingQueueEventProcessingPlan()
PojoIndexingPlan	currentIndexingPlan(boolean createIfDoesNotExist)
PojoSelectionLoadingContext	defaultLoadingContext()
EntityReferenceFactory	entityReferenceFactory()
static HibernateOrmSearchSession	get(HibernateOrmSearchSessionMappingContext context, org.hibernate.engine.spi.SessionImplementor sessionImplementor)
static HibernateOrmSearchSession	get(HibernateOrmSearchSessionMappingContext context, org.hibernate.engine.spi.SessionImplementor sessionImplementor, boolean createIfDoesNotExist)
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.
HibernateOrmSearchSessionMappingContext	mappingContext()
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.
PojoRuntimeIntrospector	runtimeIntrospector()
SearchSchemaManager	schemaManager(Collection<? extends Class<?>> types)	Create a SearchSchemaManager for the indexes mapped to the given types, or to any of their sub-types.
<T> SearchScope<T>	scope(Class<T> expectedSuperType, Collection<String> entityNames)	Create a SearchScope limited to entity types referenced by their name.
<T> SearchScopeImpl<T>	scope(Collection<? extends Class<? extends T>> types)	Create a SearchScope limited to the given types.
<T> SearchQuerySelectStep<?,EntityReference,T,SearchLoadingOptionsStep,?,?>	search(Collection<? extends Class<? extends T>> types)	Initiate the building of a search query.
<T> SearchQuerySelectStep<?,EntityReference,T,SearchLoadingOptionsStep,?,?>	search(SearchScopeImpl<T> scope)
<T> SearchQuerySelectStep<?,EntityReference,T,SearchLoadingOptionsStep,?,?>	search(SearchScope<T> scope)	Initiate the building of a search query.
org.hibernate.engine.spi.SessionImplementor	session()
String	tenantIdentifier()
EntityManager	toEntityManager()
org.hibernate.Session	toOrmSession()
SearchWorkspace	workspace(Collection<? extends Class<?>> types)	Create a SearchWorkspace for the indexes mapped to the given types, or to any of their sub-types.

Methods inherited from class org.hibernate.search.mapper.pojo.session.spi.AbstractPojoSearchSession

identifierBridgeFromDocumentIdentifierContext, propertyBridgeWriteContext, routingBridgeRouteContext, typeBridgeWriteContext, valueBridgeFromIndexedValueContext

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.pojo.bridge.runtime.spi.BridgeSessionContext

identifierBridgeFromDocumentIdentifierContext, propertyBridgeWriteContext, routingBridgeRouteContext, typeBridgeWriteContext, valueBridgeFromIndexedValueContext

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

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

Method Detail

get

public static HibernateOrmSearchSession get(HibernateOrmSearchSessionMappingContext context,
                                            org.hibernate.engine.spi.SessionImplementor sessionImplementor)

Parameters:

sessionImplementor - A Hibernate session

Returns:

The HibernateOrmSearchSession to use within the context of the given session.

get

public static HibernateOrmSearchSession get(HibernateOrmSearchSessionMappingContext context,
                                            org.hibernate.engine.spi.SessionImplementor sessionImplementor,
                                            boolean createIfDoesNotExist)

Parameters:

sessionImplementor - A Hibernate session

Returns:

The HibernateOrmSearchSession to use within the context of the given session.

mappingContext

public HibernateOrmSearchSessionMappingContext mappingContext()

Specified by:

mappingContext in interface BackendSessionContext

Specified by:

mappingContext in interface BridgeSessionContext

Specified by:

mappingContext in interface PojoScopeSessionContext

Specified by:

mappingContext in interface PojoWorkSessionContext

Overrides:

mappingContext in class AbstractPojoSearchSession

tenantIdentifier

public String tenantIdentifier()

Specified by:

tenantIdentifier in interface BackendSessionContext

Specified by:

tenantIdentifier in interface BridgeSessionContext

Specified by:

tenantIdentifier in interface PojoMassIndexingSessionContext

createIndexer

public PojoIndexer createIndexer()

Specified by:

createIndexer in interface BatchSessionContext

Specified by:

createIndexer in interface PojoMassIndexingSessionContext

Overrides:

createIndexer in class AbstractPojoSearchSession

search

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

Description copied from interface: SearchSession

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.

Specified by:

search in interface SearchSession

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:

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

search

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

schemaManager

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

Description copied from interface: SearchSession

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

Specified by:

schemaManager in interface SearchSession

Parameters:

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

Returns:

A SearchSchemaManager.

workspace

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

Description copied from interface: SearchSession

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

Specified by:

workspace in interface SearchSession

Parameters:

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

Returns:

A SearchWorkspace.

massIndexer

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

Description copied from interface: SearchSession

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

Specified by:

massIndexer in interface SearchSession

Parameters:

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

Returns:

A SearchWorkspace.

scope

public <T> SearchScopeImpl<T> scope(Collection<? extends Class<? extends T>> types)

Description copied from interface: SearchSession

Create a SearchScope limited to the given types.

Specified by:

scope in interface SearchSession

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

scope

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

Description copied from interface: SearchSession

Create a SearchScope limited to entity types referenced by their name.

Specified by:

scope in interface SearchSession

Type Parameters:

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

Parameters:

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

entityNames - A collection of entity names. See Entity.name().

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 org.hibernate.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.

configuredIndexingPlanFilter

public ConfiguredSearchIndexingPlanFilter configuredIndexingPlanFilter()

Specified by:

configuredIndexingPlanFilter in interface PojoWorkSessionContext

session

public org.hibernate.engine.spi.SessionImplementor session()

Specified by:

session in interface AutomaticIndexingEventSendingSessionContext

Specified by:

session in interface HibernateOrmMassIndexingSessionContext

Specified by:

session in interface HibernateOrmSessionContext

Specified by:

session in interface LoadingSessionContext

Returns:

The Hibernate ORM Session.

entityReferenceFactory

public EntityReferenceFactory entityReferenceFactory()

Specified by:

entityReferenceFactory in interface AutomaticIndexingEventSendingSessionContext

defaultLoadingContext

public PojoSelectionLoadingContext defaultLoadingContext()

Specified by:

defaultLoadingContext in interface PojoWorkSessionContext

runtimeIntrospector

public PojoRuntimeIntrospector runtimeIntrospector()

Specified by:

runtimeIntrospector in interface LoadingSessionContext

Specified by:

runtimeIntrospector in interface PojoImplicitReindexingResolverSessionContext

Specified by:

runtimeIntrospector in interface PojoIndexingProcessorSessionContext

Specified by:

runtimeIntrospector in interface PojoMassIndexingSessionContext

Specified by:

runtimeIntrospector in interface SearchIndexingPlanSessionContext

currentIndexingPlan

public PojoIndexingPlan currentIndexingPlan(boolean createIfDoesNotExist)

Specified by:

currentIndexingPlan in interface SearchIndexingPlanSessionContext

createIndexingQueueEventProcessingPlan

public PojoIndexingQueueEventProcessingPlan createIndexingQueueEventProcessingPlan()

checkOpen

public void checkOpen()

Specified by:

checkOpen in interface SearchIndexingPlanSessionContext

configuredAutomaticIndexingSynchronizationStrategy

public ConfiguredIndexingPlanSynchronizationStrategy configuredAutomaticIndexingSynchronizationStrategy()

Specified by:

configuredAutomaticIndexingSynchronizationStrategy in interface SearchIndexingPlanSessionContext