Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class CompletionFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.CompletionFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent, ToXContentFragment

public class CompletionFieldMapper
extends FieldMapper

Mapper for completion field. The field values are indexed as a weighted FST for fast auto-completion/search-as-you-type functionality.
Type properties:

• "analyzer": "simple", (default)
• "search_analyzer": "simple", (default)
• "preserve_separators" : true, (default)
• "preserve_position_increments" : true (default)
• "min_input_length": 50 (default)
• "contexts" : CONTEXTS

see ContextMappings.load(Object) for CONTEXTS
see parse(DocumentParserContext) for acceptable inputs for indexing

This field type constructs completion queries that are run against the weighted FST index by the CompletionSuggester. This field can also be extended to add search criteria to suggestions for query-time filtering and boosting (see ContextMappings

Nested Class Summary

Nested Classes

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

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

FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.TypeParser

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	ALLOWED_CONTENT_FIELD_NAMES
static final String	CONTENT_TYPE
static final FieldMapper.TypeParser	PARSER

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

COERCE_SETTING, copyTo, deprecationLogger, hasScript, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields, onScriptError

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CompletionFieldMapper(String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, CompletionFieldMapper.Builder builder)

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
void	doValidate(MappingLookup mappers)
CompletionFieldMapper.CompletionFieldType	fieldType()
FieldMapper.Builder	getMergeBuilder()	Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);
Map<String,NamedAnalyzer>	indexAnalyzers()
void	parse(DocumentParserContext 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 } Indexing: if context mappings are defined, delegates to ContextMappings.addField(LuceneDocument, String, String, int, Map) else adds inputs as a SuggestField
protected void	parseCreateField(DocumentParserContext context)	Parse the field value and populate the fields on DocumentParserContext.doc().
boolean	parsesArrayValue()	Whether this mapper can handle an array value during document parsing.

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

checkIncomingMergeType, copyTo, doXContentBody, executeScript, hasScript, ignoreMalformed, indexScriptValues, iterator, merge, multiFields, name, notInMultiFields, toXContent, typeName, validate

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

internFieldName, simpleName, syntheticFieldLoader, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

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

PARSER

public static final FieldMapper.TypeParser PARSER

Constructor Details

CompletionFieldMapper

public CompletionFieldMapper(String simpleName,
 MappedFieldType mappedFieldType,
 FieldMapper.MultiFields multiFields,
 FieldMapper.CopyTo copyTo,
 CompletionFieldMapper.Builder builder)

Method Details

getMergeBuilder

public FieldMapper.Builder getMergeBuilder()

Description copied from class: FieldMapper

Returns a FieldMapper.Builder to be used for merging and serialization Implement as follows: return new MyBuilder(simpleName()).init(this);

Specified by:

getMergeBuilder in class FieldMapper

indexAnalyzers

public Map<String,NamedAnalyzer> indexAnalyzers()

Overrides:

indexAnalyzers in class FieldMapper

fieldType

public CompletionFieldMapper.CompletionFieldType fieldType()

Overrides:

fieldType in class FieldMapper

parsesArrayValue

public boolean parsesArrayValue()

Description copied from class: FieldMapper

Whether this mapper can handle an array value during document parsing. If true, when an array is encountered during parsing, the document parser will pass the whole array to the mapper. If false, the array is split into individual values and each value is passed to the mapper for parsing.

Overrides:

parsesArrayValue in class FieldMapper

parse

public void parse(DocumentParserContext 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 } Indexing: if context mappings are defined, delegates to ContextMappings.addField(LuceneDocument, String, String, int, Map) else adds inputs as a SuggestField

Overrides:

parse in class FieldMapper

Throws:

IOException

parseCreateField

protected void parseCreateField(DocumentParserContext context)
                         throws IOException

Description copied from class: FieldMapper

Parse the field value and populate the fields on DocumentParserContext.doc(). Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token

Specified by:

parseCreateField in class FieldMapper

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

doValidate

public void doValidate(MappingLookup mappers)

Overrides:

doValidate in class FieldMapper