Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class DistanceFeatureQueryBuilder

java.lang.Object

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

org.elasticsearch.index.query.DistanceFeatureQueryBuilder

All Implemented Interfaces:

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

public class DistanceFeatureQueryBuilder
extends AbstractQueryBuilder<DistanceFeatureQueryBuilder>

A query to boost scores based on their proximity to the given origin for date, date_nanos and geo_point field types

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DistanceFeatureQueryBuilder.Origin

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
static final 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.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DistanceFeatureQueryBuilder(String field, DistanceFeatureQueryBuilder.Origin origin, String pivot)
DistanceFeatureQueryBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(DistanceFeatureQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
static DistanceFeatureQueryBuilder	fromXContent(XContentParser parser)
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object

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

addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, throwParsingExceptionOnMultipleFields, 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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

DistanceFeatureQueryBuilder

public DistanceFeatureQueryBuilder(String field,
 DistanceFeatureQueryBuilder.Origin origin,
 String pivot)

DistanceFeatureQueryBuilder

public DistanceFeatureQueryBuilder(StreamInput in)
                            throws IOException

Throws:

IOException

Method Details

fromXContent

public static DistanceFeatureQueryBuilder fromXContent(XContentParser parser)

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<DistanceFeatureQueryBuilder>

Throws:

IOException

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<DistanceFeatureQueryBuilder>

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<DistanceFeatureQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<DistanceFeatureQueryBuilder>

doEquals

protected boolean doEquals(DistanceFeatureQueryBuilder 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<DistanceFeatureQueryBuilder>

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to