org.elasticsearch.search.suggest.context

Class ContextMapping.ContextQuery

java.lang.Object

org.elasticsearch.search.suggest.context.ContextMapping.ContextQuery

All Implemented Interfaces:

ToXContent

Enclosing class:

ContextMapping

public abstract static class ContextMapping.ContextQuery
extends Object
implements ToXContent

A ContextMapping.ContextQuery defines the context information for a specific ContextMapping defined within a suggestion request. According to the parameters set in the request and the ContextMapping such a query is used to wrap the TokenStream of the actual suggestion request into a TokenStream with the context settings

Nested Class Summary

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 String	name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContextMapping.ContextQuery(String name)

Method Summary

Methods

Modifier and Type	Method and Description
String	name()
static List<ContextMapping.ContextQuery>	parseQueries(Map<String,ContextMapping> mappings, XContentParser parser) Parse a set of ContextMapping.ContextQuery according to a given mapping
protected abstract org.apache.lucene.util.automaton.Automaton	toAutomaton() Build a LookUp Automaton for this context.
static org.apache.lucene.util.automaton.Automaton	toAutomaton(boolean preserveSep, Iterable<ContextMapping.ContextQuery> queries) Create a automaton for a given context query this automaton will be used to find the matching paths with the fst
String	toString()

Methods inherited from class java.lang.Object

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

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

toXContent

Field Detail

name

protected final String name

Constructor Detail

ContextMapping.ContextQuery

protected ContextMapping.ContextQuery(String name)

Method Detail

name

public String name()

toAutomaton

public static org.apache.lucene.util.automaton.Automaton toAutomaton(boolean preserveSep,
                                                     Iterable<ContextMapping.ContextQuery> queries)

Create a automaton for a given context query this automaton will be used to find the matching paths with the fst

Parameters:

preserveSep - set an additional char (XAnalyzingSuggester.SEP_LABEL) between each context query

queries - list of ContextMapping.ContextQuery defining the lookup context

Returns:

Automaton matching the given Query

toAutomaton

protected abstract org.apache.lucene.util.automaton.Automaton toAutomaton()

Build a LookUp Automaton for this context.

Returns:

LookUp Automaton

parseQueries

public static List<ContextMapping.ContextQuery> parseQueries(Map<String,ContextMapping> mappings,
                                             XContentParser parser)
                                                      throws IOException,
                                                             ElasticsearchParseException

Parse a set of ContextMapping.ContextQuery according to a given mapping

Parameters:

mappings - List of mapping defined y the suggest field

parser - parser holding the settings of the queries. The parsers current token is assumed hold an array. The number of elements in this array must match the number of elements in the mappings.

Returns:

List of context queries

Throws:

IOException - if something unexpected happened on the underlying stream

ElasticsearchParseException - if the list of queries could not be parsed

toString

public String toString()

Overrides:

toString in class Object