PathHierarchyTokenizer.java

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is
// regenerated.

package com.azure.search.documents.models;

import com.azure.core.annotation.Fluent;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * Tokenizer for path-like hierarchies. This tokenizer is implemented using
 * Apache Lucene.
 */
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "@odata.type")
@JsonTypeName("#Microsoft.Azure.Search.PathHierarchyTokenizer")
@Fluent
public final class PathHierarchyTokenizer extends Tokenizer {
    /*
     * The delimiter character to use. Default is "/".
     */
    @JsonProperty(value = "delimiter")
    private String delimiter;

    /*
     * A value that, if set, replaces the delimiter character. Default is "/".
     */
    @JsonProperty(value = "replacement")
    private String replacement;

    /*
     * The buffer size. Default is 1024.
     */
    @JsonProperty(value = "bufferSize")
    private Integer bufferSize;

    /*
     * A value indicating whether to generate tokens in reverse order. Default
     * is false.
     */
    @JsonProperty(value = "reverse")
    private Boolean reverseTokenOrder;

    /*
     * The number of initial tokens to skip. Default is 0.
     */
    @JsonProperty(value = "skip")
    private Integer numberOfTokensToSkip;

    /**
     * Get the delimiter property: The delimiter character to use. Default is
     * "/".
     *
     * @return the delimiter value.
     */
    public String getDelimiter() {
        return this.delimiter;
    }

    /**
     * Set the delimiter property: The delimiter character to use. Default is
     * "/".
     *
     * @param delimiter the delimiter value to set.
     * @return the PathHierarchyTokenizer object itself.
     */
    public PathHierarchyTokenizer setDelimiter(String delimiter) {
        this.delimiter = delimiter;
        return this;
    }

    /**
     * Get the replacement property: A value that, if set, replaces the
     * delimiter character. Default is "/".
     *
     * @return the replacement value.
     */
    public String getReplacement() {
        return this.replacement;
    }

    /**
     * Set the replacement property: A value that, if set, replaces the
     * delimiter character. Default is "/".
     *
     * @param replacement the replacement value to set.
     * @return the PathHierarchyTokenizer object itself.
     */
    public PathHierarchyTokenizer setReplacement(String replacement) {
        this.replacement = replacement;
        return this;
    }

    /**
     * Get the bufferSize property: The buffer size. Default is 1024.
     *
     * @return the bufferSize value.
     */
    public Integer getBufferSize() {
        return this.bufferSize;
    }

    /**
     * Set the bufferSize property: The buffer size. Default is 1024.
     *
     * @param bufferSize the bufferSize value to set.
     * @return the PathHierarchyTokenizer object itself.
     */
    public PathHierarchyTokenizer setBufferSize(Integer bufferSize) {
        this.bufferSize = bufferSize;
        return this;
    }

    /**
     * Get the reverseTokenOrder property: A value indicating whether to
     * generate tokens in reverse order. Default is false.
     *
     * @return the reverseTokenOrder value.
     */
    public Boolean isReverseTokenOrder() {
        return this.reverseTokenOrder;
    }

    /**
     * Set the reverseTokenOrder property: A value indicating whether to
     * generate tokens in reverse order. Default is false.
     *
     * @param reverseTokenOrder the reverseTokenOrder value to set.
     * @return the PathHierarchyTokenizer object itself.
     */
    public PathHierarchyTokenizer setReverseTokenOrder(Boolean reverseTokenOrder) {
        this.reverseTokenOrder = reverseTokenOrder;
        return this;
    }

    /**
     * Get the numberOfTokensToSkip property: The number of initial tokens to
     * skip. Default is 0.
     *
     * @return the numberOfTokensToSkip value.
     */
    public Integer getNumberOfTokensToSkip() {
        return this.numberOfTokensToSkip;
    }

    /**
     * Set the numberOfTokensToSkip property: The number of initial tokens to
     * skip. Default is 0.
     *
     * @param numberOfTokensToSkip the numberOfTokensToSkip value to set.
     * @return the PathHierarchyTokenizer object itself.
     */
    public PathHierarchyTokenizer setNumberOfTokensToSkip(Integer numberOfTokensToSkip) {
        this.numberOfTokensToSkip = numberOfTokensToSkip;
        return this;
    }
}