DefaultSearchContext

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

All Implemented Interfaces:

AutoCloseable, HasContext, HasContextAndHeaders, HasHeaders, 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

Constructor Summary

Constructors

Constructor and Description
`DefaultSearchContext(long id, ShardSearchRequest request, SearchShardTarget shardTarget, Engine.Searcher engineSearcher, IndexService indexService, IndexShard indexShard, ScriptService scriptService, CacheRecycler cacheRecycler, PageCacheRecycler pageCacheRecycler, BigArrays bigArrays, org.apache.lucene.util.Counter timeEstimateCounter)`

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.Filter`	`aliasFilter()`
`AnalysisService`	`analysisService()`
`BigArrays`	`bigArrays()`
`CacheRecycler`	`cacheRecycler()`
`int`	`contextSize()`
`void`	`copyContextAndHeadersFrom(HasContextAndHeaders other)` copies over the context and the headers
`void`	`copyContextFrom(HasContext other)` Copies the context from the given context holder to this context holder.
`void`	`copyHeadersFrom(HasHeaders from)`
`DfsSearchResult`	`dfsResult()`
`int[]`	`docIdsToLoad()`
`SearchContext`	`docIdsToLoad(int[] docIdsToLoad, int docsIdsToLoadFrom, int docsIdsToLoadSize)`
`int`	`docIdsToLoadFrom()`
`int`	`docIdsToLoadSize()`
`void`	`doClose()`
`DocSetCache`	`docSetCache()`
`void`	`emptyFieldNames()`
`boolean`	`explain()`
`void`	`explain(boolean explain)`
`SearchContextFacets`	`facets()`
`SearchContext`	`facets(SearchContextFacets facets)`
`FetchSearchResult`	`fetchResult()`
`FetchSourceContext`	`fetchSourceContext()`
`SearchContext`	`fetchSourceContext(FetchSourceContext fetchSourceContext)`
`IndexFieldDataService`	`fieldData()`
`FieldDataFieldsContext`	`fieldDataFields()`
`List<String>`	`fieldNames()`
`FilterCache`	`filterCache()`
`FixedBitSetFilterCache`	`fixedBitSetFilterCache()`
`int`	`from()`
`SearchContext`	`from(int from)`
`ImmutableOpenMap<Object,Object>`	`getContext()`
`<V> V`	`getFromContext(Object key)`
`<V> V`	`getFromContext(Object key, V defaultValue)`
`<V> V`	`getHeader(String key)`
`Set<String>`	`getHeaders()`
`List<String>`	`groupStats()`
`void`	`groupStats(List<String> groupStats)`
`boolean`	`hasFetchSourceContext()`
`boolean`	`hasFieldDataFields()`
`boolean`	`hasFieldNames()`
`boolean`	`hasHeader(String key)`
`boolean`	`hasInContext(Object key)` Checks if the context contains an entry with the given key
`boolean`	`hasPartialFields()`
`boolean`	`hasScriptFields()`
`boolean`	`hasTypes()`
`SearchContextHighlight`	`highlight()`
`void`	`highlight(SearchContextHighlight highlight)`
`long`	`id()`
`IndexShard`	`indexShard()`
`InnerHitsContext`	`innerHits()`
`void`	`innerHits(InnerHitsContext innerHitsContext)`
`boolean`	`isContextEmpty()` Checks if the context is empty.
`long`	`keepAlive()`
`void`	`keepAlive(long keepAlive)`
`long`	`lastAccessTime()`
`org.apache.lucene.search.ScoreDoc`	`lastEmittedDoc()`
`void`	`lastEmittedDoc(org.apache.lucene.search.ScoreDoc doc)`
`SearchLookup`	`lookup()`
`MapperService`	`mapperService()`
`Float`	`minimumScore()`
`SearchContext`	`minimumScore(float minimumScore)`
`protected long`	`nowInMillisImpl()`
`int`	`numberOfShards()`
`PageCacheRecycler`	`pageCacheRecycler()`
`ParsedFilter`	`parsedPostFilter()`
`SearchContext`	`parsedPostFilter(ParsedFilter postFilter)`
`ParsedQuery`	`parsedQuery()`
`SearchContext`	`parsedQuery(ParsedQuery query)`
`PartialFieldsContext`	`partialFields()`
`void`	`preProcess()` Should be called before executing the main query and after all other parameters have been set.
`void`	`putAllInContext(<any> map)` Attaches the given values to the context
`HasHeaders`	`putHeader(String key, Object value)`
`<V> V`	`putInContext(Object key, Object value)` Attaches the given value to the context.
`org.apache.lucene.search.Query`	`query()` The query to execute, might be rewritten.
`float`	`queryBoost()`
`SearchContext`	`queryBoost(float queryBoost)`
`IndexQueryParserService`	`queryParserService()`
`QuerySearchResult`	`queryResult()`
`boolean`	`queryRewritten()` Has the query been rewritten already?
`ShardSearchRequest`	`request()`
`List<RescoreSearchContext>`	`rescore()`
`ScanContext`	`scanContext()`
`ScriptFieldsContext`	`scriptFields()`
`ScriptService`	`scriptService()`
`Scroll`	`scroll()`
`SearchContext`	`scroll(Scroll scroll)`
`ContextIndexSearcher`	`searcher()`
`org.apache.lucene.search.Filter`	`searchFilter(String[] types)`
`SearchType`	`searchType()`
`SearchContext`	`searchType(SearchType searchType)`
`SearchShardTarget`	`shardTarget()`
`SimilarityService`	`similarityService()`
`int`	`size()`
`SearchContext`	`size(int size)`
`MapperService.SmartNameFieldMappers`	`smartFieldMappers(String name)`
`FieldMapper`	`smartNameFieldMapper(String name)`
`FieldMapper`	`smartNameFieldMapperFromAnyType(String name)` Looks up the given field, but does not restrict to fields in the types set on this context.
`FieldMappers`	`smartNameFieldMappers(String name)`
`MapperService.SmartNameObjectMapper`	`smartNameObjectMapper(String name)`
`org.apache.lucene.search.Sort`	`sort()`
`SearchContext`	`sort(org.apache.lucene.search.Sort sort)`
`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)`
`String[]`	`types()`
`SearchContext`	`updateRewriteQuery(org.apache.lucene.search.Query rewriteQuery)` Rewrites the query and updates it.
`boolean`	`useSlowScroll()`
`DefaultSearchContext`	`useSlowScroll(boolean useSlowScroll)`
`boolean`	`version()`
`void`	`version(boolean version)`

Methods inherited from class org.elasticsearch.search.internal.SearchContext
addReleasable, clearReleasables, close, current, nowInMillis, nowInMillisUsed, removeCurrent, 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,
                            CacheRecycler cacheRecycler,
                            PageCacheRecycler pageCacheRecycler,
                            BigArrays bigArrays,
                            org.apache.lucene.util.Counter timeEstimateCounter)

Method Detail

doClose
```
public void doClose()
             throws ElasticsearchException
```
Specified by:

doClose in class SearchContext

Throws:

ElasticsearchException

preProcess
```
public void preProcess()
```
Should be called before executing the main query and after all other parameters have been set.

searchFilter

public org.apache.lucene.search.Filter searchFilter(String[] types)

id
```
public long id()
```

source
```
public String source()
```

request
```
public ShardSearchRequest request()
```

searchType
```
public SearchType searchType()
```

searchType

public SearchContext searchType(SearchType searchType)

shardTarget

public SearchShardTarget shardTarget()

numberOfShards
```
public int numberOfShards()
```

hasTypes
```
public boolean hasTypes()
```

types
```
public String[] types()
```

queryBoost
```
public float queryBoost()
```

queryBoost

public SearchContext queryBoost(float queryBoost)

nowInMillisImpl
```
protected long nowInMillisImpl()
```

scroll
```
public Scroll scroll()
```

scroll

public SearchContext scroll(Scroll scroll)

aggregations

public SearchContextAggregations aggregations()

aggregations

public SearchContext aggregations(SearchContextAggregations aggregations)

facets
```
public SearchContextFacets facets()
```

facets

public SearchContext facets(SearchContextFacets facets)

highlight

public SearchContextHighlight highlight()

highlight

public void highlight(SearchContextHighlight highlight)

suggest

public SuggestionSearchContext suggest()

suggest

public void suggest(SuggestionSearchContext suggest)

rescore
```
public 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)

hasFieldDataFields
```
public boolean hasFieldDataFields()
```

fieldDataFields

public FieldDataFieldsContext fieldDataFields()

hasScriptFields
```
public boolean hasScriptFields()
```

scriptFields

public ScriptFieldsContext scriptFields()

hasPartialFields
```
public boolean hasPartialFields()
```

partialFields

public PartialFieldsContext partialFields()

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

Returns:

hasFetchSourceContext

public boolean hasFetchSourceContext()

fetchSourceContext

public FetchSourceContext fetchSourceContext()

fetchSourceContext

public SearchContext fetchSourceContext(FetchSourceContext fetchSourceContext)

searcher

public ContextIndexSearcher searcher()

indexShard
```
public IndexShard indexShard()
```

mapperService
```
public MapperService mapperService()
```

analysisService

public AnalysisService analysisService()

queryParserService

public IndexQueryParserService queryParserService()

similarityService

public SimilarityService similarityService()

scriptService
```
public ScriptService scriptService()
```

cacheRecycler
```
public CacheRecycler cacheRecycler()
```

pageCacheRecycler

public PageCacheRecycler pageCacheRecycler()

bigArrays
```
public BigArrays bigArrays()
```

filterCache
```
public FilterCache filterCache()
```

fixedBitSetFilterCache

public FixedBitSetFilterCache fixedBitSetFilterCache()

docSetCache
```
public DocSetCache docSetCache()
```

fieldData

public IndexFieldDataService fieldData()

timeoutInMillis
```
public long timeoutInMillis()
```

timeoutInMillis

public void timeoutInMillis(long timeoutInMillis)

terminateAfter
```
public int terminateAfter()
```

terminateAfter

public void terminateAfter(int terminateAfter)

minimumScore

public SearchContext minimumScore(float minimumScore)

minimumScore
```
public Float minimumScore()
```

sort

public SearchContext sort(org.apache.lucene.search.Sort sort)

sort

public org.apache.lucene.search.Sort sort()

trackScores

public SearchContext trackScores(boolean trackScores)

trackScores
```
public boolean trackScores()
```

parsedPostFilter

public SearchContext parsedPostFilter(ParsedFilter postFilter)

parsedPostFilter

public ParsedFilter parsedPostFilter()

aliasFilter

public org.apache.lucene.search.Filter aliasFilter()

parsedQuery

public SearchContext parsedQuery(ParsedQuery query)

parsedQuery
```
public ParsedQuery parsedQuery()
```

query

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

The query to execute, might be rewritten.

queryRewritten
```
public boolean queryRewritten()
```
Has the query been rewritten already?

updateRewriteQuery

public SearchContext updateRewriteQuery(org.apache.lucene.search.Query rewriteQuery)

Rewrites the query and updates it. Only happens once.

from
```
public int from()
```

from
```
public SearchContext from(int from)
```

size
```
public int size()
```

size
```
public SearchContext size(int size)
```

hasFieldNames
```
public boolean hasFieldNames()
```

fieldNames
```
public List<String> fieldNames()
```

emptyFieldNames
```
public void emptyFieldNames()
```

explain
```
public boolean explain()
```

explain
```
public void explain(boolean explain)
```

groupStats

@Nullable
public List<String> groupStats()

groupStats

public void groupStats(List<String> groupStats)

version
```
public boolean version()
```

version
```
public void version(boolean version)
```

docIdsToLoad
```
public int[] docIdsToLoad()
```

docIdsToLoadFrom
```
public int docIdsToLoadFrom()
```

docIdsToLoadSize
```
public int docIdsToLoadSize()
```

docIdsToLoad

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

accessed

public void accessed(long accessTime)

lastAccessTime
```
public long lastAccessTime()
```

keepAlive
```
public long keepAlive()
```

keepAlive

public void keepAlive(long keepAlive)

lastEmittedDoc

public void lastEmittedDoc(org.apache.lucene.search.ScoreDoc doc)

lastEmittedDoc

public org.apache.lucene.search.ScoreDoc lastEmittedDoc()

lookup
```
public SearchLookup lookup()
```

dfsResult
```
public DfsSearchResult dfsResult()
```

queryResult

public QuerySearchResult queryResult()

fetchResult

public FetchSearchResult fetchResult()

scanContext
```
public ScanContext scanContext()
```

smartFieldMappers

public MapperService.SmartNameFieldMappers smartFieldMappers(String name)

smartNameFieldMappers

public FieldMappers smartNameFieldMappers(String name)

smartNameFieldMapper

public FieldMapper smartNameFieldMapper(String name)

smartNameFieldMapperFromAnyType
```
public FieldMapper smartNameFieldMapperFromAnyType(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.

smartNameObjectMapper

public MapperService.SmartNameObjectMapper smartNameObjectMapper(String name)

useSlowScroll
```
public boolean useSlowScroll()
```

useSlowScroll

public DefaultSearchContext useSlowScroll(boolean useSlowScroll)

timeEstimateCounter

public org.apache.lucene.util.Counter timeEstimateCounter()

innerHits

public void innerHits(InnerHitsContext innerHitsContext)

innerHits
```
public InnerHitsContext innerHits()
```

putInContext
```
public <V> V putInContext(Object key,
                          Object value)
```
Description copied from interface: HasContext

Attaches the given value to the context.

Returns:

The previous value that was associated with the given key in the context, or null if there was none.

putAllInContext
```
public void putAllInContext(<any> map)
```
Description copied from interface: HasContext

Attaches the given values to the context

getFromContext
```
public <V> V getFromContext(Object key)
```
Returns:

The context value that is associated with the given key

See Also:

HasContext.putInContext(Object, Object)

getFromContext
```
public <V> V getFromContext(Object key,
                            V defaultValue)
```
defaultValue - The default value that should be returned for the given key, if no value is currently associated with it.

Returns:

The value that is associated with the given key in the context

See Also:

HasContext.putInContext(Object, Object)

hasInContext
```
public boolean hasInContext(Object key)
```
Description copied from interface: HasContext

Checks if the context contains an entry with the given key

contextSize
```
public int contextSize()
```
Returns:

The number of values attached in the context.

isContextEmpty
```
public boolean isContextEmpty()
```
Description copied from interface: HasContext

Checks if the context is empty.

getContext
```
public ImmutableOpenMap<Object,Object> getContext()
```
Returns:

A safe immutable copy of the current context.

copyContextFrom
```
public void copyContextFrom(HasContext other)
```
Description copied from interface: HasContext

Copies the context from the given context holder to this context holder. Any shared keys between the two context will be overridden by the given context holder.

putHeader

public HasHeaders putHeader(String key,
                            Object value)

getHeader
```
public <V> V getHeader(String key)
```

hasHeader
```
public boolean hasHeader(String key)
```

getHeaders
```
public Set<String> getHeaders()
```

copyHeadersFrom

public void copyHeadersFrom(HasHeaders from)

copyContextAndHeadersFrom
```
public void copyContextAndHeadersFrom(HasContextAndHeaders other)
```
Description copied from interface: HasContextAndHeaders

copies over the context and the headers

Parameters:

other - another object supporting headers and context

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

Constructors

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

hasTypes

types

queryBoost

queryBoost

nowInMillisImpl

scroll

scroll

aggregations

aggregations

facets

facets

highlight

highlight

suggest

suggest

rescore

addRescore

hasFieldDataFields

fieldDataFields

hasScriptFields

scriptFields

hasPartialFields

partialFields

sourceRequested

hasFetchSourceContext

fetchSourceContext

fetchSourceContext

searcher

indexShard

mapperService

analysisService

queryParserService

similarityService

scriptService

cacheRecycler

pageCacheRecycler

bigArrays

filterCache

fixedBitSetFilterCache

docSetCache

fieldData

timeoutInMillis

timeoutInMillis

terminateAfter

terminateAfter

minimumScore

minimumScore

sort

sort

trackScores

trackScores

parsedPostFilter

parsedPostFilter

aliasFilter

parsedQuery

parsedQuery

query