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

Class LuceneIndexManagerImpl

java.lang.Object

org.hibernate.search.backend.lucene.index.impl.LuceneIndexManagerImpl

All Implemented Interfaces:

LuceneIndexManager, ReadIndexManagerContext, LuceneScopeIndexManagerContext, LuceneSearchIndexContext, IndexManager, IndexManagerImplementor

public class LuceneIndexManagerImpl
extends Object
implements IndexManagerImplementor, LuceneIndexManager, LuceneScopeIndexManagerContext

Method Summary

Modifier and Type	Method	Description
void	addTo(IndexScopeBuilder builder)
List<? extends AnalysisToken>	analyze(String analyzerName, String terms)	Applies the analyzer to a given string to produce a list of tokens.
CompletionStage<List<? extends AnalysisToken>>	analyzeAsync(String analyzerName, String terms, OperationSubmitter operationSubmitter)	Applies the analyzer to a given string to produce a list of tokens in an async manner.
LuceneBackend	backend()
long	computeSizeInBytes()
CompletableFuture<Long>	computeSizeInBytesAsync()
CompletableFuture<Long>	computeSizeInBytesAsync(OperationSubmitter operationSubmitter)
IndexIndexer	createIndexer(BackendSessionContext sessionContext)
IndexIndexingPlan	createIndexingPlan(BackendSessionContext sessionContext, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy)
IndexScopeBuilder	createScopeBuilder(BackendMappingContext mappingContext)
IndexWorkspace	createWorkspace(BackendMappingContext mappingContext, Set<String> tenantIds)
IndexDescriptor	descriptor()
final List<Shard>	getShardsForTests()
SearchIndexIdentifierContext	identifier()
org.apache.lucene.analysis.Analyzer	indexingAnalyzer()
LuceneIndexModel	model()
AnalysisToken	normalize(String normalizerName, String terms)	Applies the normalizer to a given string to produce a normalized token.
CompletionStage<AnalysisToken>	normalizeAsync(String normalizerName, String terms, OperationSubmitter operationSubmitter)	Applies the normalizer to a given string to produce a normalized token in an async manner.
void	openIndexReaders(Set<String> routingKeys, DirectoryReaderCollector readerCollector)
void	preStart(IndexManagerStartContext context, SavedState savedState)	Starts a subset of resources that are necessary to operate the index manager at runtime, and are expected to be reused upon restarts.
CompletableFuture<?>	preStop()	Prepare for IndexManagerImplementor.stop().
SavedState	saveForRestart()
IndexSchemaManager	schemaManager()
org.apache.lucene.analysis.Analyzer	searchAnalyzer()
void	start(IndexManagerStartContext context)	Start any resource necessary to operate the index manager at runtime.
void	stop()	Stop and release any resource necessary to operate the backend at runtime.
IndexManager	toAPI()
String	toString()
<T> T	unwrap(Class<T> clazz)	Unwrap the index manager 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

saveForRestart

public SavedState saveForRestart()

Specified by:

saveForRestart in interface IndexManagerImplementor

preStart

public void preStart(IndexManagerStartContext context,
 SavedState savedState)

Description copied from interface: IndexManagerImplementor

Starts a subset of resources that are necessary to operate the index manager at runtime, and are expected to be reused upon restarts. The resources may be retrieved them from the saved state, or created if they are not present in the saved state.

Called by the engine once after bootstrap, after BackendImplementor.start(BackendStartContext) was called on the corresponding backend.

Specified by:

preStart in interface IndexManagerImplementor

Parameters:

context - The start context.

savedState - The saved state returned by the corresponding index manager in the Hibernate Search integration being restarted, or SavedState.empty() on the first start.

start

public void start(IndexManagerStartContext context)

Description copied from interface: IndexManagerImplementor

Start any resource necessary to operate the index manager at runtime.

Called by the engine once just after IndexManagerImplementor.preStart(IndexManagerStartContext, SavedState).

Specified by:

start in interface IndexManagerImplementor

Parameters:

context - The start context.

preStop

public CompletableFuture<?> preStop()

Description copied from interface: IndexManagerImplementor

Prepare for IndexManagerImplementor.stop().

Specified by:

preStop in interface IndexManagerImplementor

Returns:

A future that completes when ongoing works complete.

stop

public void stop()

Description copied from interface: IndexManagerImplementor

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

Called by the engine once before shutdown.

Specified by:

stop in interface IndexManagerImplementor

schemaManager

public IndexSchemaManager schemaManager()

Specified by:

schemaManager in interface IndexManagerImplementor

createIndexingPlan

public IndexIndexingPlan createIndexingPlan(BackendSessionContext sessionContext,
 DocumentCommitStrategy commitStrategy,
 DocumentRefreshStrategy refreshStrategy)

Specified by:

createIndexingPlan in interface IndexManagerImplementor

createIndexer

public IndexIndexer createIndexer(BackendSessionContext sessionContext)

Specified by:

createIndexer in interface IndexManagerImplementor

createWorkspace

public IndexWorkspace createWorkspace(BackendMappingContext mappingContext,
 Set<String> tenantIds)

Specified by:

createWorkspace in interface IndexManagerImplementor

createScopeBuilder

public IndexScopeBuilder createScopeBuilder(BackendMappingContext mappingContext)

Specified by:

createScopeBuilder in interface IndexManagerImplementor

addTo

public void addTo(IndexScopeBuilder builder)

Specified by:

addTo in interface IndexManagerImplementor

openIndexReaders

public void openIndexReaders(Set<String> routingKeys,
 DirectoryReaderCollector readerCollector)
                      throws IOException

Specified by:

openIndexReaders in interface ReadIndexManagerContext

Throws:

IOException

model

public LuceneIndexModel model()

Specified by:

model in interface LuceneScopeIndexManagerContext

identifier

public SearchIndexIdentifierContext identifier()

Specified by:

identifier in interface LuceneSearchIndexContext

toAPI

public IndexManager toAPI()

Specified by:

toAPI in interface IndexManagerImplementor

Returns:

The object that should be exposed as API to users.

backend

public LuceneBackend backend()

Specified by:

backend in interface IndexManager

Specified by:

backend in interface LuceneIndexManager

Returns:

The backend in which this index manager is defined.

descriptor

public IndexDescriptor descriptor()

Specified by:

descriptor in interface IndexManager

Returns:

A descriptor of this index, exposing in particular a list of field and their characteristics.

analyze

public List<? extends AnalysisToken> analyze(String analyzerName,
 String terms)

Description copied from interface: IndexManager

Applies the analyzer to a given string to produce a list of tokens.

Specified by:

analyze in interface IndexManager

Parameters:

analyzerName - The name of the configured analyzer to apply.

terms - The string to apply the analysis to.

Returns:

The list of tokens produced by the analyzer for a given string.

normalize

public AnalysisToken normalize(String normalizerName,
 String terms)

Description copied from interface: IndexManager

Applies the normalizer to a given string to produce a normalized token.

Specified by:

normalize in interface IndexManager

Parameters:

normalizerName - The name of the configured normalizer to apply.

terms - The string to apply the normalizer to.

Returns:

The token produced by the normalizer for a given string.

analyzeAsync

public CompletionStage<List<? extends AnalysisToken>> analyzeAsync(String analyzerName,
 String terms,
 OperationSubmitter operationSubmitter)

Description copied from interface: IndexManager

Applies the analyzer to a given string to produce a list of tokens in an async manner.

Specified by:

analyzeAsync in interface IndexManager

Parameters:

analyzerName - The name of the configured analyzer to apply.

terms - The string to apply the analysis to.

operationSubmitter - How to handle request to submit operation when the queue is full.

Returns:

A future that will ultimately provide the list of tokens produced by the analyzer for a given string.

normalizeAsync

public CompletionStage<AnalysisToken> normalizeAsync(String normalizerName,
 String terms,
 OperationSubmitter operationSubmitter)

Description copied from interface: IndexManager

Applies the normalizer to a given string to produce a normalized token in an async manner.

Specified by:

normalizeAsync in interface IndexManager

Parameters:

normalizerName - The name of the configured normalizer to apply.

terms - The string to apply the normalizer to.

operationSubmitter - How to handle request to submit operation when the queue is full.

Returns:

A future that will ultimately provide the token produced by the normalizer for a given string.

indexingAnalyzer

public org.apache.lucene.analysis.Analyzer indexingAnalyzer()

Specified by:

indexingAnalyzer in interface LuceneIndexManager

Returns:

The analyzer used when indexing. This analyzer behaves differently for each field, delegating to the analyzer configured in the mapping.

searchAnalyzer

public org.apache.lucene.analysis.Analyzer searchAnalyzer()

Specified by:

searchAnalyzer in interface LuceneIndexManager

Returns:

The analyzer used in search queries. This analyzer behaves differently for each field, delegating to the analyzer configured in the mapping.

computeSizeInBytes

public long computeSizeInBytes()

Specified by:

computeSizeInBytes in interface LuceneIndexManager

Returns:

The size of the index on its storage support, in bytes.

computeSizeInBytesAsync

public CompletableFuture<Long> computeSizeInBytesAsync()

Specified by:

computeSizeInBytesAsync in interface LuceneIndexManager

Returns:

A future that will ultimately provide the size of the index on its storage support, in bytes.

computeSizeInBytesAsync

public CompletableFuture<Long> computeSizeInBytesAsync(OperationSubmitter operationSubmitter)

Specified by:

computeSizeInBytesAsync in interface LuceneIndexManager

Parameters:

operationSubmitter - How to handle request to submit operation when the queue is full.

Returns:

A future that will ultimately provide the size of the index on its storage support, in bytes.

unwrap

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

Description copied from interface: IndexManager

Unwrap the index manager to some implementation-specific type.

Specified by:

unwrap in interface IndexManager

Type Parameters:

T - The expected type

Parameters:

clazz - The Class representing the expected type

Returns:

The unwrapped index manager.

getShardsForTests

public final List<Shard> getShardsForTests()