EdgeNGramTokenFilter Class

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

public final class EdgeNGramTokenFilter
extends TokenFilter

Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.

Constructor Summary

Constructor Description
EdgeNGramTokenFilter(String name)

Creates an instance of EdgeNGramTokenFilter class.

Method Summary

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

Reads an instance of EdgeNGramTokenFilter 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.
EdgeNGramTokenFilterSide getSide()

Get the side property: Specifies which side of the input the n-gram should be generated from.
EdgeNGramTokenFilter setMaxGram(Integer maxGram)

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

Set the minGram property: The minimum n-gram length.
EdgeNGramTokenFilter setSide(EdgeNGramTokenFilterSide side)

Set the side property: Specifies which side of the input the n-gram should be generated from.
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

EdgeNGramTokenFilter

public EdgeNGramTokenFilter(String name)

Creates an instance of EdgeNGramTokenFilter class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static EdgeNGramTokenFilter fromJson(JsonReader jsonReader)

Reads an instance of EdgeNGramTokenFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Returns:

the maxGram value.

getMinGram

public Integer getMinGram()

Get the minGram property: The minimum n-gram length. Default is 1. 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:

EdgeNGramTokenFilter.getOdataType()

Returns:

the odataType value.

getSide

public EdgeNGramTokenFilterSide getSide()

Get the side property: Specifies which side of the input the n-gram should be generated from. Default is "front".

Returns:

the side value.

setMaxGram

public EdgeNGramTokenFilter setMaxGram(Integer maxGram)

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

Parameters:

maxGram - the maxGram value to set.

Returns:

the EdgeNGramTokenFilter object itself.

setMinGram

public EdgeNGramTokenFilter setMinGram(Integer minGram)

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

Parameters:

minGram - the minGram value to set.

Returns:

the EdgeNGramTokenFilter object itself.

setSide

public EdgeNGramTokenFilter setSide(EdgeNGramTokenFilterSide side)

Set the side property: Specifies which side of the input the n-gram should be generated from. Default is "front".

Parameters:

side - the side value to set.

Returns:

the EdgeNGramTokenFilter object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

EdgeNGramTokenFilter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to