Package org.hibernate.search

Interface SearchFactory

public interface SearchFactory

Deprecated.

Instead of using Hibernate Search 5 APIs, get a SearchMapping using Search.mapping(javax.persistence.EntityManagerFactory), or Search.mapping(SessionFactory). See the individual methods for the replacement of each method. Refer to the migration guide for more information.

Provide application wide operations as well as access to the underlying Lucene resources.

Author:

Emmanuel Bernard, Hardy Ferentschik, Sanne Grinovero

Method Summary

Modifier and Type	Method	Description
QueryContextBuilder	buildQueryBuilder()	Deprecated. See the deprecation note on QueryBuilder for predicates ("queries") SortContext for sorts, FacetContext for aggregations ("facets").
Analyzer	getAnalyzer(Class<?> clazz)	Deprecated. Instead of using Hibernate Search 5 APIs, get a SearchMapping using Search.mapping(javax.persistence.EntityManagerFactory), or Search.mapping(SessionFactory), then get access to the entity metadata using SearchMapping.indexedEntity(Class), then get the corresponding index using SearchIndexedEntity.indexManager(), then convert it to a LuceneIndexManager using IndexManager.unwrap(Class), then get the analyzer using LuceneIndexManager.searchAnalyzer().
Analyzer	getAnalyzer(String name)	Deprecated. Instead of using Hibernate Search 5 APIs, get a SearchMapping using Search.mapping(javax.persistence.EntityManagerFactory), or Search.mapping(SessionFactory), then get access to the backend using SearchMapping.backend(), then convert it to a LuceneBackend using Backend.unwrap(Class), then get the analyzer using LuceneBackend.analyzer(String).
Set<Class<?>>	getIndexedTypes()	Deprecated. Instead of using Hibernate Search 5 APIs, get a SearchMapping using Search.mapping(javax.persistence.EntityManagerFactory), or Search.mapping(SessionFactory), then get access to the entity metadata using SearchMapping.allIndexedEntities().
void	optimize()	Deprecated. Instead of using Hibernate Search 5 APIs, get a SearchScope using SearchSession.scope(Class) or SearchMapping.scope(Class), then a SearchWorkspace using SearchScope.workspace(), then call SearchWorkspace.mergeSegments() to "optimize" all indexes in scope.
void	optimize(Class<?> entityType)	Deprecated. Instead of using Hibernate Search 5 APIs, get a SearchScope using SearchSession.scope(Class) or SearchMapping.scope(Class), then a SearchWorkspace using SearchScope.workspace(), then call SearchWorkspace.mergeSegments() to "optimize" all indexes in scope.
<T> T	unwrap(Class<T> cls)	Deprecated. Unwraps some internal Hibernate Search types.

Method Details

optimize

@Deprecated
void optimize()

Deprecated.

Instead of using Hibernate Search 5 APIs, get a SearchScope using SearchSession.scope(Class) or SearchMapping.scope(Class), then a SearchWorkspace using SearchScope.workspace(), then call SearchWorkspace.mergeSegments() to "optimize" all indexes in scope.

Optimize all indexes

optimize

@Deprecated
void optimize(Class<?> entityType)

Deprecated.

Instead of using Hibernate Search 5 APIs, get a SearchScope using SearchSession.scope(Class) or SearchMapping.scope(Class), then a SearchWorkspace using SearchScope.workspace(), then call SearchWorkspace.mergeSegments() to "optimize" all indexes in scope.

Optimize the index holding entityType

Parameters:

entityType - the entity type (index) to optimize

getAnalyzer

@Deprecated
Analyzer getAnalyzer(String name)

Deprecated.

Instead of using Hibernate Search 5 APIs, get a SearchMapping using Search.mapping(javax.persistence.EntityManagerFactory), or Search.mapping(SessionFactory), then get access to the backend using SearchMapping.backend(), then convert it to a LuceneBackend using Backend.unwrap(Class), then get the analyzer using LuceneBackend.analyzer(String). Refer to the migration guide for more information.

Retrieve an analyzer instance by its definition name

Parameters:

name - the name of the analyzer

Returns:

analyzer with the specified name

Throws:

org.hibernate.search.util.common.SearchException - if the definition name is unknown

getAnalyzer

@Deprecated
Analyzer getAnalyzer(Class<?> clazz)

Deprecated.

Instead of using Hibernate Search 5 APIs, get a SearchMapping using Search.mapping(javax.persistence.EntityManagerFactory), or Search.mapping(SessionFactory), then get access to the entity metadata using SearchMapping.indexedEntity(Class), then get the corresponding index using SearchIndexedEntity.indexManager(), then convert it to a LuceneIndexManager using IndexManager.unwrap(Class), then get the analyzer using LuceneIndexManager.searchAnalyzer(). Refer to the migration guide for more information.

Retrieves the scoped analyzer for a given class.

Parameters:

clazz - The class for which to retrieve the analyzer.

Returns:

The scoped analyzer for the specified class.

Throws:

IllegalArgumentException - in case clazz == null or the specified class is not an indexed entity.

buildQueryBuilder

@Deprecated
QueryContextBuilder buildQueryBuilder()

Deprecated.

See the deprecation note on QueryBuilder for predicates ("queries") SortContext for sorts, FacetContext for aggregations ("facets").

Returns:

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

getIndexedTypes

@Deprecated
Set<Class<?>> getIndexedTypes()

Deprecated.

Instead of using Hibernate Search 5 APIs, get a SearchMapping using Search.mapping(javax.persistence.EntityManagerFactory), or Search.mapping(SessionFactory), then get access to the entity metadata using SearchMapping.allIndexedEntities().

Returns the set of currently indexed types.

Returns:

the set of currently indexed types. If no types are indexed the empty set is returned.

unwrap

<T> T unwrap(Class<T> cls)

Deprecated.

Unwraps some internal Hibernate Search types. Currently, no public type is accessible. This method should not be used by users.

Type Parameters:

T - the type of the unwrapped class

Parameters:

cls - the type to unwrap

Returns:

the unwrapped object