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

Interface OpenSearchAnalyzerProvider

All Known Implementing Classes:
ExactAnalyzerProvider, ExactFilenameAnalyzerProvider, ExactQueryAnalyzerProvider, FilenameAnalyzerProvider, KeywordAnalyzerProvider, StandardAnalyzerProvider, TwoGramAnalyzerProvider, UnstemmedAnalyzerProvider, WhitespaceAnalyzerProvider
public interface OpenSearchAnalyzerProvider
Provides an OpenSearch Analyzer for a specific Confluence MappingAnalyzerDescriptor. Each MappingAnalyzerDescriptor must have a corresponding implementation of this interface.
Since:
8.7

  • Method Details

    • getMappingClass

      Class<? extends MappingAnalyzerDescriptor> getMappingClass()
      Returns:
      the concrete type of MappingAnalyzerDescriptor that's mapped to this analyzer

    • getAnalyzer

      org.opensearch.client.opensearch._types.analysis.Analyzer getAnalyzer()
      Returns:
      the OpenSearch analyzer for the given v2 analyzer specified at getMappingClass().

    • getName

      String getName()
      Returns:
      the analyzer name that is registered in OpenSearch. It should be unique within the index it is used.

    • isCustom

      boolean isCustom()
      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.