org.hibernate.search.impl

Class MutableSearchFactory

java.lang.Object

org.hibernate.search.impl.MutableSearchFactory

All Implemented Interfaces:

SearchFactoryImplementor, SearchFactory, BuildContext, SearchFactoryImplementorWithShareableState, SearchFactoryState, SearchFactoryIntegrator, WorkerBuildContext

public class MutableSearchFactory
extends Object
implements SearchFactoryImplementorWithShareableState, SearchFactoryIntegrator, WorkerBuildContext

Factory delegating to a concrete implementation of another factory. Useful to swap one factory for another. Swapping factory is thread safe.

Author:

Emmanuel Bernard

Constructor Summary

Constructors

Constructor and Description
MutableSearchFactory()

Method Summary

Methods

Modifier and Type	Method and Description
void	addClasses(Class<?>... classes) Add the following classes to the SearchFactory.
QueryContextBuilder	buildQueryBuilder()
void	close()
HSQuery	createHSQuery() Return an Hibernate Search query object.
IndexManagerHolder	getAllIndexesManager()
Analyzer	getAnalyzer(Class<?> clazz) Retrieves the scoped analyzer for a given class.
Analyzer	getAnalyzer(String name) Retrieve an analyzer instance by its definition name
Map<String,Analyzer>	getAnalyzers()
int	getCacheBitResultsSize()
Properties	getConfigurationProperties()
TimeoutExceptionFactory	getDefaultTimeoutExceptionFactory()
<T> DocumentBuilderContainedEntity<T>	getDocumentBuilderContainedEntity(Class<T> entityType)
Map<Class<?>,DocumentBuilderContainedEntity<?>>	getDocumentBuildersContainedEntities()
ErrorHandler	getErrorHandler() Used to catch exceptions in all synchronous operations; but default they are logged, the user can configure alternative error management means.
int	getFilterCacheBitResultsSize()
FilterCachingStrategy	getFilterCachingStrategy()
FilterDef	getFilterDefinition(String name)
Map<String,FilterDef>	getFilterDefinitions()
EntityIndexBinding	getIndexBinding(Class<?> entityType) Returns the entity to index binding for the given type.
Map<Class<?>,EntityIndexBinder>	getIndexBindingForEntity()
EntityIndexBinder	getIndexBindingForEntity(Class<?> entityType)
Map<Class<?>,EntityIndexBinding>	getIndexBindings() Returns a map of all known entity index binding (indexed entities) keyed against the indexed type
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.
Set<Class<?>>	getIndexedTypesPolymorphic(Class<?>[] classes)
PolymorphicIndexHierarchy	getIndexHierarchy()
String	getIndexingStrategy() Returns the configured indexing strategy (event vs manual).
IndexManagerFactory	getIndexManagerFactory()
IndexManagerHolder	getIndexManagerHolder()
IndexReaderAccessor	getIndexReaderAccessor() Provides access to the IndexReader API
InstanceInitializer	getInstanceInitializer()
SearchMapping	getProgrammaticMapping()
ServiceManager	getServiceManager() Access the ServiceManager.
Statistics	getStatistics() Retrieve the statistics instance for this factory.
StatisticsImplementor	getStatisticsImplementor() Retrieve the statistics implementor instance for this factory.
TimingSource	getTimingSource()
SearchFactoryImplementor	getUninitializedSearchFactory() Returns the SessionFactoryImplementor instance.
Worker	getWorker()
boolean	isDirtyChecksEnabled()
boolean	isIdProvidedImplicit()
boolean	isIndexMetadataComplete()
boolean	isJMXEnabled()
boolean	isStopped()
boolean	isTransactionManagerExpected()
BatchBackend	makeBatchBackend(MassIndexerProgressMonitor progressMonitor)
void	optimize() Optimize all indexes
void	optimize(Class entityType) Optimize the index holding entityType
void	releaseService(Class<? extends ServiceProvider<?>> provider) Release a service from duty.
<T> T	requestService(Class<? extends ServiceProvider<T>> provider) Declare the use of a service.
void	setDelegate(SearchFactoryImplementorWithShareableState delegate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MutableSearchFactory

public MutableSearchFactory()

Method Detail

setDelegate

public void setDelegate(SearchFactoryImplementorWithShareableState delegate)

getFilterDefinitions

public Map<String,FilterDef> getFilterDefinitions()

Specified by:

getFilterDefinitions in interface SearchFactoryState

getIndexBindings

public Map<Class<?>,EntityIndexBinding> getIndexBindings()

Description copied from interface: SearchFactoryImplementor

Returns a map of all known entity index binding (indexed entities) keyed against the indexed type

Specified by:

getIndexBindings in interface SearchFactoryImplementor

Specified by:

getIndexBindings in interface SearchFactoryState

Returns:

a map of all known entity index binding (indexed entities) keyed against the indexed type. The empty map is returned if there are no indexed types.

getIndexBindingForEntity

public Map<Class<?>,EntityIndexBinder> getIndexBindingForEntity()

Specified by:

getIndexBindingForEntity in interface SearchFactoryImplementor

Specified by:

getIndexBindingForEntity in interface SearchFactoryState

getIndexBindingForEntity

public EntityIndexBinder getIndexBindingForEntity(Class<?> entityType)

Specified by:

getIndexBindingForEntity in interface SearchFactoryIntegrator

getIndexBinding

public EntityIndexBinding getIndexBinding(Class<?> entityType)

Description copied from interface: SearchFactoryIntegrator

Returns the entity to index binding for the given type.

Specified by:

getIndexBinding in interface SearchFactoryIntegrator

Parameters:

entityType - the type for which to retrieve the binding

Returns:

the entity to index binding for the given type. null is returned for types which are unindexed or unknown.

getDocumentBuilderContainedEntity

public <T> DocumentBuilderContainedEntity<T> getDocumentBuilderContainedEntity(Class<T> entityType)

Specified by:

getDocumentBuilderContainedEntity in interface SearchFactoryImplementor

getWorker

public Worker getWorker()

Specified by:

getWorker in interface SearchFactoryState

Specified by:

getWorker in interface SearchFactoryIntegrator

getFilterCachingStrategy

public FilterCachingStrategy getFilterCachingStrategy()

Specified by:

getFilterCachingStrategy in interface SearchFactoryImplementor

Specified by:

getFilterCachingStrategy in interface SearchFactoryState

getAnalyzers

public Map<String,Analyzer> getAnalyzers()

Specified by:

getAnalyzers in interface SearchFactoryState

getCacheBitResultsSize

public int getCacheBitResultsSize()

Specified by:

getCacheBitResultsSize in interface SearchFactoryState

getConfigurationProperties

public Properties getConfigurationProperties()

Specified by:

getConfigurationProperties in interface SearchFactoryState

getFilterDefinition

public FilterDef getFilterDefinition(String name)

Specified by:

getFilterDefinition in interface SearchFactoryImplementor

getUninitializedSearchFactory

public SearchFactoryImplementor getUninitializedSearchFactory()

Description copied from interface: BuildContext

Returns the SessionFactoryImplementor instance. Do not use until after the initialize and/or start method is fully executed. Implementations should not cache values provided by the SessionFactoryImplementor, but rather access them each time, because the configuration can be dynamically updated and new changes made available. For example, prefer:

 void method() {
   int size = sfi.getDirectoryProviders().size();
 }
 
 

over

 void method() {
 int size = directoryProviders.size();
 }
 
 

where directoryProviders is a class variable.

Specified by:

getUninitializedSearchFactory in interface BuildContext

getIndexingStrategy

public String getIndexingStrategy()

Description copied from interface: BuildContext

Returns the configured indexing strategy (event vs manual).

Specified by:

getIndexingStrategy in interface SearchFactoryImplementor

Specified by:

getIndexingStrategy in interface BuildContext

Specified by:

getIndexingStrategy in interface SearchFactoryState

Returns:

hte configured indexing strategy

See Also:

Environment.INDEXING_STRATEGY

requestService

public <T> T requestService(Class<? extends ServiceProvider<T>> provider)

Description copied from interface: BuildContext

Declare the use of a service. All callers of this method must call (@link #releaseService} or the service will not be released

Specified by:

requestService in interface BuildContext

Type Parameters:

T - class of the service

Parameters:

provider - of the service

Returns:

the service instance

releaseService

public void releaseService(Class<? extends ServiceProvider<?>> provider)

Description copied from interface: BuildContext

Release a service from duty. Each call to (@link #requestService} should be coupled with a call to (@link #releaseService} when the service is no longer needed.

Specified by:

releaseService in interface BuildContext

Parameters:

provider - of the service

close

public void close()

Specified by:

close in interface SearchFactoryIntegrator

createHSQuery

public HSQuery createHSQuery()

Description copied from interface: SearchFactoryIntegrator

Return an Hibernate Search query object. This object uses fluent APIs to define the query executed. Offers a few execution approaches: - return the list of results eagerly - return the list of results lazily - get the number of results

Specified by:

createHSQuery in interface SearchFactoryIntegrator

getFilterCacheBitResultsSize

public int getFilterCacheBitResultsSize()

Specified by:

getFilterCacheBitResultsSize in interface SearchFactoryImplementor

getIndexedTypesPolymorphic

public Set<Class<?>> getIndexedTypesPolymorphic(Class<?>[] classes)

Specified by:

getIndexedTypesPolymorphic in interface SearchFactoryImplementor

makeBatchBackend

public BatchBackend makeBatchBackend(MassIndexerProgressMonitor progressMonitor)

Specified by:

makeBatchBackend in interface SearchFactoryImplementor

isJMXEnabled

public boolean isJMXEnabled()

Specified by:

isJMXEnabled in interface SearchFactoryImplementor

getStatisticsImplementor

public StatisticsImplementor getStatisticsImplementor()

Description copied from interface: SearchFactoryImplementor

Retrieve the statistics implementor instance for this factory.

Specified by:

getStatisticsImplementor in interface SearchFactoryImplementor

Returns:

The statistics implementor.

getIndexHierarchy

public PolymorphicIndexHierarchy getIndexHierarchy()

Specified by:

getIndexHierarchy in interface SearchFactoryState

getServiceManager

public ServiceManager getServiceManager()

Description copied from interface: BuildContext

Access the ServiceManager. Clients should keep a reference to the ServiceManager to allow for cleanup, but should not keep a reference to the BuildContext.

Specified by:

getServiceManager in interface BuildContext

Specified by:

getServiceManager in interface SearchFactoryState

optimize

public void optimize()

Description copied from interface: SearchFactory

Optimize all indexes

Specified by:

optimize in interface SearchFactory

optimize

public void optimize(Class entityType)

Description copied from interface: SearchFactory

Optimize the index holding entityType

Specified by:

optimize in interface SearchFactory

Parameters:

entityType - the entity type (index) to optimize

getAnalyzer

public Analyzer getAnalyzer(String name)

Description copied from interface: SearchFactory

Retrieve an analyzer instance by its definition name

Specified by:

getAnalyzer in interface SearchFactory

Parameters:

name - the name of the analyzer

Returns:

analyzer with the specified name

getAnalyzer

public Analyzer getAnalyzer(Class<?> clazz)

Description copied from interface: SearchFactory

Retrieves the scoped analyzer for a given class.

Specified by:

getAnalyzer in interface SearchFactory

Parameters:

clazz - The class for which to retrieve the analyzer.

Returns:

The scoped analyzer for the specified class.

buildQueryBuilder

public QueryContextBuilder buildQueryBuilder()

Specified by:

buildQueryBuilder in interface SearchFactory

Returns:

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

getStatistics

public Statistics getStatistics()

Description copied from interface: SearchFactory

Retrieve the statistics instance for this factory.

Specified by:

getStatistics in interface SearchFactory

Returns:

The statistics.

getDocumentBuildersContainedEntities

public Map<Class<?>,DocumentBuilderContainedEntity<?>> getDocumentBuildersContainedEntities()

Specified by:

getDocumentBuildersContainedEntities in interface SearchFactoryState

addClasses

public void addClasses(Class<?>... classes)

Description copied from interface: SearchFactoryIntegrator

Add the following classes to the SearchFactory. If these classes are new to the SearchFactory this will trigger a reconfiguration.

Specified by:

addClasses in interface SearchFactoryIntegrator

isDirtyChecksEnabled

public boolean isDirtyChecksEnabled()

Specified by:

isDirtyChecksEnabled in interface SearchFactoryImplementor

Returns:

true if we are allowed to inspect entity state to skip some indexing operations. Can be disabled to get pre-3.4 behavior which always rebuilds the document.

isStopped

public boolean isStopped()

Specified by:

isStopped in interface SearchFactoryIntegrator

Returns:

true if the SearchFactory was stopped

isTransactionManagerExpected

public boolean isTransactionManagerExpected()

Specified by:

isTransactionManagerExpected in interface SearchFactoryState

Specified by:

isTransactionManagerExpected in interface WorkerBuildContext

Returns:

true if a transaction manager is expected, false otherwise.

See Also:

SearchConfiguration.isTransactionManagerExpected()

getAllIndexesManager

public IndexManagerHolder getAllIndexesManager()

Specified by:

getAllIndexesManager in interface SearchFactoryImplementor

Specified by:

getAllIndexesManager in interface BuildContext

Specified by:

getAllIndexesManager in interface SearchFactoryState

Returns:

the IndexManagerHolder which gives access to all index managers known to this factory

getIndexManagerHolder

public IndexManagerHolder getIndexManagerHolder()

Specified by:

getIndexManagerHolder in interface SearchFactoryImplementor

Returns:

Returns the IndexManagerHolder which gives access to all index managers known to this factory

getErrorHandler

public ErrorHandler getErrorHandler()

Description copied from interface: SearchFactoryIntegrator

Used to catch exceptions in all synchronous operations; but default they are logged, the user can configure alternative error management means.

Specified by:

getErrorHandler in interface BuildContext

Specified by:

getErrorHandler in interface SearchFactoryState

Specified by:

getErrorHandler in interface SearchFactoryIntegrator

Returns:

the configured ErrorHandler, global to the SearchFactory

getIndexReaderAccessor

public IndexReaderAccessor getIndexReaderAccessor()

Description copied from interface: SearchFactory

Provides access to the IndexReader API

Specified by:

getIndexReaderAccessor in interface SearchFactory

Returns:

the IndexReaderAccessor for this SearchFactory

getIndexedTypeDescriptor

public IndexedTypeDescriptor getIndexedTypeDescriptor(Class<?> entityType)

Description copied from interface: SearchFactory

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

Specified by:

getIndexedTypeDescriptor in interface SearchFactory

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.

getIndexedTypes

public Set<Class<?>> getIndexedTypes()

Description copied from interface: SearchFactory

Returns the set of currently indexed types.

Specified by:

getIndexedTypes in interface SearchFactory

Returns:

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

getInstanceInitializer

public InstanceInitializer getInstanceInitializer()

Specified by:

getInstanceInitializer in interface SearchFactoryImplementor

Specified by:

getInstanceInitializer in interface SearchFactoryState

Specified by:

getInstanceInitializer in interface WorkerBuildContext

Returns:

an instance of InstanceInitializer for class/object initialization.

getDefaultTimeoutExceptionFactory

public TimeoutExceptionFactory getDefaultTimeoutExceptionFactory()

Specified by:

getDefaultTimeoutExceptionFactory in interface SearchFactoryState

Specified by:

getDefaultTimeoutExceptionFactory in interface SearchFactoryIntegrator

getTimingSource

public TimingSource getTimingSource()

Specified by:

getTimingSource in interface SearchFactoryImplementor

Specified by:

getTimingSource in interface SearchFactoryState

getProgrammaticMapping

public SearchMapping getProgrammaticMapping()

Specified by:

getProgrammaticMapping in interface SearchFactoryState

isIndexMetadataComplete

public boolean isIndexMetadataComplete()

Specified by:

isIndexMetadataComplete in interface SearchFactoryState

Specified by:

isIndexMetadataComplete in interface WorkerBuildContext

Returns:

true if it is safe to assume that the information we have about index metadata is accurate. This should be set to false for example if the index could contain Documents related to types not known to this SearchFactory instance.

See Also:

SearchConfiguration.isIndexMetadataComplete()

isIdProvidedImplicit

public boolean isIdProvidedImplicit()

Specified by:

isIdProvidedImplicit in interface SearchFactoryState

getIndexManagerFactory

public IndexManagerFactory getIndexManagerFactory()

Specified by:

getIndexManagerFactory in interface SearchFactoryState