Class SearchGroupsFieldCommand
- java.lang.Object
-
- org.apache.solr.search.grouping.distributed.command.SearchGroupsFieldCommand
-
- All Implemented Interfaces:
Command<SearchGroupsFieldCommandResult>
public class SearchGroupsFieldCommand extends Object implements Command<SearchGroupsFieldCommandResult>
Creates all the collectors needed for the first phase and how to handle the results.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SearchGroupsFieldCommand.Builder
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<org.apache.lucene.search.Collector>
create()
Returns a list ofCollector
instances to be included in the search based on the .org.apache.lucene.search.Sort
getGroupSort()
String
getKey()
org.apache.lucene.search.Sort
getWithinGroupSort()
SearchGroupsFieldCommandResult
result()
Returns the results that the collectors created byCommand.create()
contain after a search has been executed.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.solr.search.grouping.Command
postCollect
-
-
-
-
Method Detail
-
create
public List<org.apache.lucene.search.Collector> create() throws IOException
Description copied from interface:Command
Returns a list ofCollector
instances to be included in the search based on the .- Specified by:
create
in interfaceCommand<SearchGroupsFieldCommandResult>
- Returns:
- a list of
Collector
instances - Throws:
IOException
- If I/O related errors occur
-
result
public SearchGroupsFieldCommandResult result() throws IOException
Description copied from interface:Command
Returns the results that the collectors created byCommand.create()
contain after a search has been executed.- Specified by:
result
in interfaceCommand<SearchGroupsFieldCommandResult>
- Returns:
- The results of the collectors
- Throws:
IOException
-
getWithinGroupSort
public org.apache.lucene.search.Sort getWithinGroupSort()
- Specified by:
getWithinGroupSort
in interfaceCommand<SearchGroupsFieldCommandResult>
- Returns:
- The sort inside a group
-
getGroupSort
public org.apache.lucene.search.Sort getGroupSort()
- Specified by:
getGroupSort
in interfaceCommand<SearchGroupsFieldCommandResult>
- Returns:
- The group sort (overall sort)
-
getKey
public String getKey()
- Specified by:
getKey
in interfaceCommand<SearchGroupsFieldCommandResult>
- Returns:
- The key of this command to uniquely identify itself
-
-