Package org.opensearch.index.query

Class GeoDistanceQueryBuilder

java.lang.Object

org.opensearch.index.query.AbstractQueryBuilder<GeoDistanceQueryBuilder>

org.opensearch.index.query.GeoDistanceQueryBuilder

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>, WithFieldName

public class GeoDistanceQueryBuilder
extends AbstractQueryBuilder<GeoDistanceQueryBuilder>
implements WithFieldName

Filter results of a query to include only those within a specific distance to some geo point.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final DistanceUnit	DEFAULT_DISTANCE_UNIT	Default for distance unit computation.
static final GeoDistance	DEFAULT_GEO_DISTANCE	Default for geo distance computation.
static final boolean	DEFAULT_IGNORE_UNMAPPED	The default value for ignore_unmapped.
static final String	NAME

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

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GeoDistanceQueryBuilder(String fieldName)	Construct new GeoDistanceQueryBuilder.
GeoDistanceQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
double	distance()	Returns the distance configured as radius.
GeoDistanceQueryBuilder	distance(double distance, DistanceUnit unit)	Sets the distance from the center for this query.
GeoDistanceQueryBuilder	distance(String distance)	Sets the distance from the center using the default distance unit.
GeoDistanceQueryBuilder	distance(String distance, DistanceUnit unit)	Sets the distance from the center for this query.
protected boolean	doEquals(GeoDistanceQueryBuilder 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 shardContext)
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
protected void	doXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
String	fieldName()	Name of the field this query is operating on.
static GeoDistanceQueryBuilder	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
GeoDistance	geoDistance()	Returns geo distance calculation type to use.
GeoDistanceQueryBuilder	geoDistance(GeoDistance geoDistance)	Which type of geo distance calculation method to use.
GeoDistanceQueryBuilder	geohash(String geohash)	Sets the center point for this query.
GeoValidationMethod	getValidationMethod()	Returns validation method for geo coordinates.
String	getWriteableName()
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.
GeoDistanceQueryBuilder	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.
GeoPoint	point()	Returns the center point of the distance query.
GeoDistanceQueryBuilder	point(double lat, double lon)	Sets the center point of the query.
GeoDistanceQueryBuilder	point(GeoPoint point)	Sets the center point for the query.
void	setValidationMethod(GeoValidationMethod method)	Set validation method for geo coordinates.

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

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo

Methods inherited from class java.lang.Object

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

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

visit

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_DISTANCE_UNIT

public static final DistanceUnit DEFAULT_DISTANCE_UNIT

Default for distance unit computation.

DEFAULT_GEO_DISTANCE

public static final GeoDistance DEFAULT_GEO_DISTANCE

Default for geo distance computation.

DEFAULT_IGNORE_UNMAPPED

public static final boolean DEFAULT_IGNORE_UNMAPPED

The default value for ignore_unmapped.

See Also:

• Constant Field Values

Constructor Details

GeoDistanceQueryBuilder

public GeoDistanceQueryBuilder(String fieldName)

Construct new GeoDistanceQueryBuilder.

Parameters:

fieldName - name of indexed geo field to operate distance computation on.

GeoDistanceQueryBuilder

public GeoDistanceQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                        throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<GeoDistanceQueryBuilder>

Throws:

IOException

fieldName

public String fieldName()

Name of the field this query is operating on.

Specified by:

fieldName in interface WithFieldName

point

public GeoDistanceQueryBuilder point(GeoPoint point)

Sets the center point for the query.

Parameters:

point - the center of the query

point

public GeoDistanceQueryBuilder point(double lat,
 double lon)

Sets the center point of the query.

Parameters:

lat - latitude of center

lon - longitude of center

point

public GeoPoint point()

Returns the center point of the distance query.

distance

public GeoDistanceQueryBuilder distance(String distance)

Sets the distance from the center using the default distance unit.

distance

public GeoDistanceQueryBuilder distance(String distance,
 DistanceUnit unit)

Sets the distance from the center for this query.

distance

public GeoDistanceQueryBuilder distance(double distance,
 DistanceUnit unit)

Sets the distance from the center for this query.

distance

public double distance()

Returns the distance configured as radius.

geohash

public GeoDistanceQueryBuilder geohash(String geohash)

Sets the center point for this query.

geoDistance

public GeoDistanceQueryBuilder geoDistance(GeoDistance geoDistance)

Which type of geo distance calculation method to use.

geoDistance

public GeoDistance geoDistance()

Returns geo distance calculation type to use.

setValidationMethod

public void setValidationMethod(GeoValidationMethod method)

Set validation method for geo coordinates.

getValidationMethod

public GeoValidationMethod getValidationMethod()

Returns validation method for geo coordinates.

ignoreUnmapped

public GeoDistanceQueryBuilder 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 shardContext)
                                            throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<GeoDistanceQueryBuilder>

Throws:

IOException

doXContent

protected void doXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<GeoDistanceQueryBuilder>

Throws:

IOException

fromXContent

public static GeoDistanceQueryBuilder fromXContent(org.opensearch.core.xcontent.XContentParser parser)
                                            throws IOException

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<GeoDistanceQueryBuilder>

doEquals

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

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable