ExactFilenameAnalyzerProvider (Atlassian Confluence 8.8.0 API)

java.lang.Object
- com.atlassian.confluence.plugins.opensearch.analysis.analyzer.ExactFilenameAnalyzerProvider

All Implemented Interfaces:

OpenSearchAnalyzerProvider
```
public class ExactFilenameAnalyzerProvider
extends Object
implements OpenSearchAnalyzerProvider
```
Provides OpenSearch analyzer for ExactFilenameAnalyzerDescriptor to support exact matching on file names.
Use when indexing for fields which should support exact matches or when searching for fields which support exact matches for filenames.
Only create tokens by whitespace, and lowercase each token. Filenames will also be split into tokens the file extension delimiter ".". The original filename will also be a token.
e.g. "filename.txt" -> {"filename.txt", "filename", "txt"} "file name.txt" -> {"file name.txt", "file", "name", "txt"}
Searching for the original filename, the name or the extension will match.

Since:

8.7

Field Summary

Fields
Modifier and Type Field Description

static String NAME
The identifier that OpenSearch recognizes when setting up the custom analyzer.

Constructor Summary

Constructors
Constructor Description

ExactFilenameAnalyzerProvider()

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()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    The identifier that OpenSearch recognizes when setting up the custom analyzer.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExactFilenameAnalyzerProvider
```
public ExactFilenameAnalyzerProvider()
```
- Method Detail
  - getMappingClass
```
public Class<? extends MappingAnalyzerDescriptor> getMappingClass()
```
    Specified by:
    
    getMappingClass in interface OpenSearchAnalyzerProvider
    
    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 interface OpenSearchAnalyzerProvider
    
    Returns:
    
    the OpenSearch analyzer for the given v2 analyzer specified at OpenSearchAnalyzerProvider.getMappingClass().
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface OpenSearchAnalyzerProvider
    
    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 interface OpenSearchAnalyzerProvider
    
    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.