org.elasticsearch.index.query

Class ConstantScoreQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.ConstantScoreQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder

public class ConstantScoreQueryBuilder
extends AbstractQueryBuilder<ConstantScoreQueryBuilder>

A query that wraps a filter and simply returns a constant score equal to the query boost for every document in the filter.

Nested Class Summary

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

Writeable.Reader<R>

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

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

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
ConstantScoreQueryBuilder(QueryBuilder filterBuilder) A query that wraps another query and simply returns a constant score equal to the query boost for every document in the query.
ConstantScoreQueryBuilder(StreamInput in) Read from a stream.

Method Summary

Modifier and Type	Method and Description
protected boolean	doEquals(ConstantScoreQueryBuilder other) Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
protected void	extractInnerHitBuilders(java.util.Map<java.lang.String,InnerHitBuilder> innerHits) For internal usage only! Extracts the inner hits from the query tree.
static java.util.Optional<ConstantScoreQueryBuilder>	fromXContent(QueryParseContext parseContext)
java.lang.String	getWriteableName() Returns the name of the writeable object
QueryBuilder	innerQuery()

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, equals, getName, hashCode, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, toFilter, toQueries, toQuery, toXContent, writeQueries, writeTo

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

buildAsBytes, buildAsBytes, 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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

ConstantScoreQueryBuilder

public ConstantScoreQueryBuilder(QueryBuilder filterBuilder)

A query that wraps another query and simply returns a constant score equal to the query boost for every document in the query.

Parameters:

filterBuilder - The query to wrap in a constant score query

ConstantScoreQueryBuilder

public ConstantScoreQueryBuilder(StreamInput in)
                          throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

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

Specified by:

doWriteTo in class AbstractQueryBuilder<ConstantScoreQueryBuilder>

Throws:

java.io.IOException

innerQuery

public QueryBuilder innerQuery()

Returns:

the query that was wrapped in this constant score query

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<ConstantScoreQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static java.util.Optional<ConstantScoreQueryBuilder> fromXContent(QueryParseContext parseContext)
                                                                  throws java.io.IOException

Throws:

java.io.IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<ConstantScoreQueryBuilder>

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<ConstantScoreQueryBuilder>

doEquals

protected boolean doEquals(ConstantScoreQueryBuilder other)

Description copied from class: AbstractQueryBuilder

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

Specified by:

doEquals in class AbstractQueryBuilder<ConstantScoreQueryBuilder>

doRewrite

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

Overrides:

doRewrite in class AbstractQueryBuilder<ConstantScoreQueryBuilder>

Throws:

java.io.IOException

extractInnerHitBuilders

protected void extractInnerHitBuilders(java.util.Map<java.lang.String,InnerHitBuilder> innerHits)

Description copied from class: AbstractQueryBuilder

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.

Overrides:

extractInnerHitBuilders in class AbstractQueryBuilder<ConstantScoreQueryBuilder>