org.hibernate.search.engine.integration.impl

Interface ExtendedSearchIntegrator

All Superinterfaces:

AutoCloseable, SearchIntegrator

All Known Subinterfaces:

ExtendedSearchIntegratorWithShareableState

All Known Implementing Classes:

ImmutableSearchFactory, MutableSearchFactory

public interface ExtendedSearchIntegrator
extends SearchIntegrator

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

Author:

Emmanuel Bernard, Hardy Ferentschik, Sanne Grinovero

Method Summary

Modifier and Type	Method and Description
Properties	getConfigurationProperties()
DatabaseRetrievalMethod	getDefaultDatabaseRetrievalMethod() Returns the default DatabaseRetrievalMethod.
ObjectLookupMethod	getDefaultObjectLookupMethod() Returns the default ObjectLookupMethod.
DocumentBuilderContainedEntity	getDocumentBuilderContainedEntity(Class<?> 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) Given a set of target entities, return the set of indexed types following our polymorphism rules for propagation of the Indexed annotation: It returns an empty set if none of the target entities is indexed, nor any of their sub types.
IndexManagerHolder	getIndexManagerHolder()
InstanceInitializer	getInstanceInitializer()
StatisticsImplementor	getStatisticsImplementor() Retrieve the statistics implementor instance for this factory.
TimingSource	getTimingSource()
boolean	isDirtyChecksEnabled()
boolean	isIndexUninvertingAllowed() Whether index uninverting should be done when running queries with sorts not covered by the configured sortable fields.
boolean	isJMXEnabled()

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

addClasses, buildQueryBuilder, close, createHSQuery, getAnalyzer, getAnalyzer, getDefaultTimeoutExceptionFactory, getErrorHandler, getIndexBinding, getIndexedTypeDescriptor, getIndexedTypes, getIndexingMode, getIndexManager, getIndexReaderAccessor, getServiceManager, getStatistics, getWorker, isStopped, makeBatchBackend, optimize, optimize, unwrap

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

DocumentBuilderContainedEntity getDocumentBuilderContainedEntity(Class<?> entityType)

getFilterCachingStrategy

FilterCachingStrategy getFilterCachingStrategy()

getFilterDefinition

FilterDef getFilterDefinition(String name)

getFilterCacheBitResultsSize

int getFilterCacheBitResultsSize()

getIndexedTypesPolymorphic

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

Given a set of target entities, return the set of indexed types following our polymorphism rules for propagation of the Indexed annotation: It returns an empty set if none of the target entities is indexed, nor any of their sub types. Each of the classes of the argument is returned iff explicitly marked as indexed. Each of the known subtypes of these classes which are explicitly marked as indexed are added to the returned set. The Indexed annotation is not inherited by subtypes which don't explicitly have it. Passing Object.class among the parameters will have the returned set contain all known indexed types.

Parameters:

classes - a list of types

Returns:

a set containing the types as in the above rules

isJMXEnabled

boolean isJMXEnabled()

Returns:

true if JMX is enabled

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()

Returns:

the globally configured TimingSource, which we use to implement timeouts during query execution.

getConfigurationProperties

Properties getConfigurationProperties()

Returns:

the configuration properties for this factory

getDefaultDatabaseRetrievalMethod

DatabaseRetrievalMethod getDefaultDatabaseRetrievalMethod()

Returns the default DatabaseRetrievalMethod. This is either the system default or the default specified via the configuration property Environment.DATABASE_RETRIEVAL_METHOD.

Returns:

returns the default DatabaseRetrievalMethod.

getDefaultObjectLookupMethod

ObjectLookupMethod getDefaultObjectLookupMethod()

Returns the default ObjectLookupMethod. This is either the system default or the default specified via the configuration property Environment.OBJECT_LOOKUP_METHOD.

Returns:

returns the default OBJECT_LOOKUP_METHOD.

isIndexUninvertingAllowed

boolean isIndexUninvertingAllowed()

Whether index uninverting should be done when running queries with sorts not covered by the configured sortable fields. If not allowed, an exception will be raised in this situation.