Package org.apache.lucene.search.grouping

Class TermGroupSelector

java.lang.Object

org.apache.lucene.search.grouping.GroupSelector<org.apache.lucene.util.BytesRef>

org.apache.lucene.search.grouping.TermGroupSelector

public class TermGroupSelector
extends GroupSelector<org.apache.lucene.util.BytesRef>

A GroupSelector implementation that groups via SortedDocValues

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.grouping.GroupSelector

GroupSelector.State

Constructor Summary

Constructors

Constructor	Description
TermGroupSelector(String field)	Create a new TermGroupSelector

Method Summary

Modifier and Type	Method	Description
GroupSelector.State	advanceTo(int doc)	Advance the GroupSelector's iterator to the given document
org.apache.lucene.util.BytesRef	copyValue()
org.apache.lucene.util.BytesRef	currentValue()	Get the group value of the current document
void	setGroups(Collection<SearchGroup<org.apache.lucene.util.BytesRef>> searchGroups)	Set a restriction on the group values returned by this selector
void	setNextReader(org.apache.lucene.index.LeafReaderContext readerContext)	Set the LeafReaderContext
void	setScorer(org.apache.lucene.search.Scorable scorer)	Set the current Scorer

Methods inherited from class java.lang.Object

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

Constructor Details

TermGroupSelector

public TermGroupSelector(String field)

Create a new TermGroupSelector

Parameters:

field - the SortedDocValues field to use for grouping

Method Details

setNextReader

public void setNextReader(org.apache.lucene.index.LeafReaderContext readerContext)
                   throws IOException

Description copied from class: GroupSelector

Set the LeafReaderContext

Specified by:

setNextReader in class GroupSelector<org.apache.lucene.util.BytesRef>

Throws:

IOException

setScorer

public void setScorer(org.apache.lucene.search.Scorable scorer)
               throws IOException

Description copied from class: GroupSelector

Set the current Scorer

Specified by:

setScorer in class GroupSelector<org.apache.lucene.util.BytesRef>

Throws:

IOException

advanceTo

public GroupSelector.State advanceTo(int doc)
                              throws IOException

Description copied from class: GroupSelector

Advance the GroupSelector's iterator to the given document

Specified by:

advanceTo in class GroupSelector<org.apache.lucene.util.BytesRef>

Throws:

IOException

currentValue

public org.apache.lucene.util.BytesRef currentValue()

Description copied from class: GroupSelector

Get the group value of the current document

N.B. this object may be reused, for a persistent version use GroupSelector.copyValue()

Specified by:

currentValue in class GroupSelector<org.apache.lucene.util.BytesRef>

copyValue

public org.apache.lucene.util.BytesRef copyValue()

Specified by:

copyValue in class GroupSelector<org.apache.lucene.util.BytesRef>

Returns:

a copy of the group value of the current document

setGroups

public void setGroups(Collection<SearchGroup<org.apache.lucene.util.BytesRef>> searchGroups)

Description copied from class: GroupSelector

Set a restriction on the group values returned by this selector

If the selector is positioned on a document whose group value is not contained within this set, then GroupSelector.advanceTo(int) will return GroupSelector.State.SKIP

Specified by:

setGroups in class GroupSelector<org.apache.lucene.util.BytesRef>

Parameters:

searchGroups - a set of SearchGroup objects to limit selections to