org.apache.lucene.search.grouping

Class TermGroupSelector

java.lang.Object

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

org.apache.lucene.search.grouping.TermGroupSelector

public class TermGroupSelector
extends GroupSelector<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

Field Summary

Fields

Modifier and Type	Field and Description
private SortedDocValues	docValues
private java.lang.String	field
private int	groupId
private boolean	includeEmpty
private java.util.Map<java.lang.Integer,java.lang.Integer>	ordsToGroupIds
private BytesRef	scratch
private boolean	secondPass
private BytesRefHash	values

Constructor Summary

Constructors

Constructor and Description
TermGroupSelector(java.lang.String field) Create a new TermGroupSelector

Method Summary

Modifier and Type	Method and Description
GroupSelector.State	advanceTo(int doc) Advance the GroupSelector's iterator to the given document
BytesRef	copyValue()
BytesRef	currentValue() Get the group value of the current document N.B.
void	setGroups(java.util.Collection<SearchGroup<BytesRef>> searchGroups) 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
void	setNextReader(LeafReaderContext readerContext) Set the LeafReaderContext

Methods inherited from class java.lang.Object

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

Field Detail

field

private final java.lang.String field

values

private final BytesRefHash values

ordsToGroupIds

private final java.util.Map<java.lang.Integer,java.lang.Integer> ordsToGroupIds

docValues

private SortedDocValues docValues

groupId

private int groupId

secondPass

private boolean secondPass

includeEmpty

private boolean includeEmpty

scratch

private BytesRef scratch

Constructor Detail

TermGroupSelector

public TermGroupSelector(java.lang.String field)

Create a new TermGroupSelector

Parameters:

field - the SortedDocValues field to use for grouping

Method Detail

setNextReader

public void setNextReader(LeafReaderContext readerContext)
                   throws java.io.IOException

Description copied from class: GroupSelector

Set the LeafReaderContext

Specified by:

setNextReader in class GroupSelector<BytesRef>

Throws:

java.io.IOException

advanceTo

public GroupSelector.State advanceTo(int doc)
                              throws java.io.IOException

Description copied from class: GroupSelector

Advance the GroupSelector's iterator to the given document

Specified by:

advanceTo in class GroupSelector<BytesRef>

Throws:

java.io.IOException

currentValue

public 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<BytesRef>

copyValue

public BytesRef copyValue()

Specified by:

copyValue in class GroupSelector<BytesRef>

Returns:

a copy of the group value of the current document

setGroups

public void setGroups(java.util.Collection<SearchGroup<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<BytesRef>

Parameters:

searchGroups - a set of SearchGroup objects to limit selections to