Class SubSearchContext
- java.lang.Object
-
- org.elasticsearch.common.util.concurrent.AbstractRefCounted
-
- org.elasticsearch.search.internal.SearchContext
-
- org.elasticsearch.search.internal.FilteredSearchContext
-
- org.elasticsearch.search.internal.SubSearchContext
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,Releasable
,RefCounted
- Direct Known Subclasses:
InnerHitsContext.InnerHitSubContext
public class SubSearchContext extends FilteredSearchContext
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.search.internal.SearchContext
SearchContext.Lifetime
-
-
Field Summary
-
Fields inherited from class org.elasticsearch.search.internal.SearchContext
DEFAULT_TERMINATE_AFTER
-
-
Constructor Summary
Constructors Constructor Description SubSearchContext(SearchContext context)
-
Method Summary
Modifier and Type Method Description void
accessed(long accessTime)
void
addRescore(RescoreContext rescore)
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 docsIdsToLoadFrom, int docsIdsToLoadSize)
int
docIdsToLoadFrom()
int
docIdsToLoadSize()
protected void
doClose()
DocValueFieldsContext
docValueFieldsContext()
SearchContext
docValueFieldsContext(DocValueFieldsContext docValueFieldsContext)
boolean
explain()
void
explain(boolean explain)
FetchSearchResult
fetchResult()
FetchSourceContext
fetchSourceContext()
SearchContext
fetchSourceContext(FetchSourceContext fetchSourceContext)
int
from()
SearchContext
from(int from)
void
groupStats(java.util.List<java.lang.String> groupStats)
boolean
hasFetchSourceContext()
boolean
hasScriptFields()
boolean
hasStoredFields()
boolean
hasStoredFieldsContext()
SearchContextHighlight
highlight()
void
highlight(SearchContextHighlight highlight)
void
keepAlive(long keepAlive)
SearchContext
minimumScore(float minimumScore)
SearchContext
parsedPostFilter(ParsedQuery postFilter)
ParsedQuery
parsedQuery()
SearchContext
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()
SearchContext
scrollContext(ScrollContext scrollContext)
boolean
seqNoAndPrimaryTerm()
indicates whether the sequence number and primary term of the last modification to each hit should be returnedvoid
seqNoAndPrimaryTerm(boolean seqNoAndPrimaryTerm)
controls whether the sequence number and primary term of the last modification to each hit should be returnedint
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)
boolean
storedFieldsRequested()
A shortcut function to see whether there is a storedFieldsContext and it says the fields are requested.void
suggest(SuggestionSearchContext suggest)
void
terminateAfter(int terminateAfter)
org.apache.lucene.util.Counter
timeEstimateCounter()
void
timeout(TimeValue timeout)
boolean
trackScores()
SearchContext
trackScores(boolean trackScores)
boolean
version()
void
version(boolean version)
-
Methods inherited from class org.elasticsearch.search.internal.FilteredSearchContext
addSearchExt, aggregations, aliasFilter, bigArrays, bitsetFilterCache, collapse, dfsResult, fetchPhase, getForField, getObjectMapper, getOriginNanoTime, getProfilers, getQueryShardContext, getSearchExt, getTask, groupStats, id, indexShard, innerHits, isCancelled, keepAlive, lastAccessTime, lookup, lowLevelCancellation, mapperService, minimumScore, numberOfShards, parsedPostFilter, queryBoost, queryCollectors, request, rescore, scrollContext, searchAfter, searchAfter, searcher, searchType, setTask, shardTarget, similarityService, smartNameFieldType, source, suggest, terminateAfter, timeout, trackTotalHits, trackTotalHits
-
Methods inherited from class org.elasticsearch.search.internal.SearchContext
addReleasable, alreadyClosed, clearReleasables, close, closeInternal, hasOnlySuggest, toString
-
-
-
-
Constructor Detail
-
SubSearchContext
public SubSearchContext(SearchContext context)
-
-
Method Detail
-
doClose
protected void doClose()
- Overrides:
doClose
in classFilteredSearchContext
-
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 classFilteredSearchContext
- Parameters:
rewrite
- if the set query should be rewritten against the searcher returned fromSearchContext.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 classFilteredSearchContext
-
scrollContext
public SearchContext scrollContext(ScrollContext scrollContext)
- Overrides:
scrollContext
in classFilteredSearchContext
-
aggregations
public SearchContext aggregations(SearchContextAggregations aggregations)
- Overrides:
aggregations
in classFilteredSearchContext
-
highlight
public SearchContextHighlight highlight()
- Overrides:
highlight
in classFilteredSearchContext
-
highlight
public void highlight(SearchContextHighlight highlight)
- Overrides:
highlight
in classFilteredSearchContext
-
suggest
public void suggest(SuggestionSearchContext suggest)
- Overrides:
suggest
in classFilteredSearchContext
-
addRescore
public void addRescore(RescoreContext rescore)
- Overrides:
addRescore
in classFilteredSearchContext
-
hasScriptFields
public boolean hasScriptFields()
- Overrides:
hasScriptFields
in classFilteredSearchContext
-
scriptFields
public ScriptFieldsContext scriptFields()
- Overrides:
scriptFields
in classFilteredSearchContext
-
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 classFilteredSearchContext
-
hasFetchSourceContext
public boolean hasFetchSourceContext()
- Overrides:
hasFetchSourceContext
in classFilteredSearchContext
-
fetchSourceContext
public FetchSourceContext fetchSourceContext()
- Overrides:
fetchSourceContext
in classFilteredSearchContext
-
fetchSourceContext
public SearchContext fetchSourceContext(FetchSourceContext fetchSourceContext)
- Overrides:
fetchSourceContext
in classFilteredSearchContext
-
docValueFieldsContext
public DocValueFieldsContext docValueFieldsContext()
- Specified by:
docValueFieldsContext
in classSearchContext
-
docValueFieldsContext
public SearchContext docValueFieldsContext(DocValueFieldsContext docValueFieldsContext)
- Specified by:
docValueFieldsContext
in classSearchContext
-
timeout
public void timeout(TimeValue timeout)
- Overrides:
timeout
in classFilteredSearchContext
-
terminateAfter
public void terminateAfter(int terminateAfter)
- Overrides:
terminateAfter
in classFilteredSearchContext
-
minimumScore
public SearchContext minimumScore(float minimumScore)
- Overrides:
minimumScore
in classFilteredSearchContext
-
sort
public SearchContext sort(SortAndFormats sort)
- Overrides:
sort
in classFilteredSearchContext
-
sort
public SortAndFormats sort()
- Overrides:
sort
in classFilteredSearchContext
-
parsedQuery
public SearchContext parsedQuery(ParsedQuery parsedQuery)
- Overrides:
parsedQuery
in classFilteredSearchContext
-
parsedQuery
public ParsedQuery parsedQuery()
- Overrides:
parsedQuery
in classFilteredSearchContext
-
query
public org.apache.lucene.search.Query query()
Description copied from class:SearchContext
The query to execute, might be rewritten.- Overrides:
query
in classFilteredSearchContext
-
trackScores
public SearchContext trackScores(boolean trackScores)
- Overrides:
trackScores
in classFilteredSearchContext
-
trackScores
public boolean trackScores()
- Overrides:
trackScores
in classFilteredSearchContext
-
parsedPostFilter
public SearchContext parsedPostFilter(ParsedQuery postFilter)
- Overrides:
parsedPostFilter
in classFilteredSearchContext
-
from
public int from()
- Overrides:
from
in classFilteredSearchContext
-
from
public SearchContext from(int from)
- Overrides:
from
in classFilteredSearchContext
-
size
public int size()
- Overrides:
size
in classFilteredSearchContext
-
size
public SearchContext size(int size)
- Overrides:
size
in classFilteredSearchContext
-
hasStoredFields
public boolean hasStoredFields()
- Overrides:
hasStoredFields
in classFilteredSearchContext
-
hasStoredFieldsContext
public boolean hasStoredFieldsContext()
- Overrides:
hasStoredFieldsContext
in classFilteredSearchContext
-
storedFieldsRequested
public boolean storedFieldsRequested()
Description copied from class:SearchContext
A shortcut function to see whether there is a storedFieldsContext and it says the fields are requested.- Overrides:
storedFieldsRequested
in classFilteredSearchContext
-
storedFieldsContext
public StoredFieldsContext storedFieldsContext()
- Overrides:
storedFieldsContext
in classFilteredSearchContext
-
storedFieldsContext
public SearchContext storedFieldsContext(StoredFieldsContext storedFieldsContext)
- Overrides:
storedFieldsContext
in classFilteredSearchContext
-
explain
public boolean explain()
- Overrides:
explain
in classFilteredSearchContext
-
explain
public void explain(boolean explain)
- Overrides:
explain
in classFilteredSearchContext
-
groupStats
public void groupStats(java.util.List<java.lang.String> groupStats)
- Overrides:
groupStats
in classFilteredSearchContext
-
version
public boolean version()
- Overrides:
version
in classFilteredSearchContext
-
version
public void version(boolean version)
- Overrides:
version
in classFilteredSearchContext
-
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 classFilteredSearchContext
-
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 classFilteredSearchContext
-
docIdsToLoad
public int[] docIdsToLoad()
- Overrides:
docIdsToLoad
in classFilteredSearchContext
-
docIdsToLoadFrom
public int docIdsToLoadFrom()
- Overrides:
docIdsToLoadFrom
in classFilteredSearchContext
-
docIdsToLoadSize
public int docIdsToLoadSize()
- Overrides:
docIdsToLoadSize
in classFilteredSearchContext
-
docIdsToLoad
public SearchContext docIdsToLoad(int[] docIdsToLoad, int docsIdsToLoadFrom, int docsIdsToLoadSize)
- Overrides:
docIdsToLoad
in classFilteredSearchContext
-
collapse
public CollapseContext collapse()
- Overrides:
collapse
in classFilteredSearchContext
-
accessed
public void accessed(long accessTime)
- Overrides:
accessed
in classFilteredSearchContext
-
keepAlive
public void keepAlive(long keepAlive)
- Overrides:
keepAlive
in classFilteredSearchContext
-
queryResult
public QuerySearchResult queryResult()
- Overrides:
queryResult
in classFilteredSearchContext
-
fetchResult
public FetchSearchResult fetchResult()
- Overrides:
fetchResult
in classFilteredSearchContext
-
timeEstimateCounter
public org.apache.lucene.util.Counter timeEstimateCounter()
- Overrides:
timeEstimateCounter
in classFilteredSearchContext
-
-