Package org.apache.solr.search

Class Grouping.CommandQuery

java.lang.Object

org.apache.solr.search.Grouping.Command<Object>

org.apache.solr.search.Grouping.CommandQuery

Enclosing class:

Grouping

public class Grouping.CommandQuery
extends Grouping.Command<Object>

A group command for grouping on a query.

Field Summary

Fields

Modifier and Type	Field	Description
org.apache.lucene.search.Query	query

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

docsPerGroup, format, groupOffset, groupSort, key, main, numGroups, offset, totalCount, withinGroupSort

Constructor Summary

Constructors

Constructor	Description
CommandQuery()

Method Summary

Modifier and Type	Method	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.
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, populateScoresIfNecessary

Methods inherited from class java.lang.Object

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

Field Details

query

public org.apache.lucene.search.Query query

Constructor Details

CommandQuery

public CommandQuery()

Method Details

prepare

protected void prepare()
                throws IOException

Description copied from class: Grouping.Command

Prepare this Command for execution.

Specified by:

prepare in class Grouping.Command<Object>

Throws:

IOException - If I/O related errors occur

createFirstPassCollector

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

Description copied from class: Grouping.Command

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<Object>

Returns:

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

Throws:

IOException - If I/O related errors occur

finish

protected void finish()
               throws IOException

Description copied from class: Grouping.Command

Performs any necessary post actions to prepare the response.

Specified by:

finish in class Grouping.Command<Object>

Throws:

IOException - If I/O related errors occur

getMatches

public int getMatches()

Description copied from class: Grouping.Command

Returns the number of matches for this Command.

Specified by:

getMatches in class Grouping.Command<Object>

Returns:

the number of matches for this Command