io.github.honhimw.ms.model.TypoTolerance Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of meilisearch-rest-client
Reactive meilisearch rest client powered by reactor-netty-http.
There is a newer version: 1.12.0.0
/*
 * 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 io.github.honhimw.ms.model;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

/**
 * Reference docs: Typo tolerance object
 * Default object:
 *  * {
 *     "enabled": true,
 *     "minWordSizeForTypos": {
 *       "oneTypo": 5,
 *       "twoTypos": 9
 *     },
 *     "disableOnWords": [],
 *     "disableOnAttributes": []
 * }
 * 
 *
 * @author hon_him
 * @since 2024-01-03
 */

@Data
@EqualsAndHashCode(callSuper = false)
@NoArgsConstructor
@AllArgsConstructor
@Builder(builderClassName = "Builder")
public class TypoTolerance implements Serializable {

    @Schema(description = "Whether typo tolerance is enabled or not", defaultValue = "true")
    private Boolean enabled;

    private MinWordSizeForTypos minWordSizeForTypos;

    @Schema(description = "An array of words for which the typo tolerance feature is disabled", defaultValue = "[]")
    private List disableOnWords;

    @Schema(description = "An array of attributes for which the typo tolerance feature is disabled", defaultValue = "[]")
    private List disableOnAttributes;

    public static TypoTolerance defaultObject() {
        TypoTolerance typoTolerance = new TypoTolerance();
        typoTolerance.setEnabled(true);
        MinWordSizeForTypos minWordSizeForTypos = new MinWordSizeForTypos();
        minWordSizeForTypos.setOneTypo(5);
        minWordSizeForTypos.setTwoTypos(9);
        typoTolerance.setMinWordSizeForTypos(minWordSizeForTypos);
        typoTolerance.setDisableOnWords(new ArrayList<>());
        typoTolerance.setDisableOnAttributes(new ArrayList<>());
        return typoTolerance;
    }

    @Data
    @EqualsAndHashCode(callSuper = false)
    @NoArgsConstructor
    @AllArgsConstructor
    @lombok.Builder(builderClassName = "Builder")
    public static class MinWordSizeForTypos implements Serializable {

        @Schema(description = "The minimum word size for accepting 1 typo; must be between 0 and twoTypos", defaultValue = "5")
        private Integer oneTypo;

        @Schema(description = "The minimum word size for accepting 2 typos; must be between oneTypo and 255", defaultValue = "9")
        private Integer twoTypos;

    }


}