Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class NestedObjectMapper

java.lang.Object

org.elasticsearch.index.mapper.Mapper

org.elasticsearch.index.mapper.ObjectMapper

org.elasticsearch.index.mapper.NestedObjectMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, ToXContent, ToXContentFragment

public class NestedObjectMapper
extends ObjectMapper

A Mapper for nested objects

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NestedObjectMapper.Builder
static class	NestedObjectMapper.TypeParser

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.ObjectMapper

ObjectMapper.Defaults, ObjectMapper.Dynamic

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE

Fields inherited from class org.elasticsearch.index.mapper.ObjectMapper

dynamic, enabled, mappers, subobjects

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected MapperBuilderContext	createChildContext(MapperBuilderContext mapperBuilderContext, String name)
Map<String,Mapper>	getChildren()
boolean	isIncludeInParent()
boolean	isIncludeInRoot()
boolean	isNested()
ObjectMapper	merge(Mapper mergeWith, MapperService.MergeReason reason, MapperBuilderContext parentBuilderContext)
org.apache.lucene.search.Query	nestedTypeFilter()
String	nestedTypePath()
ObjectMapper.Builder	newBuilder(Version indexVersionCreated)
void	setIncludeInParent(boolean includeInParent)
void	setIncludeInRoot(boolean includeInRoot)
SourceLoader.SyntheticFieldLoader	syntheticFieldLoader()	Create a SourceLoader.SyntheticFieldLoader to populate synthetic source.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.index.mapper.ObjectMapper

clone, doMerge, doXContent, dynamic, fullPath, getMapper, isEnabled, iterator, merge, name, serializeMappers, startSyntheticField, subobjects, syntheticFieldLoader, typeName, validate

Methods inherited from class org.elasticsearch.index.mapper.Mapper

internFieldName, simpleName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

Method Details

nestedTypeFilter

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

nestedTypePath

public String nestedTypePath()

isNested

public boolean isNested()

Overrides:

isNested in class ObjectMapper

isIncludeInParent

public boolean isIncludeInParent()

setIncludeInParent

public void setIncludeInParent(boolean includeInParent)

isIncludeInRoot

public boolean isIncludeInRoot()

setIncludeInRoot

public void setIncludeInRoot(boolean includeInRoot)

getChildren

public Map<String,Mapper> getChildren()

newBuilder

public ObjectMapper.Builder newBuilder(Version indexVersionCreated)

Overrides:

newBuilder in class ObjectMapper

Returns:

a Builder that will produce an empty ObjectMapper with the same configuration as this one

toXContent

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

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class ObjectMapper

Throws:

IOException

merge

public ObjectMapper merge(Mapper mergeWith,
 MapperService.MergeReason reason,
 MapperBuilderContext parentBuilderContext)

Overrides:

merge in class ObjectMapper

createChildContext

protected MapperBuilderContext createChildContext(MapperBuilderContext mapperBuilderContext,
 String name)

Overrides:

createChildContext in class ObjectMapper

syntheticFieldLoader

public SourceLoader.SyntheticFieldLoader syntheticFieldLoader()

Description copied from class: Mapper

Create a SourceLoader.SyntheticFieldLoader to populate synthetic source.

Overrides:

syntheticFieldLoader in class ObjectMapper