org.apache.lucene.search.grouping
Class SearchGroup<GROUP_VALUE_TYPE>

java.lang.Object
  extended by org.apache.lucene.search.grouping.SearchGroup<GROUP_VALUE_TYPE>

public class SearchGroup<GROUP_VALUE_TYPE>
extends Object

Represents a group that is found during the first pass search.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary
 GROUP_VALUE_TYPE groupValue
          The value that defines this group
 Object[] sortValues
          The sort values used during sorting.
 
Constructor Summary
SearchGroup()
           
 
Method Summary
static
<T> Collection<SearchGroup<T>>
merge(List<Collection<SearchGroup<T>>> topGroups, int offset, int topN, Sort groupSort)
          Merges multiple collections of top groups, for example obtained from separate index shards.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

groupValue

public GROUP_VALUE_TYPE groupValue
The value that defines this group


sortValues

public Object[] sortValues
The sort values used during sorting. These are the groupSort field values of the highest rank document (by the groupSort) within the group. Can be null if fillFields=false had been passed to AbstractFirstPassGroupingCollector.getTopGroups(int, boolean)

Constructor Detail

SearchGroup

public SearchGroup()
Method Detail

toString

public String toString()
Overrides:
toString in class Object

merge

public static <T> Collection<SearchGroup<T>> merge(List<Collection<SearchGroup<T>>> topGroups,
                                                   int offset,
                                                   int topN,
                                                   Sort groupSort)
                                        throws IOException
Merges multiple collections of top groups, for example obtained from separate index shards. The provided groupSort must match how the groups were sorted, and the provided SearchGroups must have been computed with fillFields=true passed to AbstractFirstPassGroupingCollector.getTopGroups(int, boolean).

NOTE: this returns null if the topGroups is empty.

Throws:
IOException


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.