StemmerOverrideTokenFilter 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.TokenFilter
  • • com.azure.search.documents.indexes.models.StemmerOverrideTokenFilter

public final class StemmerOverrideTokenFilter
extends TokenFilter

Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene.

Constructor Summary

Constructor	Description
StemmerOverrideTokenFilter(String name, List<String> rules)	Creates an instance of StemmerOverrideTokenFilter class.

Method Summary

Modifier and Type	Method and Description
static StemmerOverrideTokenFilter	fromJson(JsonReader jsonReader) Reads an instance of StemmerOverrideTokenFilter from the JsonReader.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of token filter.
List<String>	getRules() Get the rules property: A list of stemming rules in the following format: "word => stem", for example: "ran => run".
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from TokenFilter

fromJson getName getOdataType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

StemmerOverrideTokenFilter

public StemmerOverrideTokenFilter(String name, List<String> rules)

Creates an instance of StemmerOverrideTokenFilter class.

Parameters:

name - the name value to set.

rules - the rules value to set.

Method Details

fromJson

public static StemmerOverrideTokenFilter fromJson(JsonReader jsonReader)

Reads an instance of StemmerOverrideTokenFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getOdataType

public String getOdataType()

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

Overrides:

StemmerOverrideTokenFilter.getOdataType()

Returns:

the odataType value.

getRules

public List<String> getRules()

Get the rules property: A list of stemming rules in the following format: "word => stem", for example: "ran => run".

Returns:

the rules value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

StemmerOverrideTokenFilter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException