com.azure.search.models

Class PhoneticTokenFilter

java.lang.Object

com.azure.search.models.TokenFilter

com.azure.search.models.PhoneticTokenFilter

public final class PhoneticTokenFilter
extends TokenFilter

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

Constructor Summary

Constructors

Constructor and Description
PhoneticTokenFilter()

Method Summary

Modifier and Type	Method and Description
PhoneticEncoder	getEncoder() Get the encoder property: The phonetic encoder to use.
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.

Methods inherited from class com.azure.search.models.TokenFilter

getName, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PhoneticTokenFilter

public PhoneticTokenFilter()

Method Detail

getEncoder

public PhoneticEncoder getEncoder()

Get the encoder property: The phonetic encoder to use. Default is "metaphone". Possible values include: 'metaphone', 'doubleMetaphone', 'soundex', 'refinedSoundex', 'caverphone1', 'caverphone2', 'cologne', 'nysiis', 'koelnerPhonetik', 'haasePhonetik', 'beiderMorse'.

Returns:

the encoder value.

setEncoder

public PhoneticTokenFilter setEncoder(PhoneticEncoder encoder)

Set the encoder property: The phonetic encoder to use. Default is "metaphone". Possible values include: 'metaphone', 'doubleMetaphone', 'soundex', 'refinedSoundex', 'caverphone1', 'caverphone2', 'cologne', 'nysiis', 'koelnerPhonetik', 'haasePhonetik', 'beiderMorse'.

Parameters:

encoder - the encoder value to set.

Returns:

the PhoneticTokenFilter object itself.

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.

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.