Package org.hibernate.search.backend.lucene.impl

Class LuceneBackendImpl

java.lang.Object

org.hibernate.search.backend.lucene.impl.LuceneBackendImpl

All Implemented Interfaces:

LuceneBackend, Backend, BackendImplementor

public class LuceneBackendImpl
extends Object
implements BackendImplementor, LuceneBackend

Method Summary

Modifier and Type	Method	Description
Optional<org.apache.lucene.analysis.Analyzer>	analyzer(String name)
IndexManagerBuilder	createIndexManagerBuilder(String indexName, String mappedTypeName, BackendBuildContext context, BackendMapperContext backendMapperContext, ConfigurationPropertySource propertySource)
Optional<String>	name()
Optional<org.apache.lucene.analysis.Analyzer>	normalizer(String name)
CompletableFuture<?>	preStop()	Prepare for BackendImplementor.stop().
void	start(BackendStartContext context)	Start any resource necessary to operate the backend at runtime.
void	stop()	Stop and release any resource necessary to operate the backend at runtime.
Backend	toAPI()
String	toString()
<T> T	unwrap(Class<T> clazz)	Unwrap the backend to some implementation-specific type.

Methods inherited from class java.lang.Object

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

Method Details

toString

public String toString()

Overrides:

toString in class Object

start

public void start(BackendStartContext context)

Description copied from interface: BackendImplementor

Start any resource necessary to operate the backend at runtime.

Called by the engine once after bootstrap, before IndexManagerImplementor.start(IndexManagerStartContext) is called on the index managers.

Specified by:

start in interface BackendImplementor

Parameters:

context - The start context.

preStop

public CompletableFuture<?> preStop()

Description copied from interface: BackendImplementor

Prepare for BackendImplementor.stop().

Specified by:

preStop in interface BackendImplementor

Returns:

A future that completes when ongoing works complete.

stop

public void stop()

Description copied from interface: BackendImplementor

Stop and release any resource necessary to operate the backend at runtime.

Called by the engine once before shutdown.

Specified by:

stop in interface BackendImplementor

unwrap

public <T> T unwrap(Class<T> clazz)

Description copied from interface: Backend

Unwrap the backend to some implementation-specific type.

Specified by:

unwrap in interface Backend

Type Parameters:

T - The expected type

Parameters:

clazz - The Class representing the expected type

Returns:

The unwrapped backend.

name

public Optional<String> name()

Specified by:

name in interface Backend

Returns:

The name of the backend. In case of a default backend - an empty optional.

toAPI

public Backend toAPI()

Specified by:

toAPI in interface BackendImplementor

Returns:

The object that should be exposed as API to users.

analyzer

public Optional<org.apache.lucene.analysis.Analyzer> analyzer(String name)

Specified by:

analyzer in interface LuceneBackend

Parameters:

name - An analyzer name, e.g. a name returned by IndexValueFieldTypeDescriptor.analyzerName() or IndexValueFieldTypeDescriptor.searchAnalyzerName().

Returns:

The corresponding analyzer, or Optional.empty() if it doesn't exist.

normalizer

public Optional<org.apache.lucene.analysis.Analyzer> normalizer(String name)

Specified by:

normalizer in interface LuceneBackend

Parameters:

name - A normalizer name, e.g. a name returned by IndexValueFieldTypeDescriptor.normalizerName().

Returns:

The corresponding normalizer, or Optional.empty() if it doesn't exist.

createIndexManagerBuilder

public IndexManagerBuilder createIndexManagerBuilder(String indexName,
 String mappedTypeName,
 BackendBuildContext context,
 BackendMapperContext backendMapperContext,
 ConfigurationPropertySource propertySource)

Specified by:

createIndexManagerBuilder in interface BackendImplementor

Parameters:

indexName - The name of the index from the point of view of Hibernate Search. A slightly different name may be used by the backend internally, but indexName is the one that will appear everywhere the index is mentioned to the user.

mappedTypeName - The name of the type mapped to this index. This is the type name that will be assigned to search query hits for this index, allowing the mapper to resolve the type of each hit in multi-index searches. Each index is mapped to one and only one type.

context - The build context

propertySource - A configuration property source, appropriately masked so that the backend doesn't need to care about Hibernate Search prefixes (hibernate.search.*, etc.). All the properties can be accessed at the root. CAUTION: the property keys listed in IndexSettings are reserved for use by the engine.

Returns:

A builder for index managers targeting this backend.