Package org.elasticsearch.search.rescore

Class QueryRescorer

java.lang.Object

org.elasticsearch.search.rescore.QueryRescorer

All Implemented Interfaces:

Rescorer

public final class QueryRescorer
extends java.lang.Object
implements Rescorer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryRescorer.QueryRescoreContext

Field Summary

Fields

Modifier and Type	Field	Description
static Rescorer	INSTANCE

Constructor Summary

Constructors

Constructor	Description
QueryRescorer()

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.Explanation	explain(int topLevelDocId, org.apache.lucene.search.IndexSearcher searcher, RescoreContext rescoreContext, org.apache.lucene.search.Explanation sourceExplanation)	Executes an Explanation phase on the rescorer.
void	extractTerms(org.apache.lucene.search.IndexSearcher searcher, RescoreContext rescoreContext, java.util.Set<org.apache.lucene.index.Term> termsSet)	Extracts all terms needed to execute this Rescorer.
org.apache.lucene.search.TopDocs	rescore(org.apache.lucene.search.TopDocs topDocs, org.apache.lucene.search.IndexSearcher searcher, RescoreContext rescoreContext)	Modifies the result of the previously executed search (TopDocs) in place based on the given RescoreContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final Rescorer INSTANCE

Constructor Detail

QueryRescorer

public QueryRescorer()

Method Detail

rescore

public org.apache.lucene.search.TopDocs rescore(org.apache.lucene.search.TopDocs topDocs,
                                                org.apache.lucene.search.IndexSearcher searcher,
                                                RescoreContext rescoreContext)
                                         throws java.io.IOException

Description copied from interface: Rescorer

Modifies the result of the previously executed search (TopDocs) in place based on the given RescoreContext.

Specified by:

rescore in interface Rescorer

Parameters:

topDocs - the result of the previously executed search

searcher - the searcher used for this search. This will never be null.

rescoreContext - the RescoreContext. This will never be null

Throws:

java.io.IOException - if an IOException occurs during rescoring

explain

public org.apache.lucene.search.Explanation explain(int topLevelDocId,
                                                    org.apache.lucene.search.IndexSearcher searcher,
                                                    RescoreContext rescoreContext,
                                                    org.apache.lucene.search.Explanation sourceExplanation)
                                             throws java.io.IOException

Description copied from interface: Rescorer

Executes an Explanation phase on the rescorer.

Specified by:

explain in interface Rescorer

Parameters:

topLevelDocId - the global / top-level document ID to explain

searcher - the searcher used for this search. This will never be null.

rescoreContext - context for this rescorer

sourceExplanation - explanation of the source of the documents being fed into this rescore

Returns:

the explain for the given top level document ID.

Throws:

java.io.IOException - if an IOException occurs

extractTerms

public void extractTerms(org.apache.lucene.search.IndexSearcher searcher,
                         RescoreContext rescoreContext,
                         java.util.Set<org.apache.lucene.index.Term> termsSet)
                  throws java.io.IOException

Description copied from interface: Rescorer

Extracts all terms needed to execute this Rescorer. This method is executed in a distributed frequency collection roundtrip for SearchType.DFS_QUERY_THEN_FETCH

Specified by:

extractTerms in interface Rescorer

Throws:

java.io.IOException