Package com.algolia.model.search

Class DictionaryEntry

java.lang.Object
com.algolia.model.search.DictionaryEntry
public class DictionaryEntry extends Object
Dictionary entry.

  • Constructor Details

    • DictionaryEntry

      public DictionaryEntry()

  • Method Details

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • setAdditionalProperty

      public DictionaryEntry setAdditionalProperty(String name, Object value)

    • setObjectID

      public DictionaryEntry setObjectID(String objectID)

    • getObjectID

      @Nonnull public String getObjectID()
      Unique identifier for a dictionary object.

    • setLanguage

      public DictionaryEntry setLanguage(String language)

    • getLanguage

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

    • setWord

      public DictionaryEntry setWord(String word)

    • getWord

      @Nullable public String getWord()
      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\".

    • setWords

      public DictionaryEntry setWords(List<String> words)

    • addWords

      public DictionaryEntry addWords(String wordsItem)

    • getWords

      @Nullable public List<String> getWords()
      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`.

    • setDecomposition

      public DictionaryEntry setDecomposition(List<String> decomposition)

    • addDecomposition

      public DictionaryEntry addDecomposition(String decompositionItem)

    • getDecomposition

      @Nullable public List<String> getDecomposition()
      For compound entries, governs the behavior of the `word` parameter.

    • setState

      public DictionaryEntry setState(DictionaryEntryState state)

    • getState

      @Nullable public DictionaryEntryState getState()
      Get state

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object