Package com.algolia.model.search

Class SynonymHit

java.lang.Object
com.algolia.model.search.SynonymHit
public class SynonymHit extends Object
Synonym object.

  • Constructor Details

    • SynonymHit

      public SynonymHit()

  • Method Details

    • setObjectID

      public SynonymHit setObjectID(String objectID)

    • getObjectID

      @Nonnull public String getObjectID()
      Unique identifier of a synonym object.
      Returns:
      objectID

    • setType

      public SynonymHit setType(SynonymType type)

    • getType

      @Nonnull public SynonymType getType()
      Get type
      Returns:
      type

    • setSynonyms

      public SynonymHit setSynonyms(List<String> synonyms)

    • addSynonyms

      public SynonymHit addSynonyms(String synonymsItem)

    • getSynonyms

      @Nullable public List<String> getSynonyms()
      Words or phrases considered equivalent.
      Returns:
      synonyms

    • setInput

      public SynonymHit setInput(String input)

    • getInput

      @Nullable public String getInput()
      Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
      Returns:
      input

    • setWord

      public SynonymHit setWord(String word)

    • getWord

      @Nullable public String getWord()
      Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
      Returns:
      word

    • setCorrections

      public SynonymHit setCorrections(List<String> corrections)

    • addCorrections

      public SynonymHit addCorrections(String correctionsItem)

    • getCorrections

      @Nullable public List<String> getCorrections()
      Words to be matched in records.
      Returns:
      corrections

    • setPlaceholder

      public SynonymHit setPlaceholder(String placeholder)

    • getPlaceholder

      @Nullable public String getPlaceholder()
      [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
      Returns:
      placeholder

    • setReplacements

      public SynonymHit setReplacements(List<String> replacements)

    • addReplacements

      public SynonymHit addReplacements(String replacementsItem)

    • getReplacements

      @Nullable public List<String> getReplacements()
      Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
      Returns:
      replacements

    • 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