Package org.elasticsearch.search.internal

Class ContextIndexSearcher

java.lang.Object

org.apache.lucene.search.IndexSearcher

org.elasticsearch.search.internal.ContextIndexSearcher

public class ContextIndexSearcher
extends IndexSearcher

Context-aware extension of IndexSearcher.

Nested Class Summary

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

IndexSearcher.LeafSlice

Field Summary

Fields inherited from class org.apache.lucene.search.IndexSearcher

leafContexts, readerContext

Constructor Summary

Constructors

Constructor	Description
ContextIndexSearcher(IndexReader reader, Similarity similarity, QueryCache queryCache, QueryCachingPolicy queryCachingPolicy)

Method Summary

Modifier and Type	Method	Description
CollectionStatistics	collectionStatistics(String field)	Returns CollectionStatistics for a field, or null if the field does not exist (has no indexed terms) This can be overridden for example, to return a field's statistics across a distributed collection.
Weight	createWeight(Query query, ScoreMode scoreMode, float boost)	Creates a Weight for the given query, potentially adding caching if possible and configured.
DirectoryReader	getDirectoryReader()
Query	rewrite(Query original)	Expert: called to re-write queries into primitive queries.
protected void	search(List<LeafReaderContext> leaves, Weight weight, Collector collector)	Lower-level search API.
void	setAggregatedDfs(AggregatedDfs aggregatedDfs)
void	setCheckCancelled(Runnable checkCancelled)	Set a Runnable that will be run on a regular basis while collecting documents.
void	setProfiler(QueryProfiler profiler)
TermStatistics	termStatistics(Term term, int docFreq, long totalTermFreq)	Returns TermStatistics for a term.

Methods inherited from class org.apache.lucene.search.IndexSearcher

count, doc, doc, doc, explain, explain, getDefaultQueryCache, getDefaultQueryCachingPolicy, getDefaultSimilarity, getExecutor, getIndexReader, getQueryCache, getQueryCachingPolicy, getSimilarity, getSlices, getTopReaderContext, search, search, search, search, search, searchAfter, searchAfter, searchAfter, setDefaultQueryCache, setDefaultQueryCachingPolicy, setQueryCache, setQueryCachingPolicy, setSimilarity, slices, termStatistics, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextIndexSearcher

public ContextIndexSearcher(IndexReader reader,
                            Similarity similarity,
                            QueryCache queryCache,
                            QueryCachingPolicy queryCachingPolicy)

Method Detail

setProfiler

public void setProfiler(QueryProfiler profiler)

setCheckCancelled

public void setCheckCancelled(Runnable checkCancelled)

Set a Runnable that will be run on a regular basis while collecting documents.

setAggregatedDfs

public void setAggregatedDfs(AggregatedDfs aggregatedDfs)

rewrite

public Query rewrite(Query original)
              throws IOException

Description copied from class: IndexSearcher

Expert: called to re-write queries into primitive queries.

Overrides:

rewrite in class IndexSearcher

Throws:

IOException

createWeight

public Weight createWeight(Query query,
                           ScoreMode scoreMode,
                           float boost)
                    throws IOException

Description copied from class: IndexSearcher

Creates a Weight for the given query, potentially adding caching if possible and configured.

Overrides:

createWeight in class IndexSearcher

Throws:

IOException

search

protected void search(List<LeafReaderContext> leaves,
                      Weight weight,
                      Collector collector)
               throws IOException

Description copied from class: IndexSearcher

Lower-level search API.

LeafCollector.collect(int) is called for every document.

NOTE: this method executes the searches on all given leaves exclusively. To search across all the searchers leaves use IndexSearcher.leafContexts.

Overrides:

search in class IndexSearcher

Parameters:

leaves - the searchers leaves to execute the searches on

weight - to match documents

collector - to receive hits

Throws:

IOException

termStatistics

public TermStatistics termStatistics(Term term,
                                     int docFreq,
                                     long totalTermFreq)
                              throws IOException

Description copied from class: IndexSearcher

Returns TermStatistics for a term.

This can be overridden for example, to return a term's statistics across a distributed collection.

Overrides:

termStatistics in class IndexSearcher

docFreq - The document frequency of the term. It must be greater or equal to 1.

totalTermFreq - The total term frequency.

Returns:

A TermStatistics (never null).

Throws:

IOException

collectionStatistics

public CollectionStatistics collectionStatistics(String field)
                                          throws IOException

Description copied from class: IndexSearcher

Returns CollectionStatistics for a field, or null if the field does not exist (has no indexed terms) This can be overridden for example, to return a field's statistics across a distributed collection.

Overrides:

collectionStatistics in class IndexSearcher

Throws:

IOException

getDirectoryReader

public DirectoryReader getDirectoryReader()