com.exalead.searchapi.xmlv10.client.results.merge

Class MergeSearchAnswer

java.lang.Object

com.exalead.searchapi.xmlv10.client.results.merge.MergeSearchAnswer

All Implemented Interfaces:

SearchAnswer

public class MergeSearchAnswer
extends java.lang.Object
implements SearchAnswer

Constructor Summary

Constructors

Constructor and Description
MergeSearchAnswer(SearchLogic logic, SearchQuery query)

Method Summary

Modifier and Type	Method and Description
void	addAnswer(SearchAnswer answer)
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.
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() Get some advanced timing information about this query.

Methods inherited from class java.lang.Object

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

Constructor Detail

MergeSearchAnswer

public MergeSearchAnswer(SearchLogic logic,
                         SearchQuery query)

Method Detail

addAnswer

public void addAnswer(SearchAnswer answer)

getSearchContext

public java.lang.String getSearchContext()

Description copied from interface: SearchAnswer

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

Specified by:

getSearchContext in interface SearchAnswer

getCategoryGroup

public CategoryGroup getCategoryGroup(java.lang.String name)

Description copied from interface: SearchAnswer

Get a facet by its id.

Specified by:

getCategoryGroup in interface SearchAnswer

See Also:

CategoryGroup

getCategoryGroups

public java.util.Collection<CategoryGroup> getCategoryGroups()

Description copied from interface: SearchAnswer

Get the facets for the query.

Specified by:

getCategoryGroups in interface SearchAnswer

See Also:

CategoryGroup

getHitsIterator

public java.util.Iterator<Hit> getHitsIterator()

Description copied from interface: SearchAnswer

Get an iterator over the hits

Specified by:

getHitsIterator in interface SearchAnswer

getHits

public java.util.List<Hit> getHits()

Description copied from interface: SearchAnswer

Get the search results that have matched the query

Specified by:

getHits in interface SearchAnswer

getInfos

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

Description copied from interface: SearchAnswer

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.

Specified by:

getInfos in interface SearchAnswer

Returns:

a Map containing informations relative to the Answer

getTimes

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

Description copied from interface: SearchAnswer

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

Specified by:

getTimes in interface SearchAnswer

getStats

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

Description copied from interface: SearchAnswer

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

Specified by:

getStats in interface SearchAnswer

getSlicesInfo

public java.util.List<SliceInfo> getSlicesInfo()

Description copied from interface: SearchAnswer

Get per slices extra info

Specified by:

getSlicesInfo in interface SearchAnswer

getSpellCheckSuggestions

public java.util.List<SpellCheckSuggestion> getSpellCheckSuggestions()

Description copied from interface: SearchAnswer

Get the spell checking suggestions for the query.

Specified by:

getSpellCheckSuggestions in interface SearchAnswer

getStoppedWords

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

Description copied from interface: SearchAnswer

Get the query words that have been ignored.

Specified by:

getStoppedWords in interface SearchAnswer

getRelatedTerms

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

Deprecated.

Description copied from interface: SearchAnswer

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.

Specified by:

getRelatedTerms in interface SearchAnswer

getStartIndex

public int getStartIndex()

Description copied from interface: SearchAnswer

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

Specified by:

getStartIndex in interface SearchAnswer

getNMatches

@Deprecated
public int getNMatches()

Deprecated.

Description copied from interface: SearchAnswer

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

Specified by:

getNMatches in interface SearchAnswer

See Also:

SearchAnswer.getNumberOfMatches()

getNHits

@Deprecated
public int getNHits()

Deprecated.

Description copied from interface: SearchAnswer

Get the number of hits available to the user.

Specified by:

getNHits in interface SearchAnswer

See Also:

SearchAnswer.getNumberOfRetrievableHits()

getNumberOfRetrievableHits

public long getNumberOfRetrievableHits()

Description copied from interface: SearchAnswer

Get the number of hits available to the user.

Specified by:

getNumberOfRetrievableHits in interface SearchAnswer

getNumberOfMatches

public long getNumberOfMatches()

Description copied from interface: SearchAnswer

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

Specified by:

getNumberOfMatches in interface SearchAnswer