java.lang.Object
org.apache.lucene.search.Collector
org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector<GH>
org.apache.lucene.search.grouping.TermAllGroupHeadsCollector<GH>
public abstract class TermAllGroupHeadsCollector<GH extends AbstractAllGroupHeadsCollector.GroupHead>
- extends AbstractAllGroupHeadsCollector<GH>
A base implementation of AbstractAllGroupHeadsCollector for retrieving the most relevant groups when grouping
on a string based group field. More specifically this all concrete implementations of this base implementation
use FieldCache.StringIndex.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TermAllGroupHeadsCollector
protected TermAllGroupHeadsCollector(String groupField,
int numberOfSorts)
create
public static AbstractAllGroupHeadsCollector create(String groupField,
Sort sortWithinGroup)
throws IOException
- Creates an
AbstractAllGroupHeadsCollector instance based on the supplied arguments.
This factory method decides with implementation is best suited.
Delegates to create(String, org.apache.lucene.search.Sort, int) with an initialSize of 128.
- Parameters:
groupField - The field to group bysortWithinGroup - The sort within each group
- Returns:
- an
AbstractAllGroupHeadsCollector instance based on the supplied arguments
- Throws:
IOException - If I/O related errors occur
create
public static AbstractAllGroupHeadsCollector create(String groupField,
Sort sortWithinGroup,
int initialSize)
throws IOException
- Creates an
AbstractAllGroupHeadsCollector instance based on the supplied arguments.
This factory method decides with implementation is best suited.
- Parameters:
groupField - The field to group bysortWithinGroup - The sort within each groupinitialSize - The initial allocation size of the internal int set and group list which should roughly match
the total number of expected unique groups. Be aware that the heap usage is
4 bytes * initialSize.
- Returns:
- an
AbstractAllGroupHeadsCollector instance based on the supplied arguments
- Throws:
IOException - If I/O related errors occur