NGramTokenFilterV2 Class

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

public final class NGramTokenFilterV2
extends TokenFilter

Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.

Constructor Summary

Constructor Description
NGramTokenFilterV2(String name)

Creates an instance of NGramTokenFilterV2 class.

Method Summary

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

Reads an instance of NGramTokenFilterV2 from the JsonReader.
Integer getMaxGram()

Get the maxGram property: The maximum n-gram length.
Integer getMinGram()

Get the minGram property: The minimum n-gram length.
String getOdataType()

Get the odataType property: The discriminator for derived types.
NGramTokenFilterV2 setMaxGram(Integer maxGram)

Set the maxGram property: The maximum n-gram length.
NGramTokenFilterV2 setMinGram(Integer minGram)

Set the minGram property: The minimum n-gram length.
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

NGramTokenFilterV2

public NGramTokenFilterV2(String name)

Creates an instance of NGramTokenFilterV2 class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static NGramTokenFilterV2 fromJson(JsonReader jsonReader)

Reads an instance of NGramTokenFilterV2 from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getMaxGram

public Integer getMaxGram()

Get the maxGram property: The maximum n-gram length. Default is 2. Maximum is 300.

Returns:

the maxGram value.

getMinGram

public Integer getMinGram()

Get the minGram property: The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram.

Returns:

the minGram value.

getOdataType

public String getOdataType()

Get the odataType property: The discriminator for derived types.

Overrides:

NGramTokenFilterV2.getOdataType()

Returns:

the odataType value.

setMaxGram

public NGramTokenFilterV2 setMaxGram(Integer maxGram)

Set the maxGram property: The maximum n-gram length. Default is 2. Maximum is 300.

Parameters:

maxGram - the maxGram value to set.

Returns:

the NGramTokenFilterV2 object itself.

setMinGram

public NGramTokenFilterV2 setMinGram(Integer minGram)

Set the minGram property: The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram.

Parameters:

minGram - the minGram value to set.

Returns:

the NGramTokenFilterV2 object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

NGramTokenFilterV2.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to