SnowballTokenFilter 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.SnowballTokenFilter

public final class SnowballTokenFilter
extends TokenFilter

A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene.

Constructor Summary

Constructor	Description
SnowballTokenFilter(String name, SnowballTokenFilterLanguage language)	Creates an instance of SnowballTokenFilter class.

Method Summary

Modifier and Type	Method and Description
static SnowballTokenFilter	fromJson(JsonReader jsonReader) Reads an instance of SnowballTokenFilter from the JsonReader.
SnowballTokenFilterLanguage	getLanguage() Get the language property: The language to use.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of token filter.
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

SnowballTokenFilter

public SnowballTokenFilter(String name, SnowballTokenFilterLanguage language)

Creates an instance of SnowballTokenFilter class.

Parameters:

name - the name value to set.

language - the language value to set.

Method Details

fromJson

public static SnowballTokenFilter fromJson(JsonReader jsonReader)

Reads an instance of SnowballTokenFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SnowballTokenFilter 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 SnowballTokenFilterLanguage getLanguage()

Get the language property: The language to use.

Returns:

the language value.

getOdataType

public String getOdataType()

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

Overrides:

SnowballTokenFilter.getOdataType()

Returns:

the odataType value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SnowballTokenFilter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException