org.elasticsearch.search.suggest.context

Class CategoryContextMapping

java.lang.Object

org.elasticsearch.search.suggest.context.ContextMapping

org.elasticsearch.search.suggest.context.CategoryContextMapping

All Implemented Interfaces:

ToXContent

public class CategoryContextMapping
extends ContextMapping

The CategoryContextMapping is used to define a ContextMapping that references a field within a document. The value of the field in turn will be used to setup the suggestions made by the completion suggester.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CategoryContextMapping.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
protected 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

Constructor and Description
CategoryContextMapping(String name) Create a new CategoryContextMapping with the default field [_type]
CategoryContextMapping(String name, Iterable<? extends CharSequence> defaultValues) Create a new CategoryContextMapping with the default field [_type]
CategoryContextMapping(String name, String fieldName) Create a new CategoryContextMapping with the default field [_type]
CategoryContextMapping(String name, String fieldName, Iterable<? extends CharSequence> defaultValues) Create a new CategoryContextMapping with the default field [_type]

Method Summary

Methods

Modifier and Type	Method and Description
org.elasticsearch.search.suggest.context.CategoryContextMapping.FieldConfig	defaultConfig()
boolean	equals(Object obj)
Iterable<? extends CharSequence>	getDefaultValues()
String	getFieldName() Name of the field used by this CategoryContextMapping
int	hashCode()
protected static CategoryContextMapping	load(String name, Map<String,Object> config) Load the specification of a CategoryContextMapping
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.CategoryContextMapping.FieldQuery	parseQuery(String name, XContentParser parser) Parse a query according to the context.
static org.elasticsearch.search.suggest.context.CategoryContextMapping.FieldQuery	query(String name, CharSequence... fieldvalues)
static org.elasticsearch.search.suggest.context.CategoryContextMapping.FieldQuery	query(String name, Iterable<? extends CharSequence> fieldvalues)
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

protected static final String TYPE

See Also:

Constant Field Values

Constructor Detail

CategoryContextMapping

public CategoryContextMapping(String name)

Create a new CategoryContextMapping with the default field [_type]

CategoryContextMapping

public CategoryContextMapping(String name,
                      String fieldName)

Create a new CategoryContextMapping with the default field [_type]

CategoryContextMapping

public CategoryContextMapping(String name,
                      Iterable<? extends CharSequence> defaultValues)

Create a new CategoryContextMapping with the default field [_type]

CategoryContextMapping

public CategoryContextMapping(String name,
                      String fieldName,
                      Iterable<? extends CharSequence> defaultValues)

Create a new CategoryContextMapping with the default field [_type]

Method Detail

getFieldName

public String getFieldName()

Name of the field used by this CategoryContextMapping

getDefaultValues

public Iterable<? extends CharSequence> getDefaultValues()

defaultConfig

public org.elasticsearch.search.suggest.context.CategoryContextMapping.FieldConfig defaultConfig()

Specified by:

defaultConfig in class ContextMapping

load

protected static CategoryContextMapping load(String name,
                          Map<String,Object> config)
                                      throws ElasticsearchParseException

Load the specification of a CategoryContextMapping

Parameters:

field - name of the field to use. If null default field will be used

Returns:

new CategoryContextMapping

Throws:

ElasticsearchParseException

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

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

parseQuery

public org.elasticsearch.search.suggest.context.CategoryContextMapping.FieldQuery 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

query

public static org.elasticsearch.search.suggest.context.CategoryContextMapping.FieldQuery query(String name,
                                                                               CharSequence... fieldvalues)

query

public static org.elasticsearch.search.suggest.context.CategoryContextMapping.FieldQuery query(String name,
                                                                               Iterable<? extends CharSequence> fieldvalues)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object