com.azure.search.models

Class CommonGramTokenFilter

java.lang.Object

com.azure.search.models.TokenFilter

com.azure.search.models.CommonGramTokenFilter

public final class CommonGramTokenFilter
extends TokenFilter

Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.

Constructor Summary

Constructors

Constructor and Description
CommonGramTokenFilter()

Method Summary

Modifier and Type	Method and Description
List<String>	getCommonWords() Get the commonWords property: The set of common words.
Boolean	isIgnoreCase() Get the ignoreCase property: A value indicating whether common words matching will be case insensitive.
Boolean	isUseQueryMode() Get the useQueryMode property: A value that indicates whether the token filter is in query mode.
CommonGramTokenFilter	setCommonWords(List<String> commonWords) Set the commonWords property: The set of common words.
CommonGramTokenFilter	setIgnoreCase(Boolean ignoreCase) Set the ignoreCase property: A value indicating whether common words matching will be case insensitive.
CommonGramTokenFilter	setUseQueryMode(Boolean useQueryMode) Set the useQueryMode property: A value that indicates whether the token filter is in query mode.

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

CommonGramTokenFilter

public CommonGramTokenFilter()

Method Detail

getCommonWords

public List<String> getCommonWords()

Get the commonWords property: The set of common words.

Returns:

the commonWords value.

setCommonWords

public CommonGramTokenFilter setCommonWords(List<String> commonWords)

Set the commonWords property: The set of common words.

Parameters:

commonWords - the commonWords value to set.

Returns:

the CommonGramTokenFilter object itself.

isIgnoreCase

public Boolean isIgnoreCase()

Get the ignoreCase property: A value indicating whether common words matching will be case insensitive. Default is false.

Returns:

the ignoreCase value.

setIgnoreCase

public CommonGramTokenFilter setIgnoreCase(Boolean ignoreCase)

Set the ignoreCase property: A value indicating whether common words matching will be case insensitive. Default is false.

Parameters:

ignoreCase - the ignoreCase value to set.

Returns:

the CommonGramTokenFilter object itself.

isUseQueryMode

public Boolean isUseQueryMode()

Get the useQueryMode property: A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false.

Returns:

the useQueryMode value.

setUseQueryMode

public CommonGramTokenFilter setUseQueryMode(Boolean useQueryMode)

Set the useQueryMode property: A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false.

Parameters:

useQueryMode - the useQueryMode value to set.

Returns:

the CommonGramTokenFilter object itself.