Package org.elasticsearch.index.mapper
Class KeywordFieldMapper
java.lang.Object
org.elasticsearch.index.mapper.Mapper
org.elasticsearch.index.mapper.FieldMapper
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 FieldMapper
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
static class
KeywordFieldMapper.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
Fields inherited from class org.elasticsearch.index.mapper.FieldMapper
COERCE_SETTING, copyTo, fieldType, 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, int ignoreAbove, boolean splitQueriesOnWhitespace, java.lang.String nullValue, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)
-
Method Summary
Modifier and Type Method Description protected KeywordFieldMapper
clone()
protected java.lang.String
contentType()
protected void
doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, boolean includeDefaults, org.elasticsearch.common.xcontent.ToXContent.Params params)
KeywordFieldMapper.KeywordFieldType
fieldType()
int
ignoreAbove()
Values that have more chars than the return value of this method will be skipped at parsing time.protected void
mergeOptions(FieldMapper other, java.util.List<java.lang.String> conflicts)
Merge type-specific options and check for incompatible settings in mappings to be mergedprotected void
parseCreateField(ParseContext context)
Parse the field value and populate the fields onParseContext.doc()
.Methods inherited from class org.elasticsearch.index.mapper.FieldMapper
copyTo, createFieldNamesField, docValuesByDefault, doXContentAnalyzers, indexedByDefault, indexOptionToString, iterator, merge, name, parse, parsesArrayValue, storedByDefault, termVectorOptionsToString, toXContent, typeName
-
Field Details
-
CONTENT_TYPE
public static final java.lang.String CONTENT_TYPE- See Also:
- Constant Field Values
-
-
Constructor Details
-
KeywordFieldMapper
protected KeywordFieldMapper(java.lang.String simpleName, org.apache.lucene.document.FieldType fieldType, MappedFieldType mappedFieldType, int ignoreAbove, boolean splitQueriesOnWhitespace, java.lang.String nullValue, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)
-
-
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
-
mergeOptions
Description copied from class:FieldMapper
Merge type-specific options and check for incompatible settings in mappings to be merged- Specified by:
mergeOptions
in classFieldMapper
-
doXContentBody
protected void doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, boolean includeDefaults, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Overrides:
doXContentBody
in classFieldMapper
- Throws:
java.io.IOException
-