Package com.algolia.model.search

Class HighlightResultOption

java.lang.Object

com.algolia.model.search.HighlightResultOption

public class HighlightResultOption
extends Object

Show highlighted section and words matched on a query.

Constructor Summary

Constructors

Constructor	Description
HighlightResultOption()

Method Summary

Modifier and Type	Method	Description
HighlightResultOption	addMatchedWords(String matchedWordsItem)
boolean	equals(Object o)
Boolean	getFullyHighlighted()	Whether the entire attribute value is highlighted.
List<String>	getMatchedWords()	List of words from the query that matched the object.
MatchLevel	getMatchLevel()	Get matchLevel
String	getValue()	Markup text with `facetQuery` matches highlighted.
int	hashCode()
HighlightResultOption	setFullyHighlighted(Boolean fullyHighlighted)
HighlightResultOption	setMatchedWords(List<String> matchedWords)
HighlightResultOption	setMatchLevel(MatchLevel matchLevel)
HighlightResultOption	setValue(String value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

HighlightResultOption

public HighlightResultOption()

Method Details

setValue

public HighlightResultOption setValue(String value)

getValue

@Nonnull
public String getValue()

Markup text with `facetQuery` matches highlighted.

Returns:

value

setMatchLevel

public HighlightResultOption setMatchLevel(MatchLevel matchLevel)

getMatchLevel

@Nonnull
public MatchLevel getMatchLevel()

Get matchLevel

Returns:

matchLevel

setMatchedWords

public HighlightResultOption setMatchedWords(List<String> matchedWords)

addMatchedWords

public HighlightResultOption addMatchedWords(String matchedWordsItem)

getMatchedWords

@Nonnull
public List<String> getMatchedWords()

List of words from the query that matched the object.

Returns:

matchedWords

setFullyHighlighted

public HighlightResultOption setFullyHighlighted(Boolean fullyHighlighted)

getFullyHighlighted

@Nullable
public Boolean getFullyHighlighted()

Whether the entire attribute value is highlighted.

Returns:

fullyHighlighted

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