org.elasticsearch.index.mapper.core

Class KeywordFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.core.KeywordFieldMapper

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<Mapper>, ToXContent, AllFieldMapper.IncludeInAll

public final class KeywordFieldMapper
extends FieldMapper
implements AllFieldMapper.IncludeInAll

A field mapper for keywords. This mapper accepts strings and indexes them as-is.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeywordFieldMapper.Builder
static class	KeywordFieldMapper.Defaults
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

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 java.lang.String	CONTENT_TYPE

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

COERCE_SETTING, copyTo, defaultFieldType, fieldType, IGNORE_MALFORMED_SETTING, multiFields

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeywordFieldMapper(java.lang.String simpleName, MappedFieldType fieldType, MappedFieldType defaultFieldType, int ignoreAbove, Settings indexSettings, FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo)

Method Summary

Modifier and Type	Method and Description
protected KeywordFieldMapper	clone()
protected java.lang.String	contentType()
protected void	doMerge(Mapper mergeWith, boolean updateAllTypes) Merge changes coming from mergeWith in place.
protected void	doXContentBody(XContentBuilder builder, boolean includeDefaults, ToXContent.Params params)
KeywordFieldMapper	includeInAll(java.lang.Boolean includeInAll) If includeInAll is not null then return a copy of this mapper that will include values in the _all field according to includeInAll.
KeywordFieldMapper	includeInAllIfNotSet(java.lang.Boolean includeInAll) If includeInAll is not null and not set on this mapper yet, then return a copy of this mapper that will include values in the _all field according to includeInAll.
protected void	parseCreateField(ParseContext context, java.util.List<org.apache.lucene.document.Field> fields) Parse the field value and populate fields.
KeywordFieldMapper	unsetIncludeInAll() If includeInAll was already set on this mapper then return a copy of this mapper that has includeInAll not set.

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

copyTo, customBoost, doXContentAnalyzers, doXContentDocValues, fieldType, indexOptionToString, indexTokenizeOption, isGenerated, iterator, merge, name, parse, termVectorOptionsToString, toXContent, updateFieldType

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

simpleName

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

KeywordFieldMapper

protected KeywordFieldMapper(java.lang.String simpleName,
                             MappedFieldType fieldType,
                             MappedFieldType defaultFieldType,
                             int ignoreAbove,
                             Settings indexSettings,
                             FieldMapper.MultiFields multiFields,
                             FieldMapper.CopyTo copyTo)

Method Detail

clone

protected KeywordFieldMapper clone()

Overrides:

clone in class FieldMapper

includeInAll

public KeywordFieldMapper includeInAll(java.lang.Boolean includeInAll)

Description copied from interface: AllFieldMapper.IncludeInAll

If includeInAll is not null then return a copy of this mapper that will include values in the _all field according to includeInAll.

Specified by:

includeInAll in interface AllFieldMapper.IncludeInAll

includeInAllIfNotSet

public KeywordFieldMapper includeInAllIfNotSet(java.lang.Boolean includeInAll)

Description copied from interface: AllFieldMapper.IncludeInAll

If includeInAll is not null and not set on this mapper yet, then return a copy of this mapper that will include values in the _all field according to includeInAll.

Specified by:

includeInAllIfNotSet in interface AllFieldMapper.IncludeInAll

unsetIncludeInAll

public KeywordFieldMapper unsetIncludeInAll()

Description copied from interface: AllFieldMapper.IncludeInAll

If includeInAll was already set on this mapper then return a copy of this mapper that has includeInAll not set.

Specified by:

unsetIncludeInAll in interface AllFieldMapper.IncludeInAll

parseCreateField

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

Description copied from class: FieldMapper

Parse the field value and populate fields.

Specified by:

parseCreateField in class FieldMapper

Throws:

java.io.IOException

contentType

protected java.lang.String contentType()

Specified by:

contentType in class FieldMapper

doMerge

protected void doMerge(Mapper mergeWith,
                       boolean updateAllTypes)

Description copied from class: FieldMapper

Merge changes coming from mergeWith in place.

Overrides:

doMerge in class FieldMapper

updateAllTypes - TODO

doXContentBody

protected void doXContentBody(XContentBuilder builder,
                              boolean includeDefaults,
                              ToXContent.Params params)
                       throws java.io.IOException

Overrides:

doXContentBody in class FieldMapper

Throws:

java.io.IOException