StopwordsTokenFilter.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;
import java.util.List;

/**
 * Removes stop words from a token stream. This token filter is implemented
 * using Apache Lucene.
 */
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "@odata.type")
@JsonTypeName("#Microsoft.Azure.Search.StopwordsTokenFilter")
@Fluent
public final class StopwordsTokenFilter extends TokenFilter {
    /*
     * The list of stopwords. This property and the stopwords list property
     * cannot both be set.
     */
    @JsonProperty(value = "stopwords")
    private List<String> stopwords;

    /*
     * A predefined list of stopwords to use. This property and the stopwords
     * property cannot both be set. Default is English. Possible values
     * include: 'arabic', 'armenian', 'basque', 'brazilian', 'bulgarian',
     * 'catalan', 'czech', 'danish', 'dutch', 'english', 'finnish', 'french',
     * 'galician', 'german', 'greek', 'hindi', 'hungarian', 'indonesian',
     * 'irish', 'italian', 'latvian', 'norwegian', 'persian', 'portuguese',
     * 'romanian', 'russian', 'sorani', 'spanish', 'swedish', 'thai', 'turkish'
     */
    @JsonProperty(value = "stopwordsList")
    private StopwordsList stopwordsList;

    /*
     * A value indicating whether to ignore case. If true, all words are
     * converted to lower case first. Default is false.
     */
    @JsonProperty(value = "ignoreCase")
    private Boolean ignoreCase;

    /*
     * A value indicating whether to ignore the last search term if it's a stop
     * word. Default is true.
     */
    @JsonProperty(value = "removeTrailing")
    private Boolean removeTrailingStopWords;

    /**
     * Get the stopwords property: The list of stopwords. This property and the
     * stopwords list property cannot both be set.
     *
     * @return the stopwords value.
     */
    public List<String> getStopwords() {
        return this.stopwords;
    }

    /**
     * Set the stopwords property: The list of stopwords. This property and the
     * stopwords list property cannot both be set.
     *
     * @param stopwords the stopwords value to set.
     * @return the StopwordsTokenFilter object itself.
     */
    public StopwordsTokenFilter setStopwords(List<String> stopwords) {
        this.stopwords = stopwords;
        return this;
    }

    /**
     * Get the stopwordsList property: A predefined list of stopwords to use.
     * This property and the stopwords property cannot both be set. Default is
     * English. Possible values include: 'arabic', 'armenian', 'basque',
     * 'brazilian', 'bulgarian', 'catalan', 'czech', 'danish', 'dutch',
     * 'english', 'finnish', 'french', 'galician', 'german', 'greek', 'hindi',
     * 'hungarian', 'indonesian', 'irish', 'italian', 'latvian', 'norwegian',
     * 'persian', 'portuguese', 'romanian', 'russian', 'sorani', 'spanish',
     * 'swedish', 'thai', 'turkish'.
     *
     * @return the stopwordsList value.
     */
    public StopwordsList getStopwordsList() {
        return this.stopwordsList;
    }

    /**
     * Set the stopwordsList property: A predefined list of stopwords to use.
     * This property and the stopwords property cannot both be set. Default is
     * English. Possible values include: 'arabic', 'armenian', 'basque',
     * 'brazilian', 'bulgarian', 'catalan', 'czech', 'danish', 'dutch',
     * 'english', 'finnish', 'french', 'galician', 'german', 'greek', 'hindi',
     * 'hungarian', 'indonesian', 'irish', 'italian', 'latvian', 'norwegian',
     * 'persian', 'portuguese', 'romanian', 'russian', 'sorani', 'spanish',
     * 'swedish', 'thai', 'turkish'.
     *
     * @param stopwordsList the stopwordsList value to set.
     * @return the StopwordsTokenFilter object itself.
     */
    public StopwordsTokenFilter setStopwordsList(StopwordsList stopwordsList) {
        this.stopwordsList = stopwordsList;
        return this;
    }

    /**
     * Get the ignoreCase property: A value indicating whether to ignore case.
     * If true, all words are converted to lower case first. Default is false.
     *
     * @return the ignoreCase value.
     */
    public Boolean isIgnoreCase() {
        return this.ignoreCase;
    }

    /**
     * Set the ignoreCase property: A value indicating whether to ignore case.
     * If true, all words are converted to lower case first. Default is false.
     *
     * @param ignoreCase the ignoreCase value to set.
     * @return the StopwordsTokenFilter object itself.
     */
    public StopwordsTokenFilter setIgnoreCase(Boolean ignoreCase) {
        this.ignoreCase = ignoreCase;
        return this;
    }

    /**
     * Get the removeTrailingStopWords property: A value indicating whether to
     * ignore the last search term if it's a stop word. Default is true.
     *
     * @return the removeTrailingStopWords value.
     */
    public Boolean isRemoveTrailingStopWords() {
        return this.removeTrailingStopWords;
    }

    /**
     * Set the removeTrailingStopWords property: A value indicating whether to
     * ignore the last search term if it's a stop word. Default is true.
     *
     * @param removeTrailingStopWords the removeTrailingStopWords value to set.
     * @return the StopwordsTokenFilter object itself.
     */
    public StopwordsTokenFilter setRemoveTrailingStopWords(Boolean removeTrailingStopWords) {
        this.removeTrailingStopWords = removeTrailingStopWords;
        return this;
    }
}