Class PathHierarchyTokenizer

java.lang.Object
com.azure.search.documents.indexes.models.LexicalTokenizer
com.azure.search.documents.indexes.models.PathHierarchyTokenizer
All Implemented Interfaces:
com.azure.json.JsonSerializable<LexicalTokenizer>
public final class PathHierarchyTokenizer extends LexicalTokenizer
Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.

  • Constructor Details

    • PathHierarchyTokenizer

      public PathHierarchyTokenizer(String name)
      Creates an instance of PathHierarchyTokenizer class.
      Parameters:
      name - the name value to set.

  • Method Details

    • getOdataType

      public String getOdataType()
      Get the odataType property: A URI fragment specifying the type of tokenizer.
      Overrides:
      getOdataType in class LexicalTokenizer
      Returns:
      the odataType value.

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

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

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

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<LexicalTokenizer>
      Overrides:
      toJson in class LexicalTokenizer
      Throws:
      IOException

    • fromJson

      public static PathHierarchyTokenizer fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the PathHierarchyTokenizer.