Module org.elasticsearch.server

Package org.elasticsearch.search.rank

Class RankSearchContext

java.lang.Object

org.elasticsearch.search.internal.SearchContext

org.elasticsearch.search.rank.RankSearchContext

All Implemented Interfaces:

Closeable, AutoCloseable, Releasable

public class RankSearchContext
extends SearchContext

Manages the appropriate values when executing multiple queries on behalf of ranking for a single ranking query.

Field Summary

Fields inherited from class org.elasticsearch.search.internal.SearchContext

DEFAULT_TERMINATE_AFTER, DEFAULT_TRACK_TOTAL_HITS_UP_TO, releasables, TRACK_TOTAL_HITS_ACCURATE, TRACK_TOTAL_HITS_DISABLED

Constructor Summary

Constructors

Constructor	Description
RankSearchContext(SearchContext parent, org.apache.lucene.search.Query rankQuery, int windowSize)

Method Summary

Modifier and Type	Method	Description
void	addDfsResult()	Indicates that the caller will be using, and thus owning, a DfsSearchResult object.
void	addFetchResult()	Indicates that the caller will be using, and thus owning, a FetchSearchResult object.
void	addQueryResult()	Indicates that the caller will be using, and thus owning, a QuerySearchResult object.
void	addRescore(RescoreContext rescore)
void	addSearchExt(SearchExtBuilder searchExtBuilder)
SearchContextAggregations	aggregations()	Aggregations are run as a separate query.
SearchContext	aggregations(SearchContextAggregations aggregations)
BitsetFilterCache	bitsetFilterCache()
org.apache.lucene.search.Query	buildFilteredQuery(org.apache.lucene.search.Query query)	Automatically apply all required filters to the given query such as alias filters, types filters, etc.
CollapseContext	collapse()	Collapse is not supported by ranking.
SearchContext	collapse(CollapseContext collapse)
DfsSearchResult	dfsResult()
FetchDocValuesContext	docValuesContext()
SearchContext	docValuesContext(FetchDocValuesContext docValuesContext)
boolean	explain()
void	explain(boolean explain)
FetchFieldsContext	fetchFieldsContext()	The context related to retrieving fields.
SearchContext	fetchFieldsContext(FetchFieldsContext fetchFieldsContext)	Sets the context related to retrieving fields.
FetchPhase	fetchPhase()
FetchSearchResult	fetchResult()
FetchSourceContext	fetchSourceContext()
SearchContext	fetchSourceContext(FetchSourceContext fetchSourceContext)
int	from()
SearchContext	from(int from)
float	getMaxScore()
Profilers	getProfilers()	Profiling is not supported by ranking.
long	getRelativeTimeInMillis()	Returns time in milliseconds that can be used for relative time calculations.
SearchExecutionContext	getSearchExecutionContext()
SearchExtBuilder	getSearchExt(String name)
SearchShardTask	getTask()
org.apache.lucene.search.TotalHits	getTotalHits()
List<String>	groupStats()
void	groupStats(List<String> groupStats)
boolean	hasScriptFields()
boolean	hasStoredFields()
SearchHighlightContext	highlight()
void	highlight(SearchHighlightContext highlight)
ShardSearchContextId	id()
IndexShard	indexShard()
InnerHitsContext	innerHits()
boolean	isCancelled()
boolean	lowLevelCancellation()	Indicates if the current index should perform frequent low level search cancellation check.
Float	minimumScore()
SearchContext	minimumScore(float minimumScore)
IdLoader	newIdLoader()
SourceLoader	newSourceLoader()	Build something to load source _source.
int	numberOfShards()
ParsedQuery	parsedPostFilter()
SearchContext	parsedPostFilter(ParsedQuery postFilter)
ParsedQuery	parsedQuery()
SearchContext	parsedQuery(ParsedQuery query)
void	preProcess()	Should be called before executing the main query and after all other parameters have been set.
org.apache.lucene.search.Query	query()	Use a single rank query.
QuerySearchResult	queryResult()	Use a separate query search result.
RankShardContext	rankShardContext()
void	rankShardContext(RankShardContext rankShardContext)
ReaderContext	readerContext()
ShardSearchRequest	request()
List<RescoreContext>	rescore()	Rescore is not supported by ranking.
ScriptFieldsContext	scriptFields()
ScrollContext	scrollContext()	Ranking is not allowed with scroll.
org.apache.lucene.search.FieldDoc	searchAfter()
SearchContext	searchAfter(org.apache.lucene.search.FieldDoc searchAfter)
ContextIndexSearcher	searcher()
SearchType	searchType()
boolean	seqNoAndPrimaryTerm()	indicates whether the sequence number and primary term of the last modification to each hit should be returned
void	seqNoAndPrimaryTerm(boolean seqNoAndPrimaryTerm)	controls whether the sequence number and primary term of the last modification to each hit should be returned
void	setTask(SearchShardTask task)
SearchShardTarget	shardTarget()
int	size()
SearchContext	size(int size)
SortAndFormats	sort()	Sort is not allowed with ranking.
SearchContext	sort(SortAndFormats sort)
String	source()
boolean	sourceRequested()	A shortcut function to see whether there is a fetchSourceContext and it says the source is requested.
StoredFieldsContext	storedFieldsContext()
SearchContext	storedFieldsContext(StoredFieldsContext storedFieldsContext)
SuggestionSearchContext	suggest()
void	suggest(SuggestionSearchContext suggest)
int	terminateAfter()
void	terminateAfter(int terminateAfter)
TimeValue	timeout()
void	timeout(TimeValue timeout)
boolean	trackScores()
SearchContext	trackScores(boolean trackScores)
int	trackTotalHitsUpTo()	Total hits are tracked as part of a separate query.
SearchContext	trackTotalHitsUpTo(int trackTotalHits)
boolean	version()
void	version(boolean version)

Methods inherited from class org.elasticsearch.search.internal.SearchContext

addReleasable, assignRescoreDocIds, close, hasOnlySuggest, rescoreDocIds, rewrittenQuery, toString

Methods inherited from class java.lang.Object

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

Constructor Details

RankSearchContext

public RankSearchContext(SearchContext parent,
 org.apache.lucene.search.Query rankQuery,
 int windowSize)

Method Details

request

public ShardSearchRequest request()

Specified by:

request in class SearchContext

shardTarget

public SearchShardTarget shardTarget()

Specified by:

shardTarget in class SearchContext

scrollContext

public ScrollContext scrollContext()

Ranking is not allowed with scroll.

Specified by:

scrollContext in class SearchContext

aggregations

public SearchContextAggregations aggregations()

Aggregations are run as a separate query.

Specified by:

aggregations in class SearchContext

rescore

public List<RescoreContext> rescore()

Rescore is not supported by ranking.

Specified by:

rescore in class SearchContext

Returns:

list of all rescore contexts. empty if there aren't any.

searcher

public ContextIndexSearcher searcher()

Specified by:

searcher in class SearchContext

indexShard

public IndexShard indexShard()

Specified by:

indexShard in class SearchContext

timeout

public TimeValue timeout()

Specified by:

timeout in class SearchContext

terminateAfter

public int terminateAfter()

Specified by:

terminateAfter in class SearchContext

minimumScore

public Float minimumScore()

Specified by:

minimumScore in class SearchContext

sort

public SortAndFormats sort()

Sort is not allowed with ranking.

Specified by:

sort in class SearchContext

trackScores

public boolean trackScores()

Specified by:

trackScores in class SearchContext

trackTotalHitsUpTo

public int trackTotalHitsUpTo()

Total hits are tracked as part of a separate query.

Specified by:

trackTotalHitsUpTo in class SearchContext

searchAfter

public org.apache.lucene.search.FieldDoc searchAfter()

Specified by:

searchAfter in class SearchContext

collapse

public CollapseContext collapse()

Collapse is not supported by ranking.

Specified by:

collapse in class SearchContext

parsedPostFilter

public ParsedQuery parsedPostFilter()

Specified by:

parsedPostFilter in class SearchContext

query

public org.apache.lucene.search.Query query()

Use a single rank query.

Specified by:

query in class SearchContext

from

public int from()

Specified by:

from in class SearchContext

size

public int size()

Specified by:

size in class SearchContext

queryResult

public QuerySearchResult queryResult()

Use a separate query search result.

Specified by:

queryResult in class SearchContext

getProfilers

public Profilers getProfilers()

Profiling is not supported by ranking.

Specified by:

getProfilers in class SearchContext

getRelativeTimeInMillis

public long getRelativeTimeInMillis()

Description copied from class: SearchContext

Returns time in milliseconds that can be used for relative time calculations. WARN: This is not the epoch time.

Specified by:

getRelativeTimeInMillis in class SearchContext

setTask

public void setTask(SearchShardTask task)

Specified by:

setTask in class SearchContext

getTask

public SearchShardTask getTask()

Specified by:

getTask in class SearchContext

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in class SearchContext

preProcess

public void preProcess()

Description copied from class: SearchContext

Should be called before executing the main query and after all other parameters have been set.

Specified by:

preProcess in class SearchContext

buildFilteredQuery

public org.apache.lucene.search.Query buildFilteredQuery(org.apache.lucene.search.Query query)

Description copied from class: SearchContext

Automatically apply all required filters to the given query such as alias filters, types filters, etc.

Specified by:

buildFilteredQuery in class SearchContext

id

public ShardSearchContextId id()

Specified by:

id in class SearchContext

source

public String source()

Specified by:

source in class SearchContext

searchType

public SearchType searchType()

Specified by:

searchType in class SearchContext

numberOfShards

public int numberOfShards()

Specified by:

numberOfShards in class SearchContext

aggregations

public SearchContext aggregations(SearchContextAggregations aggregations)

Specified by:

aggregations in class SearchContext

addSearchExt

public void addSearchExt(SearchExtBuilder searchExtBuilder)

Specified by:

addSearchExt in class SearchContext

getSearchExt

public SearchExtBuilder getSearchExt(String name)

Specified by:

getSearchExt in class SearchContext

highlight

public SearchHighlightContext highlight()

Specified by:

highlight in class SearchContext

highlight

public void highlight(SearchHighlightContext highlight)

Specified by:

highlight in class SearchContext

innerHits

public InnerHitsContext innerHits()

Overrides:

innerHits in class SearchContext

suggest

public SuggestionSearchContext suggest()

Specified by:

suggest in class SearchContext

suggest

public void suggest(SuggestionSearchContext suggest)

Specified by:

suggest in class SearchContext

rankShardContext

public RankShardContext rankShardContext()

Specified by:

rankShardContext in class SearchContext

rankShardContext

public void rankShardContext(RankShardContext rankShardContext)

Specified by:

rankShardContext in class SearchContext

addRescore

public void addRescore(RescoreContext rescore)

Specified by:

addRescore in class SearchContext

hasScriptFields

public boolean hasScriptFields()

Specified by:

hasScriptFields in class SearchContext

scriptFields

public ScriptFieldsContext scriptFields()

Specified by:

scriptFields in class SearchContext

sourceRequested

public boolean sourceRequested()

Description copied from class: SearchContext

A shortcut function to see whether there is a fetchSourceContext and it says the source is requested.

Specified by:

sourceRequested in class SearchContext

fetchSourceContext

public FetchSourceContext fetchSourceContext()

Specified by:

fetchSourceContext in class SearchContext

fetchSourceContext

public SearchContext fetchSourceContext(FetchSourceContext fetchSourceContext)

Specified by:

fetchSourceContext in class SearchContext

docValuesContext

public FetchDocValuesContext docValuesContext()

Specified by:

docValuesContext in class SearchContext

docValuesContext

public SearchContext docValuesContext(FetchDocValuesContext docValuesContext)

Specified by:

docValuesContext in class SearchContext

fetchFieldsContext

public FetchFieldsContext fetchFieldsContext()

Description copied from class: SearchContext

The context related to retrieving fields.

Specified by:

fetchFieldsContext in class SearchContext

fetchFieldsContext

public SearchContext fetchFieldsContext(FetchFieldsContext fetchFieldsContext)

Description copied from class: SearchContext

Sets the context related to retrieving fields.

Specified by:

fetchFieldsContext in class SearchContext

bitsetFilterCache

public BitsetFilterCache bitsetFilterCache()

Specified by:

bitsetFilterCache in class SearchContext

timeout

public void timeout(TimeValue timeout)

Specified by:

timeout in class SearchContext

terminateAfter

public void terminateAfter(int terminateAfter)

Specified by:

terminateAfter in class SearchContext

lowLevelCancellation

public boolean lowLevelCancellation()

Description copied from class: SearchContext

Indicates if the current index should perform frequent low level search cancellation check. Enabling low-level checks will make long running searches to react to the cancellation request faster. However, since it will produce more cancellation checks it might slow the search performance down.

Specified by:

lowLevelCancellation in class SearchContext

minimumScore

public SearchContext minimumScore(float minimumScore)

Specified by:

minimumScore in class SearchContext

sort

public SearchContext sort(SortAndFormats sort)

Specified by:

sort in class SearchContext

trackScores

public SearchContext trackScores(boolean trackScores)

Specified by:

trackScores in class SearchContext

trackTotalHitsUpTo

public SearchContext trackTotalHitsUpTo(int trackTotalHits)

Specified by:

trackTotalHitsUpTo in class SearchContext

searchAfter

public SearchContext searchAfter(org.apache.lucene.search.FieldDoc searchAfter)

Specified by:

searchAfter in class SearchContext

collapse

public SearchContext collapse(CollapseContext collapse)

Specified by:

collapse in class SearchContext

parsedPostFilter

public SearchContext parsedPostFilter(ParsedQuery postFilter)

Specified by:

parsedPostFilter in class SearchContext

parsedQuery

public SearchContext parsedQuery(ParsedQuery query)

Specified by:

parsedQuery in class SearchContext

parsedQuery

public ParsedQuery parsedQuery()

Specified by:

parsedQuery in class SearchContext

from

public SearchContext from(int from)

Specified by:

from in class SearchContext

size

public SearchContext size(int size)

Specified by:

size in class SearchContext

hasStoredFields

public boolean hasStoredFields()

Specified by:

hasStoredFields in class SearchContext

storedFieldsContext

public StoredFieldsContext storedFieldsContext()

Specified by:

storedFieldsContext in class SearchContext

storedFieldsContext

public SearchContext storedFieldsContext(StoredFieldsContext storedFieldsContext)

Specified by:

storedFieldsContext in class SearchContext

explain

public boolean explain()

Specified by:

explain in class SearchContext

explain

public void explain(boolean explain)

Specified by:

explain in class SearchContext

groupStats

public List<String> groupStats()

Specified by:

groupStats in class SearchContext

groupStats

public void groupStats(List<String> groupStats)

Specified by:

groupStats in class SearchContext

version

public boolean version()

Specified by:

version in class SearchContext

version

public void version(boolean version)

Specified by:

version in class SearchContext

seqNoAndPrimaryTerm

public boolean seqNoAndPrimaryTerm()

Description copied from class: SearchContext

indicates whether the sequence number and primary term of the last modification to each hit should be returned

Specified by:

seqNoAndPrimaryTerm in class SearchContext

seqNoAndPrimaryTerm

public void seqNoAndPrimaryTerm(boolean seqNoAndPrimaryTerm)

Description copied from class: SearchContext

controls whether the sequence number and primary term of the last modification to each hit should be returned

Specified by:

seqNoAndPrimaryTerm in class SearchContext

dfsResult

public DfsSearchResult dfsResult()

Specified by:

dfsResult in class SearchContext

addDfsResult

public void addDfsResult()

Description copied from class: SearchContext

Indicates that the caller will be using, and thus owning, a DfsSearchResult object. It is the caller's responsibility to correctly cleanup this result object.

Specified by:

addDfsResult in class SearchContext

addQueryResult

public void addQueryResult()

Description copied from class: SearchContext

Indicates that the caller will be using, and thus owning, a QuerySearchResult object. It is the caller's responsibility to correctly cleanup this result object.

Specified by:

addQueryResult in class SearchContext

getTotalHits

public org.apache.lucene.search.TotalHits getTotalHits()

Specified by:

getTotalHits in class SearchContext

getMaxScore

public float getMaxScore()

Specified by:

getMaxScore in class SearchContext

fetchPhase

public FetchPhase fetchPhase()

Specified by:

fetchPhase in class SearchContext

fetchResult

public FetchSearchResult fetchResult()

Specified by:

fetchResult in class SearchContext

addFetchResult

public void addFetchResult()

Description copied from class: SearchContext

Indicates that the caller will be using, and thus owning, a FetchSearchResult object. It is the caller's responsibility to correctly cleanup this result object.

Specified by:

addFetchResult in class SearchContext

getSearchExecutionContext

public SearchExecutionContext getSearchExecutionContext()

Specified by:

getSearchExecutionContext in class SearchContext

readerContext

public ReaderContext readerContext()

Specified by:

readerContext in class SearchContext

newSourceLoader

public SourceLoader newSourceLoader()

Description copied from class: SearchContext

Build something to load source _source.

Specified by:

newSourceLoader in class SearchContext

newIdLoader

public IdLoader newIdLoader()

Specified by:

newIdLoader in class SearchContext