Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class SeqNoFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

org.elasticsearch.index.mapper.SeqNoFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent, ToXContentFragment

public class SeqNoFieldMapper
extends MetadataFieldMapper

Mapper for the _seq_no field. We expect to use the seq# for sorting, during collision checking and for doing range searches. Therefore the _seq_no field is stored both as a numeric doc value and as numeric indexed field. This mapper also manages the primary term field, which has no ES named equivalent. The primary term is only used during collision after receiving identical seq# values for two document copies. The primary term is stored as a doc value field without being indexed, since it is only intended for use as a key-value lookup.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SeqNoFieldMapper.SequenceIDFields	A sequence ID, which is made up of a sequence number (both the searchable and doc_value version of the field) and the primary term.

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

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

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

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
void	postParse(DocumentParserContext context)	Called after FieldMapper.parse(DocumentParserContext) on the RootObjectMapper.
void	preParse(DocumentParserContext context)	Called before FieldMapper.parse(DocumentParserContext) on the RootObjectMapper.
SourceLoader.SyntheticFieldLoader	syntheticFieldLoader()	Create a SourceLoader.SyntheticFieldLoader to populate synthetic source.

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

getMergeBuilder, parseCreateField, toXContent, updateableBoolParam

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

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

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

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

NAME

public static final String NAME

See Also:

• Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

PRIMARY_TERM_NAME

public static final String PRIMARY_TERM_NAME

See Also:

• Constant Field Values

TOMBSTONE_NAME

public static final String TOMBSTONE_NAME

See Also:

• Constant Field Values

INSTANCE

public static final SeqNoFieldMapper INSTANCE

PARSER

public static final MetadataFieldMapper.TypeParser PARSER

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

postParse

public void postParse(DocumentParserContext context)
               throws IOException

Description copied from class: MetadataFieldMapper

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

Overrides:

postParse in class MetadataFieldMapper

Throws:

IOException

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper

syntheticFieldLoader

public SourceLoader.SyntheticFieldLoader syntheticFieldLoader()

Description copied from class: Mapper

Create a SourceLoader.SyntheticFieldLoader to populate synthetic source.

Specified by:

syntheticFieldLoader in class MetadataFieldMapper