MicrosoftLanguageTokenizer Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.8.1

public final class MicrosoftLanguageTokenizer
extends LexicalTokenizer

Divides text using language-specific rules.

Constructor Summary

Constructor Description
MicrosoftLanguageTokenizer(String name)

Creates an instance of MicrosoftLanguageTokenizer class.

Method Summary

Modifier and Type Method and Description
static MicrosoftLanguageTokenizer fromJson(JsonReader jsonReader)

Reads an instance of MicrosoftLanguageTokenizer from the JsonReader.
MicrosoftTokenizerLanguage getLanguage()

Get the language property: The language to use.
Integer getMaxTokenLength()

Get the maxTokenLength property: The maximum token length.
String getOdataType()

Get the odataType property: A URI fragment specifying the type of tokenizer.
Boolean isSearchTokenizer()

Get the isSearchTokenizer property: A value indicating how the tokenizer is used.
MicrosoftLanguageTokenizer setIsSearchTokenizer(Boolean isSearchTokenizer)

Set the isSearchTokenizer property: A value indicating how the tokenizer is used.
MicrosoftLanguageTokenizer setLanguage(MicrosoftTokenizerLanguage language)

Set the language property: The language to use.
MicrosoftLanguageTokenizer setMaxTokenLength(Integer maxTokenLength)

Set the maxTokenLength property: The maximum token length.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from LexicalTokenizer

fromJson getName getOdataType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MicrosoftLanguageTokenizer

public MicrosoftLanguageTokenizer(String name)

Creates an instance of MicrosoftLanguageTokenizer class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static MicrosoftLanguageTokenizer fromJson(JsonReader jsonReader)

Reads an instance of MicrosoftLanguageTokenizer from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MicrosoftLanguageTokenizer 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.

getLanguage

public MicrosoftTokenizerLanguage getLanguage()

Get the language property: The language to use. The default is English.

Returns:

the language value.

getMaxTokenLength

public Integer getMaxTokenLength()

Get the maxTokenLength property: The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255.

Returns:

the maxTokenLength value.

getOdataType

public String getOdataType()

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

Overrides:

MicrosoftLanguageTokenizer.getOdataType()

Returns:

the odataType value.

isSearchTokenizer

public Boolean isSearchTokenizer()

Get the isSearchTokenizer property: A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false.

Returns:

the isSearchTokenizer value.

setIsSearchTokenizer

public MicrosoftLanguageTokenizer setIsSearchTokenizer(Boolean isSearchTokenizer)

Set the isSearchTokenizer property: A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false.

Parameters:

isSearchTokenizer - the isSearchTokenizer value to set.

Returns:

the MicrosoftLanguageTokenizer object itself.

setLanguage

public MicrosoftLanguageTokenizer setLanguage(MicrosoftTokenizerLanguage language)

Set the language property: The language to use. The default is English.

Parameters:

language - the language value to set.

Returns:

the MicrosoftLanguageTokenizer object itself.

setMaxTokenLength

public MicrosoftLanguageTokenizer setMaxTokenLength(Integer maxTokenLength)

Set the maxTokenLength property: The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255.

Parameters:

maxTokenLength - the maxTokenLength value to set.

Returns:

the MicrosoftLanguageTokenizer object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

MicrosoftLanguageTokenizer.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to