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.
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SUMMARY_CLASS |
Constructor and Description |
---|
DocumentSourceSearcher() |
Modifier and Type | Method and Description |
---|---|
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) |
void |
fill(Result result,
String summaryClass,
Execution execution)
Fill hit properties with data using the given summary class.
|
int |
getQueryCount()
Returns the number of queries made to this searcher since the last
reset.
|
void |
resetQueryCount() |
Result |
search(Query query,
Execution execution)
Override this to implement your searcher.
|
ensureFilled, getLogger, process, toString
getAnnotatedDependencies, getDefaultAnnotatedDependencies, getDependencies, initDependencies
public static final String DEFAULT_SUMMARY_CLASS
public boolean addResult(Query query, Result fullResult)
public void addSummaryClassByCopy(String name, Collection<String> fields)
public Result search(Query query, Execution execution)
Searcher
Searcher implementation subclasses will, depending on their type of logic, do one of the following:
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:
public void fill(Result result, String summaryClass, Execution execution)
Searcher
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.
public int getQueryCount()
public void resetQueryCount()
Copyright © 2018. All rights reserved.