com.exalead.searchapi.xmlv10.client

Interface SearchAnswer

All Known Implementing Classes:

FleaSearchAnswerImpl, MergeSearchAnswer, SearchAnswerImpl

public interface SearchAnswer

Answer of a search on the search-api.

The "results" are available via getHits() and the "navigation" via getRelatedTerms() and getCategoryGroups().

This object and all contained objects are not thread-safe. You should not use the results of a search answer concurrently in multiple threads.

Method Summary

Modifier and Type	Method and Description
CategoryGroup	getCategoryGroup(java.lang.String name) Get a facet by its id.
java.util.Collection<CategoryGroup>	getCategoryGroups() Get the facets for the query.
java.util.List<Hit>	getHits() Get the search results that have matched the query
java.util.Iterator<Hit>	getHitsIterator() Get an iterator over the hits
java.util.Map<java.lang.String,java.lang.String>	getInfos() Get various information about the answer.
int	getNHits() Deprecated.
int	getNMatches() Deprecated.
long	getNumberOfMatches() Get the (potentially estimated) total number of hits for this answer.
long	getNumberOfRetrievableHits() Get the number of hits available to the user.
java.util.List<RelatedTerm>	getRelatedTerms() Deprecated. use getCategoryGroup("rt_keyword")
java.lang.String	getSearchContext() Get the "search context".
java.util.List<SliceInfo>	getSlicesInfo() Get per slices extra info
java.util.List<SpellCheckSuggestion>	getSpellCheckSuggestions() Get the spell checking suggestions for the query.
int	getStartIndex() Get the index of the first search result ("full hit") in the list of all search results.
java.util.Map<java.lang.String,java.lang.String>	getStats() Get some advanced performance stats infos.
java.util.List<java.lang.String>	getStoppedWords() Get the query words that have been ignored.
java.util.Map<java.lang.String,java.lang.Long>	getTimes() Deprecated.

Method Detail

getInfos

java.util.Map<java.lang.String,java.lang.String> getInfos()

Get various information about the answer. The following keys may be available:

• "context", Search context containing current query settings. This can be used to perform the next queries.
• "nmatches", Total number of documents matching the query. (may be estimated, see below)
• "estimated", Is the total number of documents matching the query an estimation ?
• "autocorrected", Has the query been auto-corrected by the spell-checker ?
• "nhits", Number of hits potentially available to the user (not estimated).
• "nslices", Number of slices actually used.
• "start", Index of the first search result ("full hit") in the list (used for pagination).
• "last", Last document identifier examined.

Returns:

a Map containing informations relative to the Answer

getSearchContext

java.lang.String getSearchContext()

Get the "search context". This is an opaque string representing the current query. The search context can be used to perform a new query with the same parameters and additional ones. This is mostly used for refinement queries:

• Perform a first query
• The user refines on a given category
• Perform the refinement query with the context of the first query and the refinement parameter

getStartIndex

int getStartIndex()

Get the index of the first search result ("full hit") in the list of all search results. This is used for pagination.

getNHits

@Deprecated
int getNHits()

Deprecated.

Get the number of hits available to the user.

See Also:

getNumberOfRetrievableHits()

getNumberOfRetrievableHits

long getNumberOfRetrievableHits()

Get the number of hits available to the user.

getNMatches

@Deprecated
int getNMatches()

Deprecated.

Get the (potentially estimated) total number of hits for this answer. Depending on the configuration, not all might be available to the user.

See Also:

getNumberOfMatches()

getNumberOfMatches

long getNumberOfMatches()

Get the (potentially estimated) total number of hits for this answer. Depending on the configuration, not all might be available to the user.

getStats

java.util.Map<java.lang.String,java.lang.String> getStats()

Get some advanced performance stats infos. The list of available keys depends on the version of the product.

getSlicesInfo

java.util.List<SliceInfo> getSlicesInfo()

Get per slices extra info

getTimes

@Deprecated
java.util.Map<java.lang.String,java.lang.Long> getTimes()

Deprecated.

Get some advanced timing information about this query. The list of available keys depends on the version of the product.

getHits

java.util.List<Hit> getHits()

Get the search results that have matched the query

getHitsIterator

java.util.Iterator<Hit> getHitsIterator()

Get an iterator over the hits

getSpellCheckSuggestions

java.util.List<SpellCheckSuggestion> getSpellCheckSuggestions()

Get the spell checking suggestions for the query.

getStoppedWords

java.util.List<java.lang.String> getStoppedWords()

Get the query words that have been ignored.

getRelatedTerms

@Deprecated
java.util.List<RelatedTerm> getRelatedTerms()

Deprecated. use getCategoryGroup("rt_keyword")

Get the "related terms" linked with the query. These are part of the navigation and are usable as refinements. Please refer to the Search Architecture Guide for more information about related terms.

getCategoryGroups

java.util.Collection<CategoryGroup> getCategoryGroups()

Get the facets for the query.

See Also:

CategoryGroup

getCategoryGroup

CategoryGroup getCategoryGroup(java.lang.String name)

Get a facet by its id.

See Also:

CategoryGroup