Class ExactAnalyzerProvider
- java.lang.Object
-
- com.atlassian.confluence.plugins.opensearch.analysis.analyzer.ExactAnalyzerProvider
-
- All Implemented Interfaces:
OpenSearchAnalyzerProvider
public class ExactAnalyzerProvider extends Object implements OpenSearchAnalyzerProvider
Provides OpenSearch analyzer forExactAnalyzerDescriptor
to support exact matching.Use when indexing for fields which should support exact matches or when searching for fields which support exact matches.
- Since:
- 8.7
-
-
Constructor Summary
Constructors Constructor Description ExactAnalyzerProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.opensearch.client.opensearch._types.analysis.Analyzer
getAnalyzer()
Class<? extends MappingAnalyzerDescriptor>
getMappingClass()
String
getName()
boolean
isCustom()
-
-
-
Field Detail
-
NAME
public static final String NAME
The identifier that OpenSearch recognizes when setting up the custom analyzer.- See Also:
- Constant Field Values
-
-
Method Detail
-
getMappingClass
public Class<? extends MappingAnalyzerDescriptor> getMappingClass()
- Specified by:
getMappingClass
in interfaceOpenSearchAnalyzerProvider
- Returns:
- the concrete type of
MappingAnalyzerDescriptor
that's mapped to this analyzer
-
getAnalyzer
public org.opensearch.client.opensearch._types.analysis.Analyzer getAnalyzer()
- Specified by:
getAnalyzer
in interfaceOpenSearchAnalyzerProvider
- Returns:
- the OpenSearch analyzer for the given v2 analyzer specified at
OpenSearchAnalyzerProvider.getMappingClass()
.
-
getName
public String getName()
- Specified by:
getName
in interfaceOpenSearchAnalyzerProvider
- Returns:
- the analyzer name that is registered in OpenSearch. It should be unique within the index it is used.
-
isCustom
public boolean isCustom()
- Specified by:
isCustom
in interfaceOpenSearchAnalyzerProvider
- Returns:
- true if the analyzer needs to be declared as a custom analyzer when the index is created. Or false if the index is available built-in on OpenSearch.
-
-