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

static class	DocumentMapper.Builder
static class	DocumentMapper.MergeFlags
static class	DocumentMapper.MergeResult A result of a merge.
static interface	DocumentMapper.ParseListener<ParseContext> A listener to be called during the parse process.
static class	DocumentMapper.ParseListenerAdapter

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

ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

DocumentMapper(String index, Settings indexSettings, DocumentMapperParser docMapperParser, RootObjectMapper rootObjectMapper, com.google.common.collect.ImmutableMap<String,Object> meta, NamedAnalyzer indexAnalyzer, NamedAnalyzer searchAnalyzer, NamedAnalyzer searchQuoteAnalyzer, Map<Class<? extends RootMapper>,RootMapper> rootMappers)

Method Summary

void	addFieldMapper(FieldMapper fieldMapper)
void	addFieldMapperListener(FieldMapperListener fieldMapperListener, boolean includeExisting)
void	addObjectMapper(ObjectMapper objectMapper)
void	addObjectMapperListener(ObjectMapperListener objectMapperListener, boolean includeExisting)
AllFieldMapper	allFieldMapper()
void	close()
boolean	hasNestedObjects()
IdFieldMapper	idFieldMapper()
org.apache.lucene.analysis.Analyzer	indexAnalyzer()
DocumentFieldMappers	mappers()
CompressedString	mappingSource()
DocumentMapper.MergeResult	merge(DocumentMapper mergeWith, DocumentMapper.MergeFlags mergeFlags)
com.google.common.collect.ImmutableMap<String,Object>	meta()
com.google.common.collect.ImmutableMap<String,ObjectMapper>	objectMappers()
ParentFieldMapper	parentFieldMapper()
ParsedDocument	parse(BytesReference source)
ParsedDocument	parse(SourceToParse source)
ParsedDocument	parse(SourceToParse source, DocumentMapper.ParseListener listener)
ParsedDocument	parse(String type, String id, BytesReference source)
void	refreshSource()
RootObjectMapper	root()
<T extends RootMapper> T	rootMapper(Class<T> type)
RoutingFieldMapper	routingFieldMapper()
org.apache.lucene.analysis.Analyzer	searchAnalyzer()
org.apache.lucene.analysis.Analyzer	searchQuotedAnalyzer()
SourceFieldMapper	sourceMapper()
TimestampFieldMapper	timestampFieldMapper()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	traverse(FieldMapperListener listener)
void	traverse(ObjectMapperListener listener)
TTLFieldMapper	TTLFieldMapper()
String	type()
org.apache.lucene.search.Filter	typeFilter()
TypeFieldMapper	typeMapper()
UidFieldMapper	uidMapper()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentMapper

public DocumentMapper(String index,
                      @Nullable
                      Settings indexSettings,
                      DocumentMapperParser docMapperParser,
                      RootObjectMapper rootObjectMapper,
                      com.google.common.collect.ImmutableMap<String,Object> meta,
                      NamedAnalyzer indexAnalyzer,
                      NamedAnalyzer searchAnalyzer,
                      NamedAnalyzer searchQuoteAnalyzer,
                      Map<Class<? extends RootMapper>,RootMapper> rootMappers)

Method Detail

type

public String type()

meta

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

mappingSource

public CompressedString mappingSource()

root

public RootObjectMapper root()

uidMapper

public UidFieldMapper uidMapper()

rootMapper

public <T extends RootMapper> T rootMapper(Class<T> type)

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()

indexAnalyzer

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

searchAnalyzer

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

searchQuotedAnalyzer

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

typeFilter

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

hasNestedObjects

public boolean hasNestedObjects()

mappers

public DocumentFieldMappers mappers()

objectMappers

public com.google.common.collect.ImmutableMap<String,ObjectMapper> objectMappers()

parse

public ParsedDocument parse(BytesReference source)
                     throws MapperParsingException

Throws:

MapperParsingException

parse

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

Throws:

MapperParsingException

parse

public ParsedDocument parse(SourceToParse source)
                     throws MapperParsingException

Throws:

MapperParsingException

parse

public ParsedDocument parse(SourceToParse source,
                            @Nullable
                            DocumentMapper.ParseListener listener)
                     throws MapperParsingException

Throws:

MapperParsingException

addFieldMapper

public void addFieldMapper(FieldMapper fieldMapper)

addFieldMapperListener

public void addFieldMapperListener(FieldMapperListener fieldMapperListener,
                                   boolean includeExisting)

traverse

public void traverse(FieldMapperListener listener)

addObjectMapper

public void addObjectMapper(ObjectMapper objectMapper)

addObjectMapperListener

public void addObjectMapperListener(ObjectMapperListener objectMapperListener,
                                    boolean includeExisting)

traverse

public void traverse(ObjectMapperListener listener)

merge

public DocumentMapper.MergeResult merge(DocumentMapper mergeWith,
                                        DocumentMapper.MergeFlags mergeFlags)

refreshSource

public void refreshSource()
                   throws FailedToGenerateSourceMapperException

Throws:

FailedToGenerateSourceMapperException

close

public void close()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException