Package com.algolia.model.search

Class RankingInfo

java.lang.Object
com.algolia.model.search.RankingInfo
public class RankingInfo extends Object
RankingInfo

  • Constructor Details

    • RankingInfo

      public RankingInfo()

  • Method Details

    • setFilters

      public RankingInfo setFilters(Integer filters)

    • getFilters

      @Nonnull public Integer getFilters()
      This field is reserved for advanced usage.

    • setFirstMatchedWord

      public RankingInfo setFirstMatchedWord(Integer firstMatchedWord)

    • getFirstMatchedWord

      @Nonnull public Integer getFirstMatchedWord()
      Position of the most important matched attribute in the attributes to index list.

    • setGeoDistance

      public RankingInfo setGeoDistance(Integer geoDistance)

    • getGeoDistance

      @Nonnull public Integer getGeoDistance()
      Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).

    • setGeoPrecision

      public RankingInfo setGeoPrecision(Integer geoPrecision)

    • getGeoPrecision

      @Nullable public Integer getGeoPrecision()
      Precision used when computing the geo distance, in meters.

    • setMatchedGeoLocation

      public RankingInfo setMatchedGeoLocation(MatchedGeoLocation matchedGeoLocation)

    • getMatchedGeoLocation

      @Nullable public MatchedGeoLocation getMatchedGeoLocation()
      Get matchedGeoLocation

    • setPersonalization

      public RankingInfo setPersonalization(Personalization personalization)

    • getPersonalization

      @Nullable public Personalization getPersonalization()
      Get personalization

    • setNbExactWords

      public RankingInfo setNbExactWords(Integer nbExactWords)

    • getNbExactWords

      @Nonnull public Integer getNbExactWords()
      Number of exactly matched words.

    • setNbTypos

      public RankingInfo setNbTypos(Integer nbTypos)

    • getNbTypos

      @Nonnull public Integer getNbTypos()
      Number of typos encountered when matching the record.

    • setPromoted

      public RankingInfo setPromoted(Boolean promoted)

    • getPromoted

      @Nonnull public Boolean getPromoted()
      Present and set to true if a Rule promoted the hit.

    • setProximityDistance

      public RankingInfo setProximityDistance(Integer proximityDistance)

    • getProximityDistance

      @Nullable public Integer getProximityDistance()
      When the query contains more than one word, the sum of the distances between matched words (in meters).

    • setUserScore

      public RankingInfo setUserScore(Integer userScore)

    • getUserScore

      @Nonnull public Integer getUserScore()
      Custom ranking for the object, expressed as a single integer value.

    • setWords

      public RankingInfo setWords(Integer words)

    • getWords

      @Nonnull public Integer getWords()
      Number of matched words, including prefixes and typos.

    • setPromotedByReRanking

      public RankingInfo setPromotedByReRanking(Boolean promotedByReRanking)

    • getPromotedByReRanking

      @Nullable public Boolean getPromotedByReRanking()
      Wether the record are promoted by the re-ranking strategy.

    • 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