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>, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment

Direct Known Subclasses:

ProvidedIdFieldMapper, TsidExtractingIdFieldMapper

public abstract class IdFieldMapper
extends MetadataFieldMapper

A mapper for the _id field.

Nested Class Summary

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

MetadataFieldMapper.Builder, MetadataFieldMapper.ConfigurableTypeParser, MetadataFieldMapper.FixedTypeParser, MetadataFieldMapper.TypeParser

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>

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final String	NAME
static final MetadataFieldMapper.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.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IdFieldMapper(MappedFieldType mappedFieldType, NamedAnalyzer indexAnalyzer)

Method Summary

Modifier and Type	Method	Description
protected final String	contentType()
abstract String	documentDescription(DocumentParserContext context)	Description of the document being parsed used in error messages.
abstract String	documentDescription(ParsedDocument parsedDocument)	Description of the document being indexed used after parsing for things like version conflicts.
static org.apache.lucene.document.Field	standardIdField(String id)	Create a Field to store the provided _id that "stores" the _id so it can be fetched easily from the index.

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

getMergeBuilder, parseCreateField, postParse, preParse, toXContent, updateableBoolParam

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

checkIncomingMergeType, copyTo, doValidate, doXContentBody, executeScript, fieldType, hasScript, indexAnalyzers, indexScriptValues, iterator, merge, multiFields, name, notInMultiFields, parse, parsesArrayValue, typeName, validate

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

simpleName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

PARSER

public static final MetadataFieldMapper.TypeParser PARSER

Constructor Details

IdFieldMapper

protected IdFieldMapper(MappedFieldType mappedFieldType,
 NamedAnalyzer indexAnalyzer)

Method Details

contentType

protected final String contentType()

Specified by:

contentType in class FieldMapper

documentDescription

public abstract String documentDescription(DocumentParserContext context)

Description of the document being parsed used in error messages. Not called unless there is an error.

documentDescription

public abstract String documentDescription(ParsedDocument parsedDocument)

Description of the document being indexed used after parsing for things like version conflicts.

standardIdField

public static org.apache.lucene.document.Field standardIdField(String id)

Create a Field to store the provided _id that "stores" the _id so it can be fetched easily from the index.