Package org.elasticsearch.index.mapper

Class IdFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

org.elasticsearch.index.mapper.IdFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent, ToXContentFragment

public class IdFieldMapper
extends MetadataFieldMapper

A mapper for the _id field. It does nothing since _id is neither indexed nor stored, but we need to keep it so that its FieldType can be used to generate queries.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IdFieldMapper.Defaults
static class	IdFieldMapper.TypeParser

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

MetadataFieldMapper.Builder<T extends MetadataFieldMapper.Builder,Y extends MetadataFieldMapper>

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	Description
static String	CONTENT_TYPE
static String	NAME

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

COERCE_SETTING, copyTo, defaultFieldType, fieldType, IGNORE_MALFORMED_SETTING, indexCreatedVersion, multiFields

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
protected void	doMerge(Mapper mergeWith)	Merge changes coming from mergeWith in place.
protected void	parseCreateField(ParseContext context, List<IndexableField> fields)	Parse the field value and populate fields.
void	preParse(ParseContext context)	Called before FieldMapper.parse(ParseContext) on the RootObjectMapper.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

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

merge, postParse

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

clone, copyTo, createFieldNamesField, doXContentAnalyzers, doXContentBody, doXContentDocValues, fieldType, indexOptionToString, iterator, name, parse, termVectorOptionsToString, typeName, 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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

Method Detail

preParse

public void preParse(ParseContext context)
              throws IOException

Description copied from class: MetadataFieldMapper

Called before FieldMapper.parse(ParseContext) on the RootObjectMapper.

Specified by:

preParse in class MetadataFieldMapper

Throws:

IOException

parseCreateField

protected void parseCreateField(ParseContext context,
                                List<IndexableField> fields)
                         throws IOException

Description copied from class: FieldMapper

Parse the field value and populate fields. 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

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class FieldMapper

Throws:

IOException

doMerge

protected void doMerge(Mapper mergeWith)

Description copied from class: FieldMapper

Merge changes coming from mergeWith in place.

Overrides:

doMerge in class FieldMapper