org.elasticsearch.index.query

Class AbstractQueryBuilder<QB extends AbstractQueryBuilder<QB>>

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, QueryBuilder

Direct Known Subclasses:

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, SpanWithinQueryBuilder, TermsQueryBuilder, TypeQueryBuilder, WildcardQueryBuilder, WrapperQueryBuilder

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

Base class for all classes producing lucene queries. Supports conversion to BytesReference and creation of lucene Query objects.

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

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

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

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected QueryValidationException	addValidationError(java.lang.String validationError, QueryValidationException validationException)
float	boost() Returns the boost for this query.
QB	boost(float boost) Sets the boost for this query.
protected static java.lang.Object	convertToBytesRefIfString(java.lang.Object obj) This helper method checks if the object passed in is a string, if so it converts it to a BytesRef.
protected static java.lang.Object	convertToStringIfBytesRef(java.lang.Object obj) This helper method checks if the object passed in is a BytesRef, if so it converts it to a utf8 string.
protected static void	declareStandardFields(AbstractObjectParser<? extends QueryBuilder,?> parser) Adds boost and query_name parsing to the AbstractObjectParser passed in.
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	doRewrite(QueryRewriteContext queryShardContext)
protected abstract org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected abstract void	doWriteTo(StreamOutput out)
protected abstract void	doXContent(XContentBuilder builder, ToXContent.Params params)
boolean	equals(java.lang.Object obj)
protected void	extractInnerHitBuilders(java.util.Map<java.lang.String,InnerHitContextBuilder> innerHits) For internal usage only! Extracts the inner hits from the query tree.
java.lang.String	getName() Returns the name that identifies uniquely the query
int	hashCode()
protected void	printBoostAndQueryName(XContentBuilder builder)
java.lang.String	queryName() Returns the query name for the query.
QB	queryName(java.lang.String queryName) Sets the query name for the query.
protected static java.util.List<QueryBuilder>	readQueries(StreamInput in)
protected static <T> T	requireValue(T value, java.lang.String message)
QueryBuilder	rewrite(QueryRewriteContext queryShardContext) Rewrites this query builder into its primitive form.
protected static void	throwParsingExceptionOnMultipleFields(java.lang.String queryName, XContentLocation contentLocation, java.lang.String processedFieldName, java.lang.String currentFieldName)
org.apache.lucene.search.Query	toFilter(QueryShardContext context) Converts this QueryBuilder to an unscored lucene Query that acts as a filter.
protected static java.util.Collection<org.apache.lucene.search.Query>	toQueries(java.util.Collection<QueryBuilder> queryBuilders, QueryShardContext context) Helper method to convert collection of QueryBuilder instances to lucene Query instances.
org.apache.lucene.search.Query	toQuery(QueryShardContext context) Converts this QueryBuilder to a lucene Query.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
protected static void	writeQueries(StreamOutput out, java.util.List<? extends QueryBuilder> queries)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.query.QueryBuilder

rewriteQuery

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

getWriteableName

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

isFragment

Field Detail

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 java.lang.String queryName

boost

protected float boost

Constructor Detail

AbstractQueryBuilder

protected AbstractQueryBuilder()

AbstractQueryBuilder

protected AbstractQueryBuilder(StreamInput in)
                        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

writeTo

public final void writeTo(StreamOutput out)
                   throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

doWriteTo

protected abstract void doWriteTo(StreamOutput out)
                           throws java.io.IOException

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

doXContent

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

Throws:

java.io.IOException

printBoostAndQueryName

protected void printBoostAndQueryName(XContentBuilder builder)
                               throws java.io.IOException

Throws:

java.io.IOException

toQuery

public final org.apache.lucene.search.Query toQuery(QueryShardContext context)
                                             throws java.io.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:

java.io.IOException

toFilter

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

Description copied from interface: QueryBuilder

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.

Specified by:

toFilter 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:

java.io.IOException

doToQuery

protected abstract org.apache.lucene.search.Query doToQuery(QueryShardContext context)
                                                     throws java.io.IOException

Throws:

java.io.IOException

queryName

public final QB queryName(java.lang.String queryName)

Sets the query name for the query.

Specified by:

queryName in interface QueryBuilder

queryName

public final java.lang.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

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(java.lang.String validationError,
                                                            QueryValidationException validationException)

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.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 java.lang.Object

doHashCode

protected abstract int doHashCode()

convertToBytesRefIfString

protected static java.lang.Object convertToBytesRefIfString(java.lang.Object obj)

This helper method checks if the object passed in is a string, if so it converts it to a BytesRef.

Parameters:

obj - the input object

Returns:

the same input object or a BytesRef representation if input was of type string

convertToStringIfBytesRef

protected static java.lang.Object convertToStringIfBytesRef(java.lang.Object obj)

This helper method checks if the object passed in is a BytesRef, if so it converts it to a utf8 string.

Parameters:

obj - the input object

Returns:

the same input object or a utf8 string if input was of type BytesRef

toQueries

protected static java.util.Collection<org.apache.lucene.search.Query> toQueries(java.util.Collection<QueryBuilder> queryBuilders,
                                                                                QueryShardContext context)
                                                                         throws QueryShardException,
                                                                                java.io.IOException

Helper method to convert collection of QueryBuilder instances to lucene Query instances. QueryBuilder that return null calling their QueryBuilder.toQuery(QueryShardContext) method are not added to the resulting collection.

Throws:

QueryShardException

java.io.IOException

getName

public java.lang.String getName()

Description copied from interface: QueryBuilder

Returns the name that identifies uniquely the query

Specified by:

getName in interface QueryBuilder

writeQueries

protected static final void writeQueries(StreamOutput out,
                                         java.util.List<? extends QueryBuilder> queries)
                                  throws java.io.IOException

Throws:

java.io.IOException

readQueries

protected static final java.util.List<QueryBuilder> readQueries(StreamInput in)
                                                         throws java.io.IOException

Throws:

java.io.IOException

rewrite

public final QueryBuilder rewrite(QueryRewriteContext queryShardContext)
                           throws java.io.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

Throws:

java.io.IOException

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryShardContext)
                          throws java.io.IOException

Throws:

java.io.IOException

extractInnerHitBuilders

protected void extractInnerHitBuilders(java.util.Map<java.lang.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.

requireValue

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

throwParsingExceptionOnMultipleFields

protected static void throwParsingExceptionOnMultipleFields(java.lang.String queryName,
                                                            XContentLocation contentLocation,
                                                            java.lang.String processedFieldName,
                                                            java.lang.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.