Package org.elasticsearch.search.internal

Class SubSearchContext

java.lang.Object

org.elasticsearch.search.internal.SearchContext

org.elasticsearch.search.internal.FilteredSearchContext

org.elasticsearch.search.internal.SubSearchContext

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.elasticsearch.common.lease.Releasable

Direct Known Subclasses:

InnerHitsContext.InnerHitSubContext

public class SubSearchContext
extends FilteredSearchContext

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
SubSearchContext(SearchContext context)

Method Summary

Modifier and Type	Method	Description
SearchContext	aggregations(SearchContextAggregations aggregations)
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()
int[]	docIdsToLoad()
SearchContext	docIdsToLoad(int[] docIdsToLoad, int docsIdsToLoadSize)
int	docIdsToLoadSize()
FetchDocValuesContext	docValuesContext()
SearchContext	docValuesContext(FetchDocValuesContext docValuesContext)
boolean	explain()
void	explain(boolean explain)
FetchFieldsContext	fetchFieldsContext()	The context related to retrieving fields.
SubSearchContext	fetchFieldsContext(FetchFieldsContext fetchFieldsContext)	Sets the context related to retrieving fields.
FetchSearchResult	fetchResult()
FetchSourceContext	fetchSourceContext()
SearchContext	fetchSourceContext(FetchSourceContext fetchSourceContext)
int	from()
SearchContext	from(int from)
long	getRelativeTimeInMillis()	Returns time in milliseconds that can be used for relative time calculations.
void	groupStats(java.util.List<java.lang.String> groupStats)
boolean	hasFetchSourceContext()
boolean	hasScriptFields()
boolean	hasStoredFields()
SearchHighlightContext	highlight()
void	highlight(SearchHighlightContext highlight)
SearchContext	minimumScore(float minimumScore)
SearchContext	parsedPostFilter(ParsedQuery postFilter)
ParsedQuery	parsedQuery()
SubSearchContext	parsedQuery(ParsedQuery parsedQuery)
void	preProcess(boolean rewrite)	Should be called before executing the main query and after all other parameters have been set.
org.apache.lucene.search.Query	query()	The query to execute, might be rewritten.
QuerySearchResult	queryResult()
ScriptFieldsContext	scriptFields()
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
int	size()
SearchContext	size(int size)
SortAndFormats	sort()
SearchContext	sort(SortAndFormats sort)
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)
void	suggest(SuggestionSearchContext suggest)
void	terminateAfter(int terminateAfter)
void	timeout(org.elasticsearch.common.unit.TimeValue timeout)
boolean	trackScores()
SearchContext	trackScores(boolean trackScores)
boolean	version()
void	version(boolean version)

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

addRescore, addSearchExt, aggregations, bitsetFilterCache, collapse, dfsResult, fetchPhase, getProfilers, getSearchExecutionContext, getSearchExt, getTask, groupStats, id, indexShard, innerHits, isCancelled, lowLevelCancellation, minimumScore, numberOfShards, parsedPostFilter, queryCollectors, readerContext, request, rescore, scrollContext, searchAfter, searchAfter, searcher, searchType, setTask, shardTarget, source, suggest, terminateAfter, timeout, trackTotalHitsUpTo, trackTotalHitsUpTo

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

addReleasable, assignRescoreDocIds, close, hasOnlySuggest, rescoreDocIds, toString

Methods inherited from class java.lang.Object

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

Constructor Details

SubSearchContext

public SubSearchContext(SearchContext context)

Method Details

preProcess

public void preProcess(boolean rewrite)

Description copied from class: SearchContext

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

Overrides:

preProcess in class FilteredSearchContext

Parameters:

rewrite - if the set query should be rewritten against the searcher returned from SearchContext.searcher()

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.

Overrides:

buildFilteredQuery in class FilteredSearchContext

aggregations

public SearchContext aggregations(SearchContextAggregations aggregations)

Overrides:

aggregations in class FilteredSearchContext

highlight

public SearchHighlightContext highlight()

Overrides:

highlight in class FilteredSearchContext

highlight

public void highlight(SearchHighlightContext highlight)

Overrides:

highlight in class FilteredSearchContext

suggest

public void suggest(SuggestionSearchContext suggest)

Overrides:

suggest in class FilteredSearchContext

hasScriptFields

public boolean hasScriptFields()

Overrides:

hasScriptFields in class FilteredSearchContext

scriptFields

public ScriptFieldsContext scriptFields()

Overrides:

scriptFields in class FilteredSearchContext

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.

Overrides:

sourceRequested in class FilteredSearchContext

hasFetchSourceContext

public boolean hasFetchSourceContext()

Overrides:

hasFetchSourceContext in class FilteredSearchContext

fetchSourceContext

public FetchSourceContext fetchSourceContext()

Overrides:

fetchSourceContext in class FilteredSearchContext

fetchSourceContext

public SearchContext fetchSourceContext(FetchSourceContext fetchSourceContext)

Overrides:

fetchSourceContext in class FilteredSearchContext

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 SubSearchContext fetchFieldsContext(FetchFieldsContext fetchFieldsContext)

Description copied from class: SearchContext

Sets the context related to retrieving fields.

Specified by:

fetchFieldsContext in class SearchContext

timeout

public void timeout(org.elasticsearch.common.unit.TimeValue timeout)

Overrides:

timeout in class FilteredSearchContext

terminateAfter

public void terminateAfter(int terminateAfter)

Overrides:

terminateAfter in class FilteredSearchContext

minimumScore

public SearchContext minimumScore(float minimumScore)

Overrides:

minimumScore in class FilteredSearchContext

sort

public SearchContext sort(SortAndFormats sort)

Overrides:

sort in class FilteredSearchContext

sort

public SortAndFormats sort()

Overrides:

sort in class FilteredSearchContext

parsedQuery

public SubSearchContext parsedQuery(ParsedQuery parsedQuery)

Overrides:

parsedQuery in class FilteredSearchContext

parsedQuery

public ParsedQuery parsedQuery()

Overrides:

parsedQuery in class FilteredSearchContext

query

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

Description copied from class: SearchContext

The query to execute, might be rewritten.

Overrides:

query in class FilteredSearchContext

trackScores

public SearchContext trackScores(boolean trackScores)

Overrides:

trackScores in class FilteredSearchContext

trackScores

public boolean trackScores()

Overrides:

trackScores in class FilteredSearchContext

parsedPostFilter

public SearchContext parsedPostFilter(ParsedQuery postFilter)

Overrides:

parsedPostFilter in class FilteredSearchContext

from

public int from()

Overrides:

from in class FilteredSearchContext

from

public SearchContext from(int from)

Overrides:

from in class FilteredSearchContext

size

public int size()

Overrides:

size in class FilteredSearchContext

size

public SearchContext size(int size)

Overrides:

size in class FilteredSearchContext

hasStoredFields

public boolean hasStoredFields()

Overrides:

hasStoredFields in class FilteredSearchContext

storedFieldsContext

public StoredFieldsContext storedFieldsContext()

Overrides:

storedFieldsContext in class FilteredSearchContext

storedFieldsContext

public SearchContext storedFieldsContext(StoredFieldsContext storedFieldsContext)

Overrides:

storedFieldsContext in class FilteredSearchContext

explain

public boolean explain()

Overrides:

explain in class FilteredSearchContext

explain

public void explain(boolean explain)

Overrides:

explain in class FilteredSearchContext

groupStats

public void groupStats(java.util.List<java.lang.String> groupStats)

Overrides:

groupStats in class FilteredSearchContext

version

public boolean version()

Overrides:

version in class FilteredSearchContext

version

public void version(boolean version)

Overrides:

version in class FilteredSearchContext

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

Overrides:

seqNoAndPrimaryTerm in class FilteredSearchContext

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

Overrides:

seqNoAndPrimaryTerm in class FilteredSearchContext

docIdsToLoad

public int[] docIdsToLoad()

Overrides:

docIdsToLoad in class FilteredSearchContext

docIdsToLoadSize

public int docIdsToLoadSize()

Specified by:

docIdsToLoadSize in class SearchContext

docIdsToLoad

public SearchContext docIdsToLoad(int[] docIdsToLoad,
int docsIdsToLoadSize)

Overrides:

docIdsToLoad in class FilteredSearchContext

collapse

public CollapseContext collapse()

Overrides:

collapse in class FilteredSearchContext

queryResult

public QuerySearchResult queryResult()

Overrides:

queryResult in class FilteredSearchContext

fetchResult

public FetchSearchResult fetchResult()

Overrides:

fetchResult in class FilteredSearchContext

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.

Overrides:

getRelativeTimeInMillis in class FilteredSearchContext