Package org.elasticsearch.indices.mapper

Class MapperRegistry

java.lang.Object

org.elasticsearch.indices.mapper.MapperRegistry

public final class MapperRegistry
extends Object

A registry for all field mappers.

Constructor Summary

Constructors

Constructor	Description
MapperRegistry(Map<String,Mapper.TypeParser> mapperParsers, Map<String,MetadataFieldMapper.TypeParser> metadataMapperParsers, Function<String,Predicate<String>> fieldFilter)

Method Summary

Modifier and Type	Method	Description
Function<String,Predicate<String>>	getFieldFilter()	Returns a function that given an index name, returns a predicate that fields must match in order to be returned by get mappings, get index, get field mappings and field capabilities API.
Map<String,Mapper.TypeParser>	getMapperParsers()	Return a map of the mappers that have been registered.
Map<String,MetadataFieldMapper.TypeParser>	getMetadataMapperParsers(Version indexCreatedVersion)	Return a map of the meta mappers that have been registered.
boolean	isMetaDataField(Version indexCreatedVersion, String field)	Returns true if the provided field is a registered metadata field, false otherwise

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapperRegistry

public MapperRegistry(Map<String,Mapper.TypeParser> mapperParsers,
                      Map<String,MetadataFieldMapper.TypeParser> metadataMapperParsers,
                      Function<String,Predicate<String>> fieldFilter)

Method Detail

getMapperParsers

public Map<String,Mapper.TypeParser> getMapperParsers()

Return a map of the mappers that have been registered. The returned map uses the type of the field as a key.

getMetadataMapperParsers

public Map<String,MetadataFieldMapper.TypeParser> getMetadataMapperParsers(Version indexCreatedVersion)

Return a map of the meta mappers that have been registered. The returned map uses the name of the field as a key.

isMetaDataField

public boolean isMetaDataField(Version indexCreatedVersion,
                               String field)

Returns true if the provided field is a registered metadata field, false otherwise

getFieldFilter

public Function<String,Predicate<String>> getFieldFilter()

Returns a function that given an index name, returns a predicate that fields must match in order to be returned by get mappings, get index, get field mappings and field capabilities API. Useful to filter the fields that such API return. The predicate receives the field name as input arguments. In case multiple plugins register a field filter through MapperPlugin.getFieldFilter(), only fields that match all the registered filters will be returned by get mappings, get index, get field mappings and field capabilities API.