org.apache.solr.search

Class Grouping.CommandQuery

java.lang.Object

org.apache.solr.search.Grouping.Command

org.apache.solr.search.Grouping.CommandQuery

Enclosing class:

Grouping

public class Grouping.CommandQuery
extends Grouping.Command

A group command for grouping on a query.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) FilterCollector	collector
org.apache.lucene.search.Query	query
(package private) org.apache.lucene.search.TopDocsCollector	topCollector

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
CommandQuery()

Method Summary

Modifier and Type	Method and Description
protected org.apache.lucene.search.Collector	createFirstPassCollector() Returns one or more Collector instances that are needed to perform the first pass search.
protected void	finish() Performs any necessary post actions to prepare the response.
int	getMatches() Returns the number of matches for this Command.
(package private) org.apache.lucene.search.TopDocsCollector	newCollector(org.apache.lucene.search.Sort sort, boolean needScores)
protected void	prepare() Prepare this Command for execution.

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

addDocList, commonResponse, createAllGroupCollector, createSecondPassCollector, createSimpleResponse, getDocList, getNumberOfGroups

Methods inherited from class java.lang.Object

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

Field Detail

query

public org.apache.lucene.search.Query query

topCollector

org.apache.lucene.search.TopDocsCollector topCollector

collector

FilterCollector collector

Constructor Detail

CommandQuery

public CommandQuery()

Method Detail

prepare

protected void prepare()
                throws java.io.IOException

Prepare this Command for execution.

Specified by:

prepare in class Grouping.Command

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

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

newCollector

org.apache.lucene.search.TopDocsCollector newCollector(org.apache.lucene.search.Sort sort,
                                                       boolean needScores)
                                                throws java.io.IOException

Throws:

java.io.IOException

finish

protected void finish()
               throws java.io.IOException

Performs any necessary post actions to prepare the response.

Specified by:

finish in class Grouping.Command

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

Returns:

the number of matches for this Command