com.yahoo.search.searchchain.testutil

Class DocumentSourceSearcher

java.lang.Object

com.yahoo.component.AbstractComponent

com.yahoo.component.chain.ChainedComponent

com.yahoo.processing.Processor

com.yahoo.search.Searcher

com.yahoo.search.searchchain.testutil.DocumentSourceSearcher

All Implemented Interfaces:

com.yahoo.component.Component, Comparable<com.yahoo.component.Component>

public class DocumentSourceSearcher
extends Searcher

Implements a document source. You pass in a query and a Result set. When this Searcher is called with that query it will return that result set.

This supports multi-phase search.

To avoid having to add type information for the fields, a quck hack is used to support testing of attribute prefetching. Any field in the configured hits which has a name starting by attribute will be returned when attribute prefetch filling is requested.

Author:

bratseth

Field Summary

Fields

Modifier and Type	Field and Description
private Map<Query,Result>	completelyFilledResults
static String	DEFAULT_SUMMARY_CLASS
private Result	defaultFilledResult
private int	queryCount
private Map<String,Set<String>>	summaryClasses
private Map<Query,Result>	unFilledResults

Fields inherited from class com.yahoo.component.AbstractComponent

isDeconstructable

Constructor Summary

Constructors

Constructor and Description
DocumentSourceSearcher()

Method Summary

Modifier and Type	Method and Description
private void	addDefaultResults()
boolean	addResult(Query query, Result fullResult) Adds a result which can be searched for and filled.
void	addSummaryClass(String name, Set<String> fields)
void	addSummaryClassByCopy(String name, Collection<String> fields)
private void	copyFieldValuesThatExist(Hit filledHit, Hit hitToFill, Set<String> fieldsToFill)
void	fill(Result result, String summaryClass, Execution execution) Fill hit properties with data using the given summary class.
private void	fillHits(Result filledHits, Result hitsToFill, String summaryClass)
private Hit	getMatchingFilledHit(com.yahoo.net.URI hitToFillId, Result filledHits)
int	getQueryCount() Returns the number of queries made to this searcher since the last reset.
private Query	getQueryKeyClone(Query query) Returns a query clone which has offset and hits set to null.
void	resetQueryCount()
Result	search(Query query, Execution execution) Override this to implement your searcher.

Methods inherited from class com.yahoo.search.Searcher

ensureFilled, getLogger, process, toString

Methods inherited from class com.yahoo.component.chain.ChainedComponent

getAnnotatedDependencies, getDefaultAnnotatedDependencies, getDependencies, initDependencies

Methods inherited from class com.yahoo.component.AbstractComponent

clone, compareTo, deconstruct, getClassName, getId, getIdString, hasInitializedId, initId, isDeconstructable, setIsDeconstructable

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SUMMARY_CLASS

public static final String DEFAULT_SUMMARY_CLASS

See Also:

Constant Field Values

defaultFilledResult

private Result defaultFilledResult

completelyFilledResults

private Map<Query,Result> completelyFilledResults

unFilledResults

private Map<Query,Result> unFilledResults

summaryClasses

private Map<String,Set<String>> summaryClasses

queryCount

private int queryCount

Constructor Detail

DocumentSourceSearcher

public DocumentSourceSearcher()

Method Detail

addResult

public boolean addResult(Query query,
                         Result fullResult)

Adds a result which can be searched for and filled. Summary fields starting by "a" are attributes, others are not.

Returns:

true when replacing an existing <query, result> pair.

addSummaryClass

public void addSummaryClass(String name,
                            Set<String> fields)

addSummaryClassByCopy

public void addSummaryClassByCopy(String name,
                                  Collection<String> fields)

addDefaultResults

private void addDefaultResults()

search

public Result search(Query query,
                     Execution execution)

Description copied from class: Searcher

Override this to implement your searcher.

Searcher implementation subclasses will, depending on their type of logic, do one of the following:

• Query processors: Access the query, then call execution.search and return the result
• Result processors: Call execution.search to get the result, access it and return
• Sources (which produces results): Create a result, add the desired hits and return it.
• Federators (which forwards the search to multiple subchains): Call search on the desired subchains in parallel and get the results. Combine the results to one and return it.
• Workflows: Call execution.search as many times as desired, using different queries. Eventually return a result.

Hits come in two kinds - concrete hits are actual content of the kind requested by the user, meta hits are hits which provides information about the collection of hits, on the query, the service and so on.

The query specifies a window into a larger result list that must be returned from the searcher through hits and offset; Searchers which returns list of hits in the top level in the result must return at least hits number of hits (or if impossible; all that are available), starting at the given offset. In addition, searchers are allowed to return any number of meta hits (although this number is expected to be low). For hits contained in nested hit groups, the concept of a window defined by hits and offset is not well defined and does not apply.

Error handling in searchers:

• Unexpected events: Throw any RuntimeException. This query will fail with the exception message, and the error will be logged
• Expected events: Create (new Result(Query, ErrorMessage) or add result.setErrorIfNoOtherErrors(ErrorMessage) an error message to the Result.
• Recoverable user errors: Add a FeedbackHit explaining the condition and how to correct it.

Specified by:

search in class Searcher

Parameters:

query - the query

Returns:

the result of making this query

getQueryKeyClone

private Query getQueryKeyClone(Query query)

Returns a query clone which has offset and hits set to null. This is used by access to the maps using the query as key to achieve lookup independent of offset/hits value

fill

public void fill(Result result,
                 String summaryClass,
                 Execution execution)

Description copied from class: Searcher

Fill hit properties with data using the given summary class. Calling this on already filled results has no cost.

This needs to be overridden by federating searchers to contact search sources again by propagating the fill call down through the search chain, and by source searchers which talks to fill capable backends to request the data to be filled. Other searchers do not need to override this.

Overrides:

fill in class Searcher

Parameters:

result - the result to fill

summaryClass - the name of the collection of fields to fetch the values of, or null to use the default

fillHits

private void fillHits(Result filledHits,
                      Result hitsToFill,
                      String summaryClass)

getMatchingFilledHit

private Hit getMatchingFilledHit(com.yahoo.net.URI hitToFillId,
                                 Result filledHits)

copyFieldValuesThatExist

private void copyFieldValuesThatExist(Hit filledHit,
                                      Hit hitToFill,
                                      Set<String> fieldsToFill)

getQueryCount

public int getQueryCount()

Returns the number of queries made to this searcher since the last reset. For testing - not reliable if multiple threads makes queries simultaneously

resetQueryCount

public void resetQueryCount()