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
-
-
Constructor Summary
Constructors Constructor Description TermGroupSelector(String field)Create a new TermGroupSelector
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GroupSelector.StateadvanceTo(int doc)Advance the GroupSelector's iterator to the given documentBytesRefcopyValue()BytesRefcurrentValue()Get the group value of the current documentvoidsetGroups(Collection<SearchGroup<BytesRef>> searchGroups)Set a restriction on the group values returned by this selectorvoidsetNextReader(LeafReaderContext readerContext)Set the LeafReaderContextvoidsetScorer(Scorable scorer)Set the current Scorer
-
-
-
Constructor Detail
-
TermGroupSelector
public TermGroupSelector(String field)
Create a new TermGroupSelector- Parameters:
field- the SortedDocValues field to use for grouping
-
-
Method Detail
-
setNextReader
public void setNextReader(LeafReaderContext readerContext) throws IOException
Description copied from class:GroupSelectorSet the LeafReaderContext- Specified by:
setNextReaderin classGroupSelector<BytesRef>- Throws:
IOException
-
setScorer
public void setScorer(Scorable scorer) throws IOException
Description copied from class:GroupSelectorSet the current Scorer- Specified by:
setScorerin classGroupSelector<BytesRef>- Throws:
IOException
-
advanceTo
public GroupSelector.State advanceTo(int doc) throws IOException
Description copied from class:GroupSelectorAdvance the GroupSelector's iterator to the given document- Specified by:
advanceToin classGroupSelector<BytesRef>- Throws:
IOException
-
currentValue
public BytesRef currentValue()
Description copied from class:GroupSelectorGet the group value of the current documentN.B. this object may be reused, for a persistent version use
GroupSelector.copyValue()- Specified by:
currentValuein classGroupSelector<BytesRef>
-
copyValue
public BytesRef copyValue()
- Specified by:
copyValuein classGroupSelector<BytesRef>- Returns:
- a copy of the group value of the current document
-
setGroups
public void setGroups(Collection<SearchGroup<BytesRef>> searchGroups)
Description copied from class:GroupSelectorSet a restriction on the group values returned by this selectorIf the selector is positioned on a document whose group value is not contained within this set, then
GroupSelector.advanceTo(int)will returnGroupSelector.State.SKIP- Specified by:
setGroupsin classGroupSelector<BytesRef>- Parameters:
searchGroups- a set ofSearchGroupobjects to limit selections to
-
-