public class GroupingExecutor extends Searcher
grouping requests
set up by other searchers. This does the necessary
transformation from the abstract request to Vespa grouping expressions (using RequestBuilder
), and the
corresponding transformation of results (using ResultBuilder
).Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_NAME |
Constructor and Description |
---|
GroupingExecutor(com.yahoo.component.ComponentId componentId)
Constructs a new instance of this searcher with the given component id.
|
Modifier and Type | Method and Description |
---|---|
void |
fill(Result result,
String summaryClass,
Execution execution)
Fill hit properties with data using the given summary class.
|
static List<com.yahoo.searchlib.aggregation.Grouping> |
getGroupingList(Query query)
Returns the list of
Grouping objects assigned to the given query. |
static boolean |
hasGroupingList(Query query) |
Result |
search(Query query,
Execution execution)
Override this to implement your searcher.
|
static void |
setGroupingList(Query query,
List<com.yahoo.searchlib.aggregation.Grouping> lst)
Sets the list of
Grouping objects assigned to the given query. |
ensureFilled, getLogger, process, toString
getAnnotatedDependencies, getDefaultAnnotatedDependencies, getDependencies, initDependencies
public static final String COMPONENT_NAME
public GroupingExecutor(com.yahoo.component.ComponentId componentId)
componentId
- The identifier to assign to this searcher.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 static List<com.yahoo.searchlib.aggregation.Grouping> getGroupingList(Query query)
Grouping
objects assigned to the given query. If no list has been assigned, this
method returns an empty list.query
- The query whose grouping list to return.public static boolean hasGroupingList(Query query)
public static void setGroupingList(Query query, List<com.yahoo.searchlib.aggregation.Grouping> lst)
Grouping
objects assigned to the given query. This method overwrites any grouping
objects already assigned to the query.query
- The query whose grouping list to set.lst
- The grouping list to set.Copyright © 2018. All rights reserved.