ExtendedSearchIntegrator (Hibernate Search Engine 5.1.2.Final API)

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

Method Summary

Methods
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)`
`String`	`getIndexingStrategy()` Deprecated.
`IndexManagerHolder`	`getIndexManagerHolder()`
`InstanceInitializer`	`getInstanceInitializer()`
`StatisticsImplementor`	`getStatisticsImplementor()` Retrieve the statistics implementor instance for this factory.
`TimingSource`	`getTimingSource()`
`boolean`	`isDirtyChecksEnabled()`
`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)
```
  - getIndexingStrategy
```
@Deprecated
String getIndexingStrategy()
```
    Deprecated.
  - getFilterCacheBitResultsSize
```
int getFilterCacheBitResultsSize()
```
  - getIndexedTypesPolymorphic
```
Set<Class<?>> getIndexedTypesPolymorphic(Class<?>[] classes)
```
  - 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
  - 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.

Interface ExtendedSearchIntegrator

Method Summary

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

Method Detail

getIndexBindings

getDocumentBuilderContainedEntity

getFilterCachingStrategy

getFilterDefinition

getIndexingStrategy

getFilterCacheBitResultsSize

getIndexedTypesPolymorphic

isJMXEnabled

getStatisticsImplementor

isDirtyChecksEnabled

getIndexManagerHolder

getInstanceInitializer

getTimingSource

getConfigurationProperties

getDefaultDatabaseRetrievalMethod

getDefaultObjectLookupMethod