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

public final class TruncateTokenFilter
extends TokenFilter

Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static TruncateTokenFilter	fromJson(JsonReader jsonReader) Reads an instance of TruncateTokenFilter from the JsonReader.
Integer	getLength() Get the length property: The length at which terms will be truncated.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of token filter.
TruncateTokenFilter	setLength(Integer length) Set the length property: The length at which terms will be truncated.
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

TruncateTokenFilter

public TruncateTokenFilter(String name)

Creates an instance of TruncateTokenFilter class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static TruncateTokenFilter fromJson(JsonReader jsonReader)

Reads an instance of TruncateTokenFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getLength

public Integer getLength()

Get the length property: The length at which terms will be truncated. Default and maximum is 300.

Returns:

the length value.

getOdataType

public String getOdataType()

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

Overrides:

TruncateTokenFilter.getOdataType()

Returns:

the odataType value.

setLength

public TruncateTokenFilter setLength(Integer length)

Set the length property: The length at which terms will be truncated. Default and maximum is 300.

Parameters:

length - the length value to set.

Returns:

the TruncateTokenFilter object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

TruncateTokenFilter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException