java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<GeoDistanceQueryBuilder>
org.elasticsearch.index.query.GeoDistanceQueryBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,QueryBuilder,Rewriteable<QueryBuilder>,ToXContent,ToXContentObject
Filter results of a query to include only those within a specific distance to some
geo point.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final DistanceUnitDefault for distance unit computation.static final GeoDistanceDefault for geo distance computation.static final booleanThe default value for ignore_unmapped.static final StringFields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryNameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionGeoDistanceQueryBuilder(String fieldName) Construct new GeoDistanceQueryBuilder.Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptiondoubledistance()Returns the distance configured as radius.distance(double distance, DistanceUnit unit) Sets the distance from the center for this query.Sets the distance from the center using the default distance unit.distance(String distance, DistanceUnit unit) Sets the distance from the center for this query.protected booleandoEquals(GeoDistanceQueryBuilder other) Indicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected intprotected org.apache.lucene.search.QuerydoToQuery(SearchExecutionContext context) protected voiddoWriteTo(StreamOutput out) protected voiddoXContent(XContentBuilder builder, ToXContent.Params params) Name of the field this query is operating on.static GeoDistanceQueryBuilderfromXContent(XContentParser parser) Returns geo distance calculation type to use.geoDistance(GeoDistance geoDistance) Which type of geo distance calculation method to use.Sets the center point for this query.The minimal version of the recipient this object can be sent toReturns validation method for geo coordinates.Returns the name of the writeable objectbooleanGets whether the query builder will ignore unmapped fields (and run aMatchNoDocsQueryin place of this query) or throw an exception if the field is unmapped.ignoreUnmapped(boolean ignoreUnmapped) Sets whether the query builder should ignore unmapped fields (and run aMatchNoDocsQueryin place of this query) or throw an exception if the field is unmapped.point()Returns the center point of the distance query.point(double lat, double lon) Sets the center point of the query.Sets the center point for the query.voidSet validation method for geo coordinates.Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doIndexMetadataRewrite, doInnerHitsRewrite, doRewrite, doSearchRewrite, equals, extractInnerHitBuilders, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
- See Also:
-
DEFAULT_DISTANCE_UNIT
Default for distance unit computation. -
DEFAULT_GEO_DISTANCE
Default for geo distance computation. -
DEFAULT_IGNORE_UNMAPPED
public static final boolean DEFAULT_IGNORE_UNMAPPEDThe default value for ignore_unmapped.- See Also:
-
-
Constructor Details
-
GeoDistanceQueryBuilder
Construct new GeoDistanceQueryBuilder.- Parameters:
fieldName- name of indexed geo field to operate distance computation on.
-
GeoDistanceQueryBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteToin classAbstractQueryBuilder<GeoDistanceQueryBuilder>- Throws:
IOException
-
fieldName
Name of the field this query is operating on. -
point
Sets the center point for the query.- Parameters:
point- the center of the query
-
point
Sets the center point of the query.- Parameters:
lat- latitude of centerlon- longitude of center
-
point
Returns the center point of the distance query. -
distance
Sets the distance from the center using the default distance unit. -
distance
Sets the distance from the center for this query. -
distance
Sets the distance from the center for this query. -
distance
public double distance()Returns the distance configured as radius. -
geohash
Sets the center point for this query. -
geoDistance
Which type of geo distance calculation method to use. -
geoDistance
Returns geo distance calculation type to use. -
setValidationMethod
Set validation method for geo coordinates. -
getValidationMethod
Returns validation method for geo coordinates. -
ignoreUnmapped
Sets whether the query builder should ignore unmapped fields (and run aMatchNoDocsQueryin 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 aMatchNoDocsQueryin place of this query) or throw an exception if the field is unmapped. -
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQueryin classAbstractQueryBuilder<GeoDistanceQueryBuilder>- Throws:
IOException
-
doXContent
- Specified by:
doXContentin classAbstractQueryBuilder<GeoDistanceQueryBuilder>- Throws:
IOException
-
fromXContent
- Throws:
IOException
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<GeoDistanceQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<GeoDistanceQueryBuilder>
-
getWriteableName
Description copied from interface:VersionedNamedWriteableReturns the name of the writeable object -
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to
-