org.elasticsearch.index.mapper

Class DocumentMapper

java.lang.Object

org.elasticsearch.index.mapper.DocumentMapper

All Implemented Interfaces:

ToXContent

public class DocumentMapper
extends Object
implements ToXContent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentMapper.Builder

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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
DocumentMapper(MapperService mapperService, Mapping mapping)

Method Summary

Methods

Modifier and Type	Method and Description
AllFieldMapper	allFieldMapper()
void	close()
ObjectMapper	findNestedObjectMapper(int nestedDocId, SearchContext sc, org.apache.lucene.index.LeafReaderContext context) Returns the best nested ObjectMapper instances that is in the scope of the specified nested docId.
ObjectMapper	findParentObjectMapper(ObjectMapper objectMapper) Returns the parent ObjectMapper instance of the specified object mapper or null if there isn't any.
boolean	hasNestedObjects()
IdFieldMapper	idFieldMapper()
IndexFieldMapper	IndexFieldMapper()
IndexFieldMapper	indexMapper()
boolean	isParent(String type)
DocumentFieldMappers	mappers()
Mapping	mapping()
CompressedXContent	mappingSource()
DocumentMapper	merge(Mapping mapping, boolean updateAllTypes)
com.google.common.collect.ImmutableMap<String,Object>	meta()
<T extends MetadataFieldMapper> T	metadataMapper(Class<T> type)
Map<String,ObjectMapper>	objectMappers()
ParentFieldMapper	parentFieldMapper()
ParsedDocument	parse(SourceToParse source)
ParsedDocument	parse(String index, String type, String id, BytesReference source)
RootObjectMapper	root()
RoutingFieldMapper	routingFieldMapper()
SourceFieldMapper	sourceMapper()
TimestampFieldMapper	timestampFieldMapper()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Map<String,Object>	transformSourceAsMap(Map<String,Object> sourceAsMap) Transform the source when it is expressed as a map.
TTLFieldMapper	TTLFieldMapper()
String	type()
org.apache.lucene.search.Query	typeFilter()
TypeFieldMapper	typeMapper()
Text	typeText()
UidFieldMapper	uidMapper()
DocumentMapper	updateFieldType(Map<String,MappedFieldType> fullNameToFieldType) Recursively update sub field types.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentMapper

public DocumentMapper(MapperService mapperService,
              Mapping mapping)

Method Detail

mapping

public Mapping mapping()

type

public String type()

typeText

public Text typeText()

meta

public com.google.common.collect.ImmutableMap<String,Object> meta()

mappingSource

public CompressedXContent mappingSource()

root

public RootObjectMapper root()

uidMapper

public UidFieldMapper uidMapper()

metadataMapper

public <T extends MetadataFieldMapper> T metadataMapper(Class<T> type)

indexMapper

public IndexFieldMapper indexMapper()

typeMapper

public TypeFieldMapper typeMapper()

sourceMapper

public SourceFieldMapper sourceMapper()

allFieldMapper

public AllFieldMapper allFieldMapper()

idFieldMapper

public IdFieldMapper idFieldMapper()

routingFieldMapper

public RoutingFieldMapper routingFieldMapper()

parentFieldMapper

public ParentFieldMapper parentFieldMapper()

timestampFieldMapper

public TimestampFieldMapper timestampFieldMapper()

TTLFieldMapper

public TTLFieldMapper TTLFieldMapper()

IndexFieldMapper

public IndexFieldMapper IndexFieldMapper()

typeFilter

public org.apache.lucene.search.Query typeFilter()

hasNestedObjects

public boolean hasNestedObjects()

mappers

public DocumentFieldMappers mappers()

objectMappers

public Map<String,ObjectMapper> objectMappers()

parse

public ParsedDocument parse(String index,
                   String type,
                   String id,
                   BytesReference source)
                     throws MapperParsingException

Throws:

MapperParsingException

parse

public ParsedDocument parse(SourceToParse source)
                     throws MapperParsingException

Throws:

MapperParsingException

findNestedObjectMapper

public ObjectMapper findNestedObjectMapper(int nestedDocId,
                                  SearchContext sc,
                                  org.apache.lucene.index.LeafReaderContext context)
                                    throws IOException

Returns the best nested ObjectMapper instances that is in the scope of the specified nested docId.

Throws:

IOException

findParentObjectMapper

public ObjectMapper findParentObjectMapper(ObjectMapper objectMapper)

Returns the parent ObjectMapper instance of the specified object mapper or null if there isn't any.

transformSourceAsMap

public Map<String,Object> transformSourceAsMap(Map<String,Object> sourceAsMap)

Transform the source when it is expressed as a map. This is public so it can be transformed the source is loaded.

Parameters:

sourceAsMap - source to transform. This may be mutated by the script.

Returns:

transformed version of transformMe. This may actually be the same object as sourceAsMap

isParent

public boolean isParent(String type)

merge

public DocumentMapper merge(Mapping mapping,
                   boolean updateAllTypes)

updateFieldType

public DocumentMapper updateFieldType(Map<String,MappedFieldType> fullNameToFieldType)

Recursively update sub field types.

close

public void close()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException