org.elasticsearch.search.suggest.context

Class ContextMapping

java.lang.Object

org.elasticsearch.search.suggest.context.ContextMapping

All Implemented Interfaces:

ToXContent

Direct Known Subclasses:

CategoryContextMapping, GeolocationContextMapping

public abstract class ContextMapping
extends Object
implements ToXContent

A ContextMapping is used t define a context that may used in conjunction with a suggester. To define a suggester that depends on a specific context derived class of ContextMapping will be used to specify the kind of additional information required in order to make suggestions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContextMapping.Context A collection of ContextMappings, their ContextMapping.ContextConfiguration and a Document form a complete ContextMapping.Context.
static class	ContextMapping.ContextConfig A ContextMapping combined with the information provided by a document form a ContextMapping.ContextConfig which is used to build the underlying FST.
static class	ContextMapping.ContextQuery A ContextMapping.ContextQuery defines the context information for a specific ContextMapping defined within a suggestion request.

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 SortedMap<String,ContextMapping.ContextConfig>	EMPTY_CONFIG Dummy Context Config matching the Dummy Mapping by providing an empty context
static ContextMapping.Context	EMPTY_CONTEXT Dummy Context matching the Dummy Mapping by not wrapping a TokenStream
static SortedMap<String,ContextMapping>	EMPTY_MAPPING Dummy Context Mapping that should be used if no context is used
static String	FIELD_MISSING
static String	FIELD_TYPE
static String	FIELD_VALUE
protected String	name
static char	SEPARATOR Character used to separate several contexts
protected String	type

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContextMapping(String type, String name) Define a new context mapping of a specific type

Method Summary

Methods

Modifier and Type	Method and Description
abstract ContextMapping.ContextConfig	defaultConfig()
static boolean	mappingsAreEqual(SortedMap<String,? extends ContextMapping> thisMappings, SortedMap<String,? extends ContextMapping> otherMappings) Test equality of two mapping
String	name()
abstract 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.
abstract ContextMapping.ContextQuery	parseQuery(String name, XContentParser parser) Parse a query according to the context.
protected abstract 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
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
protected String	type()

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final char SEPARATOR

Character used to separate several contexts

See Also:

Constant Field Values

EMPTY_MAPPING

public static final SortedMap<String,ContextMapping> EMPTY_MAPPING

Dummy Context Mapping that should be used if no context is used

EMPTY_CONFIG

public static final SortedMap<String,ContextMapping.ContextConfig> EMPTY_CONFIG

Dummy Context Config matching the Dummy Mapping by providing an empty context

EMPTY_CONTEXT

public static final ContextMapping.Context EMPTY_CONTEXT

Dummy Context matching the Dummy Mapping by not wrapping a TokenStream

FIELD_VALUE

public static final String FIELD_VALUE

See Also:

Constant Field Values

FIELD_MISSING

public static final String FIELD_MISSING

See Also:

Constant Field Values

FIELD_TYPE

public static final String FIELD_TYPE

See Also:

Constant Field Values

type

protected final String type

name

protected final String name

Constructor Detail

ContextMapping

protected ContextMapping(String type,
              String name)

Define a new context mapping of a specific type

Parameters:

type - name of the new context mapping

Method Detail

type

protected String type()

Returns:

the type name of the context

name

public String name()

Returns:

the name/id of the context

toXContent

public final XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                                 throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

parseContext

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

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

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

defaultConfig

public abstract ContextMapping.ContextConfig defaultConfig()

parseQuery

public abstract ContextMapping.ContextQuery parseQuery(String name,
                                     XContentParser parser)
                                                throws IOException,
                                                       ElasticsearchParseException

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

Parameters:

name - name of the context

parser - XContentParser providing the data of the query

Returns:

ContextMapping.ContextQuery according to this mapping

Throws:

IOException

ElasticsearchParseException

toInnerXContent

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

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

Parameters:

builder - builder to append the mapping to

params - parameters passed to the builder

Returns:

the builder used

Throws:

IOException

mappingsAreEqual

public static boolean mappingsAreEqual(SortedMap<String,? extends ContextMapping> thisMappings,
                       SortedMap<String,? extends ContextMapping> otherMappings)

Test equality of two mapping

Parameters:

thisMappings - first mapping

otherMappings - second mapping

Returns:

true if both arguments are equal

toString

public String toString()

Overrides:

toString in class Object