Package org.elasticsearch.index.mapper
Class KeywordFieldMapper
java.lang.Object
org.elasticsearch.index.mapper.Mapper
org.elasticsearch.index.mapper.FieldMapper
org.elasticsearch.index.mapper.ParametrizedFieldMapper
org.elasticsearch.index.mapper.KeywordFieldMapper
- All Implemented Interfaces:
java.lang.Cloneable
,java.lang.Iterable<Mapper>
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
public final class KeywordFieldMapper extends ParametrizedFieldMapper
A field mapper for keywords. This mapper accepts strings and indexes them as-is.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
KeywordFieldMapper.Builder
static class
KeywordFieldMapper.Defaults
static class
KeywordFieldMapper.KeywordField
static class
KeywordFieldMapper.KeywordFieldType
Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.ParametrizedFieldMapper
ParametrizedFieldMapper.Parameter<T>, ParametrizedFieldMapper.Serializer<T>, ParametrizedFieldMapper.SerializerCheck<T>, ParametrizedFieldMapper.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
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CONTENT_TYPE
static ParametrizedFieldMapper.TypeParser
PARSER
Fields inherited from class org.elasticsearch.index.mapper.FieldMapper
COERCE_SETTING, copyTo, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields
-
Constructor Summary
Constructors Modifier Constructor Description protected
KeywordFieldMapper(java.lang.String simpleName, org.apache.lucene.document.FieldType fieldType, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, KeywordFieldMapper.Builder builder)
-
Method Summary
Modifier and Type Method Description protected KeywordFieldMapper
clone()
protected java.lang.String
contentType()
KeywordFieldMapper.KeywordFieldType
fieldType()
ParametrizedFieldMapper.Builder
getMergeBuilder()
Returns aParametrizedFieldMapper.Builder
to be used for merging and serialization Implement as follows:return new MyBuilder(simpleName()).init(this);
int
ignoreAbove()
Values that have more chars than the return value of this method will be skipped at parsing time.protected void
parseCreateField(ParseContext context)
Parse the field value and populate the fields onParseContext.doc()
.Methods inherited from class org.elasticsearch.index.mapper.ParametrizedFieldMapper
doXContentBody, merge, mergeOptions
Methods inherited from class org.elasticsearch.index.mapper.FieldMapper
copyTo, createFieldNamesField, docValuesByDefault, doValidate, doXContentAnalyzers, indexedByDefault, indexOptionToString, iterator, multiFields, name, parse, parsesArrayValue, storedByDefault, toXContent, typeName, validate
-
Field Details
-
CONTENT_TYPE
public static final java.lang.String CONTENT_TYPE- See Also:
- Constant Field Values
-
PARSER
-
-
Constructor Details
-
KeywordFieldMapper
protected KeywordFieldMapper(java.lang.String simpleName, org.apache.lucene.document.FieldType fieldType, MappedFieldType mappedFieldType, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, KeywordFieldMapper.Builder builder)
-
-
Method Details
-
ignoreAbove
public int ignoreAbove()Values that have more chars than the return value of this method will be skipped at parsing time. -
clone
- Overrides:
clone
in classFieldMapper
-
fieldType
- Overrides:
fieldType
in classFieldMapper
-
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
-
getMergeBuilder
Description copied from class:ParametrizedFieldMapper
Returns aParametrizedFieldMapper.Builder
to be used for merging and serialization Implement as follows:return new MyBuilder(simpleName()).init(this);
- Specified by:
getMergeBuilder
in classParametrizedFieldMapper
-