Module org.elasticsearch.server

Package org.elasticsearch.search.rank

Class RankCoordinatorContext

java.lang.Object

org.elasticsearch.search.rank.RankCoordinatorContext

public abstract class RankCoordinatorContext
extends Object

RankContext is a base class used to generate ranking results on the coordinator and then set the rank for any search hits that are found.

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	from
protected final int	size
protected final int	windowSize

Constructor Summary

Constructors

Constructor	Description
RankCoordinatorContext(int size, int from, int windowSize)

Method Summary

Modifier and Type	Method	Description
abstract SearchPhaseController.SortedTopDocs	rank(List<QuerySearchResult> querySearchResults, SearchPhaseController.TopDocsStats topDocStats)	This is used to pull information passed back from the shards as part of QuerySearchResult.getRankShardResult() and return a SearchPhaseController.SortedTopDocs of the final rank results.

Methods inherited from class java.lang.Object

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

Field Details

size

protected final int size

from

protected final int from

windowSize

protected final int windowSize

Constructor Details

RankCoordinatorContext

public RankCoordinatorContext(int size,
 int from,
 int windowSize)

Method Details

rank

public abstract SearchPhaseController.SortedTopDocs rank(List<QuerySearchResult> querySearchResults,
 SearchPhaseController.TopDocsStats topDocStats)

This is used to pull information passed back from the shards as part of QuerySearchResult.getRankShardResult() and return a SearchPhaseController.SortedTopDocs of the final rank results. Note that SearchPhaseController.TopDocsStats is included so that appropriate stats may be updated based on rank results. This is called at the end of the query phase prior to the fetch phase.