org.elasticsearch.index.query

Class GeoDistanceRangeQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.GeoDistanceRangeQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, QueryBuilder

public class GeoDistanceRangeQueryBuilder
extends AbstractQueryBuilder<GeoDistanceRangeQueryBuilder>

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
static GeoDistance	DEFAULT_GEO_DISTANCE
static boolean	DEFAULT_IGNORE_UNMAPPED The default value for ignore_unmapped.
static boolean	DEFAULT_INCLUDE_LOWER
static boolean	DEFAULT_INCLUDE_UPPER
static java.lang.String	DEFAULT_OPTIMIZE_BBOX Deprecated.
static DistanceUnit	DEFAULT_UNIT
static java.lang.String	NAME

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

boost, DEFAULT_BOOST, queryName

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
GeoDistanceRangeQueryBuilder(StreamInput in) Read from a stream.
GeoDistanceRangeQueryBuilder(java.lang.String fieldName, double lat, double lon)
GeoDistanceRangeQueryBuilder(java.lang.String fieldName, GeoPoint point)
GeoDistanceRangeQueryBuilder(java.lang.String fieldName, java.lang.String geohash)

Method Summary

Modifier and Type	Method and Description
protected boolean	doEquals(GeoDistanceRangeQueryBuilder 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(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	fieldName()
java.lang.Object	from()
GeoDistanceRangeQueryBuilder	from(java.lang.Number from)
GeoDistanceRangeQueryBuilder	from(java.lang.String from)
static java.util.Optional<GeoDistanceRangeQueryBuilder>	fromXContent(QueryParseContext parseContext)
GeoDistance	geoDistance()
GeoDistanceRangeQueryBuilder	geoDistance(GeoDistance geoDistance)
GeoValidationMethod	getValidationMethod() Returns validation method for coordinates.
java.lang.String	getWriteableName() Returns the name of the writeable object
boolean	ignoreUnmapped() Gets whether the query builder will ignore unmapped fields (and run a MatchNoDocsQuery in place of this query) or throw an exception if the field is unmapped.
GeoDistanceRangeQueryBuilder	ignoreUnmapped(boolean ignoreUnmapped) Sets whether the query builder should ignore unmapped fields (and run a MatchNoDocsQuery in place of this query) or throw an exception if the field is unmapped.
boolean	includeLower()
GeoDistanceRangeQueryBuilder	includeLower(boolean includeLower)
boolean	includeUpper()
GeoDistanceRangeQueryBuilder	includeUpper(boolean includeUpper)
java.lang.String	optimizeBbox() Deprecated.
GeoDistanceRangeQueryBuilder	optimizeBbox(java.lang.String optimizeBbox) Deprecated.
GeoPoint	point()
GeoDistanceRangeQueryBuilder	setValidationMethod(GeoValidationMethod method) Set validation method for coordinates.
java.lang.Object	to()
GeoDistanceRangeQueryBuilder	to(java.lang.Number to)
GeoDistanceRangeQueryBuilder	to(java.lang.String to)
DistanceUnit	unit()
GeoDistanceRangeQueryBuilder	unit(DistanceUnit unit)

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

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

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.xcontent.ToXContentObject

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DEFAULT_INCLUDE_LOWER

public static final boolean DEFAULT_INCLUDE_LOWER

See Also:

Constant Field Values

DEFAULT_INCLUDE_UPPER

public static final boolean DEFAULT_INCLUDE_UPPER

See Also:

Constant Field Values

DEFAULT_GEO_DISTANCE

public static final GeoDistance DEFAULT_GEO_DISTANCE

DEFAULT_UNIT

public static final DistanceUnit DEFAULT_UNIT

DEFAULT_OPTIMIZE_BBOX

@Deprecated
public static final java.lang.String DEFAULT_OPTIMIZE_BBOX

Deprecated.

See Also:

Constant Field Values

DEFAULT_IGNORE_UNMAPPED

public static final boolean DEFAULT_IGNORE_UNMAPPED

The default value for ignore_unmapped.

See Also:

Constant Field Values

Constructor Detail

GeoDistanceRangeQueryBuilder

public GeoDistanceRangeQueryBuilder(java.lang.String fieldName,
                                    GeoPoint point)

GeoDistanceRangeQueryBuilder

public GeoDistanceRangeQueryBuilder(java.lang.String fieldName,
                                    double lat,
                                    double lon)

GeoDistanceRangeQueryBuilder

public GeoDistanceRangeQueryBuilder(java.lang.String fieldName,
                                    java.lang.String geohash)

GeoDistanceRangeQueryBuilder

public GeoDistanceRangeQueryBuilder(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<GeoDistanceRangeQueryBuilder>

Throws:

java.io.IOException

fieldName

public java.lang.String fieldName()

point

public GeoPoint point()

from

public GeoDistanceRangeQueryBuilder from(java.lang.String from)

from

public GeoDistanceRangeQueryBuilder from(java.lang.Number from)

from

public java.lang.Object from()

to

public GeoDistanceRangeQueryBuilder to(java.lang.String to)

to

public GeoDistanceRangeQueryBuilder to(java.lang.Number to)

to

public java.lang.Object to()

includeLower

public GeoDistanceRangeQueryBuilder includeLower(boolean includeLower)

includeLower

public boolean includeLower()

includeUpper

public GeoDistanceRangeQueryBuilder includeUpper(boolean includeUpper)

includeUpper

public boolean includeUpper()

geoDistance

public GeoDistanceRangeQueryBuilder geoDistance(GeoDistance geoDistance)

geoDistance

public GeoDistance geoDistance()

unit

public GeoDistanceRangeQueryBuilder unit(DistanceUnit unit)

unit

public DistanceUnit unit()

optimizeBbox

@Deprecated
public GeoDistanceRangeQueryBuilder optimizeBbox(java.lang.String optimizeBbox)

Deprecated.

optimizeBbox

@Deprecated
public java.lang.String optimizeBbox()

Deprecated.

setValidationMethod

public GeoDistanceRangeQueryBuilder setValidationMethod(GeoValidationMethod method)

Set validation method for coordinates.

getValidationMethod

public GeoValidationMethod getValidationMethod()

Returns validation method for coordinates.

ignoreUnmapped

public GeoDistanceRangeQueryBuilder ignoreUnmapped(boolean ignoreUnmapped)

Sets whether the query builder should ignore unmapped fields (and run a MatchNoDocsQuery in place of this query) or throw an exception if the field is unmapped.

ignoreUnmapped

public boolean ignoreUnmapped()

Gets whether the query builder will ignore unmapped fields (and run a MatchNoDocsQuery in place of this query) or throw an exception if the field is unmapped.

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<GeoDistanceRangeQueryBuilder>

Throws:

java.io.IOException

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<GeoDistanceRangeQueryBuilder>

Throws:

java.io.IOException

fromXContent

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

Throws:

java.io.IOException

doEquals

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

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<GeoDistanceRangeQueryBuilder>

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object