Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class LeafQueryBuilder<QB extends LeafQueryBuilder<QB>>

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractGeometryQueryBuilder, BaseTermQueryBuilder, BoostingQueryBuilder, CombinedFieldsQueryBuilder, DistanceFeatureQueryBuilder, ExactKnnQueryBuilder, ExistsQueryBuilder, FieldMaskingSpanQueryBuilder, FuzzyQueryBuilder, GeoBoundingBoxQueryBuilder, GeoDistanceQueryBuilder, GeoPolygonQueryBuilder, IdsQueryBuilder, IntervalQueryBuilder, KnnScoreDocQueryBuilder, KnnVectorQueryBuilder, MatchAllQueryBuilder, MatchNoneQueryBuilder, MoreLikeThisQueryBuilder, NestedQueryBuilder, PrefixQueryBuilder, QueryStringQueryBuilder, RandomSamplingQueryBuilder, RangeQueryBuilder, RankDocsQueryBuilder, RegexpQueryBuilder, ScriptQueryBuilder, SimpleQueryStringBuilder, SpanContainingQueryBuilder, SpanFirstQueryBuilder, SpanMultiTermQueryBuilder, SpanNearQueryBuilder, SpanNotQueryBuilder, SpanOrQueryBuilder, SpanWithinQueryBuilder, TermsQueryBuilder, TermsSetQueryBuilder, ToChildBlockJoinQueryBuilder, WildcardQueryBuilder

public abstract class LeafQueryBuilder<QB extends LeafQueryBuilder<QB>>
extends AbstractQueryBuilder<QB>

Base class for query builders that produce a single Lucene query.

Implementations provide the query via doToQuery(SearchExecutionContext) and this class ensures the resulting query is visited by the provided QueryVisitor.

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 inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, 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	LeafQueryBuilder()
protected	LeafQueryBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected abstract org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected final org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context, MaxClauseCountQueryVisitor queryVisitor)	Builds the Lucene Query for this builder.

Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doEquals, doHashCode, doIndexMetadataRewrite, doInnerHitsRewrite, doRewrite, doSearchRewrite, doWriteTo, doXContent, equals, extractInnerHitBuilders, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toQuery, toString, toXContent, writeQueries, writeTo

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

Constructor Details

LeafQueryBuilder

protected LeafQueryBuilder()

LeafQueryBuilder

protected LeafQueryBuilder(StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

doToQuery

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

Description copied from class: AbstractQueryBuilder

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.

Specified by:

doToQuery in class AbstractQueryBuilder<QB extends LeafQueryBuilder<QB>>

Parameters:

context - additional information needed to construct the query

queryVisitor - 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)
                                                     throws IOException

Throws:

IOException