DefaultSearchContext (core 5.0.0-alpha1 API)

java.lang.Object
- org.elasticsearch.search.internal.SearchContext
- - org.elasticsearch.search.internal.DefaultSearchContext

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Releasable
```
public class DefaultSearchContext
extends SearchContext
```

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, parseFieldMatcher

Constructor Summary

Constructors
Constructor and Description
`DefaultSearchContext(long id, ShardSearchRequest request, SearchShardTarget shardTarget, Engine.Searcher engineSearcher, IndexService indexService, IndexShard indexShard, ScriptService scriptService, PageCacheRecycler pageCacheRecycler, BigArrays bigArrays, org.apache.lucene.util.Counter timeEstimateCounter, ParseFieldMatcher parseFieldMatcher, TimeValue timeout, FetchPhase fetchPhase)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accessed(long accessTime)`
`void`	`addRescore(RescoreSearchContext rescore)`
`SearchContextAggregations`	`aggregations()`
`SearchContext`	`aggregations(SearchContextAggregations aggregations)`
`org.apache.lucene.search.Query`	`aliasFilter()`
`AnalysisService`	`analysisService()`
`BigArrays`	`bigArrays()`
`BitsetFilterCache`	`bitsetFilterCache()`
`DfsSearchResult`	`dfsResult()`
`int[]`	`docIdsToLoad()`
`SearchContext`	`docIdsToLoad(int[] docIdsToLoad, int docsIdsToLoadFrom, int docsIdsToLoadSize)`
`int`	`docIdsToLoadFrom()`
`int`	`docIdsToLoadSize()`
`void`	`doClose()`
`void`	`emptyFieldNames()`
`boolean`	`explain()`
`void`	`explain(boolean explain)`
`FetchPhase`	`fetchPhase()`
`FetchSearchResult`	`fetchResult()`
`FetchSourceContext`	`fetchSourceContext()`
`SearchContext`	`fetchSourceContext(FetchSourceContext fetchSourceContext)`
`IndexFieldDataService`	`fieldData()`
`java.util.List<java.lang.String>`	`fieldNames()`
`ParsedQuery`	`filteredQuery()`
`int`	`from()`
`SearchContext`	`from(int from)`
`<SubPhaseContext extends FetchSubPhaseContext> SubPhaseContext`	`getFetchSubPhaseContext(FetchSubPhase.ContextFactory<SubPhaseContext> contextFactory)`
`ObjectMapper`	`getObjectMapper(java.lang.String name)`
`long`	`getOriginNanoTime()`
`Profilers`	`getProfilers()` Return a handle over the profilers for the current search request, or `null` if profiling is not enabled.
`QueryShardContext`	`getQueryShardContext()`
`java.util.List<java.lang.String>`	`groupStats()`
`void`	`groupStats(java.util.List<java.lang.String> groupStats)`
`boolean`	`hasFetchSourceContext()`
`boolean`	`hasFieldNames()`
`boolean`	`hasScriptFields()`
`SearchContextHighlight`	`highlight()`
`void`	`highlight(SearchContextHighlight highlight)`
`long`	`id()`
`IndexShard`	`indexShard()`
`long`	`keepAlive()`
`void`	`keepAlive(long keepAlive)`
`long`	`lastAccessTime()`
`SearchLookup`	`lookup()`
`MapperService`	`mapperService()`
`java.lang.Float`	`minimumScore()`
`SearchContext`	`minimumScore(float minimumScore)`
`protected long`	`nowInMillisImpl()`
`int`	`numberOfShards()`
`PageCacheRecycler`	`pageCacheRecycler()`
`ParsedQuery`	`parsedPostFilter()`
`SearchContext`	`parsedPostFilter(ParsedQuery postFilter)`
`ParsedQuery`	`parsedQuery()`
`SearchContext`	`parsedQuery(ParsedQuery query)`
`PercolatorQueryCache`	`percolatorQueryCache()`
`void`	`preProcess()` 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, in its rewritten form.
`float`	`queryBoost()`
`SearchContext`	`queryBoost(float queryBoost)`
`java.util.Map<java.lang.Class<?>,org.apache.lucene.search.Collector>`	`queryCollectors()` Return a view of the additional query collectors that should be run for this context.
`QuerySearchResult`	`queryResult()`
`ShardSearchRequest`	`request()`
`java.util.List<RescoreSearchContext>`	`rescore()`
`ScriptFieldsContext`	`scriptFields()`
`ScriptService`	`scriptService()`
`ScrollContext`	`scrollContext()`
`SearchContext`	`scrollContext(ScrollContext scrollContext)`
`org.apache.lucene.search.FieldDoc`	`searchAfter()`
`SearchContext`	`searchAfter(org.apache.lucene.search.FieldDoc searchAfter)`
`ContextIndexSearcher`	`searcher()`
`org.apache.lucene.search.Query`	`searchFilter(java.lang.String[] types)`
`SearchType`	`searchType()`
`SearchContext`	`searchType(SearchType searchType)`
`void`	`setProfilers(Profilers profilers)`
`SearchShardTarget`	`shardTarget()`
`SimilarityService`	`similarityService()`
`int`	`size()`
`SearchContext`	`size(int size)`
`MappedFieldType`	`smartNameFieldType(java.lang.String name)` Looks up the given field, but does not restrict to fields in the types set on this context.
`org.apache.lucene.search.Sort`	`sort()`
`SearchContext`	`sort(org.apache.lucene.search.Sort sort)`
`java.lang.String`	`source()`
`boolean`	`sourceRequested()` A shortcut function to see whether there is a fetchSourceContext and it says the source is requested.
`SuggestionSearchContext`	`suggest()`
`void`	`suggest(SuggestionSearchContext suggest)`
`int`	`terminateAfter()`
`void`	`terminateAfter(int terminateAfter)`
`org.apache.lucene.util.Counter`	`timeEstimateCounter()`
`long`	`timeoutInMillis()`
`void`	`timeoutInMillis(long timeoutInMillis)`
`boolean`	`trackScores()`
`SearchContext`	`trackScores(boolean trackScores)`
`boolean`	`version()`
`void`	`version(boolean version)`

Methods inherited from class org.elasticsearch.search.internal.SearchContext
addReleasable, clearReleasables, close, current, hasOnlySuggest, innerHits, nowInMillis, nowInMillisUsed, parseFieldMatcher, removeCurrent, resetNowInMillisUsed, setCurrent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultSearchContext
```
public DefaultSearchContext(long id,
                            ShardSearchRequest request,
                            SearchShardTarget shardTarget,
                            Engine.Searcher engineSearcher,
                            IndexService indexService,
                            IndexShard indexShard,
                            ScriptService scriptService,
                            PageCacheRecycler pageCacheRecycler,
                            BigArrays bigArrays,
                            org.apache.lucene.util.Counter timeEstimateCounter,
                            ParseFieldMatcher parseFieldMatcher,
                            TimeValue timeout,
                            FetchPhase fetchPhase)
```
- Method Detail
  - doClose
```
public void doClose()
```
    Specified by:
    
    doClose in class SearchContext
  - preProcess
```
public void preProcess()
```
    Should be called before executing the main query and after all other parameters have been set.
    
    Specified by:
    
    preProcess in class SearchContext
  - searchFilter
```
@Nullable
public org.apache.lucene.search.Query searchFilter(java.lang.String[] types)
```
    Specified by:
    
    searchFilter in class SearchContext
  - id
```
public long id()
```
    Specified by:
    
    id in class SearchContext
  - source
```
public java.lang.String source()
```
    Specified by:
    
    source in class SearchContext
  - request
```
public ShardSearchRequest request()
```
    Specified by:
    
    request in class SearchContext
  - searchType
```
public SearchType searchType()
```
    Specified by:
    
    searchType in class SearchContext
  - searchType
```
public SearchContext searchType(SearchType searchType)
```
    Specified by:
    
    searchType in class SearchContext
  - shardTarget
```
public SearchShardTarget shardTarget()
```
    Specified by:
    
    shardTarget in class SearchContext
  - numberOfShards
```
public int numberOfShards()
```
    Specified by:
    
    numberOfShards in class SearchContext
  - queryBoost
```
public float queryBoost()
```
    Specified by:
    
    queryBoost in class SearchContext
  - queryBoost
```
public SearchContext queryBoost(float queryBoost)
```
    Specified by:
    
    queryBoost in class SearchContext
  - getOriginNanoTime
```
public long getOriginNanoTime()
```
    Specified by:
    
    getOriginNanoTime in class SearchContext
  - nowInMillisImpl
```
protected long nowInMillisImpl()
```
    Specified by:
    
    nowInMillisImpl in class SearchContext
  - scrollContext
```
public ScrollContext scrollContext()
```
    Specified by:
    
    scrollContext in class SearchContext
  - scrollContext
```
public SearchContext scrollContext(ScrollContext scrollContext)
```
    Specified by:
    
    scrollContext in class SearchContext
  - aggregations
```
public SearchContextAggregations aggregations()
```
    Specified by:
    
    aggregations in class SearchContext
  - aggregations
```
public SearchContext aggregations(SearchContextAggregations aggregations)
```
    Specified by:
    
    aggregations in class SearchContext
  - getFetchSubPhaseContext
```
public <SubPhaseContext extends FetchSubPhaseContext> SubPhaseContext getFetchSubPhaseContext(FetchSubPhase.ContextFactory<SubPhaseContext> contextFactory)
```
    Specified by:
    
    getFetchSubPhaseContext in class SearchContext
  - highlight
```
public SearchContextHighlight highlight()
```
    Specified by:
    
    highlight in class SearchContext
  - highlight
```
public void highlight(SearchContextHighlight highlight)
```
    Specified by:
    
    highlight 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
  - rescore
```
public java.util.List<RescoreSearchContext> rescore()
```
    Specified by:
    
    rescore in class SearchContext
    
    Returns:
    
    list of all rescore contexts. empty if there aren't any.
  - addRescore
```
public void addRescore(RescoreSearchContext 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()
```
    A shortcut function to see whether there is a fetchSourceContext and it says the source is requested.
    
    Specified by:
    
    sourceRequested in class SearchContext
  - hasFetchSourceContext
```
public boolean hasFetchSourceContext()
```
    Specified by:
    
    hasFetchSourceContext 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
  - searcher
```
public ContextIndexSearcher searcher()
```
    Specified by:
    
    searcher in class SearchContext
  - indexShard
```
public IndexShard indexShard()
```
    Specified by:
    
    indexShard in class SearchContext
  - mapperService
```
public MapperService mapperService()
```
    Specified by:
    
    mapperService in class SearchContext
  - analysisService
```
public AnalysisService analysisService()
```
    Specified by:
    
    analysisService in class SearchContext
  - similarityService
```
public SimilarityService similarityService()
```
    Specified by:
    
    similarityService in class SearchContext
  - scriptService
```
public ScriptService scriptService()
```
    Specified by:
    
    scriptService in class SearchContext
  - pageCacheRecycler
```
public PageCacheRecycler pageCacheRecycler()
```
    Specified by:
    
    pageCacheRecycler in class SearchContext
  - bigArrays
```
public BigArrays bigArrays()
```
    Specified by:
    
    bigArrays in class SearchContext
  - bitsetFilterCache
```
public BitsetFilterCache bitsetFilterCache()
```
    Specified by:
    
    bitsetFilterCache in class SearchContext
  - fieldData
```
public IndexFieldDataService fieldData()
```
    Specified by:
    
    fieldData in class SearchContext
  - percolatorQueryCache
```
public PercolatorQueryCache percolatorQueryCache()
```
    Specified by:
    
    percolatorQueryCache in class SearchContext
  - timeoutInMillis
```
public long timeoutInMillis()
```
    Specified by:
    
    timeoutInMillis in class SearchContext
  - timeoutInMillis
```
public void timeoutInMillis(long timeoutInMillis)
```
    Specified by:
    
    timeoutInMillis in class SearchContext
  - terminateAfter
```
public int terminateAfter()
```
    Specified by:
    
    terminateAfter in class SearchContext
  - terminateAfter
```
public void terminateAfter(int terminateAfter)
```
    Specified by:
    
    terminateAfter in class SearchContext
  - minimumScore
```
public SearchContext minimumScore(float minimumScore)
```
    Specified by:
    
    minimumScore in class SearchContext
  - minimumScore
```
public java.lang.Float minimumScore()
```
    Specified by:
    
    minimumScore in class SearchContext
  - sort
```
public SearchContext sort(org.apache.lucene.search.Sort sort)
```
    Specified by:
    
    sort in class SearchContext
  - sort
```
public org.apache.lucene.search.Sort sort()
```
    Specified by:
    
    sort in class SearchContext
  - trackScores
```
public SearchContext trackScores(boolean trackScores)
```
    Specified by:
    
    trackScores in class SearchContext
  - trackScores
```
public boolean trackScores()
```
    Specified by:
    
    trackScores in class SearchContext
  - searchAfter
```
public SearchContext searchAfter(org.apache.lucene.search.FieldDoc searchAfter)
```
    Specified by:
    
    searchAfter in class SearchContext
  - searchAfter
```
public org.apache.lucene.search.FieldDoc searchAfter()
```
    Specified by:
    
    searchAfter in class SearchContext
  - parsedPostFilter
```
public SearchContext parsedPostFilter(ParsedQuery postFilter)
```
    Specified by:
    
    parsedPostFilter in class SearchContext
  - parsedPostFilter
```
public ParsedQuery parsedPostFilter()
```
    Specified by:
    
    parsedPostFilter in class SearchContext
  - aliasFilter
```
public org.apache.lucene.search.Query aliasFilter()
```
    Specified by:
    
    aliasFilter in class SearchContext
  - parsedQuery
```
public SearchContext parsedQuery(ParsedQuery query)
```
    Specified by:
    
    parsedQuery in class SearchContext
  - filteredQuery
```
public ParsedQuery filteredQuery()
```
  - parsedQuery
```
public ParsedQuery parsedQuery()
```
    Specified by:
    
    parsedQuery in class SearchContext
  - query
```
public org.apache.lucene.search.Query query()
```
    The query to execute, in its rewritten form.
    
    Specified by:
    
    query in class SearchContext
  - from
```
public int from()
```
    Specified by:
    
    from in class SearchContext
  - from
```
public SearchContext from(int from)
```
    Specified by:
    
    from in class SearchContext
  - size
```
public int size()
```
    Specified by:
    
    size in class SearchContext
  - size
```
public SearchContext size(int size)
```
    Specified by:
    
    size in class SearchContext
  - hasFieldNames
```
public boolean hasFieldNames()
```
    Specified by:
    
    hasFieldNames in class SearchContext
  - fieldNames
```
public java.util.List<java.lang.String> fieldNames()
```
    Specified by:
    
    fieldNames in class SearchContext
  - emptyFieldNames
```
public void emptyFieldNames()
```
    Specified by:
    
    emptyFieldNames 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
```
@Nullable
public java.util.List<java.lang.String> groupStats()
```
    Specified by:
    
    groupStats in class SearchContext
  - groupStats
```
public void groupStats(java.util.List<java.lang.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
  - docIdsToLoad
```
public int[] docIdsToLoad()
```
    Specified by:
    
    docIdsToLoad in class SearchContext
  - docIdsToLoadFrom
```
public int docIdsToLoadFrom()
```
    Specified by:
    
    docIdsToLoadFrom in class SearchContext
  - docIdsToLoadSize
```
public int docIdsToLoadSize()
```
    Specified by:
    
    docIdsToLoadSize in class SearchContext
  - docIdsToLoad
```
public SearchContext docIdsToLoad(int[] docIdsToLoad,
                                  int docsIdsToLoadFrom,
                                  int docsIdsToLoadSize)
```
    Specified by:
    
    docIdsToLoad in class SearchContext
  - accessed
```
public void accessed(long accessTime)
```
    Specified by:
    
    accessed in class SearchContext
  - lastAccessTime
```
public long lastAccessTime()
```
    Specified by:
    
    lastAccessTime in class SearchContext
  - keepAlive
```
public long keepAlive()
```
    Specified by:
    
    keepAlive in class SearchContext
  - keepAlive
```
public void keepAlive(long keepAlive)
```
    Specified by:
    
    keepAlive in class SearchContext
  - lookup
```
public SearchLookup lookup()
```
    Specified by:
    
    lookup in class SearchContext
  - dfsResult
```
public DfsSearchResult dfsResult()
```
    Specified by:
    
    dfsResult in class SearchContext
  - queryResult
```
public QuerySearchResult queryResult()
```
    Specified by:
    
    queryResult in class SearchContext
  - fetchPhase
```
public FetchPhase fetchPhase()
```
    Specified by:
    
    fetchPhase in class SearchContext
  - fetchResult
```
public FetchSearchResult fetchResult()
```
    Specified by:
    
    fetchResult in class SearchContext
  - smartNameFieldType
```
public MappedFieldType smartNameFieldType(java.lang.String name)
```
    Description copied from class: SearchContext
    
    Looks up the given field, but does not restrict to fields in the types set on this context.
    
    Specified by:
    
    smartNameFieldType in class SearchContext
  - getObjectMapper
```
public ObjectMapper getObjectMapper(java.lang.String name)
```
    Specified by:
    
    getObjectMapper in class SearchContext
  - timeEstimateCounter
```
public org.apache.lucene.util.Counter timeEstimateCounter()
```
    Specified by:
    
    timeEstimateCounter in class SearchContext
  - queryCollectors
```
public java.util.Map<java.lang.Class<?>,org.apache.lucene.search.Collector> queryCollectors()
```
    Description copied from class: SearchContext
    
    Return a view of the additional query collectors that should be run for this context.
    
    Specified by:
    
    queryCollectors in class SearchContext
  - getQueryShardContext
```
public QueryShardContext getQueryShardContext()
```
    Specified by:
    
    getQueryShardContext in class SearchContext
  - getProfilers
```
public Profilers getProfilers()
```
    Description copied from class: SearchContext
    
    Return a handle over the profilers for the current search request, or null if profiling is not enabled.
    
    Specified by:
    
    getProfilers in class SearchContext
  - setProfilers
```
public void setProfilers(Profilers profilers)
```

Class DefaultSearchContext

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.internal.SearchContext

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

DefaultSearchContext

Method Detail

doClose

preProcess

searchFilter

id

source

request

searchType

searchType

shardTarget

numberOfShards

queryBoost

queryBoost

getOriginNanoTime

nowInMillisImpl

scrollContext

scrollContext

aggregations

aggregations

getFetchSubPhaseContext

highlight

highlight

suggest

suggest

rescore

addRescore

hasScriptFields

scriptFields

sourceRequested

hasFetchSourceContext

fetchSourceContext

fetchSourceContext

searcher

indexShard

mapperService

analysisService

similarityService

scriptService

pageCacheRecycler

bigArrays

bitsetFilterCache

fieldData

percolatorQueryCache

timeoutInMillis

timeoutInMillis

terminateAfter

terminateAfter

minimumScore

minimumScore

sort

sort

trackScores

trackScores

searchAfter

searchAfter

parsedPostFilter

parsedPostFilter

aliasFilter

parsedQuery

filteredQuery

parsedQuery

query

from

from

size

size

hasFieldNames

fieldNames

emptyFieldNames