Package com.azure.search.documents.indexes.models

Class PathHierarchyTokenizer

  • public final class PathHierarchyTokenizer
extends LexicalTokenizer
    Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.

    • Constructor Detail

      • PathHierarchyTokenizer

        public PathHierarchyTokenizer​(String name)
        Constructor of PathHierarchyTokenizer.
        Parameters:
        name - The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.

    • Method Detail

      • getDelimiter

        public Character getDelimiter()
        Get the delimiter property: The delimiter character to use. Default is "/".
        Returns:
        the delimiter 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 PathHierarchyTokenizerV2 object itself.

      • getReplacement

        public Character getReplacement()
        Get the replacement property: A value that, if set, replaces the delimiter character. Default is "/".
        Returns:
        the replacement value.

      • 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 PathHierarchyTokenizerV2 object itself.

      • getMaxTokenLength

        public Integer getMaxTokenLength()
        Get the maxTokenLength property: The maximum token length. Default and maximum is 300.
        Returns:
        the maxTokenLength value.

      • 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 PathHierarchyTokenizerV2 object itself.

      • isTokenOrderReversed

        public Boolean isTokenOrderReversed()
        Get the reverseTokenOrder property: A value indicating whether to generate tokens in reverse order. Default is false.
        Returns:
        the reverseTokenOrder value.

      • setTokenOrderReversed

        public PathHierarchyTokenizer setTokenOrderReversed​(Boolean tokenOrderReversed)
        Set the reverseTokenOrder property: A value indicating whether to generate tokens in reverse order. Default is false.
        Parameters:
        tokenOrderReversed - the reverseTokenOrder value to set.
        Returns:
        the PathHierarchyTokenizerV2 object itself.

      • getNumberOfTokensToSkip

        public Integer getNumberOfTokensToSkip()
        Get the numberOfTokensToSkip property: The number of initial tokens to skip. Default is 0.
        Returns:
        the numberOfTokensToSkip value.

      • 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 PathHierarchyTokenizerV2 object itself.