Introduce FirstPassGroupingCollectorManager #15574
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.lucene.search.grouping; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.List; | ||
| import java.util.function.Supplier; | ||
| import org.apache.lucene.search.CollectorManager; | ||
| import org.apache.lucene.search.Sort; | ||
|
|
||
| /** A CollectorManager implementation for FirstPassGroupingCollector. */ | ||
| public class FirstPassGroupingCollectorManager<T> | ||
| implements CollectorManager<FirstPassGroupingCollector<T>, Collection<SearchGroup<T>>> { | ||
|
|
||
| private final Supplier<GroupSelector<T>> groupSelectorFactory; | ||
| private final Sort groupSort; | ||
| private final int topNGroups; | ||
| private final boolean ignoreDocsWithoutGroupField; | ||
| private final List<FirstPassGroupingCollector<T>> collectors; | ||
|
|
||
| /** | ||
| * Creates a new FirstPassGroupingCollectorManager. | ||
| * | ||
| * @param groupSelectorFactory factory to create group selectors for each collector | ||
| * @param groupSort the sort to use for groups | ||
| * @param topNGroups the number of top groups to collect | ||
| */ | ||
| public FirstPassGroupingCollectorManager( | ||
| Supplier<GroupSelector<T>> groupSelectorFactory, Sort groupSort, int topNGroups) { | ||
| this(groupSelectorFactory, groupSort, topNGroups, false); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new FirstPassGroupingCollectorManager. | ||
| * | ||
| * @param groupSelectorFactory factory to create group selectors for each collector | ||
| * @param groupSort the sort to use for groups | ||
| * @param topNGroups the number of top groups to collect | ||
| * @param ignoreDocsWithoutGroupField whether to ignore documents without a group field | ||
| */ | ||
| public FirstPassGroupingCollectorManager( | ||
| Supplier<GroupSelector<T>> groupSelectorFactory, | ||
| Sort groupSort, | ||
| int topNGroups, | ||
| boolean ignoreDocsWithoutGroupField) { | ||
| this.groupSelectorFactory = groupSelectorFactory; | ||
| this.groupSort = groupSort; | ||
| this.topNGroups = topNGroups; | ||
| this.ignoreDocsWithoutGroupField = ignoreDocsWithoutGroupField; | ||
| this.collectors = new ArrayList<>(); | ||
| } | ||
|
|
||
| @Override | ||
| public FirstPassGroupingCollector<T> newCollector() throws IOException { | ||
| FirstPassGroupingCollector<T> collector = | ||
| new FirstPassGroupingCollector<>( | ||
| groupSelectorFactory.get(), groupSort, topNGroups, ignoreDocsWithoutGroupField); | ||
| collectors.add(collector); | ||
| return collector; | ||
| } | ||
|
|
||
| @Override | ||
| public Collection<SearchGroup<T>> reduce(Collection<FirstPassGroupingCollector<T>> collectors) | ||
| throws IOException { | ||
| if (collectors.isEmpty()) { | ||
| return null; | ||
|
Contributor
There was a problem hiding this comment. Returning null here could cause issues downstream. |
||
| } | ||
|
|
||
| if (collectors.size() == 1) { | ||
| return collectors.iterator().next().getTopGroups(0); | ||
| } | ||
|
Contributor
There was a problem hiding this comment. I have a slight preference to remove these two above conditionals. I wonder how much value they bring. |
||
|
|
||
| List<Collection<SearchGroup<T>>> allGroups = new ArrayList<>(); | ||
| for (FirstPassGroupingCollector<T> collector : collectors) { | ||
| Collection<SearchGroup<T>> groups = collector.getTopGroups(0); | ||
| if (groups != null) { | ||
| allGroups.add(groups); | ||
| } | ||
| } | ||
|
|
||
| return SearchGroup.merge(allGroups, 0, topNGroups, groupSort); | ||
| } | ||
|
|
||
| public List<FirstPassGroupingCollector<T>> getCollectors() { | ||
|
Contributor
There was a problem hiding this comment. this looks unused, can we remove it? |
||
| return collectors; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
given the corresponding collector is experimental, should this be too?