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

public final class LengthTokenFilter
extends TokenFilter

Removes words that are too long or too short. This token filter is implemented using Apache Lucene.

Constructor Summary

Constructor	Description
LengthTokenFilter(String name)	Creates an instance of LengthTokenFilter class.

Method Summary

Modifier and Type	Method and Description
static LengthTokenFilter	fromJson(JsonReader jsonReader) Reads an instance of LengthTokenFilter from the JsonReader.
Integer	getMaxLength() Get the maxLength property: The maximum length in characters.
Integer	getMinLength() Get the minLength property: The minimum length in characters.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of token filter.
LengthTokenFilter	setMaxLength(Integer maxLength) Set the maxLength property: The maximum length in characters.
LengthTokenFilter	setMinLength(Integer minLength) Set the minLength property: The minimum length in characters.
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

LengthTokenFilter

public LengthTokenFilter(String name)

Creates an instance of LengthTokenFilter class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static LengthTokenFilter fromJson(JsonReader jsonReader)

Reads an instance of LengthTokenFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getMaxLength

public Integer getMaxLength()

Get the maxLength property: The maximum length in characters. Default and maximum is 300.

Returns:

the maxLength value.

getMinLength

public Integer getMinLength()

Get the minLength property: The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max.

Returns:

the minLength value.

getOdataType

public String getOdataType()

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

Overrides:

LengthTokenFilter.getOdataType()

Returns:

the odataType value.

setMaxLength

public LengthTokenFilter setMaxLength(Integer maxLength)

Set the maxLength property: The maximum length in characters. Default and maximum is 300.

Parameters:

maxLength - the maxLength value to set.

Returns:

the LengthTokenFilter object itself.

setMinLength

public LengthTokenFilter setMinLength(Integer minLength)

Set the minLength property: The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max.

Parameters:

minLength - the minLength value to set.

Returns:

the LengthTokenFilter object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

LengthTokenFilter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException