Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class ProvidedIdFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

org.elasticsearch.index.mapper.IdFieldMapper

org.elasticsearch.index.mapper.ProvidedIdFieldMapper

All Implemented Interfaces:

Iterable<Mapper>, ToXContent, ToXContentFragment

public class ProvidedIdFieldMapper
extends IdFieldMapper

A mapper for the _id field that reads the from the SourceToParse.id(). It also supports field data if the cluster is configured to allow it.

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final ProvidedIdFieldMapper	NO_FIELD_DATA

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

CONTENT_TYPE, NAME, PARSER

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

COERCE_SETTING, copyTo, hasScript, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields, onScriptError

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ProvidedIdFieldMapper(BooleanSupplier fieldDataEnabled)

Method Summary

Modifier and Type	Method	Description
String	documentDescription(DocumentParserContext context)	Description of the document being parsed used in error messages.
String	documentDescription(ParsedDocument parsedDocument)	Description of the document being indexed used after parsing for things like version conflicts.
void	preParse(DocumentParserContext context)	Called before FieldMapper.parse(DocumentParserContext) on the RootObjectMapper.
String	reindexId(String id)	Build the _id to use on requests reindexing into indices using this _id.

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

contentType, indexAnalyzers, standardIdField, syntheticFieldLoader

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

getMergeBuilder, parseCreateField, postParse, toXContent, updateableBoolParam

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

checkIncomingMergeType, copyTo, doValidate, doXContentBody, executeScript, fieldType, getTotalFieldsCount, hasScript, ignoreMalformed, indexScriptValues, iterator, merge, multiFields, multiFieldsIterator, name, notInMultiFields, parse, parsesArrayValue, sourcePathUsedBy, supportsParsingObject, typeName, validate

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

freezeAndDeduplicateFieldType, internFieldName, 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

NO_FIELD_DATA

public static final ProvidedIdFieldMapper NO_FIELD_DATA

Constructor Details

ProvidedIdFieldMapper

public ProvidedIdFieldMapper(BooleanSupplier fieldDataEnabled)

Method Details

preParse

public void preParse(DocumentParserContext context)

Description copied from class: MetadataFieldMapper

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

Overrides:

preParse in class MetadataFieldMapper

documentDescription

public String documentDescription(DocumentParserContext context)

Description copied from class: IdFieldMapper

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

Specified by:

documentDescription in class IdFieldMapper

documentDescription

public String documentDescription(ParsedDocument parsedDocument)

Description copied from class: IdFieldMapper

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

Specified by:

documentDescription in class IdFieldMapper

reindexId

public String reindexId(String id)

Description copied from class: IdFieldMapper

Build the _id to use on requests reindexing into indices using this _id.

Specified by:

reindexId in class IdFieldMapper