Interface Searchable

public void close()
            throws IOException

Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects like Hits.

public Document doc(int i)
            throws IOException

Expert: Returns the stored fields of document i. Called by HitCollector implementations.

See Also:

IndexReader.document(int).

public int docFreq(Term term)
            throws IOException

Expert: Returns the number of documents containing term. Called by search code to compute term weights.

See Also:

IndexReader.docFreq(Term).

public Explanation explain(Query query,
                           int doc)
            throws IOException

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.

public Query rewrite(Query query)
            throws IOException

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

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

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

Called by Hits.

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

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

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 Searcher.search(Query,Filter,Sort) instead.

public void search(Query query,
                   Filter filter,
                   HitCollector results)
            throws IOException

Lower-level search API.

HitCollector.collect(int,float) is called for every non-zero scoring document.

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

Parameters:

query - to match documents

filter - if non-null, a bitset used to eliminate some documents

results - to receive hits