org.elasticsearch.index.mapper.core

Class CompletionFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.core.CompletionFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent

public class CompletionFieldMapper
extends FieldMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompletionFieldMapper.Builder
static class	CompletionFieldMapper.CompletionFieldType
static class	CompletionFieldMapper.Defaults
static class	CompletionFieldMapper.Fields
static class	CompletionFieldMapper.TypeParser

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.FieldMapper

FieldMapper.CopyTo, FieldMapper.MultiFields

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.Mapper

Mapper.BuilderContext

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 Set<String>	ALLOWED_CONTENT_FIELD_NAMES
static String	CONTENT_TYPE

Fields inherited from class org.elasticsearch.index.mapper.FieldMapper

copyTo, defaultFieldType, fieldType, indexCreatedBefore2x, multiFields

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
CompletionFieldMapper(String simpleName, MappedFieldType fieldType, int maxInputLength, Settings indexSettings, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.util.BytesRef	buildPayload(org.apache.lucene.util.BytesRef surfaceForm, long weight, org.apache.lucene.util.BytesRef payload)
protected String	contentType()
static int	correctSubStringLen(String input, int len)
protected void	doMerge(Mapper mergeWith, boolean updateAllTypes) Merge changes coming from mergeWith in place.
CompletionFieldMapper.CompletionFieldType	fieldType()
org.apache.lucene.document.Field	getCompletionField(ContextMapping.Context ctx, String input, org.apache.lucene.util.BytesRef payload)
static boolean	isReservedChar(char character)
boolean	isStoringPayloads()
Mapper	parse(ParseContext context) Parses and indexes inputs Parsing: Acceptable format: "STRING" - interpreted as field value (input) "ARRAY" - each element can be one of "OBJECT" (see below) "OBJECT" - { "input": STRING|ARRAY, "weight": STRING|INT, "contexts": ARRAY|OBJECT }
protected void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.index.mapper.FieldMapper

clone, copyTo, customBoost, doXContentAnalyzers, doXContentBody, doXContentDocValues, hasCustomFieldDataSettings, indexOptionToString, indexTokenizeOptionToString, isGenerated, iterator, merge, name, termVectorOptionsToString, updateFieldType

Methods inherited from class org.elasticsearch.index.mapper.Mapper

simpleName

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

ALLOWED_CONTENT_FIELD_NAMES

public static final Set<String> ALLOWED_CONTENT_FIELD_NAMES

Constructor Detail

CompletionFieldMapper

public CompletionFieldMapper(String simpleName,
                     MappedFieldType fieldType,
                     int maxInputLength,
                     Settings indexSettings,
                     FieldMapper.MultiFields multiFields,
                     FieldMapper.CopyTo copyTo)

Method Detail

fieldType

public CompletionFieldMapper.CompletionFieldType fieldType()

Overrides:

fieldType in class FieldMapper

parse

public Mapper parse(ParseContext context)
             throws IOException

Parses and indexes inputs

Parsing: Acceptable format: "STRING" - interpreted as field value (input) "ARRAY" - each element can be one of "OBJECT" (see below) "OBJECT" - { "input": STRING|ARRAY, "weight": STRING|INT, "contexts": ARRAY|OBJECT }

Overrides:

parse in class FieldMapper

Throws:

IOException

getCompletionField

public org.apache.lucene.document.Field getCompletionField(ContextMapping.Context ctx,
                                                  String input,
                                                  org.apache.lucene.util.BytesRef payload)

correctSubStringLen

public static int correctSubStringLen(String input,
                      int len)

buildPayload

public org.apache.lucene.util.BytesRef buildPayload(org.apache.lucene.util.BytesRef surfaceForm,
                                           long weight,
                                           org.apache.lucene.util.BytesRef payload)
                                             throws IOException

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class FieldMapper

Throws:

IOException

parseCreateField

protected void parseCreateField(ParseContext context,
                    List<org.apache.lucene.document.Field> fields)
                         throws IOException

Description copied from class: FieldMapper

Parse the field value and populate fields.

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

isStoringPayloads

public boolean isStoringPayloads()

doMerge

protected void doMerge(Mapper mergeWith,
           boolean updateAllTypes)

Description copied from class: FieldMapper

Merge changes coming from mergeWith in place.

Overrides:

doMerge in class FieldMapper

updateAllTypes - TODO

isReservedChar

public static boolean isReservedChar(char character)