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

Constructor	Description
CommonGramTokenFilter(String name, List<String> commonWords)	Creates an instance of CommonGramTokenFilter class.

Method Summary

Modifier and Type	Method and Description
static CommonGramTokenFilter	fromJson(JsonReader jsonReader) Reads an instance of CommonGramTokenFilter from the JsonReader.
List<String>	getCommonWords() Get the commonWords property: The set of common words.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of token filter.
Boolean	isCaseIgnored() Get the caseIgnored property: A value indicating whether common words matching will be case insensitive.
Boolean	isQueryModeUsed() Get the queryModeUsed property: A value that indicates whether the token filter is in query mode.
CommonGramTokenFilter	setCaseIgnored(Boolean caseIgnored) Set the caseIgnored property: A value indicating whether common words matching will be case insensitive.
CommonGramTokenFilter	setQueryModeUsed(Boolean queryModeUsed) Set the queryModeUsed property: A value that indicates whether the token filter is in query mode.
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

CommonGramTokenFilter

public CommonGramTokenFilter(String name, List<String> commonWords)

Creates an instance of CommonGramTokenFilter class.

Parameters:

name - the name value to set.

commonWords - the commonWords value to set.

Method Details

fromJson

public static CommonGramTokenFilter fromJson(JsonReader jsonReader)

Reads an instance of CommonGramTokenFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getCommonWords

public List<String> getCommonWords()

Get the commonWords property: The set of common words.

Returns:

the commonWords value.

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of token filter.

Overrides:

CommonGramTokenFilter.getOdataType()

Returns:

the odataType value.

isCaseIgnored

public Boolean isCaseIgnored()

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

Returns:

the caseIgnored value.

isQueryModeUsed

public Boolean isQueryModeUsed()

Get the queryModeUsed 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 queryModeUsed value.

setCaseIgnored

public CommonGramTokenFilter setCaseIgnored(Boolean caseIgnored)

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

Parameters:

caseIgnored - the caseIgnored value to set.

Returns:

the CommonGramTokenFilter object itself.

setQueryModeUsed

public CommonGramTokenFilter setQueryModeUsed(Boolean queryModeUsed)

Set the queryModeUsed 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:

queryModeUsed - the queryModeUsed value to set.

Returns:

the CommonGramTokenFilter object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

CommonGramTokenFilter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException