Package com.algolia.model.search

Class Hit

java.lang.Object
com.algolia.model.search.Hit
public class Hit extends Object
Search result. A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.

  • Constructor Details

    • Hit

      public Hit()

  • Method Details

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • setAdditionalProperty

      public Hit setAdditionalProperty(String name, Object value)

    • setObjectID

      public Hit setObjectID(String objectID)

    • getObjectID

      @Nonnull public String getObjectID()
      Unique record identifier.

    • setHighlightResult

      public Hit setHighlightResult(Map<String,HighlightResult> highlightResult)

    • putHighlightResult

      public Hit putHighlightResult(String key, HighlightResult highlightResultItem)

    • getHighlightResult

      @Nullable public Map<String,HighlightResult> getHighlightResult()
      Surround words that match the query with HTML tags for highlighting.

    • setSnippetResult

      public Hit setSnippetResult(Map<String,SnippetResult> snippetResult)

    • putSnippetResult

      public Hit putSnippetResult(String key, SnippetResult snippetResultItem)

    • getSnippetResult

      @Nullable public Map<String,SnippetResult> getSnippetResult()
      Snippets that show the context around a matching search query.

    • setRankingInfo

      public Hit setRankingInfo(RankingInfo rankingInfo)

    • getRankingInfo

      @Nullable public RankingInfo getRankingInfo()
      Get rankingInfo

    • setDistinctSeqID

      public Hit setDistinctSeqID(Integer distinctSeqID)

    • getDistinctSeqID

      @Nullable public Integer getDistinctSeqID()
      Get distinctSeqID

    • 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