org.elasticsearch.search.suggest.context

Class GeolocationContextMapping

java.lang.Object

org.elasticsearch.search.suggest.context.ContextMapping

org.elasticsearch.search.suggest.context.GeolocationContextMapping

All Implemented Interfaces:

ToXContent

public class GeolocationContextMapping
extends ContextMapping

The GeolocationContextMapping allows to take GeoInfomation into account during building suggestions. The mapping itself works with geohashes explicitly and is configured by three parameters:

• precision: length of the geohash indexed as prefix of the completion field
• neighbors: Should the neighbor cells of the deepest geohash level also be indexed as alternatives to the actual geohash
• location: (optional) location assumed if it is not provided

Internally this mapping wraps the suggestions into a form [geohash][suggestion]. If the neighbor option is set the cells next to the cell on the deepest geohash level ( precision) will be indexed as well. The TokenStream used to build the FST for suggestion will be wrapped into a PrefixAnalyzer.PrefixTokenFilter managing these geohases as prefixes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeolocationContextMapping.Builder

Nested classes/interfaces inherited from class org.elasticsearch.search.suggest.context.ContextMapping

ContextMapping.Context, ContextMapping.ContextConfig, ContextMapping.ContextQuery

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 String	FIELD_FIELDNAME
static String	FIELD_NEIGHBORS
static String	FIELD_PRECISION
static String	TYPE

Fields inherited from class org.elasticsearch.search.suggest.context.ContextMapping

EMPTY_CONFIG, EMPTY_CONTEXT, EMPTY_MAPPING, FIELD_MISSING, FIELD_TYPE, FIELD_VALUE, name, SEPARATOR, type

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GeolocationContextMapping(String name, int[] precision, boolean neighbors, Collection<String> defaultLocations, String fieldName) Create a new GeolocationContextMapping with a given precision

Method Summary

Methods

Modifier and Type	Method and Description
ContextMapping.ContextConfig	defaultConfig()
boolean	equals(Object obj)
int	hashCode()
protected static GeolocationContextMapping	load(String name, Map<String,Object> config) load a GeolocationContextMapping by configuration.
ContextMapping.ContextConfig	parseContext(ParseContext parseContext, XContentParser parser) A ContextMapping combined with the information provided by a document form a ContextMapping.ContextConfig which is used to build the underlying FST.
org.elasticsearch.search.suggest.context.GeolocationContextMapping.GeoQuery	parseQuery(String name, XContentParser parser) Parse a query according to the context.
protected static Collection<String>	parseSinglePointOrList(XContentParser parser)
static org.elasticsearch.search.suggest.context.GeolocationContextMapping.GeoQuery	query(String name, double lat, double lon, int... precisions) Create a new geolocation query from a given geocoordinate
static org.elasticsearch.search.suggest.context.GeolocationContextMapping.GeoQuery	query(String name, double lat, double lon, String... precisions)
static org.elasticsearch.search.suggest.context.GeolocationContextMapping.GeoQuery	query(String name, GeoPoint point) Create a new geolocation query from a given GeoPoint
static org.elasticsearch.search.suggest.context.GeolocationContextMapping.GeoQuery	query(String name, String geohash, int... precisions) Create a new geolocation query from a given geohash
protected XContentBuilder	toInnerXContent(XContentBuilder builder, ToXContent.Params params) Since every context mapping is assumed to have a name given by the field name of an context object, this method is used to build the value used to serialize the mapping

Methods inherited from class org.elasticsearch.search.suggest.context.ContextMapping

mappingsAreEqual, name, toString, toXContent, type

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

FIELD_PRECISION

public static final String FIELD_PRECISION

See Also:

Constant Field Values

FIELD_NEIGHBORS

public static final String FIELD_NEIGHBORS

See Also:

Constant Field Values

FIELD_FIELDNAME

public static final String FIELD_FIELDNAME

See Also:

Constant Field Values

Constructor Detail

GeolocationContextMapping

protected GeolocationContextMapping(String name,
                         int[] precision,
                         boolean neighbors,
                         Collection<String> defaultLocations,
                         String fieldName)

Create a new GeolocationContextMapping with a given precision

Parameters:

precision - length of the geohashes

neighbors - should neighbors be indexed

defaultLocations - location to use, if it is not provided by the document

Method Detail

load

protected static GeolocationContextMapping load(String name,
                             Map<String,Object> config)

load a GeolocationContextMapping by configuration. Such a configuration can set the parameters

• precision [String, Double, Float or Integer] defines the length of the underlying geohash
• defaultLocation [String] defines the location to use if it is not provided by the document
• neighbors [Boolean] defines if the last level of the geohash should be extended by neighbor cells

Parameters:

config - Configuration for GeolocationContextMapping

Returns:

new GeolocationContextMapping configured by the parameters of config

toInnerXContent

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

Description copied from class: ContextMapping

Since every context mapping is assumed to have a name given by the field name of an context object, this method is used to build the value used to serialize the mapping

Specified by:

toInnerXContent in class ContextMapping

Parameters:

builder - builder to append the mapping to

params - parameters passed to the builder

Returns:

the builder used

Throws:

IOException

parseSinglePointOrList

protected static Collection<String> parseSinglePointOrList(XContentParser parser)
                                                    throws IOException

Throws:

IOException

defaultConfig

public ContextMapping.ContextConfig defaultConfig()

Specified by:

defaultConfig in class ContextMapping

parseContext

public ContextMapping.ContextConfig parseContext(ParseContext parseContext,
                                        XContentParser parser)
                                          throws IOException,
                                                 ElasticsearchParseException

Description copied from class: ContextMapping

A ContextMapping combined with the information provided by a document form a ContextMapping.ContextConfig which is used to build the underlying FST.

Specified by:

parseContext in class ContextMapping

Parameters:

parseContext - context of parsing phase

parser - XContentParser used to read and setup the configuration

Returns:

A ContextMapping.ContextConfig related to this mapping

Throws:

IOException

ElasticsearchParseException

query

public static org.elasticsearch.search.suggest.context.GeolocationContextMapping.GeoQuery query(String name,
                                                                                GeoPoint point)

Create a new geolocation query from a given GeoPoint

Parameters:

point - query location

Returns:

new geolocation query

query

public static org.elasticsearch.search.suggest.context.GeolocationContextMapping.GeoQuery query(String name,
                                                                                double lat,
                                                                                double lon,
                                                                                int... precisions)

Create a new geolocation query from a given geocoordinate

Parameters:

lat - latitude of the location

lon - longitude of the location

Returns:

new geolocation query

query

public static org.elasticsearch.search.suggest.context.GeolocationContextMapping.GeoQuery query(String name,
                                                                                double lat,
                                                                                double lon,
                                                                                String... precisions)

query

public static org.elasticsearch.search.suggest.context.GeolocationContextMapping.GeoQuery query(String name,
                                                                                String geohash,
                                                                                int... precisions)

Create a new geolocation query from a given geohash

Parameters:

geohash - geohash of the location

Returns:

new geolocation query

parseQuery

public org.elasticsearch.search.suggest.context.GeolocationContextMapping.GeoQuery parseQuery(String name,
                                                                                     XContentParser parser)
                                                                                       throws IOException,
                                                                                              ElasticsearchParseException

Description copied from class: ContextMapping

Parse a query according to the context. Parsing starts at parsers current position

Specified by:

parseQuery in class ContextMapping

Parameters:

name - name of the context

parser - XContentParser providing the data of the query

Returns:

ContextMapping.ContextQuery according to this mapping

Throws:

IOException

ElasticsearchParseException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object