com.atlassian.confluence.search.v2.analysis

Interface SearchQueryTokenizer

All Known Implementing Classes:

LuceneSearchQueryTokenizer

@ExperimentalApi
public interface SearchQueryTokenizer

Breaks a text of a text field into tokens. A plugin can obtain it via ComponentImport. The AnalyzerDescriptor will provide an implementation of the service enough information to do the job.

Since:

7.0

Method Summary

Modifier and Type	Method and Description
Collection<String>	tokenize(String fieldName, com.atlassian.confluence.plugins.index.api.AnalyzerDescriptorProvider analyzerProvider, String text) Tokenize a string using the given analyzer.
Collection<String>	tokenize(String fieldName, String text) Tokenize a string using the default analyzer provided by Confluence.

Method Detail

tokenize

Collection<String> tokenize(String fieldName,
                            com.atlassian.confluence.plugins.index.api.AnalyzerDescriptorProvider analyzerProvider,
                            String text)

Tokenize a string using the given analyzer.

Parameters:

fieldName - field name

text - text to be broken into tokens

analyzerProvider - information about how to tokenized

Returns:

stream of tokens

tokenize

Collection<String> tokenize(String fieldName,
                            String text)

Tokenize a string using the default analyzer provided by Confluence.

Parameters:

fieldName - field name

text - text to be broken into tokens

Returns:

stream of tokens