org.elasticsearch.index.query

Interface QueryBuilder

All Superinterfaces:

NamedWriteable, ToXContent, ToXContentObject, Writeable

All Known Subinterfaces:

MultiTermQueryBuilder, SpanQueryBuilder

All Known Implementing Classes:

AbstractQueryBuilder, BaseTermQueryBuilder, BoolQueryBuilder, BoostingQueryBuilder, CommonTermsQueryBuilder, ConstantScoreQueryBuilder, DisMaxQueryBuilder, ExistsQueryBuilder, FieldMaskingSpanQueryBuilder, FunctionScoreQueryBuilder, FuzzyQueryBuilder, GeoBoundingBoxQueryBuilder, GeoDistanceQueryBuilder, GeoDistanceRangeQueryBuilder, GeohashCellQuery.Builder, GeoPolygonQueryBuilder, GeoShapeQueryBuilder, IdsQueryBuilder, IndicesQueryBuilder, MatchAllQueryBuilder, MatchNoneQueryBuilder, MatchPhrasePrefixQueryBuilder, MatchPhraseQueryBuilder, MatchQueryBuilder, MoreLikeThisQueryBuilder, MultiMatchQueryBuilder, NestedQueryBuilder, PrefixQueryBuilder, QueryStringQueryBuilder, RangeQueryBuilder, RegexpQueryBuilder, ScriptQueryBuilder, SimpleQueryStringBuilder, SpanContainingQueryBuilder, SpanFirstQueryBuilder, SpanMultiTermQueryBuilder, SpanNearQueryBuilder, SpanNotQueryBuilder, SpanOrQueryBuilder, SpanTermQueryBuilder, SpanWithinQueryBuilder, TermQueryBuilder, TermsQueryBuilder, TypeQueryBuilder, WildcardQueryBuilder, WrapperQueryBuilder

public interface QueryBuilder
extends NamedWriteable, ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
float	boost() Returns the boost for this query.
QueryBuilder	boost(float boost) Sets the boost for this query.
java.lang.String	getName() Returns the name that identifies uniquely the query
java.lang.String	queryName() Returns the arbitrary name assigned to the query (see named queries).
QueryBuilder	queryName(java.lang.String queryName) Sets the arbitrary name to be assigned to the query (see named queries).
default QueryBuilder	rewrite(QueryRewriteContext queryShardContext) Rewrites this query builder into its primitive form.
static QueryBuilder	rewriteQuery(QueryBuilder original, QueryRewriteContext context) Rewrites the given query into its primitive form.
org.apache.lucene.search.Query	toFilter(QueryShardContext context) Converts this QueryBuilder to an unscored lucene Query that acts as a filter.
org.apache.lucene.search.Query	toQuery(QueryShardContext context) Converts this QueryBuilder to a lucene Query.

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

toXContent

Method Detail

toQuery

org.apache.lucene.search.Query toQuery(QueryShardContext context)
                                throws java.io.IOException

Converts this QueryBuilder to a lucene Query. Returns null if this query should be ignored in the context of parent queries.

Parameters:

context - additional information needed to construct the queries

Returns:

the Query or null if this query should be ignored upstream

Throws:

java.io.IOException

toFilter

org.apache.lucene.search.Query toFilter(QueryShardContext context)
                                 throws java.io.IOException

Converts this QueryBuilder to an unscored lucene Query that acts as a filter. Returns null if this query should be ignored in the context of parent queries.

Parameters:

context - additional information needed to construct the queries

Returns:

the Query or null if this query should be ignored upstream

Throws:

java.io.IOException

queryName

QueryBuilder queryName(java.lang.String queryName)

Sets the arbitrary name to be assigned to the query (see named queries). Implementers should return the concrete type of the QueryBuilder so that calls can be chained. This is done automatically when extending AbstractQueryBuilder.

queryName

java.lang.String queryName()

Returns the arbitrary name assigned to the query (see named queries).

boost

float boost()

Returns the boost for this query.

boost

QueryBuilder boost(float boost)

Sets the boost for this query. Documents matching this query will (in addition to the normal weightings) have their score multiplied by the boost provided. Implementers should return the concrete type of the QueryBuilder so that calls can be chained. This is done automatically when extending AbstractQueryBuilder.

getName

java.lang.String getName()

Returns the name that identifies uniquely the query

rewrite

default QueryBuilder rewrite(QueryRewriteContext queryShardContext)
                      throws java.io.IOException

Rewrites this query builder into its primitive form. By default this method return the builder itself. If the builder did not change the identity reference must be returned otherwise the builder will be rewritten infinitely.

Throws:

java.io.IOException

rewriteQuery

static QueryBuilder rewriteQuery(QueryBuilder original,
                                 QueryRewriteContext context)
                          throws java.io.IOException

Rewrites the given query into its primitive form. Queries 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 query until it doesn't change anymore.

Throws:

java.io.IOException - if an IOException occurs