org.hibernate.search.backend.lucene.search.query

Interface LuceneSearchQuery<H>

All Superinterfaces:

ExtendedSearchFetchable<H,LuceneSearchResult<H>>, ExtendedSearchQuery<H,LuceneSearchResult<H>>, LuceneSearchFetchable<H>, SearchFetchable<H>, SearchQuery<H>

public interface LuceneSearchQuery<H>
extends ExtendedSearchQuery<H,LuceneSearchResult<H>>, LuceneSearchFetchable<H>

Method Summary

Modifier and Type	Method and Description
Explanation	explain(String id) Explain score computation of this query for the document with the given id.
Explanation	explain(String indexName, String id) Explain score computation of this query for the document with the given id in the given index.

Methods inherited from interface org.hibernate.search.engine.search.query.SearchQuery

extension, getQueryString

Methods inherited from interface org.hibernate.search.engine.search.query.ExtendedSearchFetchable

fetch, fetch, fetch, fetchAll

Methods inherited from interface org.hibernate.search.engine.search.query.SearchFetchable

fetchAllHits, fetchHits, fetchHits, fetchHits, fetchSingleHit, fetchTotalHitCount

Method Detail

explain

Explanation explain(String id)

Explain score computation of this query for the document with the given id.

This is a shorthand for explain(String, String) when the query only targets one index.

Parameters:

id - The id of the document to test.

Returns:

An Explanation describing the score computation for the hit.

Throws:

org.hibernate.search.util.common.SearchException - If the query targets multiple indexes, or if the explain request fails.

explain

Explanation explain(String indexName,
                    String id)

Explain score computation of this query for the document with the given id in the given index.

This feature is relatively expensive, use it only sparingly and when you need to debug a slow query.

Parameters:

indexName - The name of the index containing the document to test.

id - The id of the document to test.

Returns:

An Explanation describing the score computation for the hit.

Throws:

org.hibernate.search.util.common.SearchException - If the given index name does not refer to an index targeted by this query, or if the explain request fails.