PathHierarchyTokenizer 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.LexicalTokenizer
  • • com.azure.search.documents.indexes.models.PathHierarchyTokenizer

public final class PathHierarchyTokenizer
extends LexicalTokenizer

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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static PathHierarchyTokenizer	fromJson(JsonReader jsonReader) Reads an instance of PathHierarchyTokenizer from the JsonReader.
Character	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: A URI fragment specifying the type of tokenizer.
Character	getReplacement() Get the replacement property: A value that, if set, replaces the delimiter character.
Boolean	isTokenOrderReversed() Get the tokenOrderReversed property: A value indicating whether to generate tokens in reverse order.
PathHierarchyTokenizer	setDelimiter(Character delimiter) Set the delimiter property: The delimiter character to use.
PathHierarchyTokenizer	setMaxTokenLength(Integer maxTokenLength) Set the maxTokenLength property: The maximum token length.
PathHierarchyTokenizer	setNumberOfTokensToSkip(Integer numberOfTokensToSkip) Set the numberOfTokensToSkip property: The number of initial tokens to skip.
PathHierarchyTokenizer	setReplacement(Character replacement) Set the replacement property: A value that, if set, replaces the delimiter character.
PathHierarchyTokenizer	setTokenOrderReversed(Boolean tokenOrderReversed) Set the tokenOrderReversed 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

PathHierarchyTokenizer

public PathHierarchyTokenizer(String name)

Creates an instance of PathHierarchyTokenizer class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static PathHierarchyTokenizer fromJson(JsonReader jsonReader)

Reads an instance of PathHierarchyTokenizer from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PathHierarchyTokenizer 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 Character 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: A URI fragment specifying the type of tokenizer.

Overrides:

PathHierarchyTokenizer.getOdataType()

Returns:

the odataType value.

getReplacement

public Character getReplacement()

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

Returns:

the replacement value.

isTokenOrderReversed

public Boolean isTokenOrderReversed()

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

Returns:

the tokenOrderReversed value.

setDelimiter

public PathHierarchyTokenizer setDelimiter(Character delimiter)

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

Parameters:

delimiter - the delimiter value to set.

Returns:

the PathHierarchyTokenizer object itself.

setMaxTokenLength

public PathHierarchyTokenizer 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 PathHierarchyTokenizer object itself.

setNumberOfTokensToSkip

public PathHierarchyTokenizer 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 PathHierarchyTokenizer object itself.

setReplacement

public PathHierarchyTokenizer setReplacement(Character 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 PathHierarchyTokenizer object itself.

setTokenOrderReversed

public PathHierarchyTokenizer setTokenOrderReversed(Boolean tokenOrderReversed)

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

Parameters:

tokenOrderReversed - the tokenOrderReversed value to set.

Returns:

the PathHierarchyTokenizer object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

PathHierarchyTokenizer.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException