org.hibernate.search.engine.spi

Interface SearchFactoryImplementor

All Superinterfaces:

SearchFactory, SearchFactoryIntegrator

All Known Subinterfaces:

SearchFactoryImplementorWithShareableState

All Known Implementing Classes:

ImmutableSearchFactory, MutableSearchFactory

public interface SearchFactoryImplementor
extends SearchFactoryIntegrator

Interface which gives access to runtime configuration. Intended to be used by Search components.

Author:

Emmanuel Bernard, Hardy Ferentschik

Method Summary

Methods

Modifier and Type	Method and Description
Properties	getConfigurationProperties()
<T> DocumentBuilderContainedEntity<T>	getDocumentBuilderContainedEntity(Class<T> entityType)
int	getFilterCacheBitResultsSize()
FilterCachingStrategy	getFilterCachingStrategy()
FilterDef	getFilterDefinition(String name)
Map<Class<?>,EntityIndexBinding>	getIndexBindings() Returns a map of all known entity index binding (indexed entities) keyed against the indexed type
Set<Class<?>>	getIndexedTypesPolymorphic(Class<?>[] classes)
String	getIndexingStrategy()
IndexManagerHolder	getIndexManagerHolder()
InstanceInitializer	getInstanceInitializer()
ServiceManager	getServiceManager() Returns the service manager.
StatisticsImplementor	getStatisticsImplementor() Retrieve the statistics implementor instance for this factory.
TimingSource	getTimingSource()
boolean	isDirtyChecksEnabled()
boolean	isJMXEnabled()
BatchBackend	makeBatchBackend(MassIndexerProgressMonitor progressMonitor)

Methods inherited from interface org.hibernate.search.spi.SearchFactoryIntegrator

addClasses, close, createHSQuery, getDefaultTimeoutExceptionFactory, getErrorHandler, getIndexBinding, getWorker, isStopped

Methods inherited from interface org.hibernate.search.engine.SearchFactory

buildQueryBuilder, getAnalyzer, getAnalyzer, getIndexedTypeDescriptor, getIndexedTypes, getIndexReaderAccessor, getStatistics, optimize, optimize

Method Detail

getIndexBindings

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

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

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.

getDocumentBuilderContainedEntity

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

getFilterCachingStrategy

FilterCachingStrategy getFilterCachingStrategy()

getFilterDefinition

FilterDef getFilterDefinition(String name)

getIndexingStrategy

String getIndexingStrategy()

getFilterCacheBitResultsSize

int getFilterCacheBitResultsSize()

getIndexedTypesPolymorphic

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

makeBatchBackend

BatchBackend makeBatchBackend(MassIndexerProgressMonitor progressMonitor)

isJMXEnabled

boolean isJMXEnabled()

getStatisticsImplementor

StatisticsImplementor getStatisticsImplementor()

Retrieve the statistics implementor instance for this factory.

Returns:

The statistics implementor.

isDirtyChecksEnabled

boolean isDirtyChecksEnabled()

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.

getIndexManagerHolder

IndexManagerHolder getIndexManagerHolder()

Returns:

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

getInstanceInitializer

InstanceInitializer getInstanceInitializer()

Returns:

an instance of InstanceInitializer for class/object initialization.

getTimingSource

TimingSource getTimingSource()

getConfigurationProperties

Properties getConfigurationProperties()

Returns:

the configuration properties for this factory

getServiceManager

ServiceManager getServiceManager()

Returns the service manager.

Returns:

Returns the service manager.