com.exalead.searchapi.xmlv10.client

Interface SuggestEntry

All Known Implementing Classes:

SuggestEntryImpl

public interface SuggestEntry

Part of an answer of a suggest command.

Method Summary

Modifier and Type	Method and Description
long	getDistance() Gets the edit distance between the entry string and the query.
java.lang.String	getEntry() Gets the suggest dictionary string which has matched the query.
long	getMatchLength() Gets the length of the part of the entry matching the query.
long	getMatchOffset() Gets the starting position of the part of the entry matching the query.
long	getScore() Gets the score.
java.lang.String	getSource() Gets the name of the suggest in which this entry was found.
java.util.List<SuggestEntryExtraInformation>	getSuggestEntryExtraInformation() Gets any extra information associated to this entry from a XML suggest for instance.

Method Detail

getEntry

java.lang.String getEntry()

Gets the suggest dictionary string which has matched the query.

Returns:

a suggested entry

getDistance

long getDistance()

Gets the edit distance between the entry string and the query. This is a levenshtein distance with unit cost for insert/delete/substitute/swap.

Returns:

the edit distance between the entry string and the query

getScore

long getScore()

Gets the score. This is the document frequency of this entry.

Returns:

a count of the documents containing this entry

getSource

java.lang.String getSource()

Gets the name of the suggest in which this entry was found.

Returns:

the name of the suggest

getMatchOffset

long getMatchOffset()

Gets the starting position of the part of the entry matching the query. This is useful for highlighting.

Returns:

position of the match in terms of characters

getMatchLength

long getMatchLength()

Gets the length of the part of the entry matching the query. This is useful for highlighting.

Returns:

length of the match in terms of characters

getSuggestEntryExtraInformation

java.util.List<SuggestEntryExtraInformation> getSuggestEntryExtraInformation()

Gets any extra information associated to this entry from a XML suggest for instance.

Returns:

any extra information associated to this entry