ImmutableSearchFactory (Hibernate Search Engine 5.0.0.CR1 API)

java.lang.Object
- org.hibernate.search.engine.impl.ImmutableSearchFactory

All Implemented Interfaces:

AutoCloseable, SearchFactoryImplementor, BuildContext, SearchFactoryImplementorWithShareableState, SearchFactoryState, SearchIntegrator, WorkerBuildContext
```
public class ImmutableSearchFactory
extends Object
implements SearchFactoryImplementorWithShareableState, WorkerBuildContext
```
This implementation is never directly exposed to the user, it is always wrapped into a MutableSearchFactory

Author:

Emmanuel Bernard

Constructor Summary

Constructors
Constructor and Description

ImmutableSearchFactory(SearchFactoryState state)

Constructors
Constructor and Description
`ImmutableSearchFactory(SearchFactoryState state)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addClasses(Class<?>... classes)` Add the following classes to the SearchFactory.
`QueryContextBuilder`	`buildQueryBuilder()`
`void`	`close()` Shuts down all workers and releases all resources.
`HSQuery`	`createHSQuery()` Return an Hibernate Search query object.
`IndexManagerHolder`	`getAllIndexesManager()`
`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
`Map<String,org.apache.lucene.analysis.Analyzer>`	`getAnalyzers()`
`int`	`getCacheBitResultsSize()`
`Properties`	`getConfigurationProperties()`
`DatabaseRetrievalMethod`	`getDefaultDatabaseRetrievalMethod()` Returns the default `DatabaseRetrievalMethod`.
`ObjectLookupMethod`	`getDefaultObjectLookupMethod()` Returns the default `ObjectLookupMethod`.
`TimeoutExceptionFactory`	`getDefaultTimeoutExceptionFactory()` Useful if you need to create custom exception types to represent query timeouts.
`DocumentBuilderContainedEntity`	`getDocumentBuilderContainedEntity(Class 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<?>,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).
`IndexManager`	`getIndexManager(String indexName)`
`IndexManagerFactory`	`getIndexManagerFactory()`
`IndexManagerHolder`	`getIndexManagerHolder()`
`IndexReaderAccessor`	`getIndexReaderAccessor()` Provides access to the IndexReader API
`InstanceInitializer`	`getInstanceInitializer()`
`SearchMapping`	`getProgrammaticMapping()`
`EntityIndexBinding`	`getSafeIndexBindingForEntity(Class<?> entityType)`
`ServiceManager`	`getServiceManager()` Returns the service manager.
`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()` The Worker is the entry point to apply writes and updates to the indexes.
`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`
`<T> T`	`unwrap(Class<T> cls)` Unwraps some internal Hibernate Search types.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ImmutableSearchFactory
```
public ImmutableSearchFactory(SearchFactoryState state)
```
- Method Detail
  - getFilterDefinitions
```
public Map<String,FilterDef> getFilterDefinitions()
```
    Specified by:
    
    getFilterDefinitions in interface SearchFactoryState
  - 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
  - close
```
public void close()
```
    Description copied from interface: SearchIntegrator
    
    Shuts down all workers and releases all resources.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface SearchIntegrator
  - createHSQuery
```
public HSQuery createHSQuery()
```
    Description copied from interface: SearchIntegrator
    
    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 SearchIntegrator
  - getDocumentBuildersContainedEntities
```
public Map<Class<?>,DocumentBuilderContainedEntity> getDocumentBuildersContainedEntities()
```
    Specified by:
    
    getDocumentBuildersContainedEntities 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.
  - getIndexBinding
```
public EntityIndexBinding getIndexBinding(Class<?> entityType)
```
    Description copied from interface: SearchIntegrator
    
    Returns the entity to index binding for the given type.
    
    Specified by:
    
    getIndexBinding in interface SearchIntegrator
    
    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 DocumentBuilderContainedEntity getDocumentBuilderContainedEntity(Class entityType)
```
    Specified by:
    
    getDocumentBuilderContainedEntity in interface SearchFactoryImplementor
  - addClasses
```
public void addClasses(Class<?>... classes)
```
    Description copied from interface: SearchIntegrator
    
    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 SearchIntegrator
  - getWorker
```
public Worker getWorker()
```
    Description copied from interface: SearchIntegrator
    
    The Worker is the entry point to apply writes and updates to the indexes.
    
    Specified by:
    
    getWorker in interface SearchFactoryState
    
    Specified by:
    
    getWorker in interface SearchIntegrator
  - optimize
```
public void optimize()
```
    Description copied from interface: SearchIntegrator
    
    Optimize all indexes
    
    Specified by:
    
    optimize in interface SearchIntegrator
  - optimize
```
public void optimize(Class entityType)
```
    Description copied from interface: SearchIntegrator
    
    Optimize the index holding entityType
    
    Specified by:
    
    optimize in interface SearchIntegrator
    
    Parameters:
    entityType - the entity type (index) to optimize
  - getAnalyzer
```
public org.apache.lucene.analysis.Analyzer getAnalyzer(String name)
```
    Description copied from interface: SearchIntegrator
    
    Retrieve an analyzer instance by its definition name
    
    Specified by:
    
    getAnalyzer in interface SearchIntegrator
    
    Parameters:
    name - the name of the analyzer
    
    Returns:
    analyzer with the specified name
  - getAnalyzer
```
public org.apache.lucene.analysis.Analyzer getAnalyzer(Class<?> clazz)
```
    Description copied from interface: SearchIntegrator
    
    Retrieves the scoped analyzer for a given class.
    
    Specified by:
    
    getAnalyzer in interface SearchIntegrator
    
    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 SearchIntegrator
    
    Returns:
    return a query builder providing a fluent API to create Lucene queries
  - getStatistics
```
public Statistics getStatistics()
```
    Description copied from interface: SearchIntegrator
    
    Retrieve the statistics instance for this factory.
    
    Specified by:
    
    getStatistics in interface SearchIntegrator
    
    Returns:
    The statistics.
  - 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.
  - getFilterCachingStrategy
```
public FilterCachingStrategy getFilterCachingStrategy()
```
    Specified by:
    
    getFilterCachingStrategy in interface SearchFactoryImplementor
    
    Specified by:
    
    getFilterCachingStrategy in interface SearchFactoryState
  - getAnalyzers
```
public Map<String,org.apache.lucene.analysis.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 SearchFactoryImplementor
    
    Specified by:
    
    getConfigurationProperties in interface SearchFactoryState
    
    Returns:
    the configuration properties for this factory
  - getFilterDefinition
```
public FilterDef getFilterDefinition(String name)
```
    Specified by:
    
    getFilterDefinition in interface SearchFactoryImplementor
  - 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
  - getIndexHierarchy
```
public PolymorphicIndexHierarchy getIndexHierarchy()
```
    Specified by:
    
    getIndexHierarchy in interface SearchFactoryState
  - getServiceManager
```
public ServiceManager getServiceManager()
```
    Description copied from interface: SearchIntegrator
    
    Returns the service manager.
    
    Specified by:
    
    getServiceManager in interface BuildContext
    
    Specified by:
    
    getServiceManager in interface SearchFactoryState
    
    Specified by:
    
    getServiceManager in interface SearchIntegrator
    
    Returns:
    Returns the service manager.
  - getDefaultDatabaseRetrievalMethod
```
public DatabaseRetrievalMethod getDefaultDatabaseRetrievalMethod()
```
    Description copied from interface: SearchFactoryImplementor
    
    Returns the default DatabaseRetrievalMethod. This is either the system default or the default specified via the configuration property Environment.DATABASE_RETRIEVAL_METHOD.
    
    Specified by:
    
    getDefaultDatabaseRetrievalMethod in interface SearchFactoryImplementor
    
    Returns:
    returns the default DatabaseRetrievalMethod.
  - getDefaultObjectLookupMethod
```
public ObjectLookupMethod getDefaultObjectLookupMethod()
```
    Description copied from interface: SearchFactoryImplementor
    
    Returns the default ObjectLookupMethod. This is either the system default or the default specified via the configuration property Environment.OBJECT_LOOKUP_METHOD.
    
    Specified by:
    
    getDefaultObjectLookupMethod in interface SearchFactoryImplementor
    
    Returns:
    returns the default OBJECT_LOOKUP_METHOD.
  - 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
  - isJMXEnabled
```
public boolean isJMXEnabled()
```
    Specified by:
    
    isJMXEnabled in interface SearchFactoryImplementor
  - 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 SearchIntegrator
    
    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 BuildContext
    
    Specified by:
    
    getAllIndexesManager in interface SearchFactoryState
    
    Returns:
    a reference to the IndexManagerHolder, storing all IndexManager instances.
  - 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
  - getSafeIndexBindingForEntity
```
public EntityIndexBinding getSafeIndexBindingForEntity(Class<?> entityType)
```
  - getErrorHandler
```
public ErrorHandler getErrorHandler()
```
    Description copied from interface: SearchIntegrator
    
    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 SearchIntegrator
    
    Returns:
    the configured ErrorHandler, global to the SearchFactory
  - getIndexReaderAccessor
```
public IndexReaderAccessor getIndexReaderAccessor()
```
    Description copied from interface: SearchIntegrator
    
    Provides access to the IndexReader API
    
    Specified by:
    
    getIndexReaderAccessor in interface SearchIntegrator
    
    Returns:
    the IndexReaderAccessor for this SearchFactory
  - getIndexedTypeDescriptor
```
public IndexedTypeDescriptor getIndexedTypeDescriptor(Class<?> entityType)
```
    Description copied from interface: SearchIntegrator
    
    Returns a descriptor for the specified entity type describing its indexed state.
    
    Specified by:
    
    getIndexedTypeDescriptor in interface SearchIntegrator
    
    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: SearchIntegrator
    
    Returns the set of currently indexed types.
    
    Specified by:
    
    getIndexedTypes in interface SearchIntegrator
    
    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()
```
    Description copied from interface: SearchIntegrator
    
    Useful if you need to create custom exception types to represent query timeouts.
    
    Specified by:
    
    getDefaultTimeoutExceptionFactory in interface SearchFactoryState
    
    Specified by:
    
    getDefaultTimeoutExceptionFactory in interface SearchIntegrator
    
    Returns:
    the configured TimeoutExceptionFactory
  - 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
  - getIndexManager
```
public IndexManager getIndexManager(String indexName)
```
    Specified by:
    
    getIndexManager in interface SearchIntegrator
  - unwrap
```
public <T> T unwrap(Class<T> cls)
```
    Description copied from interface: SearchIntegrator
    
    Unwraps some internal Hibernate Search types. Currently, no public type is accessible. This method should not be used by users.
    
    Specified by:
    
    unwrap in interface SearchIntegrator

Class ImmutableSearchFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImmutableSearchFactory

Method Detail

getFilterDefinitions

getIndexingStrategy

close

createHSQuery

getDocumentBuildersContainedEntities

getIndexBindings

getIndexBinding

getDocumentBuilderContainedEntity

addClasses

getWorker

optimize

optimize

getAnalyzer

getAnalyzer

buildQueryBuilder

getStatistics

getStatisticsImplementor

getFilterCachingStrategy

getAnalyzers

getCacheBitResultsSize

getConfigurationProperties

getFilterDefinition

getFilterCacheBitResultsSize

getIndexedTypesPolymorphic

makeBatchBackend

getIndexHierarchy

getServiceManager

getDefaultDatabaseRetrievalMethod

getDefaultObjectLookupMethod

getUninitializedSearchFactory

isJMXEnabled

isDirtyChecksEnabled

isStopped

isTransactionManagerExpected

getAllIndexesManager

getIndexManagerHolder

getSafeIndexBindingForEntity

getErrorHandler

getIndexReaderAccessor

getIndexedTypeDescriptor

getIndexedTypes

getInstanceInitializer

getDefaultTimeoutExceptionFactory

getTimingSource

getProgrammaticMapping

isIndexMetadataComplete

isIdProvidedImplicit

getIndexManagerFactory

getIndexManager

unwrap