org.elasticsearch.index.mapper

Class MapperService

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.mapper.MapperService

All Implemented Interfaces:

Closeable, AutoCloseable, IndexComponent

public class MapperService
extends AbstractIndexComponent
implements Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapperService.MergeReason The reason why a mapping is being merged.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MAPPING
static boolean	INDEX_MAPPER_DYNAMIC_DEFAULT
static String	INDEX_MAPPER_DYNAMIC_SETTING
static String	INDEX_MAPPING_NESTED_FIELDS_LIMIT_SETTING

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

deprecationLogger, index, logger

Constructor Summary

Constructors

Constructor and Description
MapperService(Index index, IndexSettingsService indexSettingsService, AnalysisService analysisService, SimilarityLookupService similarityLookupService, ScriptService scriptService, MapperRegistry mapperRegistry)
MapperService(Index index, Settings indexSettings, AnalysisService analysisService, SimilarityLookupService similarityLookupService, ScriptService scriptService, MapperRegistry mapperRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
void	addTypeListener(DocumentTypeListener listener)
AnalysisService	analysisService()
void	close()
Iterable<DocumentMapper>	docMappers(boolean includingDefaultMapping) returns an immutable iterator over current document mappers.
DocumentMapper	documentMapper(String type) Return the DocumentMapper for the given type.
DocumentMapperParser	documentMapperParser()
DocumentMapperForType	documentMapperWithAutoCreate(String type) Returns the document mapper created, including a mapping update if the type has been dynamically created.
MappedFieldType	fullName(String fullName) Returns the MappedFieldType for the give fullName.
static String[]	getAllMetaFields()
ObjectMapper	getObjectMapper(String name, String[] types)
Set<String>	getParentTypes()
boolean	hasMapping(String mappingType)
boolean	hasNested()
org.apache.lucene.analysis.Analyzer	indexAnalyzer()
MappedFieldType	indexName(String indexName) Returns an MappedFieldType which has the given index name.
static boolean	isMetadataField(String fieldName)
void	merge(Map<String,Map<String,Object>> mappings, boolean updateAllTypes)
DocumentMapper	merge(String type, CompressedXContent mappingSource, MapperService.MergeReason reason, boolean updateAllTypes)
DocumentMapper	parse(String mappingType, CompressedXContent mappingSource, boolean applyDefault)
static Map<String,Object>	parseMapping(String mappingSource)
void	removeTypeListener(DocumentTypeListener listener)
ObjectMapper	resolveClosestNestedObjectMapper(String fieldName) Resolves the closest inherited ObjectMapper that is nested.
org.apache.lucene.analysis.Analyzer	searchAnalyzer()
org.apache.lucene.search.Query	searchFilter(String... types) A filter for search.
org.apache.lucene.analysis.Analyzer	searchQuoteAnalyzer()
Collection<String>	simpleMatchToIndexNames(String pattern) Returns all the fields that match the given pattern.
Collection<String>	simpleMatchToIndexNames(String pattern, String[] types)
MappedFieldType	smartNameFieldType(String smartName)
MappedFieldType	smartNameFieldType(String smartName, String[] types)
Collection<String>	types() Return the set of concrete types that have a mapping.
MappedFieldType	unmappedFieldType(String type) Given a type (eg.

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

index, indexSettings

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAPPING

public static final String DEFAULT_MAPPING

See Also:

Constant Field Values

INDEX_MAPPER_DYNAMIC_SETTING

public static final String INDEX_MAPPER_DYNAMIC_SETTING

See Also:

Constant Field Values

INDEX_MAPPING_NESTED_FIELDS_LIMIT_SETTING

public static final String INDEX_MAPPING_NESTED_FIELDS_LIMIT_SETTING

See Also:

Constant Field Values

INDEX_MAPPER_DYNAMIC_DEFAULT

public static final boolean INDEX_MAPPER_DYNAMIC_DEFAULT

See Also:

Constant Field Values

Constructor Detail

MapperService

@Inject
public MapperService(Index index,
                    IndexSettingsService indexSettingsService,
                    AnalysisService analysisService,
                    SimilarityLookupService similarityLookupService,
                    ScriptService scriptService,
                    MapperRegistry mapperRegistry)

MapperService

public MapperService(Index index,
             Settings indexSettings,
             AnalysisService analysisService,
             SimilarityLookupService similarityLookupService,
             ScriptService scriptService,
             MapperRegistry mapperRegistry)

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

hasNested

public boolean hasNested()

docMappers

public Iterable<DocumentMapper> docMappers(boolean includingDefaultMapping)

returns an immutable iterator over current document mappers.

Parameters:

includingDefaultMapping - indicates whether the iterator should contain the DEFAULT_MAPPING document mapper. As is this not really an active type, you would typically set this to false

analysisService

public AnalysisService analysisService()

documentMapperParser

public DocumentMapperParser documentMapperParser()

addTypeListener

public void addTypeListener(DocumentTypeListener listener)

removeTypeListener

public void removeTypeListener(DocumentTypeListener listener)

parseMapping

public static Map<String,Object> parseMapping(String mappingSource)
                                       throws Exception

Throws:

Exception

merge

public void merge(Map<String,Map<String,Object>> mappings,
         boolean updateAllTypes)
           throws MapperParsingException

Throws:

MapperParsingException

merge

public DocumentMapper merge(String type,
                   CompressedXContent mappingSource,
                   MapperService.MergeReason reason,
                   boolean updateAllTypes)

parse

public DocumentMapper parse(String mappingType,
                   CompressedXContent mappingSource,
                   boolean applyDefault)
                     throws MapperParsingException

Throws:

MapperParsingException

hasMapping

public boolean hasMapping(String mappingType)

types

public Collection<String> types()

Return the set of concrete types that have a mapping. NOTE: this does not return the default mapping.

documentMapper

public DocumentMapper documentMapper(String type)

Return the DocumentMapper for the given type. By using the special "_default_" type, you can get a DocumentMapper for the default mapping.

documentMapperWithAutoCreate

public DocumentMapperForType documentMapperWithAutoCreate(String type)

Returns the document mapper created, including a mapping update if the type has been dynamically created.

searchFilter

@Nullable
public org.apache.lucene.search.Query searchFilter(String... types)

A filter for search. If a filter is required, will return it, otherwise, will return null.

indexName

public MappedFieldType indexName(String indexName)

Returns an MappedFieldType which has the given index name. If multiple types have fields with the same index name, the first is returned.

fullName

public MappedFieldType fullName(String fullName)

Returns the MappedFieldType for the give fullName. If multiple types have fields with the same full name, the first is returned.

simpleMatchToIndexNames

public Collection<String> simpleMatchToIndexNames(String pattern)

Returns all the fields that match the given pattern. If the pattern is prefixed with a type then the fields will be returned with a type prefix.

simpleMatchToIndexNames

public Collection<String> simpleMatchToIndexNames(String pattern,
                                         @Nullable
                                         String[] types)

getObjectMapper

public ObjectMapper getObjectMapper(String name,
                           @Nullable
                           String[] types)

smartNameFieldType

public MappedFieldType smartNameFieldType(String smartName)

smartNameFieldType

public MappedFieldType smartNameFieldType(String smartName,
                                 @Nullable
                                 String[] types)

unmappedFieldType

public MappedFieldType unmappedFieldType(String type)

Given a type (eg. long, string, ...), return an anonymous field mapper that can be used for search operations.

indexAnalyzer

public org.apache.lucene.analysis.Analyzer indexAnalyzer()

searchAnalyzer

public org.apache.lucene.analysis.Analyzer searchAnalyzer()

searchQuoteAnalyzer

public org.apache.lucene.analysis.Analyzer searchQuoteAnalyzer()

resolveClosestNestedObjectMapper

public ObjectMapper resolveClosestNestedObjectMapper(String fieldName)

Resolves the closest inherited ObjectMapper that is nested.

getParentTypes

public Set<String> getParentTypes()

isMetadataField

public static boolean isMetadataField(String fieldName)

Returns:

Whether a field is a metadata field.

getAllMetaFields

public static String[] getAllMetaFields()