A B C D E F G H M N O R S T U V W 

A

AbstractAllGroupHeadsCollector<GH extends AbstractAllGroupHeadsCollector.GroupHead> - Class in org.apache.lucene.search.grouping
This collector specializes in collecting the most relevant document (group head) for each group that match the query.
AbstractAllGroupHeadsCollector(int) - Constructor for class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
 
AbstractAllGroupHeadsCollector.GroupHead<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
Represents a group head.
AbstractAllGroupHeadsCollector.GroupHead(GROUP_VALUE_TYPE, int) - Constructor for class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.GroupHead
 
AbstractAllGroupHeadsCollector.TemporalResult - Class in org.apache.lucene.search.grouping
Contains the result of group head retrieval.
AbstractAllGroupHeadsCollector.TemporalResult() - Constructor for class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.TemporalResult
 
AbstractAllGroupsCollector<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
A collector that collects all groups that match the query.
AbstractAllGroupsCollector() - Constructor for class org.apache.lucene.search.grouping.AbstractAllGroupsCollector
 
AbstractDistinctValuesCollector<GC extends AbstractDistinctValuesCollector.GroupCount<?>> - Class in org.apache.lucene.search.grouping
A second pass grouping collector that keeps track of distinct values for a specified field for the top N group.
AbstractDistinctValuesCollector() - Constructor for class org.apache.lucene.search.grouping.AbstractDistinctValuesCollector
 
AbstractDistinctValuesCollector.GroupCount<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
Returned by AbstractDistinctValuesCollector.getGroups(), representing the value and set of distinct values for the group.
AbstractDistinctValuesCollector.GroupCount(GROUP_VALUE_TYPE) - Constructor for class org.apache.lucene.search.grouping.AbstractDistinctValuesCollector.GroupCount
 
AbstractFirstPassGroupingCollector<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
FirstPassGroupingCollector is the first of two passes necessary to collect grouped hits.
AbstractFirstPassGroupingCollector(Sort, int) - Constructor for class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
Create the first pass collector.
AbstractGroupFacetCollector - Class in org.apache.lucene.search.grouping
Base class for computing grouped facets.
AbstractGroupFacetCollector(String, String, BytesRef) - Constructor for class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
AbstractGroupFacetCollector.FacetEntry - Class in org.apache.lucene.search.grouping
Represents a facet entry with a value and a count.
AbstractGroupFacetCollector.FacetEntry(BytesRef, int) - Constructor for class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.FacetEntry
 
AbstractGroupFacetCollector.GroupedFacetResult - Class in org.apache.lucene.search.grouping
The grouped facet result.
AbstractGroupFacetCollector.GroupedFacetResult(int, int, boolean, int, int) - Constructor for class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.GroupedFacetResult
 
AbstractGroupFacetCollector.SegmentResult - Class in org.apache.lucene.search.grouping
Contains the local grouped segment counts for a particular segment.
AbstractGroupFacetCollector.SegmentResult(int[], int, int, int) - Constructor for class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.SegmentResult
 
AbstractSecondPassGroupingCollector<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
SecondPassGroupingCollector is the second of two passes necessary to collect grouped docs.
AbstractSecondPassGroupingCollector(Collection<SearchGroup<GROUP_VALUE_TYPE>>, Sort, Sort, int, boolean, boolean, boolean) - Constructor for class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
 
AbstractSecondPassGroupingCollector.SearchGroupDocs<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
 
AbstractSecondPassGroupingCollector.SearchGroupDocs(GROUP_VALUE_TYPE, TopDocsCollector<?>) - Constructor for class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector.SearchGroupDocs
 
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
 
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupsCollector
 
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.AbstractDistinctValuesCollector
 
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
 
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
 
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
 
addFacetCount(BytesRef, int) - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.GroupedFacetResult
 

B

BlockGroupingCollector - Class in org.apache.lucene.search.grouping
BlockGroupingCollector performs grouping with a single pass collector, as long as you are grouping by a doc block field, ie all documents sharing a given group value were indexed as a doc block using the atomic IndexWriter.addDocuments() or IndexWriter.updateDocuments() API.
BlockGroupingCollector(Sort, int, boolean, Filter) - Constructor for class org.apache.lucene.search.grouping.BlockGroupingCollector
Create the single pass collector.

C

collect(int) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
 
collect(int) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
 
collect(int) - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
 
collect(int) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
 
collect(int) - Method in class org.apache.lucene.search.grouping.function.FunctionAllGroupsCollector
 
collect(int) - Method in class org.apache.lucene.search.grouping.function.FunctionDistinctValuesCollector
 
collect(int) - Method in class org.apache.lucene.search.grouping.term.TermAllGroupsCollector
 
collect(int) - Method in class org.apache.lucene.search.grouping.term.TermDistinctValuesCollector
 
CollectedSearchGroup<T> - Class in org.apache.lucene.search.grouping
Expert: representation of a group in AbstractFirstPassGroupingCollector, tracking the top doc and FieldComparator slot.
CollectedSearchGroup() - Constructor for class org.apache.lucene.search.grouping.CollectedSearchGroup
 
collector - Variable in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector.SearchGroupDocs
 
compare(int, int) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.GroupHead
Compares the specified document for a specified comparator against the current most relevant document.
compare(int, int) - Method in class org.apache.lucene.search.grouping.function.FunctionAllGroupHeadsCollector.GroupHead
 
compIDXEnd - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
 
copyDocGroupValue(GROUP_VALUE_TYPE, GROUP_VALUE_TYPE) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
Returns a copy of the specified group value by creating a new instance and copying the value from the specified groupValue in the new instance.
copyDocGroupValue(MutableValue, MutableValue) - Method in class org.apache.lucene.search.grouping.function.FunctionFirstPassGroupingCollector
 
copyDocGroupValue(BytesRef, BytesRef) - Method in class org.apache.lucene.search.grouping.term.TermFirstPassGroupingCollector
 
counts - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.SegmentResult
 
create(String, Sort, DocValues.Type, boolean) - Static method in class org.apache.lucene.search.grouping.dv.DVAllGroupHeadsCollector
Creates an AbstractAllGroupHeadsCollector instance based on the supplied arguments.
create(String, DocValues.Type, boolean, int) - Static method in class org.apache.lucene.search.grouping.dv.DVAllGroupsCollector
Expert: Constructs a DVAllGroupsCollector.
create(String, DocValues.Type, boolean) - Static method in class org.apache.lucene.search.grouping.dv.DVAllGroupsCollector
Constructs a DVAllGroupsCollector.
create(String, String, Collection<SearchGroup<T>>, boolean, DocValues.Type) - Static method in class org.apache.lucene.search.grouping.dv.DVDistinctValuesCollector
Constructs a docvalues based implementation of AbstractDistinctValuesCollector based on the specified type.
create(Sort, int, String, DocValues.Type, boolean) - Static method in class org.apache.lucene.search.grouping.dv.DVFirstPassGroupingCollector
create(String, boolean, DocValues.Type, Collection<SearchGroup<T>>, Sort, Sort, int, boolean, boolean, boolean) - Static method in class org.apache.lucene.search.grouping.dv.DVSecondPassGroupingCollector
create(String, Sort) - Static method in class org.apache.lucene.search.grouping.term.TermAllGroupHeadsCollector
Creates an AbstractAllGroupHeadsCollector instance based on the supplied arguments.
create(String, Sort, int) - Static method in class org.apache.lucene.search.grouping.term.TermAllGroupHeadsCollector
Creates an AbstractAllGroupHeadsCollector instance based on the supplied arguments.
createDvGroupFacetCollector(String, DocValues.Type, boolean, String, DocValues.Type, boolean, BytesRef, int) - Static method in class org.apache.lucene.search.grouping.dv.DVGroupFacetCollector
Factory method for creating the right implementation based on the group docvalues type and the facet docvalues type.
createSegmentResult() - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
createTermGroupFacetCollector(String, String, boolean, BytesRef, int) - Static method in class org.apache.lucene.search.grouping.term.TermGroupFacetCollector
Factory method for creating the right implementation based on the fact whether the facet field contains multiple tokens per documents.

D

disableCaching() - Method in class org.apache.lucene.search.grouping.GroupingSearch
Disables any enabled cache.
doc - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.GroupHead
 
DVAllGroupHeadsCollector<GH extends AbstractAllGroupHeadsCollector.GroupHead<?>> - Class in org.apache.lucene.search.grouping.dv
A base implementation of AbstractAllGroupHeadsCollector for retrieving the most relevant groups when grouping on a indexed doc values field.
DVAllGroupsCollector<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping.dv
Implementation of AbstractAllGroupsCollector that groups documents based on DocValues fields.
DVDistinctValuesCollector<GC extends AbstractDistinctValuesCollector.GroupCount<?>> - Class in org.apache.lucene.search.grouping.dv
Docvalues implementation of AbstractDistinctValuesCollector.
DVFirstPassGroupingCollector<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping.dv
IDV based Implementations of AbstractFirstPassGroupingCollector.
DVGroupFacetCollector - Class in org.apache.lucene.search.grouping.dv
An implementation of AbstractGroupFacetCollector that computes grouped facets based on docvalues.
DVSecondPassGroupingCollector<GROUP_VALUE> - Class in org.apache.lucene.search.grouping.dv
IDV based implementation of AbstractSecondPassGroupingCollector.

E

endFacetOrd - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
equals(Object) - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.FacetEntry
 
equals(Object) - Method in class org.apache.lucene.search.grouping.SearchGroup
 

F

facetField - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
facetPrefix - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
FunctionAllGroupHeadsCollector - Class in org.apache.lucene.search.grouping.function
An implementation of AbstractAllGroupHeadsCollector for retrieving the most relevant groups when grouping by ValueSource.
FunctionAllGroupHeadsCollector(ValueSource, Map<?, ?>, Sort) - Constructor for class org.apache.lucene.search.grouping.function.FunctionAllGroupHeadsCollector
Constructs a FunctionAllGroupHeadsCollector instance.
FunctionAllGroupHeadsCollector.GroupHead - Class in org.apache.lucene.search.grouping.function
Holds current head document for a single group.
FunctionAllGroupsCollector - Class in org.apache.lucene.search.grouping.function
A collector that collects all groups that match the query.
FunctionAllGroupsCollector(ValueSource, Map<?, ?>) - Constructor for class org.apache.lucene.search.grouping.function.FunctionAllGroupsCollector
Constructs a FunctionAllGroupsCollector instance.
FunctionDistinctValuesCollector - Class in org.apache.lucene.search.grouping.function
Function based implementation of AbstractDistinctValuesCollector.
FunctionDistinctValuesCollector(Map<?, ?>, ValueSource, ValueSource, Collection<SearchGroup<MutableValue>>) - Constructor for class org.apache.lucene.search.grouping.function.FunctionDistinctValuesCollector
 
FunctionDistinctValuesCollector.GroupCount - Class in org.apache.lucene.search.grouping.function
Holds distinct values for a single group.
FunctionFirstPassGroupingCollector - Class in org.apache.lucene.search.grouping.function
Concrete implementation of AbstractFirstPassGroupingCollector that groups based on ValueSource instances.
FunctionFirstPassGroupingCollector(ValueSource, Map<?, ?>, Sort, int) - Constructor for class org.apache.lucene.search.grouping.function.FunctionFirstPassGroupingCollector
Creates a first pass collector.
FunctionSecondPassGroupingCollector - Class in org.apache.lucene.search.grouping.function
Concrete implementation of AbstractSecondPassGroupingCollector that groups based on ValueSource instances.
FunctionSecondPassGroupingCollector(Collection<SearchGroup<MutableValue>>, Sort, Sort, int, boolean, boolean, boolean, ValueSource, Map<?, ?>) - Constructor for class org.apache.lucene.search.grouping.function.FunctionSecondPassGroupingCollector

G

getAllGroupHeads() - Method in class org.apache.lucene.search.grouping.GroupingSearch
Returns the matching group heads if GroupingSearch.setAllGroupHeads(boolean) was set to true or an empty bit set.
getAllMatchingGroups() - Method in class org.apache.lucene.search.grouping.GroupingSearch
If GroupingSearch.setAllGroups(boolean) was set to true then all matching groups are returned, otherwise an empty collection is returned.
getCollectedGroupHeads() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
Returns the collected group heads.
getCollectedGroupHeads() - Method in class org.apache.lucene.search.grouping.function.FunctionAllGroupHeadsCollector
 
getCount() - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.FacetEntry
 
getDefaultSource(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.dv.DVAllGroupHeadsCollector
 
getDefaultSource(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.dv.DVAllGroupsCollector
 
getDefaultSource(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.dv.DVFirstPassGroupingCollector
 
getDefaultSource(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.dv.DVSecondPassGroupingCollector
 
getDocGroupValue(int) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
Returns the group value for the specified doc.
getDocGroupValue(int) - Method in class org.apache.lucene.search.grouping.function.FunctionFirstPassGroupingCollector
 
getDocGroupValue(int) - Method in class org.apache.lucene.search.grouping.term.TermFirstPassGroupingCollector
 
getFacetEntries(int, int) - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.GroupedFacetResult
Returns a list of facet entries to be rendered based on the specified offset and limit.
getGroupCount() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupsCollector
Returns the total number of groups for the executed search.
getGroups() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupsCollector
Returns the group values

This is an unordered collections of group values.

getGroups() - Method in class org.apache.lucene.search.grouping.AbstractDistinctValuesCollector
Returns all unique values for each top N group.
getGroups() - Method in class org.apache.lucene.search.grouping.function.FunctionAllGroupsCollector
 
getGroups() - Method in class org.apache.lucene.search.grouping.function.FunctionDistinctValuesCollector
 
getGroups() - Method in class org.apache.lucene.search.grouping.term.TermAllGroupsCollector
 
getGroups() - Method in class org.apache.lucene.search.grouping.term.TermDistinctValuesCollector
 
getTopGroups(int, boolean) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
Returns top groups, starting from offset.
getTopGroups(int) - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
 
getTopGroups(Sort, int, int, int, boolean) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
Returns the grouped results.
getTotalCount() - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.GroupedFacetResult
Returns the sum of all facet entries counts.
getTotalMissingCount() - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.GroupedFacetResult
Returns the number of groups that didn't have a facet value.
getValue() - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.FacetEntry
 
groupByDocBlock(IndexSearcher, Filter, Query, int, int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
 
groupByFieldOrFunction(IndexSearcher, Filter, Query, int, int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
 
groupDocs - Variable in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
 
GroupDocs<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
Represents one group in the results.
GroupDocs(float, float, int, ScoreDoc[], GROUP_VALUE_TYPE, Object[]) - Constructor for class org.apache.lucene.search.grouping.GroupDocs
 
groupField - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
groupHead - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.TemporalResult
 
groupHeadsSize() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
 
GroupingSearch - Class in org.apache.lucene.search.grouping
Convenience class to perform grouping in a non distributed environment.
GroupingSearch(String) - Constructor for class org.apache.lucene.search.grouping.GroupingSearch
Constructs a GroupingSearch instance that groups documents by index terms using the FieldCache.
GroupingSearch(String, DocValues.Type, boolean) - Constructor for class org.apache.lucene.search.grouping.GroupingSearch
Constructs a GroupingSearch instance that groups documents by doc values.
GroupingSearch(ValueSource, Map<?, ?>) - Constructor for class org.apache.lucene.search.grouping.GroupingSearch
Constructs a GroupingSearch instance that groups documents by function using a ValueSource instance.
GroupingSearch(Filter) - Constructor for class org.apache.lucene.search.grouping.GroupingSearch
Constructor for grouping documents by doc block.
groupMap - Variable in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
 
groups - Variable in class org.apache.lucene.search.grouping.TopGroups
Group results in groupSort order
groupSort - Variable in class org.apache.lucene.search.grouping.TopGroups
How groups are sorted against each other
groupSortValues - Variable in class org.apache.lucene.search.grouping.GroupDocs
Matches the groupSort passed to AbstractFirstPassGroupingCollector.
groupValue - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.GroupHead
 
groupValue - Variable in class org.apache.lucene.search.grouping.AbstractDistinctValuesCollector.GroupCount
 
groupValue - Variable in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector.SearchGroupDocs
 
groupValue - Variable in class org.apache.lucene.search.grouping.GroupDocs
The groupField value for all docs in this group; this may be null if hits did not have the groupField.
groupValue - Variable in class org.apache.lucene.search.grouping.SearchGroup
The value that defines this group

H

hashCode() - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.FacetEntry
 
hashCode() - Method in class org.apache.lucene.search.grouping.SearchGroup
 

M

maxScore - Variable in class org.apache.lucene.search.grouping.GroupDocs
Max score in this group
maxScore - Variable in class org.apache.lucene.search.grouping.TopGroups
Highest score across all hits, or Float.NaN if scores were not computed.
maxTermPos - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.SegmentResult
 
merge(List<Collection<SearchGroup<T>>>, int, int, Sort) - Static method in class org.apache.lucene.search.grouping.SearchGroup
Merges multiple collections of top groups, for example obtained from separate index shards.
merge(TopGroups<T>[], Sort, Sort, int, int, TopGroups.ScoreMergeMode) - Static method in class org.apache.lucene.search.grouping.TopGroups
Merges an array of TopGroups, for example obtained from the second-pass collector across multiple shards.
mergePos - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.SegmentResult
 
mergeSegmentResults(int, int, boolean) - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
Returns grouped facet results that were computed over zero or more segments.
mergeTerm - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.SegmentResult
 
missing - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.SegmentResult
 

N

nextTerm() - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.SegmentResult
Go to next term in this SegmentResult in order to retrieve the grouped facet counts.

O

orderedGroups - Variable in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
 
org.apache.lucene.search.grouping - package org.apache.lucene.search.grouping
This module enables search result grouping with Lucene, where hits with the same value in the specified single-valued group field are grouped together.
org.apache.lucene.search.grouping.dv - package org.apache.lucene.search.grouping.dv
Support for grouping on DocValues fields.
org.apache.lucene.search.grouping.function - package org.apache.lucene.search.grouping.function
Support for grouping by {org.apache.lucene.queries.function.ValueSource}.
org.apache.lucene.search.grouping.term - package org.apache.lucene.search.grouping.term
Support for grouping by indexed terms via {org.apache.lucene.search.FieldCache}.

R

retrieveGroup(int) - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
Returns the group the specified doc belongs to or null if no group could be retrieved.
retrieveGroup(int) - Method in class org.apache.lucene.search.grouping.function.FunctionSecondPassGroupingCollector
 
retrieveGroup(int) - Method in class org.apache.lucene.search.grouping.term.TermSecondPassGroupingCollector
 
retrieveGroupHeadAndAddIfNotExist(int) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
Returns the group head and puts it into AbstractAllGroupHeadsCollector.temporalResult.
retrieveGroupHeadAndAddIfNotExist(int) - Method in class org.apache.lucene.search.grouping.function.FunctionAllGroupHeadsCollector
 
retrieveGroupHeads(int) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
 
retrieveGroupHeads() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
 
reversed - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
 

S

score - Variable in class org.apache.lucene.search.grouping.GroupDocs
Overall aggregated score of this group (currently only set by join queries).
scoreDocs - Variable in class org.apache.lucene.search.grouping.GroupDocs
Hits; this may be FieldDoc instances if the withinGroupSort sorted by fields.
search(IndexSearcher, Query, int, int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Executes a grouped search.
search(IndexSearcher, Filter, Query, int, int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Executes a grouped search.
SearchGroup<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
Represents a group that is found during the first pass search.
SearchGroup() - Constructor for class org.apache.lucene.search.grouping.SearchGroup
 
segmentFacetCounts - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
segmentResults - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
segmentTotalCount - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
setAllGroupHeads(boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Whether to compute all group heads (most relevant document per group) matching the query.
setAllGroups(boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Whether to also co0.0mpute all groups matching the query.
setCaching(int, boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Enables caching for the second pass search.
setCachingInMB(double, boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Enables caching for the second pass search.
setDocValuesSources(DocValues.Source) - Method in class org.apache.lucene.search.grouping.dv.DVAllGroupHeadsCollector
Sets the idv source for concrete implementations to use.
setDocValuesSources(DocValues.Source, AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.dv.DVAllGroupsCollector
Sets the idv source for concrete implementations to use.
setDocValuesSources(DocValues.Source) - Method in class org.apache.lucene.search.grouping.dv.DVFirstPassGroupingCollector
Sets the idv source for concrete implementations to use.
setDocValuesSources(DocValues.Source, AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.dv.DVSecondPassGroupingCollector
Sets the idv source for concrete implementations to use.
setFillSortFields(boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Whether to also fill the sort fields per returned group and groups docs.
setGroupDocsLimit(int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Specifies the number of documents to return inside a group from the specified groupDocsOffset.
setGroupDocsOffset(int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Specifies the offset for documents inside a group.
setGroupSort(Sort) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Specifies how groups are sorted.
setIncludeMaxScore(boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Whether to include the score of the most relevant document per group.
setIncludeScores(boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Whether to include the scores per doc inside a group.
setInitialSize(int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Sets the initial size of some internal used data structures.
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.dv.DVAllGroupHeadsCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.dv.DVAllGroupsCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.dv.DVFirstPassGroupingCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.dv.DVSecondPassGroupingCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.function.FunctionAllGroupHeadsCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.function.FunctionAllGroupsCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.function.FunctionDistinctValuesCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.function.FunctionFirstPassGroupingCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.function.FunctionSecondPassGroupingCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.term.TermAllGroupsCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.term.TermDistinctValuesCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.term.TermFirstPassGroupingCollector
 
setNextReader(AtomicReaderContext) - Method in class org.apache.lucene.search.grouping.term.TermSecondPassGroupingCollector
 
setScorer(Scorer) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupsCollector
 
setScorer(Scorer) - Method in class org.apache.lucene.search.grouping.AbstractDistinctValuesCollector
 
setScorer(Scorer) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
 
setScorer(Scorer) - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
setScorer(Scorer) - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
 
setScorer(Scorer) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
 
setScorer(Scorer) - Method in class org.apache.lucene.search.grouping.function.FunctionAllGroupHeadsCollector
 
setSortWithinGroup(Sort) - Method in class org.apache.lucene.search.grouping.GroupingSearch
Specified how documents inside a group are sorted.
sortValues - Variable in class org.apache.lucene.search.grouping.SearchGroup
The sort values used during sorting.
startFacetOrd - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector
 
stop - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.TemporalResult
 

T

temporalResult - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
 
TermAllGroupHeadsCollector<GH extends AbstractAllGroupHeadsCollector.GroupHead<?>> - Class in org.apache.lucene.search.grouping.term
A base implementation of AbstractAllGroupHeadsCollector for retrieving the most relevant groups when grouping on a string based group field.
TermAllGroupHeadsCollector(String, int) - Constructor for class org.apache.lucene.search.grouping.term.TermAllGroupHeadsCollector
 
TermAllGroupsCollector - Class in org.apache.lucene.search.grouping.term
A collector that collects all groups that match the query.
TermAllGroupsCollector(String, int) - Constructor for class org.apache.lucene.search.grouping.term.TermAllGroupsCollector
Expert: Constructs a AbstractAllGroupsCollector
TermAllGroupsCollector(String) - Constructor for class org.apache.lucene.search.grouping.term.TermAllGroupsCollector
TermDistinctValuesCollector - Class in org.apache.lucene.search.grouping.term
A term based implementation of AbstractDistinctValuesCollector that relies on FieldCache.DocTermsIndex to count the distinct values per group.
TermDistinctValuesCollector(String, String, Collection<SearchGroup<BytesRef>>) - Constructor for class org.apache.lucene.search.grouping.term.TermDistinctValuesCollector
Constructs TermDistinctValuesCollector instance.
TermDistinctValuesCollector.GroupCount - Class in org.apache.lucene.search.grouping.term
Holds distinct values for a single group.
TermFirstPassGroupingCollector - Class in org.apache.lucene.search.grouping.term
Concrete implementation of AbstractFirstPassGroupingCollector that groups based on field values and more specifically uses FieldCache.DocTermsIndex to collect groups.
TermFirstPassGroupingCollector(String, Sort, int) - Constructor for class org.apache.lucene.search.grouping.term.TermFirstPassGroupingCollector
Create the first pass collector.
TermGroupFacetCollector - Class in org.apache.lucene.search.grouping.term
An implementation of AbstractGroupFacetCollector that computes grouped facets based on the indexed terms from the FieldCache.
TermSecondPassGroupingCollector - Class in org.apache.lucene.search.grouping.term
Concrete implementation of AbstractSecondPassGroupingCollector that groups based on field values and more specifically uses FieldCache.DocTermsIndex to collect grouped docs.
TermSecondPassGroupingCollector(String, Collection<SearchGroup<BytesRef>>, Sort, Sort, int, boolean, boolean, boolean) - Constructor for class org.apache.lucene.search.grouping.term.TermSecondPassGroupingCollector
 
TopGroups<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
Represents result returned by a grouping search.
TopGroups(SortField[], SortField[], int, int, GroupDocs<GROUP_VALUE_TYPE>[], float) - Constructor for class org.apache.lucene.search.grouping.TopGroups
 
TopGroups(TopGroups<GROUP_VALUE_TYPE>, Integer) - Constructor for class org.apache.lucene.search.grouping.TopGroups
 
TopGroups.ScoreMergeMode - Enum in org.apache.lucene.search.grouping
How the GroupDocs score (if any) should be merged.
toString() - Method in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.FacetEntry
 
toString() - Method in class org.apache.lucene.search.grouping.SearchGroup
 
total - Variable in class org.apache.lucene.search.grouping.AbstractGroupFacetCollector.SegmentResult
 
totalGroupCount - Variable in class org.apache.lucene.search.grouping.TopGroups
The total number of unique groups.
totalGroupedHitCount - Variable in class org.apache.lucene.search.grouping.TopGroups
Number of documents grouped into the topN groups
totalHitCount - Variable in class org.apache.lucene.search.grouping.TopGroups
Number of documents matching the search
totalHits - Variable in class org.apache.lucene.search.grouping.GroupDocs
Total hits within this group

U

uniqueValues - Variable in class org.apache.lucene.search.grouping.AbstractDistinctValuesCollector.GroupCount
 
updateDocHead(int) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.GroupHead
Updates the current most relevant document with the specified document.
updateDocHead(int) - Method in class org.apache.lucene.search.grouping.function.FunctionAllGroupHeadsCollector.GroupHead
 

V

valueOf(String) - Static method in enum org.apache.lucene.search.grouping.TopGroups.ScoreMergeMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.lucene.search.grouping.TopGroups.ScoreMergeMode
Returns an array containing the constants of this enum type, in the order they are declared.

W

withinGroupSort - Variable in class org.apache.lucene.search.grouping.TopGroups
How docs are sorted within each group
A B C D E F G H M N O R S T U V W 

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