Package com.azure.search.documents.indexes.models

Class PhoneticTokenFilter

java.lang.Object

com.azure.search.documents.indexes.models.TokenFilter

com.azure.search.documents.indexes.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	Description
PhoneticTokenFilter(String name)	Constructor of PhoneticTokenFilter.

Method Summary

Modifier and Type	Method	Description
Boolean	areOriginalTokensReplaced()	Get the replaceOriginalTokens property: A value indicating whether encoded tokens should replace original tokens.
PhoneticEncoder	getEncoder()	Get the encoder property: The phonetic encoder to use.
PhoneticTokenFilter	setEncoder(PhoneticEncoder encoder)	Set the encoder property: The phonetic encoder to use.
PhoneticTokenFilter	setOriginalTokensReplaced(Boolean originalTokensReplaced)	Set the replaceOriginalTokens property: A value indicating whether encoded tokens should replace original tokens.

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

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

PhoneticTokenFilter

public PhoneticTokenFilter(String name)

Constructor of PhoneticTokenFilter.

Parameters:

name - The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.

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.

areOriginalTokensReplaced

public Boolean areOriginalTokensReplaced()

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.

setOriginalTokensReplaced

public PhoneticTokenFilter setOriginalTokensReplaced(Boolean originalTokensReplaced)

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:

originalTokensReplaced - the replaceOriginalTokens value to set.

Returns:

the PhoneticTokenFilter object itself.