MicrosoftLanguageStemmingTokenizer Class

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

public final class MicrosoftLanguageStemmingTokenizer
extends LexicalTokenizer

Divides text using language-specific rules and reduces words to their base forms.

Constructor Summary

Constructor Description
MicrosoftLanguageStemmingTokenizer(String name)

Creates an instance of MicrosoftLanguageStemmingTokenizer class.

Method Summary

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

Reads an instance of MicrosoftLanguageStemmingTokenizer from the JsonReader.
MicrosoftStemmingTokenizerLanguage 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 isSearchTokenizerUsed property: A value indicating how the tokenizer is used.
MicrosoftLanguageStemmingTokenizer setIsSearchTokenizerUsed(Boolean isSearchTokenizerUsed)

Set the isSearchTokenizerUsed property: A value indicating how the tokenizer is used.
MicrosoftLanguageStemmingTokenizer setLanguage(MicrosoftStemmingTokenizerLanguage language)

Set the language property: The language to use.
MicrosoftLanguageStemmingTokenizer 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

MicrosoftLanguageStemmingTokenizer

public MicrosoftLanguageStemmingTokenizer(String name)

Creates an instance of MicrosoftLanguageStemmingTokenizer class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static MicrosoftLanguageStemmingTokenizer fromJson(JsonReader jsonReader)

Reads an instance of MicrosoftLanguageStemmingTokenizer from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MicrosoftLanguageStemmingTokenizer 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 MicrosoftStemmingTokenizerLanguage 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:

MicrosoftLanguageStemmingTokenizer.getOdataType()

Returns:

the odataType value.

isSearchTokenizer

public Boolean isSearchTokenizer()

Get the isSearchTokenizerUsed 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 isSearchTokenizerUsed value.

setIsSearchTokenizerUsed

public MicrosoftLanguageStemmingTokenizer setIsSearchTokenizerUsed(Boolean isSearchTokenizerUsed)

Set the isSearchTokenizerUsed 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:

isSearchTokenizerUsed - the isSearchTokenizerUsed value to set.

Returns:

the MicrosoftLanguageStemmingTokenizer object itself.

setLanguage

public MicrosoftLanguageStemmingTokenizer setLanguage(MicrosoftStemmingTokenizerLanguage language)

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

Parameters:

language - the language value to set.

Returns:

the MicrosoftLanguageStemmingTokenizer object itself.

setMaxTokenLength

public MicrosoftLanguageStemmingTokenizer 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 MicrosoftLanguageStemmingTokenizer object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

MicrosoftLanguageStemmingTokenizer.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to