org.elasticsearch.index.query

Interface Rewriteable<T>

All Known Subinterfaces:

MultiTermQueryBuilder, QueryBuilder, SpanQueryBuilder

All Known Implementing Classes:

AbstractHighlighterBuilder, AbstractQueryBuilder, AliasFilter, BaseTermQueryBuilder, BoolQueryBuilder, BoostingQueryBuilder, CommonTermsQueryBuilder, ConstantScoreQueryBuilder, DisMaxQueryBuilder, ExistsQueryBuilder, FieldMaskingSpanQueryBuilder, FieldSortBuilder, FunctionScoreQueryBuilder, FuzzyQueryBuilder, GeoBoundingBoxQueryBuilder, GeoDistanceQueryBuilder, GeoDistanceSortBuilder, GeoPolygonQueryBuilder, GeoShapeQueryBuilder, HighlightBuilder, HighlightBuilder.Field, IdsQueryBuilder, MatchAllQueryBuilder, MatchNoneQueryBuilder, MatchPhrasePrefixQueryBuilder, MatchPhraseQueryBuilder, MatchQueryBuilder, MoreLikeThisQueryBuilder, MultiMatchQueryBuilder, NestedQueryBuilder, PrefixQueryBuilder, QueryRescorerBuilder, QueryStringQueryBuilder, RangeQueryBuilder, RegexpQueryBuilder, RescoreBuilder, ScoreSortBuilder, ScriptQueryBuilder, ScriptSortBuilder, SearchSourceBuilder, SimpleQueryStringBuilder, SortBuilder, SpanContainingQueryBuilder, SpanFirstQueryBuilder, SpanMultiTermQueryBuilder, SpanNearQueryBuilder, SpanNotQueryBuilder, SpanOrQueryBuilder, SpanTermQueryBuilder, SpanWithinQueryBuilder, TermQueryBuilder, TermsQueryBuilder, TypeQueryBuilder, WildcardQueryBuilder, WrapperQueryBuilder

public interface Rewriteable<T>

A basic interface for rewriteable classes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_REWRITE_ROUNDS

Method Summary

Modifier and Type	Method and Description
static <T extends Rewriteable<T>> java.util.List<T>	rewrite(java.util.List<T> rewritables, QueryRewriteContext context) Rewrites each element of the list until it doesn't change and returns a new list iff there is at least one element of the list that changed during it's rewrite.
T	rewrite(QueryRewriteContext ctx) Rewrites this instance based on the provided context.
static <T extends Rewriteable<T>> T	rewrite(T original, QueryRewriteContext context) Rewrites the given Rewriteable into its primitive form.
static <T extends Rewriteable<T>> T	rewrite(T original, QueryRewriteContext context, boolean assertNoAsyncTasks) Rewrites the given Rewriteable into its primitive form.
static <T extends Rewriteable<T>> void	rewriteAndFetch(T original, QueryRewriteContext context, ActionListener<T> rewriteResponse) Rewrites the given rewriteable and fetches pending async tasks for each round before rewriting again.
static <T extends Rewriteable<T>> void	rewriteAndFetch(T original, QueryRewriteContext context, ActionListener<T> rewriteResponse, int iteration) Rewrites the given rewriteable and fetches pending async tasks for each round before rewriting again.

Field Detail

MAX_REWRITE_ROUNDS

static final int MAX_REWRITE_ROUNDS

See Also:

Constant Field Values

Method Detail

rewrite

T rewrite(QueryRewriteContext ctx)
   throws java.io.IOException

Rewrites this instance based on the provided context. The returned objects will be the same instance as this if no changes during the rewrite were applied.

Throws:

java.io.IOException

rewrite

static <T extends Rewriteable<T>> T rewrite(T original,
                                            QueryRewriteContext context)
                                     throws java.io.IOException

Rewrites the given Rewriteable into its primitive form. Rewriteables that for instance fetch resources from remote hosts or can simplify / optimize itself should do their heavy lifting during rewrite(QueryRewriteContext). This method rewrites the rewriteable until it doesn't change anymore.

Parameters:

original - the original rewriteable to rewrite

context - the rewrite context to use

Throws:

java.io.IOException - if an IOException occurs

rewrite

static <T extends Rewriteable<T>> T rewrite(T original,
                                            QueryRewriteContext context,
                                            boolean assertNoAsyncTasks)
                                     throws java.io.IOException

Rewrites the given Rewriteable into its primitive form. Rewriteables that for instance fetch resources from remote hosts or can simplify / optimize itself should do their heavy lifting during rewriteAndFetch(Rewriteable, QueryRewriteContext, ActionListener) (QueryRewriteContext)}. This method rewrites the rewriteable until it doesn't change anymore.

Parameters:

original - the original rewriteable to rewrite

context - the rewrite context to use

assertNoAsyncTasks - if true the rewrite will fail if there are any pending async tasks on the context after the rewrite. See QueryRewriteContext.executeAsyncActions(ActionListener) for detals

Throws:

java.io.IOException - if an IOException occurs

rewriteAndFetch

static <T extends Rewriteable<T>> void rewriteAndFetch(T original,
                                                       QueryRewriteContext context,
                                                       ActionListener<T> rewriteResponse)

Rewrites the given rewriteable and fetches pending async tasks for each round before rewriting again.

rewriteAndFetch

static <T extends Rewriteable<T>> void rewriteAndFetch(T original,
                                                       QueryRewriteContext context,
                                                       ActionListener<T> rewriteResponse,
                                                       int iteration)

Rewrites the given rewriteable and fetches pending async tasks for each round before rewriting again.

rewrite

static <T extends Rewriteable<T>> java.util.List<T> rewrite(java.util.List<T> rewritables,
                                                            QueryRewriteContext context)
                                                     throws java.io.IOException

Rewrites each element of the list until it doesn't change and returns a new list iff there is at least one element of the list that changed during it's rewrite. Otherwise the given list instance is returned unchanged.

Throws:

java.io.IOException