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 | Class and Description |
---|---|
private static class |
GroupingExecutor.ContextInjector |
private static class |
GroupingExecutor.RequestContext |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_NAME |
private static Logger |
log |
private static com.yahoo.processing.request.CompoundName |
PROP_GROUPINGLIST |
Constructor and Description |
---|
GroupingExecutor()
Constructs a new instance of this searcher without configuration.
|
GroupingExecutor(com.yahoo.component.ComponentId componentId)
Constructs a new instance of this searcher with the given component id.
|
Modifier and Type | Method and Description |
---|---|
private GroupingExecutor.RequestContext |
convertRequest(Query query,
GroupingRequest req,
Map<Integer,com.yahoo.searchlib.aggregation.Grouping> map)
Converts the given
GroupingRequest into a set of Grouping objects. |
private RootGroup |
convertResult(GroupingExecutor.RequestContext requestContext,
Map<Integer,com.yahoo.searchlib.aggregation.Grouping> groupingMap,
HitConverter hitConverter)
Converts the results of the given request context into a single
Group . |
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. |
private List<com.yahoo.searchlib.aggregation.Grouping> |
getGroupingListForPassN(Map<Integer,com.yahoo.searchlib.aggregation.Grouping> groupingMap,
int pass)
Returns a list of
Grouping objects that are to be used for the given pass. |
static boolean |
hasGroupingList(Query query) |
private void |
mergeGroupingMaps(Map<Integer,com.yahoo.searchlib.aggregation.Grouping> state,
Map<Integer,com.yahoo.searchlib.aggregation.Grouping> result)
Merges the content of result into state.
|
private Map<Integer,com.yahoo.searchlib.aggregation.Grouping> |
mergeGroupingResults(Result result)
Merges the grouping content of the given result object.
|
private static com.yahoo.processing.request.CompoundName |
newCompoundName(String name) |
private Result |
performSearch(Query query,
Execution execution,
Map<Integer,com.yahoo.searchlib.aggregation.Grouping> groupingMap)
Performs the actual search passes to complete all the given
Grouping requests. |
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
private static final com.yahoo.processing.request.CompoundName PROP_GROUPINGLIST
private static final Logger log
GroupingExecutor()
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.
private GroupingExecutor.RequestContext convertRequest(Query query, GroupingRequest req, Map<Integer,com.yahoo.searchlib.aggregation.Grouping> map)
GroupingRequest
into a set of Grouping
objects. The returned object holds the
context that corresponds to the given request, whereas the created Grouping
objects are written directly
to the given map.query
- The query being executed.req
- The request to convert.map
- The grouping map to write to.private RootGroup convertResult(GroupingExecutor.RequestContext requestContext, Map<Integer,com.yahoo.searchlib.aggregation.Grouping> groupingMap, HitConverter hitConverter)
Group
.requestContext
- The context that identifies the results to convert.groupingMap
- The map of all Grouping
objects available.hitConverter
- The converter to use for Hit
conversion.private Result performSearch(Query query, Execution execution, Map<Integer,com.yahoo.searchlib.aggregation.Grouping> groupingMap)
Grouping
requests. This method uses the
grouping map argument as both an input and an output variable, as the contained Grouping
objects are
updates as results arrive from the back end.query
- The query to execute.execution
- The execution context used to run the queries.groupingMap
- The map of grouping requests to perform.private void mergeGroupingMaps(Map<Integer,com.yahoo.searchlib.aggregation.Grouping> state, Map<Integer,com.yahoo.searchlib.aggregation.Grouping> result)
state
- the current state.result
- the results from the current pass.private List<com.yahoo.searchlib.aggregation.Grouping> getGroupingListForPassN(Map<Integer,com.yahoo.searchlib.aggregation.Grouping> groupingMap, int pass)
Grouping
objects that are to be used for the given pass.groupingMap
- The map of all grouping objects.pass
- The pass about to be performed.private Map<Integer,com.yahoo.searchlib.aggregation.Grouping> mergeGroupingResults(Result result)
result
- The result to traverse.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.private static com.yahoo.processing.request.CompoundName newCompoundName(String name)
Copyright © 2017. All rights reserved.