Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class AbstractQueryBuilder<QB extends AbstractQueryBuilder<QB>>

java.lang.Object

org.elasticsearch.index.query.AbstractQueryBuilder<QB>

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, QueryBuilder, Rewriteable<QueryBuilder>, ToXContent, ToXContentObject

Direct Known Subclasses:

BoolQueryBuilder, ConstantScoreQueryBuilder, DisMaxQueryBuilder, FunctionScoreQueryBuilder, LeafQueryBuilder, MatchBoolPrefixQueryBuilder, MatchPhrasePrefixQueryBuilder, MatchPhraseQueryBuilder, MatchQueryBuilder, MultiMatchQueryBuilder, ScriptScoreQueryBuilder, WrapperQueryBuilder

public abstract class AbstractQueryBuilder<QB extends AbstractQueryBuilder<QB>>
extends Object
implements QueryBuilder

Base class for query builders that produce Lucene queries. Provides XContent/stream serialization, boost and query-name handling, and the rewrite entry point.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected float	boost
static final ParseField	BOOST_FIELD
static final float	DEFAULT_BOOST	Default for boost to apply to resulting Lucene query.
static final ParseField	NAME_FIELD
protected String	queryName

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractQueryBuilder()
protected	AbstractQueryBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected final QueryValidationException	addValidationError(String validationError, QueryValidationException validationException)
final float	boost()	Returns the boost for this query.
final QB	boost(float boost)	Sets the boost for this query.
protected final void	boostAndQueryNameToXContent(XContentBuilder builder)	Add boost and query_name to the builder.
protected final void	checkNegativeBoost(float boost)
protected static void	declareStandardFields(AbstractObjectParser<? extends QueryBuilder,?> parser)	Adds boost and query_name parsing to the AbstractObjectParser passed in.
protected QueryBuilder	doCoordinatorRewrite(CoordinatorRewriteContext coordinatorRewriteContext)
protected abstract boolean	doEquals(QB other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected abstract int	doHashCode()
protected QueryBuilder	doIndexMetadataRewrite(QueryRewriteContext context)	Optional rewrite logic that only needs access to index level metadata and services (e.g.
protected QueryBuilder	doInnerHitsRewrite(InnerHitsRewriteContext context)	Optional rewrite logic that allows for optimization for extracting inner hits
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
protected QueryBuilder	doSearchRewrite(SearchExecutionContext searchExecutionContext)
protected abstract org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context, MaxClauseCountQueryVisitor visitor)	Builds the Lucene Query for this builder.
protected abstract void	doWriteTo(StreamOutput out)
protected abstract void	doXContent(XContentBuilder builder, ToXContent.Params params)
final boolean	equals(Object obj)
protected void	extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)	For internal usage only! Extracts the inner hits from the query tree.
static int	getMaxNestedDepth()
String	getName()	Returns the name that identifies uniquely the query
final int	hashCode()
protected static QueryBuilder	parseInnerQueryBuilder(XContentParser parser)	Parses an inner query.
static QueryBuilder	parseTopLevelQuery(XContentParser parser)	Parses and returns a query (excluding the query field that wraps it).
static QueryBuilder	parseTopLevelQuery(XContentParser parser, Consumer<String> queryNameConsumer)	Parses and returns a query (excluding the query field that wraps it).
protected final void	printBoostAndQueryName(XContentBuilder builder)	Deprecated. use boostAndQueryNameToXContent(org.elasticsearch.xcontent.XContentBuilder)
final String	queryName()	Returns the query name for the query.
final QB	queryName(String queryName)	Sets the query name for the query.
protected static List<QueryBuilder>	readQueries(StreamInput in)
protected static <T> T	requireValue(T value, String message)
final QueryBuilder	rewrite(QueryRewriteContext queryRewriteContext)	Rewrites this query builder into its primitive form.
static void	setMaxNestedDepth(int maxNestedDepth)	Set the maximum nested depth of bool queries.
protected static void	throwParsingExceptionOnMultipleFields(String queryName, XContentLocation contentLocation, String processedFieldName, String currentFieldName)
final org.apache.lucene.search.Query	toQuery(SearchExecutionContext context)	Converts this QueryBuilder to a lucene Query.
final org.apache.lucene.search.Query	toQuery(SearchExecutionContext context, MaxClauseCountQueryVisitor visitor)	Converts this QueryBuilder to a lucene Query with a MaxClauseCountQueryVisitor to prevent boolean query explosion.
final String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
protected static void	writeQueries(StreamOutput out, List<? extends QueryBuilder> queries)
final void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

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

getMinimalSupportedVersion, getWriteableName, supportsVersion

Field Details

DEFAULT_BOOST

public static final float DEFAULT_BOOST

Default for boost to apply to resulting Lucene query. Defaults to 1.0

See Also:

• Constant Field Values

NAME_FIELD

public static final ParseField NAME_FIELD

BOOST_FIELD

public static final ParseField BOOST_FIELD

queryName

protected String queryName

boost

protected float boost

Constructor Details

AbstractQueryBuilder

protected AbstractQueryBuilder()

AbstractQueryBuilder

protected AbstractQueryBuilder(StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

doWriteTo

protected abstract void doWriteTo(StreamOutput out)
                           throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

doXContent

protected abstract void doXContent(XContentBuilder builder,
 ToXContent.Params params)
                            throws IOException

Throws:

IOException

printBoostAndQueryName

@Deprecated
protected final void printBoostAndQueryName(XContentBuilder builder)
                                     throws IOException

Deprecated.

use boostAndQueryNameToXContent(org.elasticsearch.xcontent.XContentBuilder)

Add boost and query_name to the builder.

Throws:

IOException

boostAndQueryNameToXContent

protected final void boostAndQueryNameToXContent(XContentBuilder builder)
                                          throws IOException

Add boost and query_name to the builder.

Throws:

IOException

toQuery

public final org.apache.lucene.search.Query toQuery(SearchExecutionContext context)
                                             throws IOException

Description copied from interface: QueryBuilder

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

Specified by:

toQuery in interface QueryBuilder

Parameters:

context - additional information needed to construct the queries

Returns:

the Query or null if this query should be ignored upstream

Throws:

IOException

toQuery

public final org.apache.lucene.search.Query toQuery(SearchExecutionContext context,
 MaxClauseCountQueryVisitor visitor)
                                             throws IOException

Description copied from interface: QueryBuilder

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

Specified by:

toQuery in interface QueryBuilder

Parameters:

context - additional information needed to construct the queries

visitor - query MaxClauseCountQueryVisitor used to account for clauses while building the query

Returns:

the Query or null if this query should be ignored upstream

Throws:

IOException

doToQuery

protected abstract org.apache.lucene.search.Query doToQuery(SearchExecutionContext context,
 MaxClauseCountQueryVisitor visitor)
                                                     throws IOException

Builds the Lucene Query for this builder.

Implementations should use the provided QueryVisitor to visit any generated query or sub-queries. Boost and named-query handling are applied by QueryBuilder.toQuery(SearchExecutionContext, MaxClauseCountQueryVisitor). LeafQueryBuilder implementations get this visitor handling automatically.

Parameters:

context - additional information needed to construct the query

visitor - query MaxClauseCountQueryVisitor used to account for clauses while building the query

Returns:

the Query or null if this query should be ignored upstream

Throws:

IOException

queryName

public final QB queryName(String queryName)

Sets the query name for the query.

Specified by:

queryName in interface QueryBuilder

queryName

public final String queryName()

Returns the query name for the query.

Specified by:

queryName in interface QueryBuilder

boost

public final float boost()

Returns the boost for this query.

Specified by:

boost in interface QueryBuilder

checkNegativeBoost

protected final void checkNegativeBoost(float boost)

boost

public final QB 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.

Specified by:

boost in interface QueryBuilder

addValidationError

protected final QueryValidationException addValidationError(String validationError,
 QueryValidationException validationException)

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

doEquals

protected abstract boolean doEquals(QB other)

Indicates whether some other QueryBuilder object of the same type is "equal to" this one.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

doHashCode

protected abstract int doHashCode()

getName

public String getName()

Description copied from interface: QueryBuilder

Returns the name that identifies uniquely the query

Specified by:

getName in interface QueryBuilder

writeQueries

protected static void writeQueries(StreamOutput out,
 List<? extends QueryBuilder> queries)
                            throws IOException

Throws:

IOException

readQueries

protected static List<QueryBuilder> readQueries(StreamInput in)
                                         throws IOException

Throws:

IOException

rewrite

public final QueryBuilder rewrite(QueryRewriteContext queryRewriteContext)
                           throws IOException

Description copied from interface: QueryBuilder

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.

Specified by:

rewrite in interface QueryBuilder

Specified by:

rewrite in interface Rewriteable<QB extends AbstractQueryBuilder<QB>>

Throws:

IOException

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Throws:

IOException

doCoordinatorRewrite

protected QueryBuilder doCoordinatorRewrite(CoordinatorRewriteContext coordinatorRewriteContext)

Parameters:

coordinatorRewriteContext - A QueryRewriteContext that enables limited rewrite capabilities happening on the coordinator node before execution moves to the data node.

Returns:

A QueryBuilder representing the rewritten query which could be executed without going to the date node.

doSearchRewrite

protected QueryBuilder doSearchRewrite(SearchExecutionContext searchExecutionContext)
                                throws IOException

Parameters:

searchExecutionContext - A QueryRewriteContext that enables full rewrite capabilities happening on the data node with all information available for rewriting.

Returns:

A QueryBuilder representing the rewritten query.

Throws:

IOException

doIndexMetadataRewrite

protected QueryBuilder doIndexMetadataRewrite(QueryRewriteContext context)
                                       throws IOException

Optional rewrite logic that only needs access to index level metadata and services (e.g. index settings and mappings) on the data node, but not the shard / Lucene index. The can_match phase can use this logic to early terminate a search without doing any search related i/o.

Parameters:

context - an QueryRewriteContext instance that has access the mappings and other index metadata

Returns:

A QueryBuilder representing the rewritten query, that could be used to determine whether this query yields result.

Throws:

IOException

doInnerHitsRewrite

protected QueryBuilder doInnerHitsRewrite(InnerHitsRewriteContext context)
                                   throws IOException

Optional rewrite logic that allows for optimization for extracting inner hits

Parameters:

context - an InnerHitsRewriteContext instance

Returns:

A QueryBuilder representing the rewritten query optimized for inner hit extraction

Throws:

IOException - if an error occurs while rewriting the query

extractInnerHitBuilders

protected void extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)

For internal usage only! Extracts the inner hits from the query tree. While it extracts inner hits, child inner hits are inlined into the inner hit builder they belong to.

parseTopLevelQuery

public static QueryBuilder parseTopLevelQuery(XContentParser parser)
                                       throws IOException

Parses and returns a query (excluding the query field that wraps it). To be called by API that support user provided queries. Note that the returned query may hold inner queries, and so on. Calling this method will initialize the tracking of nested depth to make sure that there's a limit to the number of queries that can be nested within one another (see SearchModule.INDICES_MAX_NESTED_DEPTH_SETTING. This variant of the method does not support collecting statistics about queries usage.

Throws:

IOException

parseTopLevelQuery

public static QueryBuilder parseTopLevelQuery(XContentParser parser,
 Consumer<String> queryNameConsumer)
                                       throws IOException

Parses and returns a query (excluding the query field that wraps it). To be called by API that support user provided queries. Note that the returned query may hold inner queries, and so on. Calling this method will initialize the tracking of nested depth to make sure that there's a limit to the number of queries that can be nested within one another (see SearchModule.INDICES_MAX_NESTED_DEPTH_SETTING. The method accepts a string consumer that will be provided with each query type used in the parsed content, to be used for instance to collect statistics about queries usage.

Throws:

IOException

parseInnerQueryBuilder

protected static QueryBuilder parseInnerQueryBuilder(XContentParser parser)
                                              throws IOException

Parses an inner query. To be called by query implementations that support inner queries.

Throws:

IOException

requireValue

protected static <T> T requireValue(T value,
 String message)

throwParsingExceptionOnMultipleFields

protected static void throwParsingExceptionOnMultipleFields(String queryName,
 XContentLocation contentLocation,
 String processedFieldName,
 String currentFieldName)

declareStandardFields

protected static void declareStandardFields(AbstractObjectParser<? extends QueryBuilder,?> parser)

Adds boost and query_name parsing to the AbstractObjectParser passed in. All query builders except MatchAllQueryBuilder and MatchNoneQueryBuilder support these fields so they should use this method.

setMaxNestedDepth

public static void setMaxNestedDepth(int maxNestedDepth)

Set the maximum nested depth of bool queries. Default value is 20.

getMaxNestedDepth

public static int getMaxNestedDepth()

toString

public final String toString()

Overrides:

toString in class Object