Package com.atlassian.confluence.plugins.opensearch.analysis

Class IndexAnalysisFactory

java.lang.Object

com.atlassian.confluence.plugins.opensearch.analysis.IndexAnalysisFactory

public class IndexAnalysisFactory
extends Object

Factory class to create OpenSearch index analysis settings needed at index creation time.

Currently, we only have analyzers and token filters.

Since:

8.7

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_ANALYZER
static String	DEFAULT_SEARCH_ANALYZER

Constructor Summary

Constructors

Constructor	Description
IndexAnalysisFactory(List<OpenSearchAnalyzerProvider> analyzerProviders, List<OpenSearchCustomTokenFilterProvider> tokenFilterProviders, ConfluenceDefaultAnalyzerFactory defaultAnalyzerFactory, OpenSearchAnalyzerMapper analyzerMapper)

Method Summary

Modifier and Type	Method	Description
org.opensearch.client.opensearch.indices.IndexSettingsAnalysis	createForCustomIndex(AnalyzerDescriptorProvider defaultAnalyzerProvider)	Create OpenSearch index analysis settings for custom indexes.
org.opensearch.client.opensearch.indices.IndexSettingsAnalysis	createForSystemIndex()	Create OpenSearch index analysis settings for system indexes.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ANALYZER

public static final String DEFAULT_ANALYZER

See Also:

Constant Field Values

DEFAULT_SEARCH_ANALYZER

public static final String DEFAULT_SEARCH_ANALYZER

See Also:

Constant Field Values

Constructor Detail

IndexAnalysisFactory

public IndexAnalysisFactory(List<OpenSearchAnalyzerProvider> analyzerProviders,
                            List<OpenSearchCustomTokenFilterProvider> tokenFilterProviders,
                            ConfluenceDefaultAnalyzerFactory defaultAnalyzerFactory,
                            OpenSearchAnalyzerMapper analyzerMapper)

Method Detail

createForSystemIndex

public org.opensearch.client.opensearch.indices.IndexSettingsAnalysis createForSystemIndex()

Create OpenSearch index analysis settings for system indexes.

Returns:

index analysis settings

createForCustomIndex

public org.opensearch.client.opensearch.indices.IndexSettingsAnalysis createForCustomIndex(@Nullable
                                                                                           AnalyzerDescriptorProvider defaultAnalyzerProvider)

Create OpenSearch index analysis settings for custom indexes.

Parameters:

defaultAnalyzerProvider - default analyzer for both indexing and searching. If null, it will default to keyword analyzer.

Returns:

index analysis settings