Class MapperRegistry

java.lang.Object
org.elasticsearch.indices.mapper.MapperRegistry

public final class MapperRegistry
extends java.lang.Object
A registry for all field mappers.
  • Constructor Summary

    Constructors 
    Constructor Description
    MapperRegistry​(java.util.Map<java.lang.String,​Mapper.TypeParser> mapperParsers, java.util.Map<java.lang.String,​MetadataFieldMapper.TypeParser> metadataMapperParsers, java.util.function.Function<java.lang.String,​java.util.function.Predicate<java.lang.String>> fieldFilter)  
  • Method Summary

    Modifier and Type Method Description
    java.util.function.Function<java.lang.String,​java.util.function.Predicate<java.lang.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.
    java.util.Map<java.lang.String,​Mapper.TypeParser> getMapperParsers()
    Return a map of the mappers that have been registered.
    java.util.Map<java.lang.String,​MetadataFieldMapper.TypeParser> getMetadataMapperParsers​(Version indexCreatedVersion)
    Return a map of the meta mappers that have been registered.
    boolean isMetaDataField​(Version indexCreatedVersion, java.lang.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 Details

    • MapperRegistry

      public MapperRegistry​(java.util.Map<java.lang.String,​Mapper.TypeParser> mapperParsers, java.util.Map<java.lang.String,​MetadataFieldMapper.TypeParser> metadataMapperParsers, java.util.function.Function<java.lang.String,​java.util.function.Predicate<java.lang.String>> fieldFilter)
  • Method Details

    • getMapperParsers

      public java.util.Map<java.lang.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 java.util.Map<java.lang.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, java.lang.String field)
      Returns true if the provided field is a registered metadata field, false otherwise
    • getFieldFilter

      public java.util.function.Function<java.lang.String,​java.util.function.Predicate<java.lang.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.