org.elasticsearch.search.suggest.completion2x.context

Class GeolocationContextMapping.Builder

java.lang.Object

org.elasticsearch.search.suggest.completion2x.context.ContextBuilder<GeolocationContextMapping>

org.elasticsearch.search.suggest.completion2x.context.GeolocationContextMapping.Builder

Enclosing class:

GeolocationContextMapping

public static class GeolocationContextMapping.Builder
extends ContextBuilder<GeolocationContextMapping>

Field Summary

Fields inherited from class org.elasticsearch.search.suggest.completion2x.context.ContextBuilder

name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(java.lang.String name)
protected	Builder(java.lang.String name, boolean neighbors, int... levels)

Method Summary

Modifier and Type	Method and Description
GeolocationContextMapping.Builder	addDefaultLocation(double lat, double lon) Set a default location that should be used, if no location is provided by the query
GeolocationContextMapping.Builder	addDefaultLocation(java.lang.String geohash) Set a default location that should be used, if no location is provided by the query
GeolocationContextMapping.Builder	addDefaultLocations(java.util.Collection<java.lang.String> geohashes) Set a default location that should be used, if no location is provided by the query
GeolocationContextMapping	build()
GeolocationContextMapping.Builder	defaultLocation(GeoPoint point) Set a default location that should be used, if no location is provided by the query
GeolocationContextMapping.Builder	field(java.lang.String fieldName) Set the name of the field containing a geolocation to use
GeolocationContextMapping.Builder	neighbors(boolean neighbors) Set neighborhood usage
GeolocationContextMapping.Builder	precision(double meters) Set the precision use o make suggestions
GeolocationContextMapping.Builder	precision(double precision, DistanceUnit unit) Set the precision use o make suggestions
GeolocationContextMapping.Builder	precision(int level) Set the precision use o make suggestions
GeolocationContextMapping.Builder	precision(java.lang.String precision) Set the precision use o make suggestions

Methods inherited from class org.elasticsearch.search.suggest.completion2x.context.ContextBuilder

category, category, loadMapping, loadMappings, location, location, reference, reference

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(java.lang.String name)

Builder

protected Builder(java.lang.String name,
                  boolean neighbors,
                  int... levels)

Method Detail

precision

public GeolocationContextMapping.Builder precision(java.lang.String precision)

Set the precision use o make suggestions

Parameters:

precision - precision as distance with DistanceUnit. Default: meters

Returns:

this

precision

public GeolocationContextMapping.Builder precision(double precision,
                                                   DistanceUnit unit)

Set the precision use o make suggestions

Parameters:

precision - precision value

unit - DistanceUnit to use

Returns:

this

precision

public GeolocationContextMapping.Builder precision(double meters)

Set the precision use o make suggestions

Parameters:

meters - precision as distance in meters

Returns:

this

precision

public GeolocationContextMapping.Builder precision(int level)

Set the precision use o make suggestions

Parameters:

level - maximum length of geohashes

Returns:

this

neighbors

public GeolocationContextMapping.Builder neighbors(boolean neighbors)

Set neighborhood usage

Parameters:

neighbors - should neighbor cells also be valid

Returns:

this

addDefaultLocation

public GeolocationContextMapping.Builder addDefaultLocation(java.lang.String geohash)

Set a default location that should be used, if no location is provided by the query

Parameters:

geohash - geohash of the default location

Returns:

this

addDefaultLocations

public GeolocationContextMapping.Builder addDefaultLocations(java.util.Collection<java.lang.String> geohashes)

Set a default location that should be used, if no location is provided by the query

Parameters:

geohashes - geohash of the default location

Returns:

this

addDefaultLocation

public GeolocationContextMapping.Builder addDefaultLocation(double lat,
                                                            double lon)

Set a default location that should be used, if no location is provided by the query

Parameters:

lat - latitude of the default location

lon - longitude of the default location

Returns:

this

defaultLocation

public GeolocationContextMapping.Builder defaultLocation(GeoPoint point)

Set a default location that should be used, if no location is provided by the query

Parameters:

point - location

Returns:

this

field

public GeolocationContextMapping.Builder field(java.lang.String fieldName)

Set the name of the field containing a geolocation to use

Parameters:

fieldName - name of the field

Returns:

this

build

public GeolocationContextMapping build()

Specified by:

build in class ContextBuilder<GeolocationContextMapping>