Class Searcher

public abstract 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.

Specified by:

close in interface Searchable

protected Weight createWeight(Query query)
            throws IOException

creates a weight for query

Returns:

new weight

public abstract Document doc(int i)
            throws IOException

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

Specified by:

doc in interface Searchable

See Also:

IndexReader.document(int)

public abstract int docFreq(Term term)
            throws IOException

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

Specified by:

docFreq in interface Searchable

See Also:

IndexReader.docFreq(Term)

public int[] docFreqs(Term[] terms)
            throws IOException

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.

Specified by:

docFreqs in interface Searchable

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.

Specified by:

explain in interface Searchable

public abstract Explanation explain(Weight weight,
                                    int doc)
            throws IOException

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).

Specified by:

explain in interface Searchable

public Similarity getSimilarity()

Expert: Return the Similarity implementation used by this Searcher.

This defaults to the current value of Similarity.getDefault().

public abstract int maxDoc()
            throws IOException

Expert: Returns one greater than the largest possible document number. Called by search code to compute term weights.

Specified by:

maxDoc in interface Searchable

See Also:

IndexReader.maxDoc()

public abstract Query rewrite(Query query)
            throws IOException

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

Specified by:

rewrite in interface Searchable

public final Hits search(Query query)
            throws IOException

Returns the documents matching query.

public Hits search(Query query,
                   Filter filter)
            throws IOException

Returns the documents matching query and filter.

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

Specified by:

search in interface Searchable

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

Specified by:

search in interface Searchable

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.
HitCollector-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)) is usually more efficient, as it skips non-high-scoring hits.

Specified by:

search in interface Searchable

Parameters:

query - to match documents

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

results - to receive hits

public Hits search(Query query,
                   Filter filter,
                   Sort sort)
            throws IOException

Returns documents matching query and filter, sorted by sort.

public void search(Query query,
                   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 (search(Query)) 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 Hits search(Query query,
                   Sort sort)
            throws IOException

Returns documents matching query sorted by sort.

public abstract TopDocs search(Weight weight,
                               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 search(Query) or search(Query,Filter) instead.

Specified by:

search in interface Searchable

public abstract TopFieldDocs search(Weight weight,
                                    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 search(Query,Filter,Sort) instead.

Specified by:

search in interface Searchable

public abstract void search(Weight weight,
                            Filter filter,
                            HitCollector results)
            throws IOException

Lower-level search API.

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

Specified by:

search in interface Searchable

Parameters:

weight - to match documents

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

results - to receive hits

public void setSimilarity(Similarity similarity)

Expert: Set the Similarity implementation used by this Searcher.

See Also:

Similarity.setDefault(Similarity)