com.algolia.model.search.DictionaryEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of algoliasearch Show documentation
Java client for Algolia Search API
There is a newer version: 4.11.0
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost
// - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

package com.algolia.model.search;

import com.fasterxml.jackson.annotation.*;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;

/** Dictionary entry. */
public class DictionaryEntry {

  @JsonProperty("objectID")
  private String objectID;

  @JsonProperty("language")
  private String language;

  @JsonProperty("word")
  private String word;

  @JsonProperty("words")
  private List words;

  @JsonProperty("decomposition")
  private List decomposition;

  @JsonProperty("state")
  private DictionaryEntryState state;

  private Map additionalProperties = new HashMap<>();

  @JsonAnyGetter
  public Map getAdditionalProperties() {
    return this.additionalProperties;
  }

  @JsonAnySetter
  public DictionaryEntry setAdditionalProperty(String name, Object value) {
    this.additionalProperties.put(name, value);
    return this;
  }

  public DictionaryEntry setObjectID(String objectID) {
    this.objectID = objectID;
    return this;
  }

  /** Unique identifier for a dictionary object. */
  @javax.annotation.Nonnull
  public String getObjectID() {
    return objectID;
  }

  public DictionaryEntry setLanguage(String language) {
    this.language = language;
    return this;
  }

  /**
   * [Supported language ISO
   * code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
   */
  @javax.annotation.Nonnull
  public String getLanguage() {
    return language;
  }

  public DictionaryEntry setWord(String word) {
    this.word = word;
    return this;
  }

  /**
   * Dictionary entry word. Usage depends on the type of dictionary entry. **`stopwordEntry`** The
   * stop word you want to add or update. If the entry already exists in Algolia's standard
   * dictionary, you can override its behavior by adding it to the custom dictionary and setting its
   * `state` to `disabled`. **`compoundEntry`** When `decomposition` is empty: adds `word` as a
   * compound atom. For example, atom “kino” decomposes the query “kopfkino” into \"kopf\" and
   * \"kino\". When `decomposition` isn't empty: creates a decomposition exception. For example,
   * when decomposition is set to the [\"hund\", \"hutte\"] exception, \"hundehutte\" decomposes
   * into “hund” and “hutte”, discarding the linking \"e\".
   */
  @javax.annotation.Nullable
  public String getWord() {
    return word;
  }

  public DictionaryEntry setWords(List words) {
    this.words = words;
    return this;
  }

  public DictionaryEntry addWords(String wordsItem) {
    if (this.words == null) {
      this.words = new ArrayList<>();
    }
    this.words.add(wordsItem);
    return this;
  }

  /**
   * Compound dictionary [word
   * declensions](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/).
   * If the entry already exists in Algolia's standard dictionary, you can override its behavior by
   * adding it to the custom dictionary and setting its `state` to `disabled`.
   */
  @javax.annotation.Nullable
  public List getWords() {
    return words;
  }

  public DictionaryEntry setDecomposition(List decomposition) {
    this.decomposition = decomposition;
    return this;
  }

  public DictionaryEntry addDecomposition(String decompositionItem) {
    if (this.decomposition == null) {
      this.decomposition = new ArrayList<>();
    }
    this.decomposition.add(decompositionItem);
    return this;
  }

  /** For compound entries, governs the behavior of the `word` parameter. */
  @javax.annotation.Nullable
  public List getDecomposition() {
    return decomposition;
  }

  public DictionaryEntry setState(DictionaryEntryState state) {
    this.state = state;
    return this;
  }

  /** Get state */
  @javax.annotation.Nullable
  public DictionaryEntryState getState() {
    return state;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    DictionaryEntry dictionaryEntry = (DictionaryEntry) o;
    return (
      Objects.equals(this.objectID, dictionaryEntry.objectID) &&
      Objects.equals(this.language, dictionaryEntry.language) &&
      Objects.equals(this.word, dictionaryEntry.word) &&
      Objects.equals(this.words, dictionaryEntry.words) &&
      Objects.equals(this.decomposition, dictionaryEntry.decomposition) &&
      Objects.equals(this.state, dictionaryEntry.state) &&
      super.equals(o)
    );
  }

  @Override
  public int hashCode() {
    return Objects.hash(objectID, language, word, words, decomposition, state, super.hashCode());
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class DictionaryEntry {\n");
    sb.append("    ").append(toIndentedString(super.toString())).append("\n");
    sb.append("    objectID: ").append(toIndentedString(objectID)).append("\n");
    sb.append("    language: ").append(toIndentedString(language)).append("\n");
    sb.append("    word: ").append(toIndentedString(word)).append("\n");
    sb.append("    words: ").append(toIndentedString(words)).append("\n");
    sb.append("    decomposition: ").append(toIndentedString(decomposition)).append("\n");
    sb.append("    state: ").append(toIndentedString(state)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces (except the first line).
   */
  private String toIndentedString(Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }
}