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
-
Field Summary
Fields inherited from class org.elasticsearch.index.mapper.FieldMapper
COERCE_SETTING, copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields
-
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 mergedvoid
postParse(ParseContext context)
Called afterFieldMapper.parse(ParseContext)
on theRootObjectMapper
.abstract void
preParse(ParseContext context)
Called beforeFieldMapper.parse(ParseContext)
on theRootObjectMapper
.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
-
Constructor Details
-
MetadataFieldMapper
protected MetadataFieldMapper(org.apache.lucene.document.FieldType fieldType, MappedFieldType mappedFieldType)
-
-
Method Details
-
validate
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
Called beforeFieldMapper.parse(ParseContext)
on theRootObjectMapper
.- Throws:
java.io.IOException
-
postParse
Called afterFieldMapper.parse(ParseContext)
on theRootObjectMapper
.- Throws:
java.io.IOException
-
mergeOptions
Description copied from class:FieldMapper
Merge type-specific options and check for incompatible settings in mappings to be merged- Specified by:
mergeOptions
in classFieldMapper
-