CustomAnalyzer Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.8.1

• 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

Constructor	Description
CustomAnalyzer(String name, LexicalTokenizerName tokenizer)	Creates an instance of CustomAnalyzer class.

Method Summary

Modifier and Type	Method and Description
static CustomAnalyzer	fromJson(JsonReader jsonReader) Reads an instance of CustomAnalyzer from the JsonReader.
List<CharFilterName>	getCharFilters() Get the charFilters property: A list of character filters used to prepare input text before it is processed by the tokenizer.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of analyzer.
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.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from LexicalAnalyzer

fromJson getName getOdataType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CustomAnalyzer

public CustomAnalyzer(String name, LexicalTokenizerName tokenizer)

Creates an instance of CustomAnalyzer class.

Parameters:

name - the name value to set.

tokenizer - the tokenizer value to set.

Method Details

fromJson

public static CustomAnalyzer fromJson(JsonReader jsonReader)

Reads an instance of CustomAnalyzer from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CustomAnalyzer if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

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.

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of analyzer.

Overrides:

CustomAnalyzer.getOdataType()

Returns:

the odataType 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.

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.

Returns:

the tokenizer 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.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

CustomAnalyzer.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException