com.azure.search.documents.indexes.models

Class CustomAnalyzer

java.lang.Object

com.azure.search.documents.indexes.models.LexicalAnalyzer

com.azure.search.documents.indexes.models.CustomAnalyzer

public final class CustomAnalyzer
extends LexicalAnalyzer

Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer.

Constructor Summary

Constructors

Constructor and Description
CustomAnalyzer(String name, LexicalTokenizerName tokenizerName) Constructor of LexicalAnalyzer.

Method Summary

Modifier and Type	Method and Description
List<CharFilterName>	getCharFilters() Get the charFilters property: A list of character filters used to prepare input text before it is processed by the tokenizer.
List<TokenFilterName>	getTokenFilters() Get the tokenFilters property: A list of token filters used to filter out or modify the tokens generated by a tokenizer.
LexicalTokenizerName	getTokenizer() Get the tokenizer property: The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words.
CustomAnalyzer	setCharFilters(CharFilterName... charFilters) Set the charFilters property: A list of character filters used to prepare input text before it is processed by the tokenizer.
CustomAnalyzer	setCharFilters(List<CharFilterName> charFilters) Set the charFilters property: A list of character filters used to prepare input text before it is processed by the tokenizer.
CustomAnalyzer	setTokenFilters(List<TokenFilterName> tokenFilters) Set the tokenFilters property: A list of token filters used to filter out or modify the tokens generated by a tokenizer.
CustomAnalyzer	setTokenFilters(TokenFilterName... tokenFilters) Set the tokenFilters property: A list of token filters used to filter out or modify the tokens generated by a tokenizer.

Methods inherited from class com.azure.search.documents.indexes.models.LexicalAnalyzer

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomAnalyzer

public CustomAnalyzer(String name,
                      LexicalTokenizerName tokenizerName)

Constructor of LexicalAnalyzer.

Parameters:

name - The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.

tokenizerName - The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words. Possible values include: 'Classic', 'EdgeNGram', 'Keyword', 'Letter', 'Lowercase', 'MicrosoftLanguageTokenizer', 'MicrosoftLanguageStemmingTokenizer', 'NGram', 'PathHierarchy', 'Pattern', 'Standard', 'UaxUrlEmail', 'Whitespace'

Method Detail

getTokenizer

public LexicalTokenizerName getTokenizer()

Get the tokenizer property: The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words. Possible values include: 'Classic', 'EdgeNGram', 'Keyword', 'Letter', 'Lowercase', 'MicrosoftLanguageTokenizer', 'MicrosoftLanguageStemmingTokenizer', 'NGram', 'PathHierarchy', 'Pattern', 'Standard', 'UaxUrlEmail', 'Whitespace'.

Returns:

the tokenizer value.

getTokenFilters

public List<TokenFilterName> getTokenFilters()

Get the tokenFilters property: A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed.

Returns:

the tokenFilters value.

setTokenFilters

public CustomAnalyzer setTokenFilters(TokenFilterName... tokenFilters)

Set the tokenFilters property: A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed.

Parameters:

tokenFilters - the tokenFilters value to set.

Returns:

the CustomAnalyzer object itself.

setTokenFilters

public CustomAnalyzer setTokenFilters(List<TokenFilterName> tokenFilters)

Set the tokenFilters property: A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed.

Parameters:

tokenFilters - the tokenFilters value to set.

Returns:

the CustomAnalyzer object itself.

getCharFilters

public List<CharFilterName> getCharFilters()

Get the charFilters property: A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed.

Returns:

the charFilters value.

setCharFilters

public CustomAnalyzer setCharFilters(CharFilterName... charFilters)

Set the charFilters property: A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed.

Parameters:

charFilters - the charFilters value to set.

Returns:

the CustomAnalyzer object itself.

setCharFilters

public CustomAnalyzer setCharFilters(List<CharFilterName> charFilters)

Set the charFilters property: A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed.

Parameters:

charFilters - the charFilters value to set.

Returns:

the CustomAnalyzer object itself.