org.elasticsearch.search.rescore

Class QueryRescorer

java.lang.Object

org.elasticsearch.search.rescore.QueryRescorer

All Implemented Interfaces:

Rescorer

public final class QueryRescorer
extends Object
implements Rescorer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryRescorer.QueryRescoreContext

Field Summary

Fields

Modifier and Type	Field and Description
static Rescorer	INSTANCE
static String	NAME

Constructor Summary

Constructors

Constructor and Description
QueryRescorer()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.search.Explanation	explain(int topLevelDocId, SearchContext context, RescoreSearchContext rescoreContext, org.apache.lucene.search.Explanation sourceExplanation) Executes an Explanation phase on the rescorer.
void	extractTerms(SearchContext context, RescoreSearchContext rescoreContext, Set<org.apache.lucene.index.Term> termsSet) Extracts all terms needed to exectue this Rescorer.
String	name() Returns the name of this rescorer
RescoreSearchContext	parse(XContentParser parser, SearchContext context) Parses the RescoreSearchContext for this impelementation
org.apache.lucene.search.TopDocs	rescore(org.apache.lucene.search.TopDocs topDocs, SearchContext context, RescoreSearchContext rescoreContext) Modifies the result of the previously executed search (TopDocs) in place based on the given RescoreSearchContext.

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

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

QueryRescorer

public QueryRescorer()

Method Detail

name

public String name()

Description copied from interface: Rescorer

Returns the name of this rescorer

Specified by:

name in interface Rescorer

rescore

public org.apache.lucene.search.TopDocs rescore(org.apache.lucene.search.TopDocs topDocs,
                                       SearchContext context,
                                       RescoreSearchContext rescoreContext)
                                         throws IOException

Description copied from interface: Rescorer

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

Specified by:

rescore in interface Rescorer

Parameters:

topDocs - the result of the previously exectued search

context - the current SearchContext. This will never be null.

rescoreContext - the RescoreSearchContext. This will never be null

Throws:

IOException - if an IOException occurs during rescoring

explain

public org.apache.lucene.search.Explanation explain(int topLevelDocId,
                                           SearchContext context,
                                           RescoreSearchContext rescoreContext,
                                           org.apache.lucene.search.Explanation sourceExplanation)
                                             throws 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

context - the explanation for the results being fed to this rescorer

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:

IOException - if an IOException occurs

parse

public RescoreSearchContext parse(XContentParser parser,
                         SearchContext context)
                           throws IOException

Description copied from interface: Rescorer

Parses the RescoreSearchContext for this impelementation

Specified by:

parse in interface Rescorer

Parameters:

parser - the parser to read the context from

context - the current search context

Returns:

the parsed RescoreSearchContext

Throws:

IOException - if an IOException occurs while parsing the context

extractTerms

public void extractTerms(SearchContext context,
                RescoreSearchContext rescoreContext,
                Set<org.apache.lucene.index.Term> termsSet)

Description copied from interface: Rescorer

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

Specified by:

extractTerms in interface Rescorer