PathHierarchyTokenizerV2 Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:12.0.0

• java.lang.Object
• • com.azure.search.documents.indexes.models.LexicalTokenizer
  • • com.azure.search.documents.indexes.models.PathHierarchyTokenizerV2

public final class PathHierarchyTokenizerV2
extends LexicalTokenizer

Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static PathHierarchyTokenizerV2	fromJson(JsonReader jsonReader) Reads an instance of PathHierarchyTokenizerV2 from the JsonReader.
String	getDelimiter() Get the delimiter property: The delimiter character to use.
Integer	getMaxTokenLength() Get the maxTokenLength property: The maximum token length.
Integer	getNumberOfTokensToSkip() Get the numberOfTokensToSkip property: The number of initial tokens to skip.
String	getOdataType() Get the odataType property: The discriminator for derived types.
String	getReplacement() Get the replacement property: A value that, if set, replaces the delimiter character.
Boolean	isReverseTokenOrder() Get the reverseTokenOrder property: A value indicating whether to generate tokens in reverse order.
PathHierarchyTokenizerV2	setDelimiter(String delimiter) Set the delimiter property: The delimiter character to use.
PathHierarchyTokenizerV2	setMaxTokenLength(Integer maxTokenLength) Set the maxTokenLength property: The maximum token length.
PathHierarchyTokenizerV2	setNumberOfTokensToSkip(Integer numberOfTokensToSkip) Set the numberOfTokensToSkip property: The number of initial tokens to skip.
PathHierarchyTokenizerV2	setReplacement(String replacement) Set the replacement property: A value that, if set, replaces the delimiter character.
PathHierarchyTokenizerV2	setReverseTokenOrder(Boolean reverseTokenOrder) Set the reverseTokenOrder property: A value indicating whether to generate tokens in reverse order.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from LexicalTokenizer

fromJson getName getOdataType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PathHierarchyTokenizerV2

public PathHierarchyTokenizerV2(String name)

Creates an instance of PathHierarchyTokenizerV2 class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static PathHierarchyTokenizerV2 fromJson(JsonReader jsonReader)

Reads an instance of PathHierarchyTokenizerV2 from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getDelimiter

public String getDelimiter()

Get the delimiter property: The delimiter character to use. Default is "/".

Returns:

the delimiter value.

getMaxTokenLength

public Integer getMaxTokenLength()

Get the maxTokenLength property: The maximum token length. Default and maximum is 300.

Returns:

the maxTokenLength value.

getNumberOfTokensToSkip

public Integer getNumberOfTokensToSkip()

Get the numberOfTokensToSkip property: The number of initial tokens to skip. Default is 0.

Returns:

the numberOfTokensToSkip value.

getOdataType

public String getOdataType()

Get the odataType property: The discriminator for derived types.

Overrides:

PathHierarchyTokenizerV2.getOdataType()

Returns:

the odataType value.

getReplacement

public String getReplacement()

Get the replacement property: A value that, if set, replaces the delimiter character. Default is "/".

Returns:

the replacement value.

isReverseTokenOrder

public Boolean isReverseTokenOrder()

Get the reverseTokenOrder property: A value indicating whether to generate tokens in reverse order. Default is false.

Returns:

the reverseTokenOrder value.

setDelimiter

public PathHierarchyTokenizerV2 setDelimiter(String delimiter)

Set the delimiter property: The delimiter character to use. Default is "/".

Parameters:

delimiter - the delimiter value to set.

Returns:

the PathHierarchyTokenizerV2 object itself.

setMaxTokenLength

public PathHierarchyTokenizerV2 setMaxTokenLength(Integer maxTokenLength)

Set the maxTokenLength property: The maximum token length. Default and maximum is 300.

Parameters:

maxTokenLength - the maxTokenLength value to set.

Returns:

the PathHierarchyTokenizerV2 object itself.

setNumberOfTokensToSkip

public PathHierarchyTokenizerV2 setNumberOfTokensToSkip(Integer numberOfTokensToSkip)

Set the numberOfTokensToSkip property: The number of initial tokens to skip. Default is 0.

Parameters:

numberOfTokensToSkip - the numberOfTokensToSkip value to set.

Returns:

the PathHierarchyTokenizerV2 object itself.

setReplacement

public PathHierarchyTokenizerV2 setReplacement(String replacement)

Set the replacement property: A value that, if set, replaces the delimiter character. Default is "/".

Parameters:

replacement - the replacement value to set.

Returns:

the PathHierarchyTokenizerV2 object itself.

setReverseTokenOrder

public PathHierarchyTokenizerV2 setReverseTokenOrder(Boolean reverseTokenOrder)

Set the reverseTokenOrder property: A value indicating whether to generate tokens in reverse order. Default is false.

Parameters:

reverseTokenOrder - the reverseTokenOrder value to set.

Returns:

the PathHierarchyTokenizerV2 object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

PathHierarchyTokenizerV2.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException