Package org.elasticsearch.search.suggest.completion.context

Class ContextMapping<T extends org.elasticsearch.common.xcontent.ToXContent>

java.lang.Object

org.elasticsearch.search.suggest.completion.context.ContextMapping<T>

All Implemented Interfaces:

org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

Direct Known Subclasses:

CategoryContextMapping, GeoContextMapping

public abstract class ContextMapping<T extends org.elasticsearch.common.xcontent.ToXContent>
extends Object
implements org.elasticsearch.common.xcontent.ToXContentFragment

A ContextMapping defines criteria that can be used to filter and/or boost suggestions at query time for CompletionFieldMapper. Implementations have to define how contexts are parsed at query/index time

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContextMapping.InternalQueryContext
static class	ContextMapping.Type

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static String	FIELD_NAME
static String	FIELD_TYPE
protected String	name
protected ContextMapping.Type	type

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

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
protected abstract T	fromXContent(org.elasticsearch.common.xcontent.XContentParser context)	Prototype for the query context
int	hashCode()
String	name()
protected abstract Set<String>	parseContext(LuceneDocument document)	Retrieves a set of context from a document at index-time.
abstract Set<String>	parseContext(ParseContext parseContext, org.elasticsearch.common.xcontent.XContentParser parser)	Parses a set of index-time contexts.
List<ContextMapping.InternalQueryContext>	parseQueryContext(org.elasticsearch.common.xcontent.XContentParser parser)	Parses query contexts for this mapper
protected abstract org.elasticsearch.common.xcontent.XContentBuilder	toInnerXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)	Implementations should add specific configurations that need to be persisted
protected abstract List<ContextMapping.InternalQueryContext>	toInternalQueryContexts(List<T> queryContexts)	Convert query contexts to common representation
String	toString()
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
ContextMapping.Type	type()
void	validateReferences(Version indexVersionCreated, Function<String,MappedFieldType> fieldResolver)	Checks if the current context is consistent with the rest of the fields.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Details

FIELD_TYPE

public static final String FIELD_TYPE

See Also:

Constant Field Values

FIELD_NAME

public static final String FIELD_NAME

See Also:

Constant Field Values

type

protected final ContextMapping.Type type

name

protected final String name

Constructor Details

ContextMapping

protected ContextMapping(ContextMapping.Type type,
 String name)

Define a new context mapping of a specific type

Parameters:

type - type of context mapping, either ContextMapping.Type.CATEGORY or ContextMapping.Type.GEO

name - name of context mapping

Method Details

type

public ContextMapping.Type type()

Returns:

the type name of the context

name

public String name()

Returns:

the name/id of the context

parseContext

public abstract Set<String> parseContext(ParseContext parseContext,
 org.elasticsearch.common.xcontent.XContentParser parser)
                                  throws IOException,
ElasticsearchParseException

Parses a set of index-time contexts.

Throws:

IOException

ElasticsearchParseException

parseContext

protected abstract Set<String> parseContext(LuceneDocument document)

Retrieves a set of context from a document at index-time.

fromXContent

protected abstract T fromXContent(org.elasticsearch.common.xcontent.XContentParser context)
                           throws IOException

Prototype for the query context

Throws:

IOException

parseQueryContext

public final List<ContextMapping.InternalQueryContext> parseQueryContext(org.elasticsearch.common.xcontent.XContentParser parser)
                                                                  throws IOException,
ElasticsearchParseException

Parses query contexts for this mapper

Throws:

IOException

ElasticsearchParseException

toInternalQueryContexts

protected abstract List<ContextMapping.InternalQueryContext> toInternalQueryContexts(List<T> queryContexts)

Convert query contexts to common representation

toInnerXContent

protected abstract org.elasticsearch.common.xcontent.XContentBuilder toInnerXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                                              throws IOException

Implementations should add specific configurations that need to be persisted

Throws:

IOException

validateReferences

public void validateReferences(Version indexVersionCreated,
 Function<String,MappedFieldType> fieldResolver)

Checks if the current context is consistent with the rest of the fields. For example, the GeoContext should check that the field that it points to has the correct type.

toXContent

public final org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                                   throws IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object