org.elasticsearch.index.mapper.core

Class CompletionFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.core.AbstractFieldMapper<String>

org.elasticsearch.index.mapper.core.CompletionFieldMapper

All Implemented Interfaces:

ToXContent, FieldMapper<String>, Mapper

public class CompletionFieldMapper
extends AbstractFieldMapper<String>

Nested Class Summary

Nested Classes

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

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

AbstractFieldMapper.CopyTo, AbstractFieldMapper.MultiFields

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

FieldMapper.Loading, FieldMapper.Names

Nested classes/interfaces inherited from interface 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.core.AbstractFieldMapper

boost, copyTo, customFieldDataSettings, docValues, docValuesFormat, fieldDataType, fieldType, indexAnalyzer, multiFields, names, normsLoading, postingsFormat, searchAnalyzer, similarity

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

DOC_VALUES_FORMAT

Fields inherited from interface org.elasticsearch.index.mapper.Mapper

EMPTY_ARRAY

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description

CompletionFieldMapper(FieldMapper.Names names, NamedAnalyzer indexAnalyzer, NamedAnalyzer searchAnalyzer, PostingsFormatProvider postingsProvider, SimilarityProvider similarity, boolean payloads, boolean preserveSeparators, boolean preservePositionIncrements, int maxInputLength, AbstractFieldMapper.MultiFields multiFields, AbstractFieldMapper.CopyTo copyTo, SortedMap<String,ContextMapping> contextMappings)

Method Summary

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)
FieldDataType	defaultFieldDataType()
org.apache.lucene.document.FieldType	defaultFieldType()
org.apache.lucene.document.Field	getCompletionField(ContextMapping.Context ctx, String input, org.apache.lucene.util.BytesRef payload)
org.apache.lucene.document.Field	getCompletionField(String input, org.apache.lucene.util.BytesRef payload)
SortedMap<String,ContextMapping>	getContextMapping() Get the context mapping associated with this completion field.
boolean	hasDocValues()
static boolean	isReservedChar(char character)
boolean	isSortable()
boolean	isStoringPayloads()
void	merge(Mapper mergeWith, MergeContext mergeContext)
void	parse(ParseContext context)
protected void	parseCreateField(ParseContext context, List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
PostingsFormatProvider	postingsFormatProvider()
boolean	requiresContext()
boolean	supportsNullValue()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	value(Object value) Returns the actual value of the field.

Methods inherited from class org.elasticsearch.index.mapper.core.AbstractFieldMapper

boost, close, copyTo, customBoost, defaultDocValuesFormat, defaultPostingFormat, docValuesFormatProvider, doXContentBody, fieldDataTermsFilter, fieldDataType, fieldType, fuzzyQuery, indexAnalyzer, indexedValueForSearch, indexOptionToString, indexTokenizeOptionToString, isGenerated, isNumeric, name, names, normsLoading, nullValueFilter, prefixFilter, prefixQuery, queryStringTermQuery, rangeFilter, rangeQuery, regexpFilter, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, similarity, stats, termFilter, termQuery, termsFilter, termVectorOptionsToString, traverse, traverse, useTermQueryWithQueryString, valueForSearch

Methods inherited from class java.lang.Object

clone, 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(FieldMapper.Names names,
                             NamedAnalyzer indexAnalyzer,
                             NamedAnalyzer searchAnalyzer,
                             PostingsFormatProvider postingsProvider,
                             SimilarityProvider similarity,
                             boolean payloads,
                             boolean preserveSeparators,
                             boolean preservePositionIncrements,
                             int maxInputLength,
                             AbstractFieldMapper.MultiFields multiFields,
                             AbstractFieldMapper.CopyTo copyTo,
                             SortedMap<String,ContextMapping> contextMappings)

Parameters:

contextMappings - Configuration of context type. If none should be used set ContextMapping.EMPTY_MAPPING

Method Detail

postingsFormatProvider

public PostingsFormatProvider postingsFormatProvider()

Specified by:

postingsFormatProvider in interface FieldMapper<String>

Overrides:

postingsFormatProvider in class AbstractFieldMapper<String>

parse

public void parse(ParseContext context)
           throws IOException

Specified by:

parse in interface Mapper

Overrides:

parse in class AbstractFieldMapper<String>

Throws:

IOException

getContextMapping

public SortedMap<String,ContextMapping> getContextMapping()

Get the context mapping associated with this completion field.

requiresContext

public boolean requiresContext()

Returns:

true if a context mapping has been defined

getCompletionField

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

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

Throws:

IOException

parseCreateField

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

Description copied from class: AbstractFieldMapper

Parse the field value and populate fields.

Specified by:

parseCreateField in class AbstractFieldMapper<String>

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class AbstractFieldMapper<String>

isSortable

public boolean isSortable()

Specified by:

isSortable in interface FieldMapper<String>

Overrides:

isSortable in class AbstractFieldMapper<String>

hasDocValues

public boolean hasDocValues()

Specified by:

hasDocValues in interface FieldMapper<String>

Overrides:

hasDocValues in class AbstractFieldMapper<String>

supportsNullValue

public boolean supportsNullValue()

Specified by:

supportsNullValue in interface FieldMapper<String>

Overrides:

supportsNullValue in class AbstractFieldMapper<String>

defaultFieldType

public org.apache.lucene.document.FieldType defaultFieldType()

Specified by:

defaultFieldType in class AbstractFieldMapper<String>

defaultFieldDataType

public FieldDataType defaultFieldDataType()

Specified by:

defaultFieldDataType in class AbstractFieldMapper<String>

value

public String value(Object value)

Description copied from interface: FieldMapper

Returns the actual value of the field.

isStoringPayloads

public boolean isStoringPayloads()

merge

public void merge(Mapper mergeWith,
                  MergeContext mergeContext)
           throws MergeMappingException

Specified by:

merge in interface Mapper

Overrides:

merge in class AbstractFieldMapper<String>

Throws:

MergeMappingException

isReservedChar

public static boolean isReservedChar(char character)