org.apache.solr.search

Class Grouping.CommandField

java.lang.Object

org.apache.solr.search.Grouping.Command<java.lang.String>

org.apache.solr.search.Grouping.CommandField

Enclosing class:

Grouping

public class Grouping.CommandField
extends Grouping.Command<java.lang.String>

A group command for grouping on a field.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) org.apache.lucene.search.grouping.TermAllGroupsCollector	allGroupsCollector
(package private) org.apache.lucene.search.TotalHitCountCollector	fallBackCollector
(package private) org.apache.lucene.search.grouping.TermFirstPassGroupingCollector	firstPass
java.lang.String	groupBy
(package private) org.apache.lucene.search.grouping.TermSecondPassGroupingCollector	secondPass
(package private) java.util.Collection<org.apache.lucene.search.grouping.SearchGroup<java.lang.String>>	topGroups

Fields inherited from class org.apache.solr.search.Grouping.Command

actualGroupsToFind, docsPerGroup, format, groupOffset, groupSort, key, main, numGroups, offset, result, sort, totalCount

Constructor Summary

Constructors

Constructor and Description
CommandField()

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector<?>	createAllGroupCollector() Returns a collector that is able to return the most relevant document of all groups.
protected org.apache.lucene.search.Collector	createFirstPassCollector() Returns one or more Collector instances that are needed to perform the first pass search.
protected org.apache.lucene.search.Collector	createSecondPassCollector() Returns zero or more Collector instances that are needed to perform the second pass search.
protected void	finish() Performs any necessary post actions to prepare the response.
int	getMatches() Returns the number of matches for this Command.
protected java.lang.Integer	getNumberOfGroups() Returns the number of groups found for this Command.
protected void	prepare() Prepare this Command for execution.

Methods inherited from class org.apache.solr.search.Grouping.Command

addDocList, commonResponse, createSimpleResponse, getDocList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

groupBy

public java.lang.String groupBy

firstPass

org.apache.lucene.search.grouping.TermFirstPassGroupingCollector firstPass

secondPass

org.apache.lucene.search.grouping.TermSecondPassGroupingCollector secondPass

allGroupsCollector

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

fallBackCollector

org.apache.lucene.search.TotalHitCountCollector fallBackCollector

topGroups

java.util.Collection<org.apache.lucene.search.grouping.SearchGroup<java.lang.String>> topGroups

Constructor Detail

CommandField

public CommandField()

Method Detail

prepare

protected void prepare()
                throws java.io.IOException

Prepare this Command for execution.

Specified by:

prepare in class Grouping.Command<java.lang.String>

Throws:

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

createFirstPassCollector

protected org.apache.lucene.search.Collector createFirstPassCollector()
                                                               throws java.io.IOException

Returns one or more Collector instances that are needed to perform the first pass search. If multiple Collectors are returned then these wrapped in a MultiCollector.

Specified by:

createFirstPassCollector in class Grouping.Command<java.lang.String>

Returns:

one or more Collector instances that are need to perform the first pass search

Throws:

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

createSecondPassCollector

protected org.apache.lucene.search.Collector createSecondPassCollector()
                                                                throws java.io.IOException

Returns zero or more Collector instances that are needed to perform the second pass search. In the case when no Collector instances are created null is returned. If multiple Collectors are returned then these wrapped in a MultiCollector.

Overrides:

createSecondPassCollector in class Grouping.Command<java.lang.String>

Returns:

zero or more Collector instances that are needed to perform the second pass search

Throws:

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

createAllGroupCollector

public org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector<?> createAllGroupCollector()
                                                                                            throws java.io.IOException

Returns a collector that is able to return the most relevant document of all groups. Returns null if the command doesn't support this type of collector.

Overrides:

createAllGroupCollector in class Grouping.Command<java.lang.String>

Returns:

a collector that is able to return the most relevant document of all groups.

Throws:

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

finish

protected void finish()
               throws java.io.IOException

Performs any necessary post actions to prepare the response.

Specified by:

finish in class Grouping.Command<java.lang.String>

Throws:

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

getMatches

public int getMatches()

Returns the number of matches for this Command.

Specified by:

getMatches in class Grouping.Command<java.lang.String>

Returns:

the number of matches for this Command

getNumberOfGroups

protected java.lang.Integer getNumberOfGroups()

Returns the number of groups found for this Command. If the command doesn't support counting the groups null is returned.

Overrides:

getNumberOfGroups in class Grouping.Command<java.lang.String>

Returns:

the number of groups found for this Command