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

Class ContextMappings

java.lang.Object

org.elasticsearch.search.suggest.completion.context.ContextMappings

All Implemented Interfaces:

Iterable<ContextMapping<?>>, ToXContent

public class ContextMappings
extends Object
implements ToXContent, Iterable<ContextMapping<?>>

ContextMappings indexes context-enabled suggestion fields and creates context queries for defined ContextMappings for a CompletionFieldMapper

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ContextMappings(List<ContextMapping<?>> contextMappings)

Method Summary

Modifier and Type	Method	Description
void	addField(ParseContext.Document document, String name, String input, int weight, Map<String,Set<String>> contexts)	Adds a context-enabled field for all the defined mappings to document see ContextMappings.TypedContextField
boolean	equals(Object obj)
ContextMapping<?>	get(String name)	Returns a context mapping by its name
Map<String,Set<String>>	getNamedContexts(List<CharSequence> contexts)	Maps an output context list to a map of context mapping names and their values see ContextMappings.TypedContextField
int	hashCode()
Iterator<ContextMapping<?>>	iterator()
static ContextMappings	load(Object configuration, Version indexVersionCreated)	Loads ContextMappings from configuration Expected configuration: List of maps representing ContextMapping [{"name": .., "type": .., ..}, {..}]
int	size()
ContextQuery	toContextQuery(CompletionQuery query, Map<String,List<ContextMapping.InternalQueryContext>> queryContexts)	Wraps a CompletionQuery with context queries
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)	Writes a list of objects specified by the defined ContextMappings see ContextMapping.toXContent(XContentBuilder, Params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

isFragment

Constructor Detail

ContextMappings

public ContextMappings(List<ContextMapping<?>> contextMappings)

Method Detail

size

public int size()

Returns:

number of context mappings held by this instance

get

public ContextMapping<?> get(String name)

Returns a context mapping by its name

addField

public void addField(ParseContext.Document document,
                     String name,
                     String input,
                     int weight,
                     Map<String,Set<String>> contexts)

Adds a context-enabled field for all the defined mappings to document see ContextMappings.TypedContextField

iterator

public Iterator<ContextMapping<?>> iterator()

Specified by:

iterator in interface Iterable<ContextMapping<?>>

toContextQuery

public ContextQuery toContextQuery(CompletionQuery query,
                                   Map<String,List<ContextMapping.InternalQueryContext>> queryContexts)

Wraps a CompletionQuery with context queries

Parameters:

query - base completion query to wrap

queryContexts - a map of context mapping name and collected query contexts

Returns:

a context-enabled query

getNamedContexts

public Map<String,Set<String>> getNamedContexts(List<CharSequence> contexts)

Maps an output context list to a map of context mapping names and their values see ContextMappings.TypedContextField

Returns:

a map of context names and their values

load

public static ContextMappings load(Object configuration,
                                   Version indexVersionCreated)
                            throws ElasticsearchParseException

Loads ContextMappings from configuration Expected configuration: List of maps representing ContextMapping [{"name": .., "type": .., ..}, {..}]

Throws:

ElasticsearchParseException

toXContent

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

Writes a list of objects specified by the defined ContextMappings see ContextMapping.toXContent(XContentBuilder, Params)

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object