org.hibernate.search

Interface SearchFactory

public interface SearchFactory

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 and Description
org.hibernate.search.query.dsl.QueryContextBuilder	buildQueryBuilder()
org.apache.lucene.analysis.Analyzer	getAnalyzer(Class<?> clazz) Retrieves the scoped analyzer for a given class.
org.apache.lucene.analysis.Analyzer	getAnalyzer(String name) Retrieve an analyzer instance by its definition name
org.hibernate.search.metadata.IndexedTypeDescriptor	getIndexedTypeDescriptor(Class<?> entityType) Returns a descriptor for the specified entity type describing its indexed state.
Set<Class<?>>	getIndexedTypes() Returns the set of currently indexed types.
org.hibernate.search.indexes.IndexFamily	getIndexFamily(org.hibernate.search.indexes.IndexFamilyType indexFamilyType) Get an IndexFamily using the index family type.
org.hibernate.search.indexes.IndexReaderAccessor	getIndexReaderAccessor() Provides access to the IndexReader API
org.hibernate.search.stat.Statistics	getStatistics() Retrieve the statistics instance for this factory.
void	optimize() Optimize all indexes
void	optimize(Class<?> entityType) Optimize the index holding entityType
<T> T	unwrap(Class<T> cls) Unwraps some internal Hibernate Search types.

Method Detail

optimize

void optimize()

Optimize all indexes

optimize

void optimize(Class<?> entityType)

Optimize the index holding entityType

Parameters:

entityType - the entity type (index) to optimize

getAnalyzer

org.apache.lucene.analysis.Analyzer getAnalyzer(String name)

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.exception.SearchException - if the definition name is unknown

getAnalyzer

org.apache.lucene.analysis.Analyzer getAnalyzer(Class<?> clazz)

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

org.hibernate.search.query.dsl.QueryContextBuilder buildQueryBuilder()

Returns:

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

getStatistics

org.hibernate.search.stat.Statistics getStatistics()

Retrieve the statistics instance for this factory.

Returns:

The statistics.

getIndexReaderAccessor

org.hibernate.search.indexes.IndexReaderAccessor getIndexReaderAccessor()

Provides access to the IndexReader API

Returns:

the IndexReaderAccessor for this SearchFactory

getIndexedTypeDescriptor

org.hibernate.search.metadata.IndexedTypeDescriptor getIndexedTypeDescriptor(Class<?> entityType)

Returns a descriptor for the specified entity type describing its indexed state.

Parameters:

entityType - the entity for which to retrieve the descriptor

Returns:

a non null IndexedEntityDescriptor. This method can also be called for non indexed types. To determine whether the entity is actually indexed IndexedTypeDescriptor.isIndexed() can be used.

Throws:

IllegalArgumentException - in case entityType is null

getIndexedTypes

Set<Class<?>> getIndexedTypes()

Returns the set of currently indexed types.

Returns:

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

getIndexFamily

org.hibernate.search.indexes.IndexFamily getIndexFamily(org.hibernate.search.indexes.IndexFamilyType indexFamilyType)

Get an IndexFamily using the index family type.

Parameters:

indexFamilyType - the type of index family to retrieve

Returns:

the selected IndexFamily, or null if it doesn't exist

unwrap

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

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