java.lang.Object

org.elasticsearch.common.util.concurrent.AbstractRefCounted

org.elasticsearch.search.internal.SearchContext

org.elasticsearch.search.internal.FilteredSearchContext

All Implemented Interfaces:: java.io.Closeable, java.lang.AutoCloseable, Releasable, org.elasticsearch.common.util.concurrent.RefCounted

Direct Known Subclasses:: SubSearchContext

public abstract class FilteredSearchContext
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, DEFAULT_TRACK_TOTAL_HITS_UP_TO, TRACK_TOTAL_HITS_ACCURATE, TRACK_TOTAL_HITS_DISABLED
Constructor Summary

Constructors

Constructor Description

FilteredSearchContext(SearchContext in)

Method Summary

Modifier and Type	Method	Description
`void`	`accessed(long accessTime)`
`void`	`addRescore(RescoreContext rescore)`
`void`	`addSearchExt(SearchExtBuilder searchExtBuilder)`
`SearchContextAggregations`	`aggregations()`
`SearchContext`	`aggregations(SearchContextAggregations aggregations)`
`org.apache.lucene.search.Query`	`aliasFilter()`
`BigArrays`	`bigArrays()`
`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()`
`SearchContext`	`collapse(CollapseContext collapse)`
`DfsSearchResult`	`dfsResult()`
`int[]`	`docIdsToLoad()`
`SearchContext`	`docIdsToLoad(int[] docIdsToLoad, int docsIdsToLoadFrom, int docsIdsToLoadSize)`
`int`	`docIdsToLoadFrom()`
`int`	`docIdsToLoadSize()`
`protected void`	`doClose()`
`boolean`	`explain()`
`void`	`explain(boolean explain)`
`FetchPhase`	`fetchPhase()`
`FetchSearchResult`	`fetchResult()`
`FetchSourceContext`	`fetchSourceContext()`
`SearchContext`	`fetchSourceContext(FetchSourceContext fetchSourceContext)`
`MappedFieldType`	`fieldType(java.lang.String name)`	Given the full name of a field, returns its `MappedFieldType`.
`int`	`from()`
`SearchContext`	`from(int from)`
`<IFD extends IndexFieldData<?>> IFD`	`getForField(MappedFieldType fieldType)`
`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()`
`long`	`getRelativeTimeInMillis()`	Returns time in milliseconds that can be used for relative time calculations.
`SearchExtBuilder`	`getSearchExt(java.lang.String name)`
`SearchShardTask`	`getTask()`
`java.util.List<java.lang.String>`	`groupStats()`
`void`	`groupStats(java.util.List<java.lang.String> groupStats)`
`boolean`	`hasFetchSourceContext()`
`boolean`	`hasScriptFields()`
`boolean`	`hasStoredFields()`
`boolean`	`hasStoredFieldsContext()`
`SearchContextHighlight`	`highlight()`
`void`	`highlight(SearchContextHighlight highlight)`
`SearchContextId`	`id()`
`IndexShard`	`indexShard()`
`InnerHitsContext`	`innerHits()`
`boolean`	`isCancelled()`
`long`	`keepAlive()`
`void`	`keepAlive(long keepAlive)`
`long`	`lastAccessTime()`
`SearchLookup`	`lookup()`
`boolean`	`lowLevelCancellation()`	Indicates if the current index should perform frequent low level search cancellation check.
`MapperService`	`mapperService()`
`java.lang.Float`	`minimumScore()`
`SearchContext`	`minimumScore(float minimumScore)`
`int`	`numberOfShards()`
`ParsedQuery`	`parsedPostFilter()`
`SearchContext`	`parsedPostFilter(ParsedQuery postFilter)`
`ParsedQuery`	`parsedQuery()`
`SearchContext`	`parsedQuery(ParsedQuery query)`
`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.
`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<RescoreContext>`	`rescore()`
`ScriptFieldsContext`	`scriptFields()`
`ScrollContext`	`scrollContext()`
`SearchContext`	`scrollContext(ScrollContext 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()`
`SimilarityService`	`similarityService()`
`int`	`size()`
`SearchContext`	`size(int size)`
`SortAndFormats`	`sort()`
`SearchContext`	`sort(SortAndFormats sort)`
`java.lang.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)`
`boolean`	`storedFieldsRequested()`	A shortcut function to see whether there is a storedFieldsContext and it says the fields are requested.
`SuggestionSearchContext`	`suggest()`
`void`	`suggest(SuggestionSearchContext suggest)`
`int`	`terminateAfter()`
`void`	`terminateAfter(int terminateAfter)`
`org.elasticsearch.common.unit.TimeValue`	`timeout()`
`void`	`timeout(org.elasticsearch.common.unit.TimeValue timeout)`
`boolean`	`trackScores()`
`SearchContext`	`trackScores(boolean trackScores)`
`int`	`trackTotalHitsUpTo()`	Indicates the total number of hits to count accurately.
`SearchContext`	`trackTotalHitsUpTo(int trackTotalHitsUpTo)`
`boolean`	`version()`
`void`	`version(boolean version)`

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

addReleasable, alreadyClosed, clearReleasables, close, closeInternal, docValuesContext, docValuesContext, hasOnlySuggest, toString

Methods inherited from class org.elasticsearch.common.util.concurrent.AbstractRefCounted

decRef, getName, incRef, refCount, tryIncRef

Methods inherited from class java.lang.Object

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

Constructor Details
- FilteredSearchContext
  
  public FilteredSearchContext(SearchContext in)
Method Details
- hasStoredFields
  
  public boolean hasStoredFields()
  
  Specified by:
  
  hasStoredFields in class SearchContext
- hasStoredFieldsContext
  
  public boolean hasStoredFieldsContext()
  
  Specified by:
  
  hasStoredFieldsContext in class SearchContext
- 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.
  
  Specified by:
  
  storedFieldsRequested 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
- doClose
  
  protected void doClose()
  
  Specified by:
  
  doClose in class SearchContext
- 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.
  
  Specified by:
  
  preProcess in class SearchContext
  
  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.
  
  Specified by:
  
  buildFilteredQuery in class SearchContext
- id
  
  public SearchContextId 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
- 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
- getOriginNanoTime
  
  public long getOriginNanoTime()
  
  Specified by:
  
  getOriginNanoTime in class SearchContext
- scrollContext
  
  public ScrollContext scrollContext()
  
  Specified by:
  
  scrollContext in class SearchContext
- scrollContext
  
  public SearchContext scrollContext(ScrollContext scroll)
  
  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
- highlight
  
  public SearchContextHighlight highlight()
  
  Specified by:
  
  highlight in class SearchContext
- highlight
  
  public void highlight(SearchContextHighlight 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
- rescore
  
  public java.util.List<RescoreContext> rescore()
  
  Specified by:
  
  rescore in class SearchContext
  
  Returns:
  
  list of all rescore contexts. empty if there aren't any.
- 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
- 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
- similarityService
  
  public SimilarityService similarityService()
  
  Specified by:
  
  similarityService in class SearchContext
- bigArrays
  
  public BigArrays bigArrays()
  
  Specified by:
  
  bigArrays in class SearchContext
- bitsetFilterCache
  
  public BitsetFilterCache bitsetFilterCache()
  
  Specified by:
  
  bitsetFilterCache in class SearchContext
- getForField
  
  public <IFD extends IndexFieldData<?>> IFD getForField(MappedFieldType fieldType)
  
  Specified by:
  
  getForField in class SearchContext
- timeout
  
  public org.elasticsearch.common.unit.TimeValue timeout()
  
  Specified by:
  
  timeout in class SearchContext
- timeout
  
  public void timeout(org.elasticsearch.common.unit.TimeValue timeout)
  
  Specified by:
  
  timeout 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
- 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
- minimumScore
  
  public java.lang.Float minimumScore()
  
  Specified by:
  
  minimumScore in class SearchContext
- sort
  
  public SearchContext sort(SortAndFormats sort)
  
  Specified by:
  
  sort in class SearchContext
- sort
  
  public SortAndFormats 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
- trackTotalHitsUpTo
  
  public SearchContext trackTotalHitsUpTo(int trackTotalHitsUpTo)
  
  Specified by:
  
  trackTotalHitsUpTo in class SearchContext
- trackTotalHitsUpTo
  
  public int trackTotalHitsUpTo()
  
  Description copied from class: SearchContext
  
  Indicates the total number of hits to count accurately. Defaults to SearchContext.DEFAULT_TRACK_TOTAL_HITS_UP_TO.
  
  Specified by:
  
  trackTotalHitsUpTo 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
- parsedQuery
  
  public ParsedQuery parsedQuery()
  
  Specified by:
  
  parsedQuery in class SearchContext
- query
  
  public org.apache.lucene.search.Query query()
  
  Description copied from class: SearchContext
  
  The query to execute, might be rewritten.
  
  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
- explain
  
  public boolean explain()
  
  Specified by:
  
  explain in class SearchContext
- explain
  
  public void explain(boolean explain)
  
  Specified by:
  
  explain in class SearchContext
- groupStats
  
  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
- 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
- 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()
  
  Overrides:
  
  lookup in class SearchContext
- dfsResult
  
  public DfsSearchResult dfsResult()
  
  Specified by:
  
  dfsResult in class SearchContext
- queryResult
  
  public QuerySearchResult queryResult()
  
  Specified by:
  
  queryResult in class SearchContext
- fetchResult
  
  public FetchSearchResult fetchResult()
  
  Specified by:
  
  fetchResult in class SearchContext
- fetchPhase
  
  public FetchPhase fetchPhase()
  
  Specified by:
  
  fetchPhase in class SearchContext
- fieldType
  
  public MappedFieldType fieldType(java.lang.String name)
  
  Description copied from class: SearchContext
  
  Given the full name of a field, returns its MappedFieldType.
  
  Specified by:
  
  fieldType in class SearchContext
- getObjectMapper
  
  public ObjectMapper getObjectMapper(java.lang.String name)
  
  Specified by:
  
  getObjectMapper 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
- addSearchExt
  
  public void addSearchExt(SearchExtBuilder searchExtBuilder)
  
  Specified by:
  
  addSearchExt in class SearchContext
- getSearchExt
  
  public SearchExtBuilder getSearchExt(java.lang.String name)
  
  Specified by:
  
  getSearchExt 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
- 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
- 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
- collapse
  
  public SearchContext collapse(CollapseContext collapse)
  
  Specified by:
  
  collapse in class SearchContext
- collapse
  
  public CollapseContext collapse()
  
  Specified by:
  
  collapse in class SearchContext

Class FilteredSearchContext

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 org.elasticsearch.common.util.concurrent.AbstractRefCounted

Methods inherited from class java.lang.Object

Constructor Details

Method Details