com.lucidworks.search.dsl.request

Class Group

java.lang.Object

com.lucidworks.search.dsl.DslBase

com.lucidworks.search.dsl.request.DslCloneable

com.lucidworks.search.dsl.request.Group

public class Group
extends DslCloneable

Grouping parameters

QueryDefinition.getGroupedQuery() and QueryDefinition.getGroupedFilters() could override main query and filter queries when selecting group details.

Note: In order to use these features the documents must be located on the same shard. This could be achieved by restricting data collection to one shard, or by setting up Document Routing on indexing.

The same shard restriction could be lifted with hint "hint.grouping.method=group". But getLeaderStrategy(), QueryDefinition.getGroupedQuery() and QueryDefinition.getGroupedFilters() will be ignored; and total number of groups will not be calculated.

To calculate total number of group with "hint.grouping.method=group", another hint has to be specified: "hint.grouping.num.found=true", but this will require the documents to be located on the same shard too.

Constructor Summary

Constructors

Constructor and Description
Group(String field, GroupLeaderStrategy leaderStrategy, List<SortElement> sort, Long size)

Method Summary

Modifier and Type	Method and Description
Group	clone()
String	getField()
GroupLeaderStrategy	getLeaderStrategy()
Long	getSize()
List<SortElement>	getSort()
void	setSort(List<SortElement> sort)

Methods inherited from class com.lucidworks.search.dsl.request.DslCloneable

clone, deepClone

Methods inherited from class com.lucidworks.search.dsl.DslBase

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Group

public Group(String field,
             GroupLeaderStrategy leaderStrategy,
             List<SortElement> sort,
             Long size)

Method Detail

getField

public String getField()

Returns:

name of the field that will be used for grouping. Required.

getLeaderStrategy

public GroupLeaderStrategy getLeaderStrategy()

Returns:

a strategy that is used to determine group head document. If no strategy specified highest scoring document is selected as the head document for a group.

This field is ignored with "hint.grouping.method=group". "sort" leader strategy with getSort() order will be used.

getSort

public List<SortElement> getSort()

Returns:

a sort order for group details

setSort

public void setSort(List<SortElement> sort)

getSize

public Long getSize()

Returns:

a number of group details to include. To only return header documents, set to 0. Default is 5.

clone

public Group clone()

Specified by:

clone in class DslCloneable