org.elasticsearch.search.suggest.completion.context

Class CategoryContextMapping

java.lang.Object

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

org.elasticsearch.search.suggest.completion.context.CategoryContextMapping

All Implemented Interfaces:

ToXContent, ToXContentFragment

public class CategoryContextMapping
extends ContextMapping<CategoryQueryContext>

A ContextMapping that uses a simple string as a criteria The suggestions are boosted and/or filtered by their associated category (string) value. CategoryQueryContext defines options for constructing a unit of query context for this context type

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CategoryContextMapping.Builder Builder for CategoryContextMapping

Nested classes/interfaces inherited from class org.elasticsearch.search.suggest.completion.context.ContextMapping

ContextMapping.InternalQueryContext, ContextMapping.Type

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.search.suggest.completion.context.ContextMapping

FIELD_NAME, FIELD_TYPE, name, type

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
protected CategoryQueryContext	fromXContent(XContentParser parser) Prototype for the query context
java.lang.String	getFieldName() Name of the field to get contexts from at index-time
int	hashCode()
protected static CategoryContextMapping	load(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> config) Loads a named CategoryContextMapping instance from a map.
java.util.Set<java.lang.CharSequence>	parseContext(ParseContext.Document document) Retrieves a set of context from a document at index-time.
java.util.Set<java.lang.CharSequence>	parseContext(ParseContext parseContext, XContentParser parser) Parse a set of CharSequence contexts at index-time.
protected XContentBuilder	toInnerXContent(XContentBuilder builder, ToXContent.Params params) Implementations should add specific configurations that need to be persisted
java.util.List<ContextMapping.InternalQueryContext>	toInternalQueryContexts(java.util.List<CategoryQueryContext> queryContexts) Parse a list of CategoryQueryContext using parser.

Methods inherited from class org.elasticsearch.search.suggest.completion.context.ContextMapping

name, parseQueryContext, toString, toXContent, type

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

Method Detail

getFieldName

public java.lang.String getFieldName()

Name of the field to get contexts from at index-time

load

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

Loads a named CategoryContextMapping instance from a map. see ContextMappings.load(Object, Version) Acceptable map param: path

Throws:

ElasticsearchParseException

toInnerXContent

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

Description copied from class: ContextMapping

Implementations should add specific configurations that need to be persisted

Specified by:

toInnerXContent in class ContextMapping<CategoryQueryContext>

Throws:

java.io.IOException

parseContext

public java.util.Set<java.lang.CharSequence> parseContext(ParseContext parseContext,
                                                          XContentParser parser)
                                                   throws java.io.IOException,
                                                          ElasticsearchParseException

Parse a set of CharSequence contexts at index-time. Acceptable formats:

• Array:

  [<string>, ..]

• String:

  "string"

Specified by:

parseContext in class ContextMapping<CategoryQueryContext>

Throws:

java.io.IOException

ElasticsearchParseException

parseContext

public java.util.Set<java.lang.CharSequence> parseContext(ParseContext.Document document)

Description copied from class: ContextMapping

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

Specified by:

parseContext in class ContextMapping<CategoryQueryContext>

fromXContent

protected CategoryQueryContext fromXContent(XContentParser parser)
                                     throws java.io.IOException

Description copied from class: ContextMapping

Prototype for the query context

Specified by:

fromXContent in class ContextMapping<CategoryQueryContext>

Throws:

java.io.IOException

toInternalQueryContexts

public java.util.List<ContextMapping.InternalQueryContext> toInternalQueryContexts(java.util.List<CategoryQueryContext> queryContexts)

Parse a list of CategoryQueryContext using parser. A QueryContexts accepts one of the following forms:

• Object: CategoryQueryContext
• String: CategoryQueryContext value with prefix=false and boost=1
• Array:

  [CategoryQueryContext, ..]

A CategoryQueryContext has one of the following forms:

• Object:

  {"context": <string>, "boost": <int>, "prefix": <boolean>}

• String:

  "string"

Specified by:

toInternalQueryContexts in class ContextMapping<CategoryQueryContext>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class ContextMapping<CategoryQueryContext>

hashCode

public int hashCode()

Overrides:

hashCode in class ContextMapping<CategoryQueryContext>