org.elasticsearch.index.mapper

Interface RootMapper

All Superinterfaces:

Mapper, ToXContent

All Known Implementing Classes:

AllFieldMapper, AnalyzerMapper, BoostFieldMapper, FieldNamesFieldMapper, IdFieldMapper, IndexFieldMapper, ParentFieldMapper, RoutingFieldMapper, SizeFieldMapper, SourceFieldMapper, TimestampFieldMapper, TTLFieldMapper, TypeFieldMapper, UidFieldMapper, VersionFieldMapper

public interface RootMapper
extends Mapper

A mapper that exists only as a mapper within a root object.

Nested Class Summary

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

Mapper.Builder<T extends Mapper.Builder,Y extends Mapper>, Mapper.BuilderContext, Mapper.TypeParser

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_ARRAY

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
boolean	includeInObject() Should the mapper be included in the root ObjectMapper.
void	postParse(ParseContext context) Called after Mapper.parse(ParseContext) on the RootObjectMapper.
void	preParse(ParseContext context) Called before Mapper.parse(ParseContext) on the RootObjectMapper.

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

close, merge, name, parse, traverse, traverse

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

toXContent

Method Detail

preParse

void preParse(ParseContext context)
       throws IOException

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

Throws:

IOException

postParse

void postParse(ParseContext context)
        throws IOException

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

Throws:

IOException

includeInObject

boolean includeInObject()

Should the mapper be included in the root ObjectMapper. If this method returns true, then Mapper.parse(ParseContext) will be called if the context has a property that matches the name of this RootMapper. Otherwise Mapper.parse(ParseContext) will not be called.