Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class QueryRewriteContext

java.lang.Object

org.elasticsearch.index.query.QueryRewriteContext

Direct Known Subclasses:

CoordinatorRewriteContext, SearchExecutionContext

public class QueryRewriteContext
extends Object

Context object used to rewrite QueryBuilder instances into simplified version.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Client	client
protected final LongSupplier	nowInMillis

Constructor Summary

Constructors

Constructor	Description
QueryRewriteContext(XContentParserConfiguration parserConfiguration, NamedWriteableRegistry writeableRegistry, Client client, LongSupplier nowInMillis)

Method Summary

Modifier and Type	Method	Description
CoordinatorRewriteContext	convertToCoordinatorRewriteContext()
SearchExecutionContext	convertToSearchExecutionContext()	Returns an instance of SearchExecutionContext if available of null otherwise
void	executeAsyncActions(ActionListener listener)	Executes all registered async actions and notifies the listener once it's done.
XContentParserConfiguration	getParserConfig()	The registry used to build new XContentParsers.
NamedWriteableRegistry	getWriteableRegistry()
boolean	hasAsyncActions()	Returns true if there are any registered async actions.
long	nowInMillis()	Returns the time in milliseconds that is shared across all resources involved.
void	registerAsyncAction(BiConsumer<Client,ActionListener<?>> asyncAction)	Registers an async action that must be executed before the next rewrite round in order to make progress.

Methods inherited from class java.lang.Object

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

Field Details

client

protected final Client client

nowInMillis

protected final LongSupplier nowInMillis

Constructor Details

QueryRewriteContext

public QueryRewriteContext(XContentParserConfiguration parserConfiguration,
 NamedWriteableRegistry writeableRegistry,
 Client client,
 LongSupplier nowInMillis)

Method Details

getParserConfig

public XContentParserConfiguration getParserConfig()

The registry used to build new XContentParsers. Contains registered named parsers needed to parse the query.

nowInMillis

public long nowInMillis()

Returns the time in milliseconds that is shared across all resources involved. Even across shards and nodes.

getWriteableRegistry

public NamedWriteableRegistry getWriteableRegistry()

convertToSearchExecutionContext

public SearchExecutionContext convertToSearchExecutionContext()

Returns an instance of SearchExecutionContext if available of null otherwise

convertToCoordinatorRewriteContext

public CoordinatorRewriteContext convertToCoordinatorRewriteContext()

registerAsyncAction

public void registerAsyncAction(BiConsumer<Client,ActionListener<?>> asyncAction)

Registers an async action that must be executed before the next rewrite round in order to make progress. This should be used if a rewriteabel needs to fetch some external resources in order to be executed ie. a document from an index.

hasAsyncActions

public boolean hasAsyncActions()

Returns true if there are any registered async actions.

executeAsyncActions

public void executeAsyncActions(ActionListener listener)

Executes all registered async actions and notifies the listener once it's done. The value that is passed to the listener is always null. The list of registered actions is cleared once this method returns.