Module org.elasticsearch.server

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:

Iterable<Mapper>, ToXContent, ToXContentFragment

Direct Known Subclasses:

ProvidedIdFieldMapper, TsidExtractingIdFieldMapper

public abstract class IdFieldMapper
extends MetadataFieldMapper

A mapper for the _id field.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	IdFieldMapper.AbstractIdFieldType

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.BuilderParams, FieldMapper.Conflicts, FieldMapper.CopyTo, FieldMapper.DimensionBuilder, FieldMapper.DocValuesParameter, FieldMapper.MergeValidator<T>, FieldMapper.MultiFields, FieldMapper.Parameter<T>, FieldMapper.Serializer<T>, FieldMapper.SerializerCheck<T>, FieldMapper.SyntheticSourceMode, FieldMapper.SyntheticSourceSupport, FieldMapper.TextFamilyBuilder

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

Mapper.IgnoreAbove, Mapper.SourceKeepMode

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 String	CONTENT_TYPE
static final String	NAME
static final MetadataFieldMapper.TypeParser	PARSER

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

builderParams, COERCE_SETTING, deprecationLogger, IGNORE_MALFORMED_SETTING, mappedFieldType

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

SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAM

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IdFieldMapper(MappedFieldType mappedFieldType)

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.
Map<String,NamedAnalyzer>	indexAnalyzers()
abstract String	reindexId(String id)	Build the _id to use on requests reindexing into indices using this _id.
static org.apache.lucene.document.Field	standardIdField(String id)	Create an indexed and stored Field for the provided _id.
static org.apache.lucene.document.Field	standardIdField(org.apache.lucene.util.BytesRef uid, org.apache.lucene.document.Field.Store stored)	Create an indexed Field for the provided _id, optionally stored.
static org.apache.lucene.document.Field	syntheticIdField(String id)	Create a Field corresponding to a synthetic _id field, which is not indexed and not stored but instead computed at runtime.
static org.apache.lucene.document.Field	syntheticIdField(org.apache.lucene.util.BytesRef uid)	Create a Field corresponding to a synthetic _id field, which is not indexed and not stored but instead resolved at runtime.

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

getMergeBuilder, parseCreateField, postParse, preParse, syntheticSourceSupport, toXContent, updateableBoolParam

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

checkIncomingMergeType, copyTo, createTypeParserWithLegacySupport, doParseMultiFields, doValidate, doXContentBody, executeScript, fieldType, fullPath, getTotalFieldsCount, hasScript, ignoreMalformed, indexScriptValues, iterator, multiFields, multiFieldsIterator, notFromDynamicTemplates, notInMultiFields, parse, parsesArrayValue, sourceKeepMode, sourcePathUsedBy, supportsParsingObject, syntheticFieldLoader, syntheticVectorsLoader, throwIndexingWithScriptParam, typeName, validate

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

freezeAndDeduplicateFieldType, getOffsetFieldName, internFieldName, leafName, supportStoringArrayOffsets, 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)

Method Details

indexAnalyzers

public Map<String,NamedAnalyzer> indexAnalyzers()

Overrides:

indexAnalyzers in class FieldMapper

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.

reindexId

public abstract String reindexId(String id)

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

standardIdField

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

Create an indexed and stored Field for the provided _id.

standardIdField

public static org.apache.lucene.document.Field standardIdField(org.apache.lucene.util.BytesRef uid,
 org.apache.lucene.document.Field.Store stored)

Create an indexed Field for the provided _id, optionally stored. The id must already be encoded using Uid.encodeId(String).

syntheticIdField

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

Create a Field corresponding to a synthetic _id field, which is not indexed and not stored but instead computed at runtime.

syntheticIdField

public static org.apache.lucene.document.Field syntheticIdField(org.apache.lucene.util.BytesRef uid)

Create a Field corresponding to a synthetic _id field, which is not indexed and not stored but instead resolved at runtime. The id must be already encoded using Uid.encodeId(String).