org.apache.solr.search.grouping.distributed.command

Class SearchGroupsFieldCommand

java.lang.Object

org.apache.solr.search.grouping.distributed.command.SearchGroupsFieldCommand

All Implemented Interfaces:

Command<Pair<java.lang.Integer,java.util.Collection<org.apache.lucene.search.grouping.SearchGroup<java.lang.String>>>>

public class SearchGroupsFieldCommand
extends java.lang.Object
implements Command<Pair<java.lang.Integer,java.util.Collection<org.apache.lucene.search.grouping.SearchGroup<java.lang.String>>>>

Creates all the collectors needed for the first phase and how to handle the results.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchGroupsFieldCommand.Builder

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.lucene.search.grouping.TermAllGroupsCollector	allGroupsCollector
private SchemaField	field
private org.apache.lucene.search.grouping.TermFirstPassGroupingCollector	firstPassGroupingCollector
private org.apache.lucene.search.Sort	groupSort
private boolean	includeGroupCount
private int	topNGroups

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SearchGroupsFieldCommand(SchemaField field, org.apache.lucene.search.Sort groupSort, int topNGroups, boolean includeGroupCount)

Method Summary

Modifier and Type	Method and Description
java.util.List<org.apache.lucene.search.Collector>	create() Returns a list of Collector instances to be included in the search based on the .
org.apache.lucene.search.Sort	getGroupSort()
java.lang.String	getKey()
org.apache.lucene.search.Sort	getSortWithinGroup()
Pair<java.lang.Integer,java.util.Collection<org.apache.lucene.search.grouping.SearchGroup<java.lang.String>>>	result() Returns the results that the collectors created by Command.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

Field Detail

field

private final SchemaField field

groupSort

private final org.apache.lucene.search.Sort groupSort

topNGroups

private final int topNGroups

includeGroupCount

private final boolean includeGroupCount

firstPassGroupingCollector

private org.apache.lucene.search.grouping.TermFirstPassGroupingCollector firstPassGroupingCollector

allGroupsCollector

private org.apache.lucene.search.grouping.TermAllGroupsCollector allGroupsCollector

Constructor Detail

SearchGroupsFieldCommand

private SearchGroupsFieldCommand(SchemaField field,
                                 org.apache.lucene.search.Sort groupSort,
                                 int topNGroups,
                                 boolean includeGroupCount)

Method Detail

create

public java.util.List<org.apache.lucene.search.Collector> create()
                                                          throws java.io.IOException

Description copied from interface: Command

Returns a list of Collector instances to be included in the search based on the .

Specified by:

create in interface Command<Pair<java.lang.Integer,java.util.Collection<org.apache.lucene.search.grouping.SearchGroup<java.lang.String>>>>

Returns:

a list of Collector instances

Throws:

java.io.IOException - If I/O related errors occur

result

public Pair<java.lang.Integer,java.util.Collection<org.apache.lucene.search.grouping.SearchGroup<java.lang.String>>> result()

Description copied from interface: Command

Returns the results that the collectors created by Command.create() contain after a search has been executed.

Specified by:

result in interface Command<Pair<java.lang.Integer,java.util.Collection<org.apache.lucene.search.grouping.SearchGroup<java.lang.String>>>>

Returns:

The results of the collectors

getSortWithinGroup

public org.apache.lucene.search.Sort getSortWithinGroup()

Specified by:

getSortWithinGroup in interface Command<Pair<java.lang.Integer,java.util.Collection<org.apache.lucene.search.grouping.SearchGroup<java.lang.String>>>>

Returns:

The sort inside a group

getGroupSort

public org.apache.lucene.search.Sort getGroupSort()

Specified by:

getGroupSort in interface Command<Pair<java.lang.Integer,java.util.Collection<org.apache.lucene.search.grouping.SearchGroup<java.lang.String>>>>

Returns:

The group sort (overall sort)

getKey

public java.lang.String getKey()

Specified by:

getKey in interface Command<Pair<java.lang.Integer,java.util.Collection<org.apache.lucene.search.grouping.SearchGroup<java.lang.String>>>>

Returns:

The key of this command to uniquely identify itself