Package org.elasticsearch.index.mapper

Class MetadataFieldMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.FieldMapper

org.elasticsearch.index.mapper.MetadataFieldMapper

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<Mapper>, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

Direct Known Subclasses:

AllFieldMapper, FieldNamesFieldMapper, IdFieldMapper, IgnoredFieldMapper, IndexFieldMapper, RoutingFieldMapper, SeqNoFieldMapper, SourceFieldMapper, TypeFieldMapper, VersionFieldMapper

public abstract class MetadataFieldMapper
extends FieldMapper

A mapper for a builtin field containing metadata about a document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataFieldMapper.Builder<T extends MetadataFieldMapper.Builder<T>>
static interface	MetadataFieldMapper.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

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

Field Summary

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

COERCE_SETTING, copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetadataFieldMapper(org.apache.lucene.document.FieldType fieldType, MappedFieldType mappedFieldType)

Method Summary

Modifier and Type	Method	Description
protected void	mergeOptions(FieldMapper other, java.util.List<java.lang.String> conflicts)	Merge type-specific options and check for incompatible settings in mappings to be merged
void	postParse(ParseContext context)	Called after FieldMapper.parse(ParseContext) on the RootObjectMapper.
abstract void	preParse(ParseContext context)	Called before FieldMapper.parse(ParseContext) on the RootObjectMapper.
void	validate(DocumentFieldMappers lookup)	Called when mapping gets merged.

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

clone, contentType, copyTo, createFieldNamesField, docValuesByDefault, doXContentAnalyzers, doXContentBody, fieldType, indexedByDefault, indexOptionToString, iterator, merge, name, parse, parseCreateField, parsesArrayValue, storedByDefault, termVectorOptionsToString, toXContent, typeName

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

Constructor Details

MetadataFieldMapper

protected MetadataFieldMapper(org.apache.lucene.document.FieldType fieldType, MappedFieldType mappedFieldType)

Method Details

validate

public void validate(DocumentFieldMappers lookup)

Called when mapping gets merged. Provides the opportunity to validate other fields a metadata field mapper is supposed to work with before a mapping update is completed.

preParse

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

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

Throws:

java.io.IOException

postParse

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

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

Throws:

java.io.IOException

mergeOptions

protected void mergeOptions(FieldMapper other, java.util.List<java.lang.String> conflicts)

Description copied from class: FieldMapper

Merge type-specific options and check for incompatible settings in mappings to be merged

Specified by:

mergeOptions in class FieldMapper