com.exalead.searchapi.xmlv10.client.results.impl

Class SuggestEntryImpl

java.lang.Object

com.exalead.searchapi.xmlv10.client.results.impl.SuggestEntryImpl

All Implemented Interfaces:

SuggestEntry

public class SuggestEntryImpl
extends java.lang.Object
implements SuggestEntry

Constructor Summary

Constructors

Constructor and Description
SuggestEntryImpl()

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.
void	setDistance(long distance)
void	setEntry(java.lang.String entry)
void	setMatchLength(long matchLength)
void	setMatchOffset(long matchOffset)
void	setScore(long score)
void	setSource(java.lang.String source)
void	setSuggestEntryExtraInformation(java.util.List<SuggestEntryExtraInformation> suggestEntryExtraInformation)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SuggestEntryImpl

public SuggestEntryImpl()

Method Detail

getEntry

public java.lang.String getEntry()

Description copied from interface: SuggestEntry

Gets the suggest dictionary string which has matched the query.

Specified by:

getEntry in interface SuggestEntry

Returns:

a suggested entry

setEntry

public void setEntry(java.lang.String entry)

getDistance

public long getDistance()

Description copied from interface: SuggestEntry

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

Specified by:

getDistance in interface SuggestEntry

Returns:

the edit distance between the entry string and the query

setDistance

public void setDistance(long distance)

getScore

public long getScore()

Description copied from interface: SuggestEntry

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

Specified by:

getScore in interface SuggestEntry

Returns:

a count of the documents containing this entry

setScore

public void setScore(long score)

getSource

public java.lang.String getSource()

Description copied from interface: SuggestEntry

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

Specified by:

getSource in interface SuggestEntry

Returns:

the name of the suggest

setSource

public void setSource(java.lang.String source)

getMatchOffset

public long getMatchOffset()

Description copied from interface: SuggestEntry

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

Specified by:

getMatchOffset in interface SuggestEntry

Returns:

position of the match in terms of characters

setMatchOffset

public void setMatchOffset(long matchOffset)

getMatchLength

public long getMatchLength()

Description copied from interface: SuggestEntry

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

Specified by:

getMatchLength in interface SuggestEntry

Returns:

length of the match in terms of characters

setMatchLength

public void setMatchLength(long matchLength)

getSuggestEntryExtraInformation

public java.util.List<SuggestEntryExtraInformation> getSuggestEntryExtraInformation()

Description copied from interface: SuggestEntry

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

Specified by:

getSuggestEntryExtraInformation in interface SuggestEntry

Returns:

any extra information associated to this entry

setSuggestEntryExtraInformation

public void setSuggestEntryExtraInformation(java.util.List<SuggestEntryExtraInformation> suggestEntryExtraInformation)