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:

java.lang.Cloneable, java.lang.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.Builder
static class	SeqNoFieldMapper.SeqNoDefaults
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.
static class	SeqNoFieldMapper.TypeParser

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 java.lang.String	CONTENT_TYPE
static java.lang.String	NAME
static java.lang.String	PRIMARY_TERM_NAME
static java.lang.String	TOMBSTONE_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

Constructor Summary

Constructors

Constructor	Description
SeqNoFieldMapper(Settings indexSettings)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	contentType()
protected void	doMerge(Mapper mergeWith)	Merge changes coming from mergeWith in place.
void	parse(ParseContext context)	Parse the field value using the provided ParseContext.
protected void	parseCreateField(ParseContext context, java.util.List<org.apache.lucene.index.IndexableField> fields)	Parse the field value and populate fields.
void	postParse(ParseContext context)	Called after FieldMapper.parse(ParseContext) on the RootObjectMapper.
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

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

clone, copyTo, createFieldNamesField, doXContentAnalyzers, doXContentBody, doXContentDocValues, fieldType, indexOptionToString, iterator, name, 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 java.lang.String NAME

See Also:

Constant Field Values

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

PRIMARY_TERM_NAME

public static final java.lang.String PRIMARY_TERM_NAME

See Also:

Constant Field Values

TOMBSTONE_NAME

public static final java.lang.String TOMBSTONE_NAME

See Also:

Constant Field Values

Constructor Detail

SeqNoFieldMapper

public SeqNoFieldMapper(Settings indexSettings)

Method Detail

preParse

public void preParse(ParseContext context)
              throws java.io.IOException

Description copied from class: MetadataFieldMapper

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

Specified by:

preParse in class MetadataFieldMapper

Throws:

java.io.IOException

parseCreateField

protected void parseCreateField(ParseContext context,
                                java.util.List<org.apache.lucene.index.IndexableField> fields)
                         throws java.io.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:

java.io.IOException

parse

public void parse(ParseContext context)
           throws java.io.IOException

Description copied from class: FieldMapper

Parse the field value using the provided ParseContext.

Overrides:

parse in class FieldMapper

Throws:

java.io.IOException

postParse

public void postParse(ParseContext context)
               throws java.io.IOException

Description copied from class: MetadataFieldMapper

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

Overrides:

postParse in class MetadataFieldMapper

Throws:

java.io.IOException

contentType

protected java.lang.String contentType()

Specified by:

contentType in class FieldMapper

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class FieldMapper

Throws:

java.io.IOException

doMerge

protected void doMerge(Mapper mergeWith)

Description copied from class: FieldMapper

Merge changes coming from mergeWith in place.

Overrides:

doMerge in class FieldMapper