Package com.algolia.model.recommend

Class RecommendHit

java.lang.Object

com.algolia.model.recommend.RecommendHit

public class RecommendHit
extends Object

Recommend hit.

Constructor Summary

Constructors

Constructor	Description
RecommendHit()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,Object>	getAdditionalProperties()
Integer	getDistinctSeqID()	Get distinctSeqID
Map<String,HighlightResult>	getHighlightResult()	Show highlighted section and words matched on a query.
String	getObjectID()	Unique object identifier.
RankingInfo	getRankingInfo()	Get rankingInfo
Double	getScore()	Recommendation score.
Map<String,SnippetResult>	getSnippetResult()	Snippeted attributes show parts of the matched attributes.
int	hashCode()
RecommendHit	putHighlightResult(String key, HighlightResult highlightResultItem)
RecommendHit	putSnippetResult(String key, SnippetResult snippetResultItem)
RecommendHit	setAdditionalProperty(String name, Object value)
RecommendHit	setDistinctSeqID(Integer distinctSeqID)
RecommendHit	setHighlightResult(Map<String,HighlightResult> highlightResult)
RecommendHit	setObjectID(String objectID)
RecommendHit	setRankingInfo(RankingInfo rankingInfo)
RecommendHit	setScore(Double score)
RecommendHit	setSnippetResult(Map<String,SnippetResult> snippetResult)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RecommendHit

public RecommendHit()

Method Details

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public RecommendHit setAdditionalProperty(String name,
 Object value)

setObjectID

public RecommendHit setObjectID(String objectID)

getObjectID

@Nonnull
public String getObjectID()

Unique object identifier.

Returns:

objectID

setHighlightResult

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

putHighlightResult

public RecommendHit putHighlightResult(String key,
 HighlightResult highlightResultItem)

getHighlightResult

@Nullable
public Map<String,HighlightResult> getHighlightResult()

Show highlighted section and words matched on a query.

Returns:

highlightResult

setSnippetResult

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

putSnippetResult

public RecommendHit putSnippetResult(String key,
 SnippetResult snippetResultItem)

getSnippetResult

@Nullable
public Map<String,SnippetResult> getSnippetResult()

Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.

Returns:

snippetResult

setRankingInfo

public RecommendHit setRankingInfo(RankingInfo rankingInfo)

getRankingInfo

@Nullable
public RankingInfo getRankingInfo()

Get rankingInfo

Returns:

rankingInfo

setDistinctSeqID

public RecommendHit setDistinctSeqID(Integer distinctSeqID)

getDistinctSeqID

@Nullable
public Integer getDistinctSeqID()

Get distinctSeqID

Returns:

distinctSeqID

setScore

public RecommendHit setScore(Double score)

getScore

@Nonnull
public Double getScore()

Recommendation score. minimum: 0 maximum: 100

Returns:

score

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