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:
java.lang.Cloneable
,java.lang.Iterable<Mapper>
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.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:
see
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
ContextMappings.load(Object)
for CONTEXTSsee
parse(ParseContext)
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 forCompletionFieldMapper
static 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.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
-
Field Summary
Fields Modifier and Type Field Description static java.util.Set<java.lang.String>
ALLOWED_CONTENT_FIELD_NAMES
static java.lang.String
CONTENT_TYPE
static FieldMapper.TypeParser
PARSER
Fields inherited from class org.elasticsearch.index.mapper.FieldMapper
COERCE_SETTING, copyTo, hasScript, IGNORE_MALFORMED_SETTING, indexAnalyzers, mappedFieldType, multiFields, onScriptError
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description CompletionFieldMapper(java.lang.String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, CompletionFieldMapper.Builder builder)
-
Method Summary
Modifier and Type Method Description protected java.lang.String
contentType()
void
doValidate(MappingLookup mappers)
CompletionFieldMapper.CompletionFieldType
fieldType()
FieldMapper.Builder
getMergeBuilder()
Returns aFieldMapper.Builder
to be used for merging and serialization Implement as follows:return new MyBuilder(simpleName()).init(this);
void
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 } Indexing: if context mappings are defined, delegates toContextMappings.addField(ParseContext.Document, String, String, int, Map)
else adds inputs as aSuggestField
protected void
parseCreateField(ParseContext context)
Parse the field value and populate the fields onParseContext.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, createFieldNamesField, doXContentBody, executeScript, hasScript, indexAnalyzers, indexScriptValues, iterator, merge, multiFields, name, toXContent, typeName, validate
Methods inherited from class org.elasticsearch.index.mapper.Mapper
simpleName
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
Field Details
-
CONTENT_TYPE
public static final java.lang.String CONTENT_TYPE- See Also:
- Constant Field Values
-
ALLOWED_CONTENT_FIELD_NAMES
public static final java.util.Set<java.lang.String> ALLOWED_CONTENT_FIELD_NAMES -
PARSER
-
-
Constructor Details
-
CompletionFieldMapper
public CompletionFieldMapper(java.lang.String simpleName, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, CompletionFieldMapper.Builder builder)
-
-
Method Details
-
getMergeBuilder
Description copied from class:FieldMapper
Returns aFieldMapper.Builder
to be used for merging and serialization Implement as follows:return new MyBuilder(simpleName()).init(this);
- Specified by:
getMergeBuilder
in classFieldMapper
-
fieldType
- Overrides:
fieldType
in classFieldMapper
-
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 classFieldMapper
-
parse
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 toContextMappings.addField(ParseContext.Document, String, String, int, Map)
else adds inputs as aSuggestField
- Overrides:
parse
in classFieldMapper
- Throws:
java.io.IOException
-
parseCreateField
Description copied from class:FieldMapper
Parse the field value and populate the fields onParseContext.doc()
. Implementations of this method should ensure that on failing to parse parser.currentToken() must be the current failing token- Specified by:
parseCreateField
in classFieldMapper
- Throws:
java.io.IOException
-
contentType
protected java.lang.String contentType()- Specified by:
contentType
in classFieldMapper
-
doValidate
- Overrides:
doValidate
in classFieldMapper
-