org.elasticsearch.index.query

Class GeohashCellQuery

java.lang.Object

org.elasticsearch.index.query.GeohashCellQuery

public class GeohashCellQuery
extends java.lang.Object

A geohash cell filter that filters GeoPoints by their geohashes. Basically the a Geohash prefix is defined by the filter and all geohashes that are matching this prefix will be returned. The neighbors flag allows to filter geohashes that surround the given geohash. In general the neighborhood of a geohash is defined by its eight adjacent cells.
The structure of the GeohashCellQuery is defined as:

 "geohash_bbox" {
     "field":"location",
     "geohash":"u33d8u5dkx8k",
     "neighbors":false
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeohashCellQuery.Builder Builder for a geohashfilter.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_IGNORE_UNMAPPED The default value for ignore_unmapped.
static boolean	DEFAULT_NEIGHBORS
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
GeohashCellQuery()

Method Summary

Modifier and Type	Method and Description
static org.apache.lucene.search.Query	create(QueryShardContext context, BaseGeoPointFieldMapper.LegacyGeoPointFieldType fieldType, java.lang.String geohash, java.util.List<java.lang.CharSequence> geohashes) Create a new geohash filter for a given set of geohashes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DEFAULT_NEIGHBORS

public static final boolean DEFAULT_NEIGHBORS

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

GeohashCellQuery

public GeohashCellQuery()

Method Detail

create

public static org.apache.lucene.search.Query create(QueryShardContext context,
                                                    BaseGeoPointFieldMapper.LegacyGeoPointFieldType fieldType,
                                                    java.lang.String geohash,
                                                    @Nullable
                                                    java.util.List<java.lang.CharSequence> geohashes)

Create a new geohash filter for a given set of geohashes. In general this method returns a boolean filter combining the geohashes OR-wise.

Parameters:

context - Context of the filter

fieldType - field mapper for geopoints

geohash - mandatory geohash

geohashes - optional array of additional geohashes

Returns:

a new GeoBoundinboxfilter