org.redisson.api.search.SpellcheckOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

There is a newer version: 3.40.2

Show newest version

/**
 * Copyright (c) 2013-2024 Nikita Koksharov
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.redisson.api.search;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

/**
 * Spellcheck options for
 * {@link org.redisson.api.RSearch#spellcheck(String, String, SpellcheckOptions)} method
 *
 * @author Nikita Koksharov
 *
 */
public final class SpellcheckOptions {

    private Integer distance;
    private Integer dialect;
    private List includedTerms = Collections.emptyList();
    private List excludedTerms = Collections.emptyList();
    private String excludedDictionary;
    private String includedDictionary;

    private SpellcheckOptions() {
    }

    public static SpellcheckOptions defaults() {
        return new SpellcheckOptions();
    }

    /**
     * Defines maximum Levenshtein distance for spelling suggestions.
     * Allowed values from 1 to 4.
     * 
     * Default is 1
     *
     * @param distance maximum Levenshtein distance
     * @return options object
     */
    public SpellcheckOptions distance(Integer distance) {
        this.distance = distance;
        return this;
    }

    /**
     * Defines dialect version used for query execution.
     *
     * @param dialect dialect version
     * @return options object
     */
    public SpellcheckOptions dialect(Integer dialect) {
        this.dialect = dialect;
        return this;
    }

    /**
     * Defines includedTerms of a custom dictionary.
     *
     * @param dictionary custom dictionary
     * @param includedTerms included terms
     * @return options object
     */
    public SpellcheckOptions includedTerms(String dictionary, String... includedTerms) {
        this.includedDictionary = dictionary;
        this.includedTerms = Arrays.asList(includedTerms);
        return this;
    }

    /**
     * Defines excludedTerms of a custom dictionary.
     *
     * @param dictionary custom dictionary
     * @param excludedTerms excluded terms
     * @return options object
     */
    public SpellcheckOptions excludedTerms(String dictionary, String... excludedTerms) {
        this.excludedDictionary = dictionary;
        this.excludedTerms = Arrays.asList(excludedTerms);
        return this;
    }

    public Integer getDistance() {
        return distance;
    }

    public Integer getDialect() {
        return dialect;
    }

    public List getIncludedTerms() {
        return includedTerms;
    }

    public List getExcludedTerms() {
        return excludedTerms;
    }

    public String getExcludedDictionary() {
        return excludedDictionary;
    }

    public String getIncludedDictionary() {
        return includedDictionary;
    }
}