PhoneticTokenFilter Class

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

public final class PhoneticTokenFilter
extends TokenFilter

Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.

Constructor Summary

Constructor Description
PhoneticTokenFilter(String name)

Creates an instance of PhoneticTokenFilter class.

Method Summary

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

Reads an instance of PhoneticTokenFilter from the JsonReader.
PhoneticEncoder getEncoder()

Get the encoder property: The phonetic encoder to use.
String getOdataType()

Get the odataType property: The discriminator for derived types.
Boolean isReplaceOriginalTokens()

Get the replaceOriginalTokens property: A value indicating whether encoded tokens should replace original tokens.
PhoneticTokenFilter setEncoder(PhoneticEncoder encoder)

Set the encoder property: The phonetic encoder to use.
PhoneticTokenFilter setReplaceOriginalTokens(Boolean replaceOriginalTokens)

Set the replaceOriginalTokens property: A value indicating whether encoded tokens should replace original tokens.
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

PhoneticTokenFilter

public PhoneticTokenFilter(String name)

Creates an instance of PhoneticTokenFilter class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static PhoneticTokenFilter fromJson(JsonReader jsonReader)

Reads an instance of PhoneticTokenFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getEncoder

public PhoneticEncoder getEncoder()

Get the encoder property: The phonetic encoder to use. Default is "metaphone".

Returns:

the encoder value.

getOdataType

public String getOdataType()

Get the odataType property: The discriminator for derived types.

Overrides:

PhoneticTokenFilter.getOdataType()

Returns:

the odataType value.

isReplaceOriginalTokens

public Boolean isReplaceOriginalTokens()

Get the replaceOriginalTokens property: A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true.

Returns:

the replaceOriginalTokens value.

setEncoder

public PhoneticTokenFilter setEncoder(PhoneticEncoder encoder)

Set the encoder property: The phonetic encoder to use. Default is "metaphone".

Parameters:

encoder - the encoder value to set.

Returns:

the PhoneticTokenFilter object itself.

setReplaceOriginalTokens

public PhoneticTokenFilter setReplaceOriginalTokens(Boolean replaceOriginalTokens)

Set the replaceOriginalTokens property: A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true.

Parameters:

replaceOriginalTokens - the replaceOriginalTokens value to set.

Returns:

the PhoneticTokenFilter object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

PhoneticTokenFilter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to