public abstract class

Searcher

extends Object
implements Searchable
java.lang.Object
   ↳ org.apache.lucene.search.Searcher
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

An abstract base class for search implementations. Implements the main search methods.

Note that you can only access hits from a Searcher as long as it is not yet closed, otherwise an IOException will be thrown.

Summary

Public Constructors
Searcher()
Public Methods
abstract void close()
Frees resources associated with this Searcher.
abstract Document doc(int i)
Returns the stored fields of document i.
abstract Document doc(int docid, FieldSelector fieldSelector)
Get the Document at the nth position.
abstract int docFreq(Term term)
Expert: Returns the number of documents containing term.
int[] docFreqs(Term[] terms)
Expert: For each term in the terms array, calculates the number of documents containing term.
Explanation explain(Query query, int doc)
Returns an Explanation that describes how doc scored against query.
abstract Explanation explain(Weight weight, int doc)
Expert: low-level implementation method Returns an Explanation that describes how doc scored against weight.
Similarity getSimilarity()
Expert: Return the Similarity implementation used by this Searcher.
abstract int maxDoc()
Expert: Returns one greater than the largest possible document number.
abstract Query rewrite(Query query)
Expert: called to re-write queries into primitive queries.
TopDocs search(Query query, int n)
Finds the top n hits for query.
abstract void search(Weight weight, Filter filter, Collector results)
Lower-level search API.
void search(Query query, Filter filter, Collector results)
Lower-level search API.
TopFieldDocs search(Query query, Filter filter, int n, Sort sort)
Search implementation with arbitrary sorting.
void search(Query query, Collector results)
Lower-level search API.
TopDocs search(Query query, Filter filter, int n)
Finds the top n hits for query, applying filter if non-null.
abstract TopDocs search(Weight weight, Filter filter, int n)
Expert: Low-level search implementation.
abstract TopFieldDocs search(Weight weight, Filter filter, int n, Sort sort)
Expert: Low-level search implementation with arbitrary sorting.
void setSimilarity(Similarity similarity)
Expert: Set the Similarity implementation used by this Searcher.
Protected Methods
Weight createWeight(Query query)
creates a weight for query
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.io.Closeable
From interface org.apache.lucene.search.Searchable

Public Constructors

public Searcher ()

Public Methods

public abstract void close ()

Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects that reference this Searchable.

Throws
IOException

public abstract Document doc (int i)

Returns the stored fields of document i.

public abstract Document doc (int docid, 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
docid 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 abstract int docFreq (Term term)

Expert: Returns the number of documents containing term.

Throws
IOException

public int[] docFreqs (Term[] terms)

Expert: For each term in the terms array, calculates the number of documents containing term. Returns an array with these document frequencies. Used to minimize number of remote calls.

Throws
IOException

public Explanation explain (Query query, int doc)

Returns an Explanation that describes how doc scored against query.

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.

Throws
IOException

public abstract 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 Similarity getSimilarity ()

Expert: Return the Similarity implementation used by this Searcher.

This defaults to the current value of getDefault().

public abstract int maxDoc ()

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

Throws
IOException

public abstract Query rewrite (Query query)

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

Throws
IOException

public TopDocs search (Query query, int n)

Finds the top n hits for query.

public abstract void search (Weight weight, Filter filter, Collector results)

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.
results to receive hits
Throws
IOException

public void search (Query query, Filter filter, Collector results)

Lower-level search API.

collect(int) is called for every matching 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, Filter, int)) is usually more efficient, as it skips non-high-scoring hits.

Parameters
query to match documents
filter if non-null, used to permit documents to be collected.
results to receive hits

public TopFieldDocs search (Query query, Filter filter, int n, Sort sort)

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.

NOTE: this does not compute scores by default; use setDefaultFieldSortScoring(boolean, boolean) to enable scoring.

public void search (Query query, Collector results)

Lower-level search API.

collect(int) is called for every matching document.

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.

Note: The score passed to this method is a raw score. In other words, the score will not necessarily be a float whose value is between 0 and 1.

public TopDocs search (Query query, Filter filter, int n)

Finds the top n hits for query, applying filter if non-null.

public abstract TopDocs search (Weight weight, Filter filter, int n)

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 abstract TopFieldDocs search (Weight weight, Filter filter, int n, 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 setSimilarity (Similarity similarity)

Expert: Set the Similarity implementation used by this Searcher.

Protected Methods

protected Weight createWeight (Query query)

creates a weight for query

Returns
  • new weight
Throws
IOException