org.elasticsearch.search.suggest.context

Class ContextBuilder<E extends ContextMapping>

java.lang.Object

org.elasticsearch.search.suggest.context.ContextBuilder<E>

Direct Known Subclasses:

CategoryContextMapping.Builder, GeolocationContextMapping.Builder

public abstract class ContextBuilder<E extends ContextMapping>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Constructor Summary

Constructors

Constructor and Description
ContextBuilder(String name)

Method Summary

Methods

Modifier and Type	Method and Description
abstract E	build()
static CategoryContextMapping.Builder	category(String name) Create a new CategoryMapping
static CategoryContextMapping.Builder	category(String name, String defaultCategory) Create a new CategoryMapping with default category
protected static ContextMapping	loadMapping(String name, Map<String,Object> config, Version indexVersionCreated)
static SortedMap<String,ContextMapping>	loadMappings(Object configuration, Version indexVersionCreated)
static GeolocationContextMapping.Builder	location(String name) Create a new GeolocationContextMapping
static GeolocationContextMapping.Builder	location(String name, int precision, boolean neighbors) Create a new GeolocationContextMapping with given precision and neighborhood usage
static CategoryContextMapping.Builder	reference(String name, String fieldname) Create a new CategoryContextMapping
static CategoryContextMapping.Builder	reference(String name, String fieldname, Iterable<? extends CharSequence> defaultValues) Create a new CategoryContextMapping

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

Constructor Detail

ContextBuilder

public ContextBuilder(String name)

Method Detail

build

public abstract E build()

location

public static GeolocationContextMapping.Builder location(String name)

Create a new GeolocationContextMapping

location

public static GeolocationContextMapping.Builder location(String name,
                                         int precision,
                                         boolean neighbors)

Create a new GeolocationContextMapping with given precision and neighborhood usage

Parameters:

precision - geohash length

neighbors - use neighbor cells

category

public static CategoryContextMapping.Builder category(String name)

Create a new CategoryMapping

category

public static CategoryContextMapping.Builder category(String name,
                                      String defaultCategory)

Create a new CategoryMapping with default category

Parameters:

defaultCategory - category to use, if it is not provided

reference

public static CategoryContextMapping.Builder reference(String name,
                                       String fieldname)

Create a new CategoryContextMapping

Parameters:

fieldname - name of the field to use

reference

public static CategoryContextMapping.Builder reference(String name,
                                       String fieldname,
                                       Iterable<? extends CharSequence> defaultValues)

Create a new CategoryContextMapping

Parameters:

fieldname - name of the field to use

defaultValues - values to use, if the document not provides a field with the given name

loadMappings

public static SortedMap<String,ContextMapping> loadMappings(Object configuration,
                                            Version indexVersionCreated)
                                                     throws ElasticsearchParseException

Throws:

ElasticsearchParseException

loadMapping

protected static ContextMapping loadMapping(String name,
                         Map<String,Object> config,
                         Version indexVersionCreated)
                                     throws ElasticsearchParseException

Throws:

ElasticsearchParseException