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

public final class AsciiFoldingTokenFilter
extends TokenFilter

Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene.

Constructor Summary

Constructor	Description
AsciiFoldingTokenFilter(String name)	Creates an instance of AsciiFoldingTokenFilter class.

Method Summary

Modifier and Type	Method and Description
static AsciiFoldingTokenFilter	fromJson(JsonReader jsonReader) Reads an instance of AsciiFoldingTokenFilter from the JsonReader.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of token filter.
Boolean	isPreserveOriginal() Get the preserveOriginal property: A value indicating whether the original token will be kept.
AsciiFoldingTokenFilter	setPreserveOriginal(Boolean preserveOriginal) Set the preserveOriginal property: A value indicating whether the original token will be kept.
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

AsciiFoldingTokenFilter

public AsciiFoldingTokenFilter(String name)

Creates an instance of AsciiFoldingTokenFilter class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static AsciiFoldingTokenFilter fromJson(JsonReader jsonReader)

Reads an instance of AsciiFoldingTokenFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

AsciiFoldingTokenFilter.getOdataType()

Returns:

the odataType value.

isPreserveOriginal

public Boolean isPreserveOriginal()

Get the preserveOriginal property: A value indicating whether the original token will be kept. Default is false.

Returns:

the preserveOriginal value.

setPreserveOriginal

public AsciiFoldingTokenFilter setPreserveOriginal(Boolean preserveOriginal)

Set the preserveOriginal property: A value indicating whether the original token will be kept. Default is false.

Parameters:

preserveOriginal - the preserveOriginal value to set.

Returns:

the AsciiFoldingTokenFilter object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AsciiFoldingTokenFilter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException