public class

IndexSearcher

extends Searcher
java.lang.Object
   ↳ org.apache.lucene.search.Searcher
     ↳ org.apache.lucene.search.IndexSearcher

Class Overview

Implements search over a single IndexReader.

Applications usually need only call the inherited search(Query, int) or search(Query, Filter, int) methods. For performance reasons it is recommended to open only one IndexSearcher and use it for all of your searches.

NOTE: IndexSearcher instances are completely thread safe, meaning multiple threads can call any of its methods, concurrently. If your application requires external synchronization, you should not synchronize on the IndexSearcher instance; use your own (non-Lucene) objects instead.

Summary

Fields
protected int[] docStarts
protected IndexReader[] subReaders
Public Constructors
IndexSearcher(Directory path)
Creates a searcher searching the index in the named directory, with readOnly=true
IndexSearcher(Directory path, boolean readOnly)
Creates a searcher searching the index in the named directory.
IndexSearcher(IndexReader r)
Creates a searcher searching the provided index.
IndexSearcher(IndexReader reader, IndexReader[] subReaders, int[] docStarts)
Expert: directly specify the reader, subReaders and their docID starts.
Public Methods
void close()
Note that the underlying IndexReader is not closed, if IndexSearcher was constructed with IndexSearcher(IndexReader r).
Document doc(int i)
Returns the stored fields of document i.
Document doc(int i, FieldSelector fieldSelector)
Get the Document at the nth position.
int docFreq(Term term)
Expert: Returns the number of documents containing term.
Explanation explain(Weight weight, int doc)
Expert: low-level implementation method Returns an Explanation that describes how doc scored against weight.
IndexReader getIndexReader()
Return the IndexReader this searches.
int maxDoc()
Expert: Returns one greater than the largest possible document number.
Query rewrite(Query original)
Expert: called to re-write queries into primitive queries.
void search(Weight weight, Filter filter, Collector collector)
Lower-level search API.
TopDocs search(Weight weight, Filter filter, int nDocs)
Expert: Low-level search implementation.
TopFieldDocs search(Weight weight, Filter filter, int nDocs, Sort sort, boolean fillFields)
Just like search(Weight, Filter, int, Sort), but you choose whether or not the fields in the returned FieldDoc instances should be set by specifying fillFields.
TopFieldDocs search(Weight weight, Filter filter, int nDocs, Sort sort)
Expert: Low-level search implementation with arbitrary sorting.
void setDefaultFieldSortScoring(boolean doTrackScores, boolean doMaxScore)
By default, no scores are computed when sorting by field (using search(Query, Filter, int, Sort)).
Protected Methods
void gatherSubReaders(List<IndexReader> allSubReaders, IndexReader r)
[Expand]
Inherited Methods
From class org.apache.lucene.search.Searcher
From class java.lang.Object
From interface java.io.Closeable
From interface org.apache.lucene.search.Searchable

Fields

protected int[] docStarts

protected IndexReader[] subReaders

Public Constructors

public IndexSearcher (Directory path)

Creates a searcher searching the index in the named directory, with readOnly=true

Parameters
path directory where IndexReader will be opened
Throws
CorruptIndexException if the index is corrupt
IOException if there is a low-level IO error

public IndexSearcher (Directory path, boolean readOnly)

Creates a searcher searching the index in the named directory. You should pass readOnly=true, since it gives much better concurrent performance, unless you intend to do write operations (delete documents or change norms) with the underlying IndexReader.

Parameters
path directory where IndexReader will be opened
readOnly if true, the underlying IndexReader will be opened readOnly
Throws
CorruptIndexException if the index is corrupt
IOException if there is a low-level IO error

public IndexSearcher (IndexReader r)

Creates a searcher searching the provided index.

public IndexSearcher (IndexReader reader, IndexReader[] subReaders, int[] docStarts)

Expert: directly specify the reader, subReaders and their docID starts.

NOTE: This API is experimental and might change in incompatible ways in the next release.

Public Methods

public void close ()

Note that the underlying IndexReader is not closed, if IndexSearcher was constructed with IndexSearcher(IndexReader r). If the IndexReader was supplied implicitly by specifying a directory, then the IndexReader gets closed.

Throws
IOException

public Document doc (int i)

Returns the stored fields of document i.

public Document doc (int i, FieldSelector fieldSelector)

Get the Document at the nth position. The FieldSelector may be used to determine what Fields to load and how they should be loaded. NOTE: If the underlying Reader (more specifically, the underlying FieldsReader) is closed before the lazy Field is loaded an exception may be thrown. If you want the value of a lazy Field to be available after closing you must explicitly load it or fetch the Document again with a new loader.

Parameters
i Get the document at the nth position
fieldSelector The FieldSelector to use to determine what Fields should be loaded on the Document. May be null, in which case all Fields will be loaded.
Returns
  • The stored fields of the Document at the nth position

public int docFreq (Term term)

Expert: Returns the number of documents containing term.

Throws
IOException

public Explanation explain (Weight weight, int doc)

Expert: low-level implementation method Returns an Explanation that describes how doc scored against weight.

This is intended to be used in developing Similarity implementations, and, for good performance, should not be displayed with every hit. Computing an explanation is as expensive as executing the query over the entire index.

Applications should call explain(Query, int).

Throws
IOException

public IndexReader getIndexReader ()

Return the IndexReader this searches.

public int maxDoc ()

Expert: Returns one greater than the largest possible document number.

Throws
IOException

public Query rewrite (Query original)

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

Throws
IOException

public void search (Weight weight, Filter filter, Collector collector)

Lower-level search API.

collect(int) is called for every document.
Collector-based access to remote indexes is discouraged.

Applications should only use this if they need all of the matching documents. The high-level search API (search(Query, int)) is usually more efficient, as it skips non-high-scoring hits.

Parameters
weight to match documents
filter if non-null, used to permit documents to be collected.
collector to receive hits
Throws
IOException

public TopDocs search (Weight weight, Filter filter, int nDocs)

Expert: Low-level search implementation. Finds the top n hits for query, applying filter if non-null.

Applications should usually call search(Query, int) or search(Query, Filter, int) instead.

Throws
IOException

public TopFieldDocs search (Weight weight, Filter filter, int nDocs, Sort sort, boolean fillFields)

Just like search(Weight, Filter, int, Sort), but you choose whether or not the fields in the returned FieldDoc instances should be set by specifying fillFields.

NOTE: this does not compute scores by default. If you need scores, create a TopFieldCollector instance by calling create(Sort, int, boolean, boolean, boolean, boolean) and then pass that to search(Weight, Filter, Collector).

Throws
IOException

public TopFieldDocs search (Weight weight, Filter filter, int nDocs, Sort sort)

Expert: Low-level search implementation with arbitrary sorting. Finds the top n hits for query, applying filter if non-null, and sorting the hits by the criteria in sort.

Applications should usually call search(Query, Filter, int, Sort) instead.

Throws
IOException

public void setDefaultFieldSortScoring (boolean doTrackScores, boolean doMaxScore)

By default, no scores are computed when sorting by field (using search(Query, Filter, int, Sort)). You can change that, per IndexSearcher instance, by calling this method. Note that this will incur a CPU cost.

Parameters
doTrackScores If true, then scores are returned for every matching document in TopFieldDocs.
doMaxScore If true, then the max score for all matching docs is computed.

Protected Methods

protected void gatherSubReaders (List<IndexReader> allSubReaders, IndexReader r)